1/*-------------------------------------------------------------------------
2 *
3 * gistvalidate.c
4 * Opclass validator for GiST.
5 *
6 * Portions Copyright (c) 1996-2019, PostgreSQL Global Development Group
7 * Portions Copyright (c) 1994, Regents of the University of California
8 *
9 * IDENTIFICATION
10 * src/backend/access/gist/gistvalidate.c
11 *
12 *-------------------------------------------------------------------------
13 */
14#include "postgres.h"
15
16#include "access/amvalidate.h"
17#include "access/gist_private.h"
18#include "access/htup_details.h"
19#include "catalog/pg_amop.h"
20#include "catalog/pg_amproc.h"
21#include "catalog/pg_opclass.h"
22#include "catalog/pg_opfamily.h"
23#include "catalog/pg_type.h"
24#include "utils/builtins.h"
25#include "utils/lsyscache.h"
26#include "utils/regproc.h"
27#include "utils/syscache.h"
28
29
30/*
31 * Validator for a GiST opclass.
32 */
33bool
34gistvalidate(Oid opclassoid)
35{
36 bool result = true;
37 HeapTuple classtup;
38 Form_pg_opclass classform;
39 Oid opfamilyoid;
40 Oid opcintype;
41 Oid opckeytype;
42 char *opclassname;
43 HeapTuple familytup;
44 Form_pg_opfamily familyform;
45 char *opfamilyname;
46 CatCList *proclist,
47 *oprlist;
48 List *grouplist;
49 OpFamilyOpFuncGroup *opclassgroup;
50 int i;
51 ListCell *lc;
52
53 /* Fetch opclass information */
54 classtup = SearchSysCache1(CLAOID, ObjectIdGetDatum(opclassoid));
55 if (!HeapTupleIsValid(classtup))
56 elog(ERROR, "cache lookup failed for operator class %u", opclassoid);
57 classform = (Form_pg_opclass) GETSTRUCT(classtup);
58
59 opfamilyoid = classform->opcfamily;
60 opcintype = classform->opcintype;
61 opckeytype = classform->opckeytype;
62 if (!OidIsValid(opckeytype))
63 opckeytype = opcintype;
64 opclassname = NameStr(classform->opcname);
65
66 /* Fetch opfamily information */
67 familytup = SearchSysCache1(OPFAMILYOID, ObjectIdGetDatum(opfamilyoid));
68 if (!HeapTupleIsValid(familytup))
69 elog(ERROR, "cache lookup failed for operator family %u", opfamilyoid);
70 familyform = (Form_pg_opfamily) GETSTRUCT(familytup);
71
72 opfamilyname = NameStr(familyform->opfname);
73
74 /* Fetch all operators and support functions of the opfamily */
75 oprlist = SearchSysCacheList1(AMOPSTRATEGY, ObjectIdGetDatum(opfamilyoid));
76 proclist = SearchSysCacheList1(AMPROCNUM, ObjectIdGetDatum(opfamilyoid));
77
78 /* Check individual support functions */
79 for (i = 0; i < proclist->n_members; i++)
80 {
81 HeapTuple proctup = &proclist->members[i]->tuple;
82 Form_pg_amproc procform = (Form_pg_amproc) GETSTRUCT(proctup);
83 bool ok;
84
85 /*
86 * All GiST support functions should be registered with matching
87 * left/right types
88 */
89 if (procform->amproclefttype != procform->amprocrighttype)
90 {
91 ereport(INFO,
92 (errcode(ERRCODE_INVALID_OBJECT_DEFINITION),
93 errmsg("operator family \"%s\" of access method %s contains support function %s with different left and right input types",
94 opfamilyname, "gist",
95 format_procedure(procform->amproc))));
96 result = false;
97 }
98
99 /*
100 * We can't check signatures except within the specific opclass, since
101 * we need to know the associated opckeytype in many cases.
102 */
103 if (procform->amproclefttype != opcintype)
104 continue;
105
106 /* Check procedure numbers and function signatures */
107 switch (procform->amprocnum)
108 {
109 case GIST_CONSISTENT_PROC:
110 ok = check_amproc_signature(procform->amproc, BOOLOID, false,
111 5, 5, INTERNALOID, opcintype,
112 INT2OID, OIDOID, INTERNALOID);
113 break;
114 case GIST_UNION_PROC:
115 ok = check_amproc_signature(procform->amproc, opckeytype, false,
116 2, 2, INTERNALOID, INTERNALOID);
117 break;
118 case GIST_COMPRESS_PROC:
119 case GIST_DECOMPRESS_PROC:
120 case GIST_FETCH_PROC:
121 ok = check_amproc_signature(procform->amproc, INTERNALOID, true,
122 1, 1, INTERNALOID);
123 break;
124 case GIST_PENALTY_PROC:
125 ok = check_amproc_signature(procform->amproc, INTERNALOID, true,
126 3, 3, INTERNALOID,
127 INTERNALOID, INTERNALOID);
128 break;
129 case GIST_PICKSPLIT_PROC:
130 ok = check_amproc_signature(procform->amproc, INTERNALOID, true,
131 2, 2, INTERNALOID, INTERNALOID);
132 break;
133 case GIST_EQUAL_PROC:
134 ok = check_amproc_signature(procform->amproc, INTERNALOID, false,
135 3, 3, opckeytype, opckeytype,
136 INTERNALOID);
137 break;
138 case GIST_DISTANCE_PROC:
139 ok = check_amproc_signature(procform->amproc, FLOAT8OID, false,
140 5, 5, INTERNALOID, opcintype,
141 INT2OID, OIDOID, INTERNALOID);
142 break;
143 default:
144 ereport(INFO,
145 (errcode(ERRCODE_INVALID_OBJECT_DEFINITION),
146 errmsg("operator family \"%s\" of access method %s contains function %s with invalid support number %d",
147 opfamilyname, "gist",
148 format_procedure(procform->amproc),
149 procform->amprocnum)));
150 result = false;
151 continue; /* don't want additional message */
152 }
153
154 if (!ok)
155 {
156 ereport(INFO,
157 (errcode(ERRCODE_INVALID_OBJECT_DEFINITION),
158 errmsg("operator family \"%s\" of access method %s contains function %s with wrong signature for support number %d",
159 opfamilyname, "gist",
160 format_procedure(procform->amproc),
161 procform->amprocnum)));
162 result = false;
163 }
164 }
165
166 /* Check individual operators */
167 for (i = 0; i < oprlist->n_members; i++)
168 {
169 HeapTuple oprtup = &oprlist->members[i]->tuple;
170 Form_pg_amop oprform = (Form_pg_amop) GETSTRUCT(oprtup);
171 Oid op_rettype;
172
173 /* TODO: Check that only allowed strategy numbers exist */
174 if (oprform->amopstrategy < 1)
175 {
176 ereport(INFO,
177 (errcode(ERRCODE_INVALID_OBJECT_DEFINITION),
178 errmsg("operator family \"%s\" of access method %s contains operator %s with invalid strategy number %d",
179 opfamilyname, "gist",
180 format_operator(oprform->amopopr),
181 oprform->amopstrategy)));
182 result = false;
183 }
184
185 /* GiST supports ORDER BY operators */
186 if (oprform->amoppurpose != AMOP_SEARCH)
187 {
188 /* ... but must have matching distance proc */
189 if (!OidIsValid(get_opfamily_proc(opfamilyoid,
190 oprform->amoplefttype,
191 oprform->amoplefttype,
192 GIST_DISTANCE_PROC)))
193 {
194 ereport(INFO,
195 (errcode(ERRCODE_INVALID_OBJECT_DEFINITION),
196 errmsg("operator family \"%s\" of access method %s contains unsupported ORDER BY specification for operator %s",
197 opfamilyname, "gist",
198 format_operator(oprform->amopopr))));
199 result = false;
200 }
201 /* ... and operator result must match the claimed btree opfamily */
202 op_rettype = get_op_rettype(oprform->amopopr);
203 if (!opfamily_can_sort_type(oprform->amopsortfamily, op_rettype))
204 {
205 ereport(INFO,
206 (errcode(ERRCODE_INVALID_OBJECT_DEFINITION),
207 errmsg("operator family \"%s\" of access method %s contains incorrect ORDER BY opfamily specification for operator %s",
208 opfamilyname, "gist",
209 format_operator(oprform->amopopr))));
210 result = false;
211 }
212 }
213 else
214 {
215 /* Search operators must always return bool */
216 op_rettype = BOOLOID;
217 }
218
219 /* Check operator signature */
220 if (!check_amop_signature(oprform->amopopr, op_rettype,
221 oprform->amoplefttype,
222 oprform->amoprighttype))
223 {
224 ereport(INFO,
225 (errcode(ERRCODE_INVALID_OBJECT_DEFINITION),
226 errmsg("operator family \"%s\" of access method %s contains operator %s with wrong signature",
227 opfamilyname, "gist",
228 format_operator(oprform->amopopr))));
229 result = false;
230 }
231 }
232
233 /* Now check for inconsistent groups of operators/functions */
234 grouplist = identify_opfamily_groups(oprlist, proclist);
235 opclassgroup = NULL;
236 foreach(lc, grouplist)
237 {
238 OpFamilyOpFuncGroup *thisgroup = (OpFamilyOpFuncGroup *) lfirst(lc);
239
240 /* Remember the group exactly matching the test opclass */
241 if (thisgroup->lefttype == opcintype &&
242 thisgroup->righttype == opcintype)
243 opclassgroup = thisgroup;
244
245 /*
246 * There is not a lot we can do to check the operator sets, since each
247 * GiST opclass is more or less a law unto itself, and some contain
248 * only operators that are binary-compatible with the opclass datatype
249 * (meaning that empty operator sets can be OK). That case also means
250 * that we shouldn't insist on nonempty function sets except for the
251 * opclass's own group.
252 */
253 }
254
255 /* Check that the originally-named opclass is complete */
256 for (i = 1; i <= GISTNProcs; i++)
257 {
258 if (opclassgroup &&
259 (opclassgroup->functionset & (((uint64) 1) << i)) != 0)
260 continue; /* got it */
261 if (i == GIST_DISTANCE_PROC || i == GIST_FETCH_PROC ||
262 i == GIST_COMPRESS_PROC || i == GIST_DECOMPRESS_PROC)
263 continue; /* optional methods */
264 ereport(INFO,
265 (errcode(ERRCODE_INVALID_OBJECT_DEFINITION),
266 errmsg("operator class \"%s\" of access method %s is missing support function %d",
267 opclassname, "gist", i)));
268 result = false;
269 }
270
271 ReleaseCatCacheList(proclist);
272 ReleaseCatCacheList(oprlist);
273 ReleaseSysCache(familytup);
274 ReleaseSysCache(classtup);
275
276 return result;
277}
278