PostgreSQL Source Code  git master
timestamp.h
Go to the documentation of this file.
1 /*-------------------------------------------------------------------------
2  *
3  * timestamp.h
4  * Definitions for the SQL "timestamp" and "interval" types.
5  *
6  * Portions Copyright (c) 1996-2023, PostgreSQL Global Development Group
7  * Portions Copyright (c) 1994, Regents of the University of California
8  *
9  * src/include/utils/timestamp.h
10  *
11  *-------------------------------------------------------------------------
12  */
13 #ifndef TIMESTAMP_H
14 #define TIMESTAMP_H
15 
16 #include "datatype/timestamp.h"
17 #include "fmgr.h"
18 #include "pgtime.h"
19 
20 
21 /*
22  * Functions for fmgr-callable functions.
23  *
24  * For Timestamp, we make use of the same support routines as for int64.
25  * Therefore Timestamp is pass-by-reference if and only if int64 is!
26  */
27 static inline Timestamp
29 {
30  return (Timestamp) DatumGetInt64(X);
31 }
32 
33 static inline TimestampTz
35 {
36  return (TimestampTz) DatumGetInt64(X);
37 }
38 
39 static inline Interval *
41 {
42  return (Interval *) DatumGetPointer(X);
43 }
44 
45 static inline Datum
47 {
48  return Int64GetDatum(X);
49 }
50 
51 static inline Datum
53 {
54  return Int64GetDatum(X);
55 }
56 
57 static inline Datum
59 {
60  return PointerGetDatum(X);
61 }
62 
63 #define PG_GETARG_TIMESTAMP(n) DatumGetTimestamp(PG_GETARG_DATUM(n))
64 #define PG_GETARG_TIMESTAMPTZ(n) DatumGetTimestampTz(PG_GETARG_DATUM(n))
65 #define PG_GETARG_INTERVAL_P(n) DatumGetIntervalP(PG_GETARG_DATUM(n))
66 
67 #define PG_RETURN_TIMESTAMP(x) return TimestampGetDatum(x)
68 #define PG_RETURN_TIMESTAMPTZ(x) return TimestampTzGetDatum(x)
69 #define PG_RETURN_INTERVAL_P(x) return IntervalPGetDatum(x)
70 
71 
72 #define TIMESTAMP_MASK(b) (1 << (b))
73 #define INTERVAL_MASK(b) (1 << (b))
74 
75 /* Macros to handle packing and unpacking the typmod field for intervals */
76 #define INTERVAL_FULL_RANGE (0x7FFF)
77 #define INTERVAL_RANGE_MASK (0x7FFF)
78 #define INTERVAL_FULL_PRECISION (0xFFFF)
79 #define INTERVAL_PRECISION_MASK (0xFFFF)
80 #define INTERVAL_TYPMOD(p,r) ((((r) & INTERVAL_RANGE_MASK) << 16) | ((p) & INTERVAL_PRECISION_MASK))
81 #define INTERVAL_PRECISION(t) ((t) & INTERVAL_PRECISION_MASK)
82 #define INTERVAL_RANGE(t) (((t) >> 16) & INTERVAL_RANGE_MASK)
83 
84 /* Macros for doing timestamp arithmetic without assuming timestamp's units */
85 #define TimestampTzPlusMilliseconds(tz,ms) ((tz) + ((ms) * (int64) 1000))
86 #define TimestampTzPlusSeconds(tz,s) ((tz) + ((s) * (int64) 1000000))
87 
88 
89 /* Set at postmaster start */
91 
92 /* Set at configuration reload */
94 
95 
96 /* Internal routines (not fmgr-callable) */
97 
98 extern TimestampTz GetCurrentTimestamp(void);
100  long *secs, int *microsecs);
102  TimestampTz stop_time);
104  TimestampTz stop_time,
105  int msec);
106 
109 
110 extern const char *timestamptz_to_str(TimestampTz t);
111 
112 extern int tm2timestamp(struct pg_tm *tm, fsec_t fsec, int *tzp, Timestamp *result);
113 extern int timestamp2tm(Timestamp dt, int *tzp, struct pg_tm *tm,
114  fsec_t *fsec, const char **tzn, pg_tz *attimezone);
115 extern void dt2time(Timestamp jd, int *hour, int *min, int *sec, fsec_t *fsec);
116 
117 extern void interval2itm(Interval span, struct pg_itm *itm);
118 extern int itm2interval(struct pg_itm *itm, Interval *span);
119 extern int itmin2interval(struct pg_itm_in *itm_in, Interval *span);
120 
121 extern Timestamp SetEpochTimestamp(void);
122 extern void GetEpochTime(struct pg_tm *tm);
123 
124 extern int timestamp_cmp_internal(Timestamp dt1, Timestamp dt2);
125 
126 /* timestamp comparison works for timestamptz also */
127 #define timestamptz_cmp_internal(dt1,dt2) timestamp_cmp_internal(dt1, dt2)
128 
130  int *overflow);
132  TimestampTz dt2);
133 
134 extern int isoweek2j(int year, int week);
135 extern void isoweek2date(int woy, int *year, int *mon, int *mday);
136 extern void isoweekdate2date(int isoweek, int wday, int *year, int *mon, int *mday);
137 extern int date2isoweek(int year, int mon, int mday);
138 extern int date2isoyear(int year, int mon, int mday);
139 extern int date2isoyearday(int year, int mon, int mday);
140 
141 extern bool TimestampTimestampTzRequiresRewrite(void);
142 
143 #endif /* TIMESTAMP_H */
#define PGDLLIMPORT
Definition: c.h:1303
signed int int32
Definition: c.h:478
int64 Timestamp
Definition: timestamp.h:38
int64 TimestampTz
Definition: timestamp.h:39
int32 fsec_t
Definition: timestamp.h:41
Datum Int64GetDatum(int64 X)
Definition: fmgr.c:1794
static struct pg_tm tm
Definition: localtime.c:104
static time_t start_time
Definition: pg_ctl.c:94
int64 pg_time_t
Definition: pgtime.h:23
int64 timestamp
static int64 DatumGetInt64(Datum X)
Definition: postgres.h:385
static Datum PointerGetDatum(const void *X)
Definition: postgres.h:322
uintptr_t Datum
Definition: postgres.h:64
static Pointer DatumGetPointer(Datum X)
Definition: postgres.h:312
Definition: pgtime.h:35
Definition: pgtz.h:66
void dt2time(Timestamp jd, int *hour, int *min, int *sec, fsec_t *fsec)
Definition: timestamp.c:1814
int timestamp_cmp_internal(Timestamp dt1, Timestamp dt2)
Definition: timestamp.c:2136
long TimestampDifferenceMilliseconds(TimestampTz start_time, TimestampTz stop_time)
Definition: timestamp.c:1706
void isoweek2date(int woy, int *year, int *mon, int *mday)
Definition: timestamp.c:4473
void GetEpochTime(struct pg_tm *tm)
Definition: timestamp.c:2094
int itmin2interval(struct pg_itm_in *itm_in, Interval *span)
Definition: timestamp.c:2043
int isoweek2j(int year, int week)
Definition: timestamp.c:4453
TimestampTz time_t_to_timestamptz(pg_time_t tm)
Definition: timestamp.c:1751
static Datum TimestampTzGetDatum(TimestampTz X)
Definition: timestamp.h:52
int date2isoweek(int year, int mon, int mday)
Definition: timestamp.c:4504
Timestamp SetEpochTimestamp(void)
Definition: timestamp.c:2116
static Datum TimestampGetDatum(Timestamp X)
Definition: timestamp.h:46
static Datum IntervalPGetDatum(const Interval *X)
Definition: timestamp.h:58
TimestampTz timestamp2timestamptz_opt_overflow(Timestamp timestamp, int *overflow)
Definition: timestamp.c:5582
int date2isoyearday(int year, int mon, int mday)
Definition: timestamp.c:4616
int tm2timestamp(struct pg_tm *tm, fsec_t fsec, int *tzp, Timestamp *result)
Definition: timestamp.c:1937
void TimestampDifference(TimestampTz start_time, TimestampTz stop_time, long *secs, int *microsecs)
Definition: timestamp.c:1670
bool TimestampTimestampTzRequiresRewrite(void)
Definition: timestamp.c:5551
void isoweekdate2date(int isoweek, int wday, int *year, int *mon, int *mday)
Definition: timestamp.c:4486
int32 timestamp_cmp_timestamptz_internal(Timestamp timestampVal, TimestampTz dt2)
Definition: timestamp.c:2251
bool TimestampDifferenceExceeds(TimestampTz start_time, TimestampTz stop_time, int msec)
Definition: timestamp.c:1730
PGDLLIMPORT TimestampTz PgReloadTime
Definition: timestamp.c:56
PGDLLIMPORT TimestampTz PgStartTime
Definition: timestamp.c:53
static Interval * DatumGetIntervalP(Datum X)
Definition: timestamp.h:40
int timestamp2tm(Timestamp dt, int *tzp, struct pg_tm *tm, fsec_t *fsec, const char **tzn, pg_tz *attimezone)
Definition: timestamp.c:1841
TimestampTz GetCurrentTimestamp(void)
Definition: timestamp.c:1585
void interval2itm(Interval span, struct pg_itm *itm)
Definition: timestamp.c:1987
const char * timestamptz_to_str(TimestampTz t)
Definition: timestamp.c:1793
static Timestamp DatumGetTimestamp(Datum X)
Definition: timestamp.h:28
int itm2interval(struct pg_itm *itm, Interval *span)
Definition: timestamp.c:2014
pg_time_t timestamptz_to_time_t(TimestampTz t)
Definition: timestamp.c:1773
static TimestampTz DatumGetTimestampTz(Datum X)
Definition: timestamp.h:34
int date2isoyear(int year, int mon, int mday)
Definition: timestamp.c:4559