File: pgtz.c

package info (click to toggle)
mobilitydb 1.3.0~rc1-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 119,380 kB
  • sloc: ansic: 175,127; sql: 100,930; xml: 23,111; yacc: 447; makefile: 200; lex: 151; sh: 142
file content (476 lines) | stat: -rw-r--r-- 13,788 bytes parent folder | download
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
/*-------------------------------------------------------------------------
 *
 * pgtz.c
 *    Timezone Library Integration Functions
 *
 * Portions Copyright (c) 1996-2021, PostgreSQL Global Development Group
 *
 * IDENTIFICATION
 *    src/timezone/pgtz.c
 *
 *-------------------------------------------------------------------------
 */
#include "postgres.h"

#include <ctype.h>
#include <fcntl.h>
#include <time.h>
#include <dirent.h> /* MEOS */
#include <common/hashfn.h> /* MEOS */
#include <sys/stat.h> /* MEOS */
// #include "datatype/timestamp.h" /* MEOS */
#include "utils/timestamp_def.h"
#include "pgtz.h"

/**
 * Structure to represent the timezone cache hash table, which extends
 * the `ENTRY` structure used by hsearch
 * https://man7.org/linux/man-pages/man3/hsearch.3.html
 * with the additional field `status` required by `simplehash`
 */
typedef struct
{
  char *key;     /**< timezone name (hashtable key) */
  void *data;    /**< pointer to the timezone structure */
  char status;   /**< hash status */
} tzentry;

static uint32 hash_string_pointer(const char *s);
#define SH_PREFIX tzcache
#define SH_ELEMENT_TYPE tzentry
#define SH_KEY_TYPE const char *
#define SH_KEY key
#define SH_HASH_KEY(tb, key) hash_string_pointer(key)
#define SH_EQUAL(tb, a, b) (strcmp(a, b) == 0)
#define SH_SCOPE static inline
#define SH_RAW_ALLOCATOR palloc0
#define SH_DESTROY tzcache_my_destroy(tzcache)
#define SH_DEFINE
#define SH_DECLARE
#include <lib/simplehash.h>
static void tzcache_my_destroy(tzcache_hash *tb);

/* Size of the timezone hash table */
#define TZCACHE_INITIAL_SIZE 32

/* Function in findtimezone.c */
extern const char *select_default_timezone(const char *share_path);

/* Current session timezone (controlled by TimeZone GUC) */
pg_tz *session_timezone = NULL;

/* Current log timezone (controlled by log_timezone GUC) */
// pg_tz *log_timezone = NULL; /* MEOS */

static bool scan_directory_ci(const char *dirname,
                const char *fname, int fnamelen,
                char *canonname, int canonnamelen);

/*
 * Helper function borrowed from PostgreSQL file `filemap.c`.
 */
static uint32
hash_string_pointer(const char *s)
{
  unsigned char *ss = (unsigned char *) s;
  return hash_bytes(ss, strlen(s));
}

/*
 * We keep loaded timezones in a hashtable so we don't have to
 * load and parse the TZ definition file every time one is selected.
 * Because we want timezone names to be found case-insensitively,
 * the hash key is the uppercased name of the zone.
 * MEOS: We use a fixed size hash table instead of a dynamic hash table
 * as in the original PG code.
 */
/* MEOS */
// typedef struct {...} pg_tz_cache;

static tzcache_hash *timezone_cache = NULL;

static bool
init_timezone_hashtable(void)
{
  /* MEOS: Create the timezone hash table */
  timezone_cache = tzcache_create(TZCACHE_INITIAL_SIZE, NULL);

  if (!timezone_cache)
    return false;

  return true;
}

/**
 * @brief Destroy function to free the memory allocated for the hash table
 */
static void tzcache_my_destroy(tzcache_hash *tb)
{
  tzcache_iterator it;
  tzentry *entry;
  tzcache_start_iterate(timezone_cache, &it);
  while ((entry = tzcache_iterate(timezone_cache, &it)) != NULL)
  {
    if (entry->key != NULL)
      pfree(entry->key); 
    if (entry->data != NULL)
      pfree(entry->data);
  }
  tzcache_destroy(tb);
}

/*
 * Return full pathname of timezone data directory
 */
static const char *
pg_TZDIR(void)
{
#ifndef SYSTEMTZDIR
  /* normal case: timezone stuff is under our share dir */
  static bool done_tzdir = false;
  static char tzdir[MAXPGPATH];

  if (done_tzdir)
    return tzdir;

  get_share_path(my_exec_path, tzdir);
  // strlcpy(tzdir + strlen(tzdir), "/timezone", MAXPGPATH - strlen(tzdir));
  strncpy(tzdir + strlen(tzdir), "/timezone", MAXPGPATH - strlen(tzdir));

  done_tzdir = true;
  return tzdir;
#else
  /* we're configured to use system's timezone database */
  return SYSTEMTZDIR;
#endif
}

/*
 * Given a timezone name, open() the timezone data file.  Return the
 * file descriptor if successful, -1 if not.
 *
 * The input name is searched for case-insensitively (we assume that the
 * timezone database does not contain case-equivalent names).
 *
 * If "canonname" is not NULL, then on success the canonical spelling of the
 * given name is stored there (the buffer must be > TZ_STRLEN_MAX bytes!).
 */
int
pg_open_tzfile(const char *name, char *canonname)
{
  char fullname[MAXPGPATH];
  int fullnamelen;
  int orignamelen;

  /* Initialize fullname with base name of tzdata directory */
  // strlcpy(fullname, pg_TZDIR(), sizeof(fullname)); /* MEOS */
  strncpy(fullname, pg_TZDIR(), sizeof(fullname));
  orignamelen = fullnamelen = strlen(fullname);

  if (fullnamelen + 1 + strlen(name) >= MAXPGPATH)
    return -1;        /* not gonna fit */

  /*
   * If the caller doesn't need the canonical spelling, first just try to
   * open the name as-is.  This can be expected to succeed if the given name
   * is already case-correct, or if the filesystem is case-insensitive; and
   * we don't need to distinguish those situations if we aren't tasked with
   * reporting the canonical spelling.
   */
  if (canonname == NULL)
  {
    fullname[fullnamelen] = '/';
    /* test above ensured this will fit: */
    strcpy(fullname + fullnamelen + 1, name);
    int result = open(fullname, O_RDONLY | PG_BINARY, 0);
    if (result >= 0)
      return result;
    /* If that didn't work, fall through to do it the hard way */
    fullname[fullnamelen] = '\0';
  }

  /*
   * Loop to split the given name into directory levels; for each level,
   * search using scan_directory_ci().
   */
  const char *fname = name;
  for (;;)
  {
    const char *slashptr = strchr(fname, '/');
    int fnamelen;
    if (slashptr)
      fnamelen = slashptr - fname;
    else
      fnamelen = strlen(fname);
    if (!scan_directory_ci(fullname, fname, fnamelen,
        fullname + fullnamelen + 1, MAXPGPATH - fullnamelen - 1))
      return -1;
    fullname[fullnamelen++] = '/';
    fullnamelen += strlen(fullname + fullnamelen);
    if (slashptr)
      fname = slashptr + 1;
    else
      break;
  }

  if (canonname)
    // strlcpy(canonname, fullname + orignamelen + 1, TZ_STRLEN_MAX + 1); /* MEOS */
    strncpy(canonname, fullname + orignamelen + 1, TZ_STRLEN_MAX + 1);

  return open(fullname, O_RDONLY | PG_BINARY, 0);
}

/* Function adapted from file fd.c */
/*
 * Alternate version of ReadDir that allows caller to specify the elevel
 * for any error report (whether it's reporting an initial failure of
 * AllocateDir or a subsequent directory read failure).
 *
 * If elevel < ERROR, returns NULL after any error.  With the normal coding
 * pattern, this will result in falling out of the loop immediately as
 * though the directory contained no (more) entries.
 */
struct dirent *
ReadDir(DIR *dir, const char *dirname)
{
  /* Give a generic message for AllocateDir failure, if caller didn't */
  if (dir == NULL)
  {
    elog(ERROR, "could not open directory \"%s\": %m", dirname);
    return NULL;
  }

  struct dirent *dent;
  errno = 0;
  if ((dent = readdir(dir)) != NULL)
    return dent;

  if (errno)
    elog(ERROR, "could not read directory \"%s\": %m", dirname);
  return NULL;
}

/*
 * Scan specified directory for a case-insensitive match to fname
 * (of length fnamelen --- fname may not be null terminated!).  If found,
 * copy the actual filename into canonname and return true.
 */
static bool
scan_directory_ci(const char *dirname, const char *fname, int fnamelen,
  char *canonname, int canonnamelen)
{
  bool found = false;
  DIR *dirdesc;
  struct dirent *direntry;

  // dirdesc = AllocateDir(dirname); /* MEOS */
  dirdesc = opendir(dirname);

  // while ((direntry = ReadDirExtended(dirdesc, dirname, LOG)) != NULL) /* MEOS */
  while ((direntry = ReadDir(dirdesc, dirname)) != NULL)
  {
    /*
     * Ignore . and .., plus any other "hidden" files.  This is a security
     * measure to prevent access to files outside the timezone directory.
     */
    if (direntry->d_name[0] == '.')
      continue;

    if (strlen(direntry->d_name) == (size_t) fnamelen &&
      pg_strncasecmp(direntry->d_name, fname, fnamelen) == 0)
    {
      /* Found our match */
      // strlcpy(canonname, direntry->d_name, canonnamelen); /* MEOS */
      strncpy(canonname, direntry->d_name, canonnamelen);
      found = true;
      break;
    }
  }

  // FreeDir(dirdesc); /* MEOS */
  closedir(dirdesc);

  return found;
}

/*
 * Load a timezone from file or from cache.
 * Does not verify that the timezone is acceptable!
 *
 * "GMT" is always interpreted as the tzparse() definition, without attempting
 * to load a definition from the filesystem.  This has a number of benefits:
 * 1. It's guaranteed to succeed, so we don't have the failure mode wherein
 * the bootstrap default timezone setting doesn't work (as could happen if
 * the OS attempts to supply a leap-second-aware version of "GMT").
 * 2. Because we aren't accessing the filesystem, we can safely initialize
 * the "GMT" zone definition before my_exec_path is known.
 * 3. It's quick enough that we don't waste much time when the bootstrap
 * default timezone setting is later overridden from postgresql.conf.
 */
pg_tz *
pg_tzset(const char *name)
{
  // pg_tz_cache *tzp; /* MEOS */
  struct state tzstate;
  char uppername[TZ_STRLEN_MAX + 1];
  char canonname[TZ_STRLEN_MAX + 1];
  char *p;

  if (strlen(name) > TZ_STRLEN_MAX)
    return NULL;      /* not going to fit */

  if (!timezone_cache)
    if (!init_timezone_hashtable())
      return NULL;

  /*
   * Upcase the given name to perform a case-insensitive hashtable search.
   * (We could alternatively downcase it, but we prefer upcase so that we
   * can get consistently upcased results from tzparse() in case the name is
   * a POSIX-style timezone spec.)
   */
  p = uppername;
  while (*name)
    *p++ = pg_toupper((unsigned char) *name++);
  *p = '\0';

  /* MEOS: Look for timezone in the cache */
  tzentry *entry = tzcache_lookup(timezone_cache, uppername);
  if (entry) {
    /* Timezone found in cache, create copy and return */
    pg_tz *cached = (pg_tz *) entry->data;

    pg_tz *tz = palloc(sizeof(pg_tz));
    strcpy(tz->TZname, cached->TZname);
    memcpy(&tz->state, &cached->state, sizeof(tzstate));

    return tz;
  }

  /*
   * "GMT" is always sent to tzparse(), as per discussion above.
   */
  if (strcmp(uppername, "GMT") == 0)
  {
    if (!tzparse(uppername, &tzstate, true))
    {
      /* This really, really should not happen ... */
      elog(ERROR, "could not initialize GMT time zone");
      return NULL;
    }
    /* Use uppercase name as canonical */
    strcpy(canonname, uppername);
  }
  else if (tzload(uppername, canonname, &tzstate, true) != 0)
  {
    if (uppername[0] == ':' || !tzparse(uppername, &tzstate, false))
    {
      /* Unknown timezone. Fail our call instead of loading GMT! */
      return NULL;
    }
    /* For POSIX timezone specs, use uppercase name as canonical */
    strcpy(canonname, uppername);
  }

  /* Create timezone object */
  pg_tz *tz = palloc(sizeof(pg_tz));
  strcpy(tz->TZname, canonname);
  memcpy(&tz->state, &tzstate, sizeof(tzstate));

  /* Create copy for cache */
  pg_tz *cached_tz = palloc(sizeof(pg_tz));
  strcpy(cached_tz->TZname, canonname);
  memcpy(&cached_tz->state, &tzstate, sizeof(tzstate));

  /* MEOS: Fill the struct to be added to the hash table */
  bool found;
  entry = tzcache_insert(timezone_cache, uppername, &found);
  if (! found)
  {
    entry->key = strdup(uppername);
    entry->data = cached_tz;
    return tz;
  }

  return NULL;
}

/*
 * Load a fixed-GMT-offset timezone.
 * This is used for SQL-spec SET TIME ZONE INTERVAL 'foo' cases.
 * It's otherwise equivalent to pg_tzset().
 *
 * The GMT offset is specified in seconds, positive values meaning west of
 * Greenwich (ie, POSIX not ISO sign convention).  However, we use ISO
 * sign convention in the displayable abbreviation for the zone.
 *
 * Caution: this can fail (return NULL) if the specified offset is outside
 * the range allowed by the zic library.
 */
pg_tz *
pg_tzset_offset(long gmtoffset)
{
  long    absoffset = (gmtoffset < 0) ? -gmtoffset : gmtoffset;
  char    offsetstr[64];
  // char    tzname[128]; /* MEOS */
  char    tzname[256];

  snprintf(offsetstr, sizeof(offsetstr),
       "%02ld", absoffset / SECS_PER_HOUR);
  absoffset %= SECS_PER_HOUR;
  if (absoffset != 0)
  {
    snprintf(offsetstr + strlen(offsetstr),
         sizeof(offsetstr) - strlen(offsetstr),
         ":%02ld", absoffset / SECS_PER_MINUTE);
    absoffset %= SECS_PER_MINUTE;
    if (absoffset != 0)
      snprintf(offsetstr + strlen(offsetstr),
           sizeof(offsetstr) - strlen(offsetstr),
           ":%02ld", absoffset);
  }
  if (gmtoffset > 0)
    snprintf(tzname, sizeof(tzname), "<-%s>+%s",
         offsetstr, offsetstr);
  else
    snprintf(tzname, sizeof(tzname), "<+%s>-%s",
         offsetstr, offsetstr);

  return pg_tzset(tzname);
}

/*
 * Initialize timezone cache
 */
void
meos_initialize_timezone(const char *tz_str)
{
  if (tz_str == NULL || strlen(tz_str) == 0)
    /* fetch local timezone */
    tz_str = select_default_timezone(NULL);
  if (tz_str == NULL)
    /* default timezone */
    tz_str = "GMT";

  /* Free the existing timezone entry */
  if (session_timezone)
    pfree(session_timezone); 
  session_timezone = pg_tzset(tz_str);
  if (! session_timezone)
    elog(ERROR, "Failed to initialize local timezone");
  return;
}

/*
 * Free the timezone cache
 */
void
meos_finalize_timezone(void)
{
  if (session_timezone)
    pfree(session_timezone); 
  if (timezone_cache)
    tzcache_my_destroy(timezone_cache);
  return;
}
/*****************************************************************************/