PostgreSQL Source Code  git master
syslogger.h
Go to the documentation of this file.
1 /*-------------------------------------------------------------------------
2  *
3  * syslogger.h
4  * Exports from postmaster/syslogger.c.
5  *
6  * Copyright (c) 2004-2022, PostgreSQL Global Development Group
7  *
8  * src/include/postmaster/syslogger.h
9  *
10  *-------------------------------------------------------------------------
11  */
12 #ifndef _SYSLOGGER_H
13 #define _SYSLOGGER_H
14 
15 #include <limits.h> /* for PIPE_BUF */
16 
17 
18 /*
19  * Primitive protocol structure for writing to syslogger pipe(s). The idea
20  * here is to divide long messages into chunks that are not more than
21  * PIPE_BUF bytes long, which according to POSIX spec must be written into
22  * the pipe atomically. The pipe reader then uses the protocol headers to
23  * reassemble the parts of a message into a single string. The reader can
24  * also cope with non-protocol data coming down the pipe, though we cannot
25  * guarantee long strings won't get split apart.
26  *
27  * We use non-nul bytes in is_last to make the protocol a tiny bit
28  * more robust against finding a false double nul byte prologue. But
29  * we still might find it in the len and/or pid bytes unless we're careful.
30  */
31 
32 #ifdef PIPE_BUF
33 /* Are there any systems with PIPE_BUF > 64K? Unlikely, but ... */
34 #if PIPE_BUF > 65536
35 #define PIPE_CHUNK_SIZE 65536
36 #else
37 #define PIPE_CHUNK_SIZE ((int) PIPE_BUF)
38 #endif
39 #else /* not defined */
40 /* POSIX says the value of PIPE_BUF must be at least 512, so use that */
41 #define PIPE_CHUNK_SIZE 512
42 #endif
43 
44 typedef struct
45 {
46  char nuls[2]; /* always \0\0 */
47  uint16 len; /* size of this chunk (counts data only) */
48  int32 pid; /* writer's pid */
49  bits8 flags; /* bitmask of PIPE_PROTO_* */
50  char data[FLEXIBLE_ARRAY_MEMBER]; /* data payload starts here */
52 
53 typedef union
54 {
56  char filler[PIPE_CHUNK_SIZE];
58 
59 #define PIPE_HEADER_SIZE offsetof(PipeProtoHeader, data)
60 #define PIPE_MAX_PAYLOAD ((int) (PIPE_CHUNK_SIZE - PIPE_HEADER_SIZE))
61 
62 /* flag bits for PipeProtoHeader->flags */
63 #define PIPE_PROTO_IS_LAST 0x01 /* last chunk of message? */
64 /* log destinations */
65 #define PIPE_PROTO_DEST_STDERR 0x10
66 #define PIPE_PROTO_DEST_CSVLOG 0x20
67 #define PIPE_PROTO_DEST_JSONLOG 0x40
68 
69 /* GUC options */
70 extern PGDLLIMPORT bool Logging_collector;
71 extern PGDLLIMPORT int Log_RotationAge;
72 extern PGDLLIMPORT int Log_RotationSize;
73 extern PGDLLIMPORT char *Log_directory;
74 extern PGDLLIMPORT char *Log_filename;
76 extern PGDLLIMPORT int Log_file_mode;
77 
78 #ifndef WIN32
79 extern PGDLLIMPORT int syslogPipe[2];
80 #else
81 extern PGDLLIMPORT HANDLE syslogPipe[2];
82 #endif
83 
84 
85 extern int SysLogger_Start(void);
86 
87 extern void write_syslogger_file(const char *buffer, int count, int destination);
88 
89 #ifdef EXEC_BACKEND
90 extern void SysLoggerMain(int argc, char *argv[]) pg_attribute_noreturn();
91 #endif
92 
93 extern bool CheckLogrotateSignal(void);
94 extern void RemoveLogrotateSignalFiles(void);
95 
96 /*
97  * Name of files saving meta-data information about the log
98  * files currently in use by the syslogger
99  */
100 #define LOG_METAINFO_DATAFILE "current_logfiles"
101 #define LOG_METAINFO_DATAFILE_TMP LOG_METAINFO_DATAFILE ".tmp"
102 
103 #endif /* _SYSLOGGER_H */
unsigned short uint16
Definition: c.h:441
#define PGDLLIMPORT
Definition: c.h:1252
signed int int32
Definition: c.h:430
#define pg_attribute_noreturn()
Definition: c.h:201
#define FLEXIBLE_ARRAY_MEMBER
Definition: c.h:362
uint8 bits8
Definition: c.h:449
const void * data
NON_EXEC_STATIC void SysLoggerMain(int argc, char *argv[]) pg_attribute_noreturn()
Definition: syslogger.c:165
PGDLLIMPORT int Log_file_mode
Definition: syslogger.c:77
PGDLLIMPORT bool Logging_collector
Definition: syslogger.c:71
PGDLLIMPORT int Log_RotationAge
Definition: syslogger.c:72
bool CheckLogrotateSignal(void)
Definition: syslogger.c:1622
PGDLLIMPORT char * Log_filename
Definition: syslogger.c:75
PGDLLIMPORT int Log_RotationSize
Definition: syslogger.c:73
PGDLLIMPORT int syslogPipe[2]
Definition: syslogger.c:117
#define PIPE_CHUNK_SIZE
Definition: syslogger.h:41
void RemoveLogrotateSignalFiles(void)
Definition: syslogger.c:1636
void write_syslogger_file(const char *buffer, int count, int destination)
Definition: syslogger.c:1143
PGDLLIMPORT bool Log_truncate_on_rotation
Definition: syslogger.c:76
PGDLLIMPORT char * Log_directory
Definition: syslogger.c:74
int SysLogger_Start(void)
Definition: syslogger.c:567
PipeProtoHeader proto
Definition: syslogger.h:55