summaryrefslogtreecommitdiff
path: root/src/backend/utils/adt/pg_ndistinct.c
blob: 5292521b1695b9277682dfae272b66e97f3c4f26 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
/*-------------------------------------------------------------------------
 *
 * pg_ndistinct.c
 *		pg_ndistinct data type support.
 *
 * Portions Copyright (c) 1996-2025, PostgreSQL Global Development Group
 * Portions Copyright (c) 1994, Regents of the University of California
 *
 * IDENTIFICATION
 *	  src/backend/utils/adt/pg_ndistinct.c
 *
 *-------------------------------------------------------------------------
 */

#include "postgres.h"

#include "common/int.h"
#include "common/jsonapi.h"
#include "lib/stringinfo.h"
#include "mb/pg_wchar.h"
#include "nodes/miscnodes.h"
#include "statistics/extended_stats_internal.h"
#include "statistics/statistics_format.h"
#include "utils/builtins.h"
#include "utils/fmgrprotos.h"

/* Parsing state data */
typedef enum
{
	NDIST_EXPECT_START = 0,
	NDIST_EXPECT_ITEM,
	NDIST_EXPECT_KEY,
	NDIST_EXPECT_ATTNUM_LIST,
	NDIST_EXPECT_ATTNUM,
	NDIST_EXPECT_NDISTINCT,
	NDIST_EXPECT_COMPLETE,
} NDistinctSemanticState;

typedef struct
{
	const char *str;
	NDistinctSemanticState state;

	List	   *distinct_items; /* Accumulated complete MVNDistinctItems */
	Node	   *escontext;

	bool		found_attributes;	/* Item has "attributes" key */
	bool		found_ndistinct;	/* Item has "ndistinct" key */
	List	   *attnum_list;	/* Accumulated attribute numbers */
	int32		ndistinct;
} NDistinctParseState;

/*
 * Invoked at the start of each MVNDistinctItem.
 *
 * The entire JSON document should be one array of MVNDistinctItem objects.
 * If we are anywhere else in the document, it is an error.
 */
static JsonParseErrorType
ndistinct_object_start(void *state)
{
	NDistinctParseState *parse = state;

	switch (parse->state)
	{
		case NDIST_EXPECT_ITEM:
			/* Now we expect to see attributes/ndistinct keys */
			parse->state = NDIST_EXPECT_KEY;
			return JSON_SUCCESS;

		case NDIST_EXPECT_START:
			/* pg_ndistinct must begin with a '[' */
			errsave(parse->escontext,
					errcode(ERRCODE_INVALID_TEXT_REPRESENTATION),
					errmsg("malformed pg_ndistinct: \"%s\"", parse->str),
					errdetail("Initial element must be an array."));
			break;

		case NDIST_EXPECT_KEY:
			/* In an object, expecting key */
			errsave(parse->escontext,
					errcode(ERRCODE_INVALID_TEXT_REPRESENTATION),
					errmsg("malformed pg_ndistinct: \"%s\"", parse->str),
					errdetail("Expected an object key."));
			break;

		case NDIST_EXPECT_ATTNUM_LIST:
			/* Just followed an "attributes" key */
			errsave(parse->escontext,
					errcode(ERRCODE_INVALID_TEXT_REPRESENTATION),
					errmsg("malformed pg_ndistinct: \"%s\"", parse->str),
					errdetail("Value of \"%s\" must be an array of attribute numbers.",
							  PG_NDISTINCT_KEY_ATTRIBUTES));
			break;

		case NDIST_EXPECT_ATTNUM:
			/* In an attribute number list, expect only scalar integers */
			errsave(parse->escontext,
					errcode(ERRCODE_INVALID_TEXT_REPRESENTATION),
					errmsg("malformed pg_ndistinct: \"%s\"", parse->str),
					errdetail("Attribute lists can only contain attribute numbers."));
			break;

		case NDIST_EXPECT_NDISTINCT:
			/* Just followed an "ndistinct" key */
			errsave(parse->escontext,
					errcode(ERRCODE_INVALID_TEXT_REPRESENTATION),
					errmsg("malformed pg_ndistinct: \"%s\"", parse->str),
					errdetail("Value of \"%s\" must be an integer.",
							  PG_NDISTINCT_KEY_NDISTINCT));
			break;

		default:
			errsave(parse->escontext,
					errcode(ERRCODE_INVALID_TEXT_REPRESENTATION),
					errmsg("malformed pg_ndistinct: \"%s\"", parse->str),
					errdetail("Unexpected parse state: %d", (int) parse->state));
			break;
	}

	return JSON_SEM_ACTION_FAILED;
}

/*
 * Invoked at the end of an object.
 *
 * Check to ensure that it was a complete MVNDistinctItem
 */
static JsonParseErrorType
ndistinct_object_end(void *state)
{
	NDistinctParseState *parse = state;

	int			natts = 0;

	MVNDistinctItem *item;

	if (parse->state != NDIST_EXPECT_KEY)
	{
		errsave(parse->escontext,
				errcode(ERRCODE_INVALID_TEXT_REPRESENTATION),
				errmsg("malformed pg_ndistinct: \"%s\"", parse->str),
				errdetail("Unexpected parse state: %d", (int) parse->state));
		return JSON_SEM_ACTION_FAILED;
	}

	if (!parse->found_attributes)
	{
		errsave(parse->escontext,
				errcode(ERRCODE_INVALID_TEXT_REPRESENTATION),
				errmsg("malformed pg_ndistinct: \"%s\"", parse->str),
				errdetail("Item must contain \"%s\" key.",
						  PG_NDISTINCT_KEY_ATTRIBUTES));
		return JSON_SEM_ACTION_FAILED;
	}

	if (!parse->found_ndistinct)
	{
		errsave(parse->escontext,
				errcode(ERRCODE_INVALID_TEXT_REPRESENTATION),
				errmsg("malformed pg_ndistinct: \"%s\"", parse->str),
				errdetail("Item must contain \"%s\" key.",
						  PG_NDISTINCT_KEY_NDISTINCT));
		return JSON_SEM_ACTION_FAILED;
	}

	/*
	 * We need at least two attribute numbers for a ndistinct item, anything
	 * less is malformed.
	 */
	natts = list_length(parse->attnum_list);
	if ((natts < 2) || (natts > STATS_MAX_DIMENSIONS))
	{
		errsave(parse->escontext,
				errcode(ERRCODE_INVALID_TEXT_REPRESENTATION),
				errmsg("malformed pg_ndistinct: \"%s\"", parse->str),
				errdetail("The \"%s\" key must contain an array of at least %d and no more than %d attributes.",
						  PG_NDISTINCT_KEY_ATTRIBUTES, 2, STATS_MAX_DIMENSIONS));
		return JSON_SEM_ACTION_FAILED;
	}

	/* Create the MVNDistinctItem */
	item = palloc(sizeof(MVNDistinctItem));
	item->nattributes = natts;
	item->attributes = palloc0(natts * sizeof(AttrNumber));
	item->ndistinct = (double) parse->ndistinct;

	for (int i = 0; i < natts; i++)
		item->attributes[i] = (AttrNumber) list_nth_int(parse->attnum_list, i);

	parse->distinct_items = lappend(parse->distinct_items, (void *) item);

	/* reset item state vars */
	list_free(parse->attnum_list);
	parse->attnum_list = NIL;
	parse->ndistinct = 0;
	parse->found_attributes = false;
	parse->found_ndistinct = false;

	/* Now we are looking for the next MVNDistinctItem */
	parse->state = NDIST_EXPECT_ITEM;
	return JSON_SUCCESS;
}


/*
 * Invoked at the start of an array.
 *
 * ndistinct input format has two types of arrays, the outer MVNDistinctItem
 * array and the attribute number array within each MVNDistinctItem.
 */
static JsonParseErrorType
ndistinct_array_start(void *state)
{
	NDistinctParseState *parse = state;

	switch (parse->state)
	{
		case NDIST_EXPECT_ATTNUM_LIST:
			parse->state = NDIST_EXPECT_ATTNUM;
			break;

		case NDIST_EXPECT_START:
			parse->state = NDIST_EXPECT_ITEM;
			break;

		default:
			errsave(parse->escontext,
					errcode(ERRCODE_INVALID_TEXT_REPRESENTATION),
					errmsg("malformed pg_ndistinct: \"%s\"", parse->str),
					errdetail("Array found in unexpected place."));
			return JSON_SEM_ACTION_FAILED;
	}

	return JSON_SUCCESS;
}


/*
 * Invoked at the end of an array.
 *
 * Arrays can never be empty.
 */
static JsonParseErrorType
ndistinct_array_end(void *state)
{
	NDistinctParseState *parse = state;

	switch (parse->state)
	{
		case NDIST_EXPECT_ATTNUM:
			if (list_length(parse->attnum_list) > 0)
			{
				/*
				 * The attribute number list is complete, look for more
				 * MVNDistinctItem keys.
				 */
				parse->state = NDIST_EXPECT_KEY;
				return JSON_SUCCESS;
			}

			errsave(parse->escontext,
					errcode(ERRCODE_INVALID_TEXT_REPRESENTATION),
					errmsg("malformed pg_ndistinct: \"%s\"", parse->str),
					errdetail("The \"%s\" key must be a non-empty array.",
							  PG_NDISTINCT_KEY_ATTRIBUTES));
			break;

		case NDIST_EXPECT_ITEM:
			if (list_length(parse->distinct_items) > 0)
			{
				/* Item list is complete, we are done. */
				parse->state = NDIST_EXPECT_COMPLETE;
				return JSON_SUCCESS;
			}

			errsave(parse->escontext,
					errcode(ERRCODE_INVALID_TEXT_REPRESENTATION),
					errmsg("malformed pg_ndistinct: \"%s\"", parse->str),
					errdetail("Item array cannot be empty."));
			break;

		default:

			/*
			 * This can only happen if a case was missed in
			 * ndistinct_array_start().
			 */
			errsave(parse->escontext,
					errcode(ERRCODE_INVALID_TEXT_REPRESENTATION),
					errmsg("malformed pg_ndistinct: \"%s\"", parse->str),
					errdetail("Array found in unexpected place."));
			break;
	}

	return JSON_SEM_ACTION_FAILED;
}

/*
 * Invoked at the start of a key/value field.
 *
 * The valid keys for the MVNDistinctItem object are:
 *   - attributes
 *   - ndistinct
 */
static JsonParseErrorType
ndistinct_object_field_start(void *state, char *fname, bool isnull)
{
	NDistinctParseState *parse = state;

	if (strcmp(fname, PG_NDISTINCT_KEY_ATTRIBUTES) == 0)
	{
		if (parse->found_attributes)
		{
			errsave(parse->escontext,
					errcode(ERRCODE_INVALID_TEXT_REPRESENTATION),
					errmsg("malformed pg_ndistinct: \"%s\"", parse->str),
					errdetail("Multiple \"%s\" keys are not allowed.",
							  PG_NDISTINCT_KEY_ATTRIBUTES));
			return JSON_SEM_ACTION_FAILED;
		}
		parse->found_attributes = true;
		parse->state = NDIST_EXPECT_ATTNUM_LIST;
		return JSON_SUCCESS;
	}

	if (strcmp(fname, PG_NDISTINCT_KEY_NDISTINCT) == 0)
	{
		if (parse->found_ndistinct)
		{
			errsave(parse->escontext,
					errcode(ERRCODE_INVALID_TEXT_REPRESENTATION),
					errmsg("malformed pg_ndistinct: \"%s\"", parse->str),
					errdetail("Multiple \"%s\" keys are not allowed.",
							  PG_NDISTINCT_KEY_NDISTINCT));
			return JSON_SEM_ACTION_FAILED;
		}
		parse->found_ndistinct = true;
		parse->state = NDIST_EXPECT_NDISTINCT;
		return JSON_SUCCESS;
	}

	errsave(parse->escontext,
			errcode(ERRCODE_INVALID_TEXT_REPRESENTATION),
			errmsg("malformed pg_ndistinct: \"%s\"", parse->str),
			errdetail("Only allowed keys are \"%s\" and \"%s\".",
					  PG_NDISTINCT_KEY_ATTRIBUTES,
					  PG_NDISTINCT_KEY_NDISTINCT));
	return JSON_SEM_ACTION_FAILED;
}

/*
 * Invoked at the start of an array element.
 *
 * The overall structure of the datatype is an array, but there are also
 * arrays as the value of every attributes key.
 */
static JsonParseErrorType
ndistinct_array_element_start(void *state, bool isnull)
{
	const NDistinctParseState *parse = state;

	switch (parse->state)
	{
		case NDIST_EXPECT_ATTNUM:
			if (!isnull)
				return JSON_SUCCESS;

			errsave(parse->escontext,
					errcode(ERRCODE_INVALID_TEXT_REPRESENTATION),
					errmsg("malformed pg_ndistinct: \"%s\"", parse->str),
					errdetail("Attribute number array cannot be null."));
			break;

		case NDIST_EXPECT_ITEM:
			if (!isnull)
				return JSON_SUCCESS;

			errsave(parse->escontext,
					errcode(ERRCODE_INVALID_TEXT_REPRESENTATION),
					errmsg("malformed pg_ndistinct: \"%s\"", parse->str),
					errdetail("Item list elements cannot be null."));

			break;

		default:
			errsave(parse->escontext,
					errcode(ERRCODE_INVALID_TEXT_REPRESENTATION),
					errmsg("malformed pg_ndistinct: \"%s\"", parse->str),
					errdetail("Unexpected array element."));
			break;
	}

	return JSON_SEM_ACTION_FAILED;
}

/*
 * Test for valid subsequent attribute number.
 *
 * If the previous value is positive, then current value must either be
 * greater than the previous value, or negative.
 *
 * If the previous value is negative, then the value must be less than
 * the previous value.
 *
 * Duplicate values are obviously not allowed, but that is already covered
 * by the rules listed above.
 */
static bool
valid_subsequent_attnum(AttrNumber prev, AttrNumber cur)
{
	Assert(prev != 0);

	if (prev > 0)
		return ((cur > prev) || (cur < 0));

	return (cur < prev);
}

/*
 * Handle scalar events from the ndistinct input parser.
 *
 * Override integer parse error messages and replace them with errors
 * specific to the context.
 */
static JsonParseErrorType
ndistinct_scalar(void *state, char *token, JsonTokenType tokentype)
{
	NDistinctParseState *parse = state;
	AttrNumber	attnum;
	ErrorSaveContext escontext = {T_ErrorSaveContext};

	switch (parse->state)
	{
		case NDIST_EXPECT_ATTNUM:
			attnum = pg_strtoint16_safe(token, (Node *) &escontext);

			if (SOFT_ERROR_OCCURRED(&escontext))
			{
				errsave(parse->escontext,
						errcode(ERRCODE_INVALID_TEXT_REPRESENTATION),
						errmsg("malformed pg_ndistinct: \"%s\"", parse->str),
						errdetail("Invalid \"%s\" value.", PG_NDISTINCT_KEY_ATTRIBUTES));
				return JSON_SEM_ACTION_FAILED;
			}

			/*
			 * The attribute number cannot be zero a negative number beyond
			 * the number of the possible expressions.
			 */
			if (attnum == 0 || attnum < (0 - STATS_MAX_DIMENSIONS))
			{
				errsave(parse->escontext,
						errcode(ERRCODE_INVALID_TEXT_REPRESENTATION),
						errmsg("malformed pg_ndistinct: \"%s\"", parse->str),
						errdetail("Invalid \"%s\" element: %d.",
								  PG_NDISTINCT_KEY_ATTRIBUTES, attnum));
				return JSON_SEM_ACTION_FAILED;
			}

			if (list_length(parse->attnum_list) > 0)
			{
				const AttrNumber prev = llast_int(parse->attnum_list);

				if (!valid_subsequent_attnum(prev, attnum))
				{
					errsave(parse->escontext,
							errcode(ERRCODE_INVALID_TEXT_REPRESENTATION),
							errmsg("malformed pg_ndistinct: \"%s\"", parse->str),
							errdetail("Invalid \"%s\" element: %d cannot follow %d.",
									  PG_NDISTINCT_KEY_ATTRIBUTES, attnum, prev));
					return JSON_SEM_ACTION_FAILED;
				}
			}

			parse->attnum_list = lappend_int(parse->attnum_list, (int) attnum);
			return JSON_SUCCESS;

		case NDIST_EXPECT_NDISTINCT:

			/*
			 * While the structure dictates that ndistinct is a double
			 * precision floating point, it has always been an integer in the
			 * output generated.  Therefore, we parse it as an integer here.
			 */
			parse->ndistinct = pg_strtoint32_safe(token, (Node *) &escontext);

			if (!SOFT_ERROR_OCCURRED(&escontext))
			{
				parse->state = NDIST_EXPECT_KEY;
				return JSON_SUCCESS;
			}

			errsave(parse->escontext,
					errcode(ERRCODE_INVALID_TEXT_REPRESENTATION),
					errmsg("malformed pg_ndistinct: \"%s\"", parse->str),
					errdetail("Invalid \"%s\" value.",
							  PG_NDISTINCT_KEY_NDISTINCT));
			break;

		default:
			errsave(parse->escontext,
					errcode(ERRCODE_INVALID_TEXT_REPRESENTATION),
					errmsg("malformed pg_ndistinct: \"%s\"", parse->str),
					errdetail("Unexpected scalar."));
			break;
	}

	return JSON_SEM_ACTION_FAILED;
}

/*
 * Compare the attribute arrays of two MVNDistinctItem values,
 * looking for duplicate sets. Return true if a duplicate set is found.
 *
 * The arrays are required to be in canonical order (all positive numbers
 * in ascending order first, followed by all negative numbers in descending
 * order) so it's safe to compare the attrnums in order, stopping at the
 * first difference.
 */
static bool
item_attributes_eq(const MVNDistinctItem *a, const MVNDistinctItem *b)
{
	if (a->nattributes != b->nattributes)
		return false;

	for (int i = 0; i < a->nattributes; i++)
	{
		if (a->attributes[i] != b->attributes[i])
			return false;
	}

	return true;
}

/*
 * Ensure that an attribute number appears as one of the attribute numbers
 * in a MVNDistinctItem.
 */
static bool
item_has_attnum(const MVNDistinctItem *item, AttrNumber attnum)
{
	for (int i = 0; i < item->nattributes; i++)
	{
		if (attnum == item->attributes[i])
			return true;
	}
	return false;
}

/*
 * Ensure that the attributes in MVNDistinctItem A are a subset of the
 * reference MVNDistinctItem B.
 */
static bool
item_is_attnum_subset(const MVNDistinctItem *item,
					  const MVNDistinctItem *refitem)
{
	for (int i = 0; i < item->nattributes; i++)
	{
		if (!item_has_attnum(refitem, item->attributes[i]))
			return false;
	}
	return true;
}

/*
 * Generate a string representing an array of attribute numbers.
 *
 * Freeing the allocated string is the responsibility of the caller.
 */
static char *
item_attnum_list(const MVNDistinctItem *item)
{
	StringInfoData str;

	initStringInfo(&str);

	appendStringInfo(&str, "%d", item->attributes[0]);

	for (int i = 1; i < item->nattributes; i++)
		appendStringInfo(&str, ", %d", item->attributes[i]);

	return str.data;
}

/*
 * Attempt to build and serialize the MVNDistinct object.
 *
 * This can only be executed after the completion of the JSON parsing.
 *
 * In the event of an error, set the error context and return NULL.
 */
static bytea *
build_mvndistinct(NDistinctParseState *parse, char *str)
{
	MVNDistinct *ndistinct;
	int			nitems = list_length(parse->distinct_items);
	bytea	   *bytes;
	int			item_most_attrs = 0;
	int			item_most_attrs_idx = 0;

	switch (parse->state)
	{
		case NDIST_EXPECT_COMPLETE:

			/*
			 * Parsing has ended correctly and we should have a list of items.
			 * If we don't, something has been done wrong in one of the
			 * earlier parsing steps.
			 */
			if (nitems == 0)
				elog(ERROR,
					 "cannot have empty item list after parsing success.");
			break;

		case NDIST_EXPECT_START:
			/* blank */
			errsave(parse->escontext,
					errcode(ERRCODE_INVALID_TEXT_REPRESENTATION),
					errmsg("malformed pg_ndistinct: \"%s\"", str),
					errdetail("Value cannot be empty."));
			return NULL;

		default:
			/* Unexpected end-state. */
			errsave(parse->escontext,
					errcode(ERRCODE_INVALID_TEXT_REPRESENTATION),
					errmsg("malformed pg_ndistinct: \"%s\"", str),
					errdetail("Unexpected end state %d.", parse->state));
			return NULL;
	}

	ndistinct = palloc(offsetof(MVNDistinct, items) +
					   nitems * sizeof(MVNDistinctItem));

	ndistinct->magic = STATS_NDISTINCT_MAGIC;
	ndistinct->type = STATS_NDISTINCT_TYPE_BASIC;
	ndistinct->nitems = nitems;

	for (int i = 0; i < nitems; i++)
	{
		MVNDistinctItem *item = list_nth(parse->distinct_items, i);

		/*
		 * Ensure that this item does not duplicate the attributes of any
		 * pre-existing item.
		 */
		for (int j = 0; j < i; j++)
		{
			if (item_attributes_eq(item, &ndistinct->items[j]))
			{
				char	   *s = item_attnum_list(item);

				errsave(parse->escontext,
						errcode(ERRCODE_INVALID_TEXT_REPRESENTATION),
						errmsg("malformed pg_ndistinct: \"%s\"", str),
						errdetail("Duplicated \"%s\" array found: [%s]",
								  PG_NDISTINCT_KEY_ATTRIBUTES, s));
				pfree(s);
				return NULL;
			}
		}

		ndistinct->items[i].ndistinct = item->ndistinct;
		ndistinct->items[i].nattributes = item->nattributes;

		/*
		 * This transfers free-ing responsibility from the distinct_items list
		 * to the ndistinct object.
		 */
		ndistinct->items[i].attributes = item->attributes;

		/*
		 * Keep track of the first longest attribute list. All other attribute
		 * lists must be a subset of this list.
		 */
		if (item->nattributes > item_most_attrs)
		{
			item_most_attrs = item->nattributes;
			item_most_attrs_idx = i;
		}
	}

	/*
	 * Verify that all the sets of attribute numbers are a proper subset of
	 * the longest set recorded.  This acts as an extra sanity check based on
	 * the input given.  Note that this still needs to be cross-checked with
	 * the extended statistics objects this would be assigned to, but it
	 * provides one extra layer of protection.
	 */
	for (int i = 0; i < nitems; i++)
	{
		if (i == item_most_attrs_idx)
			continue;

		if (!item_is_attnum_subset(&ndistinct->items[i],
								   &ndistinct->items[item_most_attrs_idx]))
		{
			const MVNDistinctItem *item = &ndistinct->items[i];
			const MVNDistinctItem *refitem = &ndistinct->items[item_most_attrs_idx];
			char	   *item_list = item_attnum_list(item);
			char	   *refitem_list = item_attnum_list(refitem);

			errsave(parse->escontext,
					errcode(ERRCODE_INVALID_TEXT_REPRESENTATION),
					errmsg("malformed pg_ndistinct: \"%s\"", str),
					errdetail("\"%s\" array: [%s] must be a subset of array: [%s]",
							  PG_NDISTINCT_KEY_ATTRIBUTES,
							  item_list, refitem_list));
			pfree(item_list);
			pfree(refitem_list);
			return NULL;
		}
	}

	bytes = statext_ndistinct_serialize(ndistinct);

	/*
	 * Free the attribute lists, before the ndistinct itself.
	 */
	for (int i = 0; i < nitems; i++)
		pfree(ndistinct->items[i].attributes);
	pfree(ndistinct);

	return bytes;
}

/*
 * pg_ndistinct_in
 *		input routine for type pg_ndistinct.
 */
Datum
pg_ndistinct_in(PG_FUNCTION_ARGS)
{
	char	   *str = PG_GETARG_CSTRING(0);
	NDistinctParseState parse_state;
	JsonParseErrorType result;
	JsonLexContext *lex;
	JsonSemAction sem_action;
	bytea	   *bytes = NULL;

	/* initialize semantic state */
	parse_state.str = str;
	parse_state.state = NDIST_EXPECT_START;
	parse_state.distinct_items = NIL;
	parse_state.escontext = fcinfo->context;
	parse_state.found_attributes = false;
	parse_state.found_ndistinct = false;
	parse_state.attnum_list = NIL;
	parse_state.ndistinct = 0;

	/* set callbacks */
	sem_action.semstate = (void *) &parse_state;
	sem_action.object_start = ndistinct_object_start;
	sem_action.object_end = ndistinct_object_end;
	sem_action.array_start = ndistinct_array_start;
	sem_action.array_end = ndistinct_array_end;
	sem_action.object_field_start = ndistinct_object_field_start;
	sem_action.object_field_end = NULL;
	sem_action.array_element_start = ndistinct_array_element_start;
	sem_action.array_element_end = NULL;
	sem_action.scalar = ndistinct_scalar;

	lex = makeJsonLexContextCstringLen(NULL, str, strlen(str),
									   PG_UTF8, true);
	result = pg_parse_json(lex, &sem_action);
	freeJsonLexContext(lex);

	if (result == JSON_SUCCESS)
		bytes = build_mvndistinct(&parse_state, str);

	list_free(parse_state.attnum_list);
	list_free_deep(parse_state.distinct_items);

	if (bytes)
		PG_RETURN_BYTEA_P(bytes);

	/*
	 * If escontext already set, just use that. Anything else is a generic
	 * JSON parse error.
	 */
	if (!SOFT_ERROR_OCCURRED(parse_state.escontext))
		errsave(parse_state.escontext,
				errcode(ERRCODE_INVALID_TEXT_REPRESENTATION),
				errmsg("malformed pg_ndistinct: \"%s\"", str),
				errdetail("Must be valid JSON."));

	PG_RETURN_NULL();
}

/*
 * pg_ndistinct_out
 *		output routine for type pg_ndistinct
 *
 * Produces a human-readable representation of the value.
 */
Datum
pg_ndistinct_out(PG_FUNCTION_ARGS)
{
	bytea	   *data = PG_GETARG_BYTEA_PP(0);
	MVNDistinct *ndist = statext_ndistinct_deserialize(data);
	int			i;
	StringInfoData str;

	initStringInfo(&str);
	appendStringInfoChar(&str, '[');

	for (i = 0; i < ndist->nitems; i++)
	{
		MVNDistinctItem item = ndist->items[i];

		if (i > 0)
			appendStringInfoString(&str, ", ");

		if (item.nattributes <= 0)
			elog(ERROR, "invalid zero-length attribute array in MVNDistinct");

		appendStringInfo(&str, "{\"" PG_NDISTINCT_KEY_ATTRIBUTES "\": [%d",
						 item.attributes[0]);

		for (int j = 1; j < item.nattributes; j++)
			appendStringInfo(&str, ", %d", item.attributes[j]);

		appendStringInfo(&str, "], \"" PG_NDISTINCT_KEY_NDISTINCT "\": %d}",
						 (int) item.ndistinct);
	}

	appendStringInfoChar(&str, ']');

	PG_RETURN_CSTRING(str.data);
}

/*
 * pg_ndistinct_recv
 *		binary input routine for type pg_ndistinct
 */
Datum
pg_ndistinct_recv(PG_FUNCTION_ARGS)
{
	ereport(ERROR,
			(errcode(ERRCODE_FEATURE_NOT_SUPPORTED),
			 errmsg("cannot accept a value of type %s", "pg_ndistinct")));

	PG_RETURN_VOID();			/* keep compiler quiet */
}

/*
 * pg_ndistinct_send
 *		binary output routine for type pg_ndistinct
 *
 * n-distinct is serialized into a bytea value, so let's send that.
 */
Datum
pg_ndistinct_send(PG_FUNCTION_ARGS)
{
	return byteasend(fcinfo);
}