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
|
#include <stdio.h>
#include "pg_query.h"
#include "pg_query_internal.h"
#include "pg_query_fingerprint.h"
#include "postgres.h"
#include "xxhash/xxhash.h"
#include "lib/ilist.h"
#include "parser/parser.h"
#include "parser/scanner.h"
#include "parser/scansup.h"
#include "nodes/parsenodes.h"
#include "nodes/value.h"
#include "common/hashfn.h"
#include <unistd.h>
#include <fcntl.h>
// Definitions
typedef struct FingerprintContext
{
XXH3_state_t *xxh_state;
struct listsort_cache_hash *listsort_cache;
bool write_tokens;
dlist_head tokens;
} FingerprintContext;
typedef struct FingerprintListsortItem
{
XXH64_hash_t hash;
size_t list_pos;
} FingerprintListsortItem;
typedef struct FingerprintListsortItemCacheEntry
{
/* List node this cache entry is for */
uintptr_t node;
/* Hashes of all list items -- this is expensive to calculate */
FingerprintListsortItem **listsort_items;
size_t listsort_items_size;
/* hash entry status */
char status;
} FingerprintListsortItemCacheEntry;
#define SH_PREFIX listsort_cache
#define SH_ELEMENT_TYPE FingerprintListsortItemCacheEntry
#define SH_KEY_TYPE uintptr_t
#define SH_KEY node
#define SH_HASH_KEY(tb, key) hash_bytes((const unsigned char *) &key, sizeof(uintptr_t))
#define SH_EQUAL(tb, a, b) a == b
#define SH_SCOPE static inline
#define SH_DEFINE
#define SH_DECLARE
#include "lib/simplehash.h"
typedef struct FingerprintToken
{
char *str;
dlist_node list_node;
} FingerprintToken;
static void _fingerprintNode(FingerprintContext *ctx, const void *obj, const void *parent, char *parent_field_name, unsigned int depth);
static void _fingerprintInitContext(FingerprintContext *ctx, FingerprintContext *parent, bool write_tokens);
static void _fingerprintFreeContext(FingerprintContext *ctx);
#define PG_QUERY_FINGERPRINT_VERSION 3
// Implementations
static void
_fingerprintString(FingerprintContext *ctx, const char *str)
{
if (ctx->xxh_state != NULL) {
XXH3_64bits_update(ctx->xxh_state, str, strlen(str));
}
if (ctx->write_tokens) {
FingerprintToken *token = palloc0(sizeof(FingerprintToken));
token->str = pstrdup(str);
dlist_push_tail(&ctx->tokens, &token->list_node);
}
}
static void
_fingerprintInteger(FingerprintContext *ctx, const union ValUnion *value)
{
if (value->ival.ival != 0) {
_fingerprintString(ctx, "Integer");
_fingerprintString(ctx, "ival");
char buffer[50];
sprintf(buffer, "%d", value->ival.ival);
_fingerprintString(ctx, buffer);
}
}
static void
_fingerprintFloat(FingerprintContext *ctx, const union ValUnion *value)
{
if (value->fval.fval != NULL) {
// NB: We output `str` here intentionally, to match the output format from libpg_query 14
// and below. This results in stable fingerprints, despite the field name being changed in
// PG15 to `fval`.
_fingerprintString(ctx, "Float");
_fingerprintString(ctx, "str");
_fingerprintString(ctx, value->fval.fval);
}
}
static void
_fingerprintBoolean(FingerprintContext *ctx, const union ValUnion *value)
{
_fingerprintString(ctx, "Boolean");
_fingerprintString(ctx, "boolval");
_fingerprintString(ctx, value->boolval.boolval ? "true" : "false");
}
static void
_fingerprintBitString(FingerprintContext *ctx, const union ValUnion *value)
{
if (value->bsval.bsval != NULL) {
// NB: We output `str` here intentionally, to match the output format from libpg_query 14
// and below. This results in stable fingerprints, despite the field name being changed in
// PG15 to `bsval`.
_fingerprintString(ctx, "BitString");
_fingerprintString(ctx, "str");
_fingerprintString(ctx, value->bsval.bsval);
}
}
static int compareFingerprintListsortItem(const void *a, const void *b)
{
FingerprintListsortItem *ca = *(FingerprintListsortItem**) a;
FingerprintListsortItem *cb = *(FingerprintListsortItem**) b;
if (ca->hash > cb->hash)
return 1;
else if (ca->hash < cb->hash)
return -1;
return 0;
}
static void
_fingerprintList(FingerprintContext *ctx, const List *node, const void *parent, char *field_name, unsigned int depth)
{
if (field_name != NULL && (strcmp(field_name, "fromClause") == 0 || strcmp(field_name, "targetList") == 0 ||
strcmp(field_name, "cols") == 0 || strcmp(field_name, "rexpr") == 0 || strcmp(field_name, "valuesLists") == 0 ||
strcmp(field_name, "args") == 0))
{
/*
* Check for cached values for the hashes of subnodes
*
* Note this cache is important so we avoid exponential runtime behavior,
* which would be the case if we fingerprinted each node twice, which
* then would also again have to fingerprint each of its subnodes twice,
* etc., leading to deep nodes to be fingerprinted many many times over.
*
* We have seen real-world problems with this logic here without
* a cache in place.
*/
FingerprintListsortItem** listsort_items = NULL;
size_t listsort_items_size = 0;
FingerprintListsortItemCacheEntry *entry = listsort_cache_lookup(ctx->listsort_cache, (uintptr_t) node);
if (entry != NULL)
{
listsort_items = entry->listsort_items;
listsort_items_size = entry->listsort_items_size;
}
else
{
listsort_items = palloc0(node->length * sizeof(FingerprintListsortItem*));
listsort_items_size = 0;
ListCell *lc;
bool found;
foreach(lc, node)
{
FingerprintContext fctx;
FingerprintListsortItem* lctx = palloc0(sizeof(FingerprintListsortItem));
_fingerprintInitContext(&fctx, ctx, false);
_fingerprintNode(&fctx, lfirst(lc), parent, field_name, depth + 1);
lctx->hash = XXH3_64bits_digest(fctx.xxh_state);
lctx->list_pos = listsort_items_size;
_fingerprintFreeContext(&fctx);
listsort_items[listsort_items_size] = lctx;
listsort_items_size += 1;
}
pg_qsort(listsort_items, listsort_items_size, sizeof(FingerprintListsortItem*), compareFingerprintListsortItem);
FingerprintListsortItemCacheEntry *entry = listsort_cache_insert(ctx->listsort_cache, (uintptr_t) node, &found);
Assert(!found);
entry->listsort_items = listsort_items;
entry->listsort_items_size = listsort_items_size;
}
for (size_t i = 0; i < listsort_items_size; i++)
{
if (i > 0 && listsort_items[i - 1]->hash == listsort_items[i]->hash)
continue; // Ignore duplicates
_fingerprintNode(ctx, lfirst(list_nth_cell(node, listsort_items[i]->list_pos)), parent, field_name, depth + 1);
}
}
else
{
const ListCell *lc;
foreach(lc, node)
{
_fingerprintNode(ctx, lfirst(lc), parent, field_name, depth + 1);
lnext(node, lc);
}
}
}
static void
_fingerprintInitContext(FingerprintContext *ctx, FingerprintContext *parent, bool write_tokens)
{
ctx->xxh_state = XXH3_createState();
if (ctx->xxh_state == NULL) abort();
if (XXH3_64bits_reset_withSeed(ctx->xxh_state, PG_QUERY_FINGERPRINT_VERSION) == XXH_ERROR) abort();
if (parent != NULL)
{
ctx->listsort_cache = parent->listsort_cache;
}
else
{
ctx->listsort_cache = listsort_cache_create(CurrentMemoryContext, 128, NULL);
}
if (write_tokens)
{
ctx->write_tokens = true;
dlist_init(&ctx->tokens);
}
else
{
ctx->write_tokens = false;
}
}
static void
_fingerprintFreeContext(FingerprintContext *ctx) {
XXH3_freeState(ctx->xxh_state);
}
#include "pg_query_enum_defs.c"
#include "pg_query_fingerprint_defs.c"
void
_fingerprintNode(FingerprintContext *ctx, const void *obj, const void *parent, char *field_name, unsigned int depth)
{
// Some queries are overly complex in their parsetree - lets consistently cut them off at 100 nodes deep
if (depth >= 100) {
return;
}
if (obj == NULL)
{
return; // Ignore
}
switch (nodeTag(obj))
{
case T_List:
_fingerprintList(ctx, obj, parent, field_name, depth);
break;
case T_Integer:
_fingerprintInteger(ctx, obj);
break;
case T_Float:
_fingerprintFloat(ctx, obj);
break;
case T_Boolean:
_fingerprintBoolean(ctx, obj);
break;
case T_String:
// NB: We output `str` here intentionally, to match the output format from libpg_query
// 14 and below. This results in stable fingerprints, despite the field name being
// changed in PG15 to `sval`.
_fingerprintString(ctx, "String");
_fingerprintString(ctx, "str");
_fingerprintString(ctx, ((union ValUnion*) obj)->sval.sval);
break;
case T_BitString:
_fingerprintBitString(ctx, obj);
break;
#include "pg_query_fingerprint_conds.c"
default:
elog(WARNING, "could not fingerprint unrecognized node type: %d",
(int) nodeTag(obj));
return;
}
}
uint64_t pg_query_fingerprint_node(const void *node)
{
FingerprintContext ctx;
uint64 result;
_fingerprintInitContext(&ctx, NULL, false);
_fingerprintNode(&ctx, node, NULL, NULL, 0);
result = XXH3_64bits_digest(ctx.xxh_state);
_fingerprintFreeContext(&ctx);
return result;
}
PgQueryFingerprintResult pg_query_fingerprint_with_opts(const char* input, int parser_options, bool printTokens)
{
MemoryContext ctx = NULL;
PgQueryInternalParsetreeAndError parsetree_and_error;
PgQueryFingerprintResult result = {0};
ctx = pg_query_enter_memory_context();
parsetree_and_error = pg_query_raw_parse(input, parser_options);
// These are all malloc-ed and will survive exiting the memory context, the caller is responsible to free them now
result.stderr_buffer = parsetree_and_error.stderr_buffer;
result.error = parsetree_and_error.error;
if (parsetree_and_error.tree != NULL || result.error == NULL) {
FingerprintContext ctx;
XXH64_canonical_t chash;
_fingerprintInitContext(&ctx, NULL, printTokens);
if (parsetree_and_error.tree != NULL) {
_fingerprintNode(&ctx, parsetree_and_error.tree, NULL, NULL, 0);
}
if (printTokens) {
dlist_iter iter;
printf("[");
dlist_foreach(iter, &ctx.tokens)
{
FingerprintToken *token = dlist_container(FingerprintToken, list_node, iter.cur);
printf("\"%s\", ", token->str);
}
printf("]\n");
}
result.fingerprint = XXH3_64bits_digest(ctx.xxh_state);
_fingerprintFreeContext(&ctx);
XXH64_canonicalFromHash(&chash, result.fingerprint);
result.fingerprint_str = malloc(17 * sizeof(char));
int n = snprintf(result.fingerprint_str, 17, "%02x%02x%02x%02x%02x%02x%02x%02x",
chash.digest[0], chash.digest[1], chash.digest[2], chash.digest[3],
chash.digest[4], chash.digest[5], chash.digest[6], chash.digest[7]);
if (n < 0 || n >= 17) {
PgQueryError* error = malloc(sizeof(PgQueryError));
error->message = strdup("Failed to output fingerprint string due to snprintf failure");
result.error = error;
}
}
pg_query_exit_memory_context(ctx);
return result;
}
PgQueryFingerprintResult pg_query_fingerprint(const char* input)
{
return pg_query_fingerprint_with_opts(input, PG_QUERY_PARSE_DEFAULT, false);
}
PgQueryFingerprintResult pg_query_fingerprint_opts(const char* input, int parser_options)
{
return pg_query_fingerprint_with_opts(input, parser_options, false);
}
void pg_query_free_fingerprint_result(PgQueryFingerprintResult result)
{
if (result.error) {
free(result.error->message);
free(result.error->filename);
free(result.error->funcname);
free(result.error);
}
free(result.fingerprint_str);
free(result.stderr_buffer);
}
|