Line data    Source code

       1             : /*-------------------------------------------------------------------------
       2             :  *
       3             :  * timestamp.h
       4             :  *    Definitions for the SQL "timestamp" and "interval" types.
       5             :  *
       6             :  * Portions Copyright (c) 1996-2025, 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
      28      853762 : DatumGetTimestamp(Datum X)
      29             : {
      30      853762 :     return (Timestamp) DatumGetInt64(X);
      31             : }
      32             : 
      33             : static inline TimestampTz
      34      239122 : DatumGetTimestampTz(Datum X)
      35             : {
      36      239122 :     return (TimestampTz) DatumGetInt64(X);
      37             : }
      38             : 
      39             : static inline Interval *
      40      398072 : DatumGetIntervalP(Datum X)
      41             : {
      42      398072 :     return (Interval *) DatumGetPointer(X);
      43             : }
      44             : 
      45             : static inline Datum
      46      407888 : TimestampGetDatum(Timestamp X)
      47             : {
      48      407888 :     return Int64GetDatum(X);
      49             : }
      50             : 
      51             : static inline Datum
      52      354102 : TimestampTzGetDatum(TimestampTz X)
      53             : {
      54      354102 :     return Int64GetDatum(X);
      55             : }
      56             : 
      57             : static inline Datum
      58      132034 : IntervalPGetDatum(const Interval *X)
      59             : {
      60      132034 :     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 */
      90             : extern PGDLLIMPORT TimestampTz PgStartTime;
      91             : 
      92             : /* Set at configuration reload */
      93             : extern PGDLLIMPORT TimestampTz PgReloadTime;
      94             : 
      95             : 
      96             : /* Internal routines (not fmgr-callable) */
      97             : 
      98             : extern int32 anytimestamp_typmod_check(bool istz, int32 typmod);
      99             : 
     100             : extern TimestampTz GetCurrentTimestamp(void);
     101             : extern TimestampTz GetSQLCurrentTimestamp(int32 typmod);
     102             : extern Timestamp GetSQLLocalTimestamp(int32 typmod);
     103             : extern void TimestampDifference(TimestampTz start_time, TimestampTz stop_time,
     104             :                                 long *secs, int *microsecs);
     105             : extern long TimestampDifferenceMilliseconds(TimestampTz start_time,
     106             :                                             TimestampTz stop_time);
     107             : extern bool TimestampDifferenceExceeds(TimestampTz start_time,
     108             :                                        TimestampTz stop_time,
     109             :                                        int msec);
     110             : 
     111             : extern TimestampTz time_t_to_timestamptz(pg_time_t tm);
     112             : extern pg_time_t timestamptz_to_time_t(TimestampTz t);
     113             : 
     114             : extern const char *timestamptz_to_str(TimestampTz t);
     115             : 
     116             : extern int  tm2timestamp(struct pg_tm *tm, fsec_t fsec, int *tzp, Timestamp *result);
     117             : extern int  timestamp2tm(Timestamp dt, int *tzp, struct pg_tm *tm,
     118             :                          fsec_t *fsec, const char **tzn, pg_tz *attimezone);
     119             : extern void dt2time(Timestamp jd, int *hour, int *min, int *sec, fsec_t *fsec);
     120             : 
     121             : extern void interval2itm(Interval span, struct pg_itm *itm);
     122             : extern int  itm2interval(struct pg_itm *itm, Interval *span);
     123             : extern int  itmin2interval(struct pg_itm_in *itm_in, Interval *span);
     124             : 
     125             : extern Timestamp SetEpochTimestamp(void);
     126             : extern void GetEpochTime(struct pg_tm *tm);
     127             : 
     128             : extern int  timestamp_cmp_internal(Timestamp dt1, Timestamp dt2);
     129             : 
     130             : /* timestamp comparison works for timestamptz also */
     131             : #define timestamptz_cmp_internal(dt1,dt2)   timestamp_cmp_internal(dt1, dt2)
     132             : 
     133             : extern TimestampTz timestamp2timestamptz_opt_overflow(Timestamp timestamp,
     134             :                                                       int *overflow);
     135             : extern int32 timestamp_cmp_timestamptz_internal(Timestamp timestampVal,
     136             :                                                 TimestampTz dt2);
     137             : 
     138             : extern int  isoweek2j(int year, int week);
     139             : extern void isoweek2date(int woy, int *year, int *mon, int *mday);
     140             : extern void isoweekdate2date(int isoweek, int wday, int *year, int *mon, int *mday);
     141             : extern int  date2isoweek(int year, int mon, int mday);
     142             : extern int  date2isoyear(int year, int mon, int mday);
     143             : extern int  date2isoyearday(int year, int mon, int mday);
     144             : 
     145             : extern bool TimestampTimestampTzRequiresRewrite(void);
     146             : 
     147             : #endif                          /* TIMESTAMP_H */