PostgreSQL Source Code  git master
libpq.h File Reference
#include <netinet/in.h>
#include "lib/stringinfo.h"
#include "libpq/libpq-be.h"
#include "storage/latch.h"
Include dependency graph for libpq.h:
This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Data Structures

struct  PQcommMethods
 

Macros

#define pq_comm_reset()   (PqCommMethods->comm_reset())
 
#define pq_flush()   (PqCommMethods->flush())
 
#define pq_flush_if_writable()   (PqCommMethods->flush_if_writable())
 
#define pq_is_send_pending()   (PqCommMethods->is_send_pending())
 
#define pq_putmessage(msgtype, s, len)   (PqCommMethods->putmessage(msgtype, s, len))
 
#define pq_putmessage_noblock(msgtype, s, len)   (PqCommMethods->putmessage_noblock(msgtype, s, len))
 
#define pq_startcopyout()   (PqCommMethods->startcopyout())
 
#define pq_endcopyout(errorAbort)   (PqCommMethods->endcopyout(errorAbort))
 

Enumerations

enum  ssl_protocol_versions {
  PG_TLS_ANY = 0, PG_TLS1_VERSION, PG_TLS1_1_VERSION, PG_TLS1_2_VERSION,
  PG_TLS1_3_VERSION
}
 

Functions

int StreamServerPort (int family, const char *hostName, unsigned short portNumber, const char *unixSocketDir, pgsocket ListenSocket[], int MaxListen)
 
int StreamConnection (pgsocket server_fd, Port *port)
 
void StreamClose (pgsocket sock)
 
void TouchSocketFiles (void)
 
void RemoveSocketFiles (void)
 
void pq_init (void)
 
int pq_getbytes (char *s, size_t len)
 
int pq_getstring (StringInfo s)
 
void pq_startmsgread (void)
 
void pq_endmsgread (void)
 
bool pq_is_reading_msg (void)
 
int pq_getmessage (StringInfo s, int maxlen)
 
int pq_getbyte (void)
 
int pq_peekbyte (void)
 
int pq_getbyte_if_available (unsigned char *c)
 
int pq_putbytes (const char *s, size_t len)
 
int secure_initialize (bool isServerStart)
 
bool secure_loaded_verify_locations (void)
 
void secure_destroy (void)
 
int secure_open_server (Port *port)
 
void secure_close (Port *port)
 
ssize_t secure_read (Port *port, void *ptr, size_t len)
 
ssize_t secure_write (Port *port, void *ptr, size_t len)
 
ssize_t secure_raw_read (Port *port, void *ptr, size_t len)
 
ssize_t secure_raw_write (Port *port, const void *ptr, size_t len)
 
int run_ssl_passphrase_command (const char *prompt, bool is_server_start, char *buf, int size)
 
bool check_ssl_key_file_permissions (const char *ssl_key_file, bool isServerStart)
 

Variables

const PGDLLIMPORT PQcommMethodsPqCommMethods
 
WaitEventSetFeBeWaitSet
 
char * ssl_library
 
char * ssl_cert_file
 
char * ssl_key_file
 
char * ssl_ca_file
 
char * ssl_crl_file
 
char * ssl_dh_params_file
 
PGDLLIMPORT char * ssl_passphrase_command
 
PGDLLIMPORT bool ssl_passphrase_command_supports_reload
 
char * SSLCipherSuites
 
char * SSLECDHCurve
 
bool SSLPreferServerCiphers
 
int ssl_min_protocol_version
 
int ssl_max_protocol_version
 

Macro Definition Documentation

◆ pq_comm_reset

#define pq_comm_reset ( )    (PqCommMethods->comm_reset())

Definition at line 38 of file libpq.h.

Referenced by PostgresMain().

◆ pq_endcopyout

#define pq_endcopyout (   errorAbort)    (PqCommMethods->endcopyout(errorAbort))

Definition at line 47 of file libpq.h.

Referenced by DoCopyTo(), errfinish(), SendCopyEnd(), and socket_comm_reset().

◆ pq_flush

◆ pq_flush_if_writable

#define pq_flush_if_writable ( )    (PqCommMethods->flush_if_writable())

Definition at line 40 of file libpq.h.

Referenced by WalSndKeepaliveIfNecessary(), WalSndLoop(), WalSndWaitForWal(), and WalSndWriteData().

◆ pq_is_send_pending

#define pq_is_send_pending ( )    (PqCommMethods->is_send_pending())

Definition at line 41 of file libpq.h.

Referenced by WalSndDone(), WalSndLoop(), WalSndWaitForWal(), and WalSndWriteData().

◆ pq_putmessage

◆ pq_putmessage_noblock

#define pq_putmessage_noblock (   msgtype,
  s,
  len 
)    (PqCommMethods->putmessage_noblock(msgtype, s, len))

Definition at line 44 of file libpq.h.

Referenced by ProcessRepliesIfAny(), WalSndKeepalive(), WalSndWriteData(), and XLogSendPhysical().

◆ pq_startcopyout

#define pq_startcopyout ( )    (PqCommMethods->startcopyout())

Definition at line 46 of file libpq.h.

Referenced by SendCopyBegin().

Enumeration Type Documentation

◆ ssl_protocol_versions

Enumerator
PG_TLS_ANY 
PG_TLS1_VERSION 
PG_TLS1_1_VERSION 
PG_TLS1_2_VERSION 
PG_TLS1_3_VERSION 

Definition at line 116 of file libpq.h.

Function Documentation

◆ check_ssl_key_file_permissions()

bool check_ssl_key_file_permissions ( const char *  ssl_key_file,
bool  isServerStart 
)

Definition at line 132 of file be-secure-common.c.

References ereport, errcode(), errcode_for_file_access(), errdetail(), errmsg(), FATAL, LOG, S_IRWXG, S_IRWXO, S_ISREG, S_IWGRP, S_IXGRP, stat::st_mode, stat::st_uid, and stat.

Referenced by be_tls_init().

133 {
134  int loglevel = isServerStart ? FATAL : LOG;
135  struct stat buf;
136 
137  if (stat(ssl_key_file, &buf) != 0)
138  {
139  ereport(loglevel,
141  errmsg("could not access private key file \"%s\": %m",
142  ssl_key_file)));
143  return false;
144  }
145 
146  if (!S_ISREG(buf.st_mode))
147  {
148  ereport(loglevel,
149  (errcode(ERRCODE_CONFIG_FILE_ERROR),
150  errmsg("private key file \"%s\" is not a regular file",
151  ssl_key_file)));
152  return false;
153  }
154 
155  /*
156  * Refuse to load key files owned by users other than us or root.
157  *
158  * XXX surely we can check this on Windows somehow, too.
159  */
160 #if !defined(WIN32) && !defined(__CYGWIN__)
161  if (buf.st_uid != geteuid() && buf.st_uid != 0)
162  {
163  ereport(loglevel,
164  (errcode(ERRCODE_CONFIG_FILE_ERROR),
165  errmsg("private key file \"%s\" must be owned by the database user or root",
166  ssl_key_file)));
167  return false;
168  }
169 #endif
170 
171  /*
172  * Require no public access to key file. If the file is owned by us,
173  * require mode 0600 or less. If owned by root, require 0640 or less to
174  * allow read access through our gid, or a supplementary gid that allows
175  * to read system-wide certificates.
176  *
177  * XXX temporarily suppress check when on Windows, because there may not
178  * be proper support for Unix-y file permissions. Need to think of a
179  * reasonable check to apply on Windows. (See also the data directory
180  * permission check in postmaster.c)
181  */
182 #if !defined(WIN32) && !defined(__CYGWIN__)
183  if ((buf.st_uid == geteuid() && buf.st_mode & (S_IRWXG | S_IRWXO)) ||
184  (buf.st_uid == 0 && buf.st_mode & (S_IWGRP | S_IXGRP | S_IRWXO)))
185  {
186  ereport(loglevel,
187  (errcode(ERRCODE_CONFIG_FILE_ERROR),
188  errmsg("private key file \"%s\" has group or world access",
189  ssl_key_file),
190  errdetail("File must have permissions u=rw (0600) or less if owned by the database user, or permissions u=rw,g=r (0640) or less if owned by root.")));
191  return false;
192  }
193 #endif
194 
195  return true;
196 }
int errcode(int sqlerrcode)
Definition: elog.c:691
#define LOG
Definition: elog.h:26
#define FATAL
Definition: elog.h:52
static char * buf
Definition: pg_test_fsync.c:68
#define S_IRWXG
Definition: win32_port.h:301
int errdetail(const char *fmt,...)
Definition: elog.c:1035
int errcode_for_file_access(void)
Definition: elog.c:714
#define S_IWGRP
Definition: win32_port.h:295
#define S_ISREG(m)
Definition: win32_port.h:319
#define ereport(elevel,...)
Definition: elog.h:155
#define S_IXGRP
Definition: win32_port.h:298
int errmsg(const char *fmt,...)
Definition: elog.c:902
char * ssl_key_file
Definition: be-secure.c:42
#define S_IRWXO
Definition: win32_port.h:313
#define stat
Definition: win32_port.h:275

◆ pq_endmsgread()

void pq_endmsgread ( void  )

Definition at line 1231 of file pqcomm.c.

References Assert, and PqCommReadingMsg.

Referenced by CopyFrom(), ProcessRepliesIfAny(), ProcessStartupPacket(), and SocketBackend().

1232 {
1234 
1235  PqCommReadingMsg = false;
1236 }
#define Assert(condition)
Definition: c.h:800
static bool PqCommReadingMsg
Definition: pqcomm.c:148

◆ pq_getbyte()

int pq_getbyte ( void  )

Definition at line 997 of file pqcomm.c.

References Assert, pq_recvbuf(), PqCommReadingMsg, PqRecvBuffer, PqRecvLength, and PqRecvPointer.

Referenced by CheckSCRAMAuth(), CopyGetData(), recv_password_packet(), and SocketBackend().

998 {
1000 
1001  while (PqRecvPointer >= PqRecvLength)
1002  {
1003  if (pq_recvbuf()) /* If nothing in buffer, then recv some */
1004  return EOF; /* Failed to recv data */
1005  }
1006  return (unsigned char) PqRecvBuffer[PqRecvPointer++];
1007 }
static char PqRecvBuffer[PQ_RECV_BUFFER_SIZE]
Definition: pqcomm.c:140
static int PqRecvLength
Definition: pqcomm.c:142
static int pq_recvbuf(void)
Definition: pqcomm.c:936
#define Assert(condition)
Definition: c.h:800
static int PqRecvPointer
Definition: pqcomm.c:141
static bool PqCommReadingMsg
Definition: pqcomm.c:148

◆ pq_getbyte_if_available()

int pq_getbyte_if_available ( unsigned char *  c)

Definition at line 1037 of file pqcomm.c.

References Assert, COMMERROR, EAGAIN, EINTR, ereport, errcode_for_socket_access(), errmsg(), EWOULDBLOCK, MyProcPort, PqCommReadingMsg, PqRecvBuffer, PqRecvLength, PqRecvPointer, secure_read(), and socket_set_nonblocking().

Referenced by ProcessRepliesIfAny().

1038 {
1039  int r;
1040 
1042 
1044  {
1046  return 1;
1047  }
1048 
1049  /* Put the socket into non-blocking mode */
1050  socket_set_nonblocking(true);
1051 
1052  r = secure_read(MyProcPort, c, 1);
1053  if (r < 0)
1054  {
1055  /*
1056  * Ok if no data available without blocking or interrupted (though
1057  * EINTR really shouldn't happen with a non-blocking socket). Report
1058  * other errors.
1059  */
1060  if (errno == EAGAIN || errno == EWOULDBLOCK || errno == EINTR)
1061  r = 0;
1062  else
1063  {
1064  /*
1065  * Careful: an ereport() that tries to write to the client would
1066  * cause recursion to here, leading to stack overflow and core
1067  * dump! This message must go *only* to the postmaster log.
1068  */
1071  errmsg("could not receive data from client: %m")));
1072  r = EOF;
1073  }
1074  }
1075  else if (r == 0)
1076  {
1077  /* EOF detected */
1078  r = EOF;
1079  }
1080 
1081  return r;
1082 }
static char PqRecvBuffer[PQ_RECV_BUFFER_SIZE]
Definition: pqcomm.c:140
struct Port * MyProcPort
Definition: globals.c:43
#define EAGAIN
Definition: win32_port.h:341
ssize_t secure_read(Port *port, void *ptr, size_t len)
Definition: be-secure.c:145
static void socket_set_nonblocking(bool nonblocking)
Definition: pqcomm.c:919
static int PqRecvLength
Definition: pqcomm.c:142
char * c
#define COMMERROR
Definition: elog.h:30
int errcode_for_socket_access(void)
Definition: elog.c:785
#define ereport(elevel,...)
Definition: elog.h:155
#define Assert(condition)
Definition: c.h:800
int errmsg(const char *fmt,...)
Definition: elog.c:902
static int PqRecvPointer
Definition: pqcomm.c:141
#define EWOULDBLOCK
Definition: win32_port.h:349
static bool PqCommReadingMsg
Definition: pqcomm.c:148
#define EINTR
Definition: win32_port.h:343

◆ pq_getbytes()

int pq_getbytes ( char *  s,
size_t  len 
)

Definition at line 1091 of file pqcomm.c.

References Assert, pq_recvbuf(), PqCommReadingMsg, PqRecvBuffer, PqRecvLength, and PqRecvPointer.

Referenced by CopyGetData(), GetOldFunctionMessage(), pq_getmessage(), and ProcessStartupPacket().

1092 {
1093  size_t amount;
1094 
1096 
1097  while (len > 0)
1098  {
1099  while (PqRecvPointer >= PqRecvLength)
1100  {
1101  if (pq_recvbuf()) /* If nothing in buffer, then recv some */
1102  return EOF; /* Failed to recv data */
1103  }
1104  amount = PqRecvLength - PqRecvPointer;
1105  if (amount > len)
1106  amount = len;
1107  memcpy(s, PqRecvBuffer + PqRecvPointer, amount);
1108  PqRecvPointer += amount;
1109  s += amount;
1110  len -= amount;
1111  }
1112  return 0;
1113 }
static char PqRecvBuffer[PQ_RECV_BUFFER_SIZE]
Definition: pqcomm.c:140
static int PqRecvLength
Definition: pqcomm.c:142
static int pq_recvbuf(void)
Definition: pqcomm.c:936
#define Assert(condition)
Definition: c.h:800
static int PqRecvPointer
Definition: pqcomm.c:141
static bool PqCommReadingMsg
Definition: pqcomm.c:148

◆ pq_getmessage()

int pq_getmessage ( StringInfo  s,
int  maxlen 
)

Definition at line 1269 of file pqcomm.c.

References Assert, COMMERROR, StringInfoData::data, enlargeStringInfo(), ereport, errcode(), errmsg(), StringInfoData::len, PG_CATCH, PG_END_TRY, pg_ntoh32, PG_RE_THROW, PG_TRY, pq_discardbytes(), pq_getbytes(), PqCommReadingMsg, and resetStringInfo().

Referenced by CheckSCRAMAuth(), CopyGetData(), ProcessRepliesIfAny(), recv_password_packet(), and SocketBackend().

1270 {
1271  int32 len;
1272 
1274 
1275  resetStringInfo(s);
1276 
1277  /* Read message length word */
1278  if (pq_getbytes((char *) &len, 4) == EOF)
1279  {
1281  (errcode(ERRCODE_PROTOCOL_VIOLATION),
1282  errmsg("unexpected EOF within message length word")));
1283  return EOF;
1284  }
1285 
1286  len = pg_ntoh32(len);
1287 
1288  if (len < 4 ||
1289  (maxlen > 0 && len > maxlen))
1290  {
1292  (errcode(ERRCODE_PROTOCOL_VIOLATION),
1293  errmsg("invalid message length")));
1294  return EOF;
1295  }
1296 
1297  len -= 4; /* discount length itself */
1298 
1299  if (len > 0)
1300  {
1301  /*
1302  * Allocate space for message. If we run out of room (ridiculously
1303  * large message), we will elog(ERROR), but we want to discard the
1304  * message body so as not to lose communication sync.
1305  */
1306  PG_TRY();
1307  {
1308  enlargeStringInfo(s, len);
1309  }
1310  PG_CATCH();
1311  {
1312  if (pq_discardbytes(len) == EOF)
1314  (errcode(ERRCODE_PROTOCOL_VIOLATION),
1315  errmsg("incomplete message from client")));
1316 
1317  /* we discarded the rest of the message so we're back in sync. */
1318  PqCommReadingMsg = false;
1319  PG_RE_THROW();
1320  }
1321  PG_END_TRY();
1322 
1323  /* And grab the message */
1324  if (pq_getbytes(s->data, len) == EOF)
1325  {
1327  (errcode(ERRCODE_PROTOCOL_VIOLATION),
1328  errmsg("incomplete message from client")));
1329  return EOF;
1330  }
1331  s->len = len;
1332  /* Place a trailing null per StringInfo convention */
1333  s->data[len] = '\0';
1334  }
1335 
1336  /* finished reading the message. */
1337  PqCommReadingMsg = false;
1338 
1339  return 0;
1340 }
static int pq_discardbytes(size_t len)
Definition: pqcomm.c:1125
int errcode(int sqlerrcode)
Definition: elog.c:691
signed int int32
Definition: c.h:417
#define pg_ntoh32(x)
Definition: pg_bswap.h:125
int pq_getbytes(char *s, size_t len)
Definition: pqcomm.c:1091
#define COMMERROR
Definition: elog.h:30
void enlargeStringInfo(StringInfo str, int needed)
Definition: stringinfo.c:283
void resetStringInfo(StringInfo str)
Definition: stringinfo.c:75
#define ereport(elevel,...)
Definition: elog.h:155
#define PG_CATCH()
Definition: elog.h:319
#define Assert(condition)
Definition: c.h:800
#define PG_RE_THROW()
Definition: elog.h:350
int errmsg(const char *fmt,...)
Definition: elog.c:902
static bool PqCommReadingMsg
Definition: pqcomm.c:148
#define PG_TRY()
Definition: elog.h:309
#define PG_END_TRY()
Definition: elog.h:334

◆ pq_getstring()

int pq_getstring ( StringInfo  s)

Definition at line 1163 of file pqcomm.c.

References appendBinaryStringInfo(), Assert, i, pq_recvbuf(), PqCommReadingMsg, PqRecvBuffer, PqRecvLength, PqRecvPointer, and resetStringInfo().

Referenced by GetOldFunctionMessage(), and SocketBackend().

1164 {
1165  int i;
1166 
1168 
1169  resetStringInfo(s);
1170 
1171  /* Read until we get the terminating '\0' */
1172  for (;;)
1173  {
1174  while (PqRecvPointer >= PqRecvLength)
1175  {
1176  if (pq_recvbuf()) /* If nothing in buffer, then recv some */
1177  return EOF; /* Failed to recv data */
1178  }
1179 
1180  for (i = PqRecvPointer; i < PqRecvLength; i++)
1181  {
1182  if (PqRecvBuffer[i] == '\0')
1183  {
1184  /* include the '\0' in the copy */
1186  i - PqRecvPointer + 1);
1187  PqRecvPointer = i + 1; /* advance past \0 */
1188  return 0;
1189  }
1190  }
1191 
1192  /* If we're here we haven't got the \0 in the buffer yet. */
1194  PqRecvLength - PqRecvPointer);
1196  }
1197 }
static char PqRecvBuffer[PQ_RECV_BUFFER_SIZE]
Definition: pqcomm.c:140
static int PqRecvLength
Definition: pqcomm.c:142
static int pq_recvbuf(void)
Definition: pqcomm.c:936
void resetStringInfo(StringInfo str)
Definition: stringinfo.c:75
#define Assert(condition)
Definition: c.h:800
int i
static int PqRecvPointer
Definition: pqcomm.c:141
static bool PqCommReadingMsg
Definition: pqcomm.c:148
void appendBinaryStringInfo(StringInfo str, const char *data, int datalen)
Definition: stringinfo.c:227

◆ pq_init()

void pq_init ( void  )

Definition at line 192 of file pqcomm.c.

References AddWaitEventToSet(), COMMERROR, CreateWaitEventSet(), DoingCopyOut, ereport, errmsg(), MemoryContextAlloc(), MyLatch, MyProcPort, on_proc_exit(), pg_set_noblock(), PQ_SEND_BUFFER_SIZE, PqCommBusy, PqCommReadingMsg, PqRecvLength, PqRecvPointer, PqSendBuffer, PqSendBufferSize, PqSendPointer, PqSendStart, Port::sock, socket_close(), TopMemoryContext, WL_LATCH_SET, WL_POSTMASTER_DEATH, and WL_SOCKET_WRITEABLE.

Referenced by BackendInitialize().

193 {
194  /* initialize state variables */
198  PqCommBusy = false;
199  PqCommReadingMsg = false;
200  DoingCopyOut = false;
201 
202  /* set up process-exit hook to close the socket */
204 
205  /*
206  * In backends (as soon as forked) we operate the underlying socket in
207  * nonblocking mode and use latches to implement blocking semantics if
208  * needed. That allows us to provide safely interruptible reads and
209  * writes.
210  *
211  * Use COMMERROR on failure, because ERROR would try to send the error to
212  * the client, which might require changing the mode again, leading to
213  * infinite recursion.
214  */
215 #ifndef WIN32
218  (errmsg("could not set socket to nonblocking mode: %m")));
219 #endif
220 
223  NULL, NULL);
226 }
#define WL_SOCKET_WRITEABLE
Definition: latch.h:126
static bool DoingCopyOut
Definition: pqcomm.c:149
struct Port * MyProcPort
Definition: globals.c:43
int AddWaitEventToSet(WaitEventSet *set, uint32 events, pgsocket fd, Latch *latch, void *user_data)
Definition: latch.c:808
void on_proc_exit(pg_on_exit_callback function, Datum arg)
Definition: ipc.c:305
static char * PqSendBuffer
Definition: pqcomm.c:135
static int PqSendStart
Definition: pqcomm.c:138
WaitEventSet * FeBeWaitSet
Definition: pqcomm.c:184
pgsocket sock
Definition: libpq-be.h:122
WaitEventSet * CreateWaitEventSet(MemoryContext context, int nevents)
Definition: latch.c:611
static int PqRecvLength
Definition: pqcomm.c:142
static int PqSendPointer
Definition: pqcomm.c:137
#define COMMERROR
Definition: elog.h:30
MemoryContext TopMemoryContext
Definition: mcxt.c:44
static int PqSendBufferSize
Definition: pqcomm.c:136
static bool PqCommBusy
Definition: pqcomm.c:147
#define WL_POSTMASTER_DEATH
Definition: latch.h:128
#define ereport(elevel,...)
Definition: elog.h:155
bool pg_set_noblock(pgsocket sock)
Definition: noblock.c:25
static void socket_close(int code, Datum arg)
Definition: pqcomm.c:254
int errmsg(const char *fmt,...)
Definition: elog.c:902
void * MemoryContextAlloc(MemoryContext context, Size size)
Definition: mcxt.c:797
struct Latch * MyLatch
Definition: globals.c:54
static int PqRecvPointer
Definition: pqcomm.c:141
static bool PqCommReadingMsg
Definition: pqcomm.c:148
#define WL_LATCH_SET
Definition: latch.h:124
#define PQ_SEND_BUFFER_SIZE
Definition: pqcomm.c:132

◆ pq_is_reading_msg()

bool pq_is_reading_msg ( void  )

Definition at line 1247 of file pqcomm.c.

References PqCommReadingMsg.

Referenced by PostgresMain().

1248 {
1249  return PqCommReadingMsg;
1250 }
static bool PqCommReadingMsg
Definition: pqcomm.c:148

◆ pq_peekbyte()

int pq_peekbyte ( void  )

Definition at line 1016 of file pqcomm.c.

References Assert, pq_recvbuf(), PqCommReadingMsg, PqRecvBuffer, PqRecvLength, and PqRecvPointer.

Referenced by recv_password_packet().

1017 {
1019 
1020  while (PqRecvPointer >= PqRecvLength)
1021  {
1022  if (pq_recvbuf()) /* If nothing in buffer, then recv some */
1023  return EOF; /* Failed to recv data */
1024  }
1025  return (unsigned char) PqRecvBuffer[PqRecvPointer];
1026 }
static char PqRecvBuffer[PQ_RECV_BUFFER_SIZE]
Definition: pqcomm.c:140
static int PqRecvLength
Definition: pqcomm.c:142
static int pq_recvbuf(void)
Definition: pqcomm.c:936
#define Assert(condition)
Definition: c.h:800
static int PqRecvPointer
Definition: pqcomm.c:141
static bool PqCommReadingMsg
Definition: pqcomm.c:148

◆ pq_putbytes()

int pq_putbytes ( const char *  s,
size_t  len 
)

Definition at line 1350 of file pqcomm.c.

References Assert, DoingCopyOut, internal_putbytes(), and PqCommBusy.

Referenced by CopySendEndOfRow(), and socket_endcopyout().

1351 {
1352  int res;
1353 
1354  /* Should only be called by old-style COPY OUT */
1356  /* No-op if reentrant call */
1357  if (PqCommBusy)
1358  return 0;
1359  PqCommBusy = true;
1360  res = internal_putbytes(s, len);
1361  PqCommBusy = false;
1362  return res;
1363 }
static bool DoingCopyOut
Definition: pqcomm.c:149
static int internal_putbytes(const char *s, size_t len)
Definition: pqcomm.c:1366
static bool PqCommBusy
Definition: pqcomm.c:147
#define Assert(condition)
Definition: c.h:800

◆ pq_startmsgread()

void pq_startmsgread ( void  )

Definition at line 1207 of file pqcomm.c.

References ereport, errcode(), errmsg(), FATAL, and PqCommReadingMsg.

Referenced by CheckSCRAMAuth(), CopyGetData(), ProcessRepliesIfAny(), ProcessStartupPacket(), ReceiveCopyBegin(), recv_password_packet(), and SocketBackend().

1208 {
1209  /*
1210  * There shouldn't be a read active already, but let's check just to be
1211  * sure.
1212  */
1213  if (PqCommReadingMsg)
1214  ereport(FATAL,
1215  (errcode(ERRCODE_PROTOCOL_VIOLATION),
1216  errmsg("terminating connection because protocol synchronization was lost")));
1217 
1218  PqCommReadingMsg = true;
1219 }
int errcode(int sqlerrcode)
Definition: elog.c:691
#define FATAL
Definition: elog.h:52
#define ereport(elevel,...)
Definition: elog.h:155
int errmsg(const char *fmt,...)
Definition: elog.c:902
static bool PqCommReadingMsg
Definition: pqcomm.c:148

◆ RemoveSocketFiles()

void RemoveSocketFiles ( void  )

Definition at line 886 of file pqcomm.c.

References lfirst, and NIL.

Referenced by CloseServerPorts().

887 {
888  ListCell *l;
889 
890  /* Loop through all created sockets... */
891  foreach(l, sock_paths)
892  {
893  char *sock_path = (char *) lfirst(l);
894 
895  /* Ignore any error. */
896  (void) unlink(sock_path);
897  }
898  /* Since we're about to exit, no need to reclaim storage */
899  sock_paths = NIL;
900 }
#define NIL
Definition: pg_list.h:65
static List * sock_paths
Definition: pqcomm.c:123
#define lfirst(lc)
Definition: pg_list.h:169

◆ run_ssl_passphrase_command()

int run_ssl_passphrase_command ( const char *  prompt,
bool  is_server_start,
char *  buf,
int  size 
)

Definition at line 39 of file be-secure-common.c.

References appendStringInfoChar(), appendStringInfoString(), Assert, ClosePipeStream(), StringInfoData::data, ereport, errcode_for_file_access(), errdetail_internal(), errmsg(), ERROR, error(), explicit_bzero(), initStringInfo(), LOG, OpenPipeStream(), pfree(), pg_strip_crlf(), ssl_passphrase_command, and wait_result_to_str().

Referenced by ssl_external_passwd_cb().

40 {
41  int loglevel = is_server_start ? ERROR : LOG;
42  StringInfoData command;
43  char *p;
44  FILE *fh;
45  int pclose_rc;
46  size_t len = 0;
47 
48  Assert(prompt);
49  Assert(size > 0);
50  buf[0] = '\0';
51 
52  initStringInfo(&command);
53 
54  for (p = ssl_passphrase_command; *p; p++)
55  {
56  if (p[0] == '%')
57  {
58  switch (p[1])
59  {
60  case 'p':
61  appendStringInfoString(&command, prompt);
62  p++;
63  break;
64  case '%':
65  appendStringInfoChar(&command, '%');
66  p++;
67  break;
68  default:
69  appendStringInfoChar(&command, p[0]);
70  }
71  }
72  else
73  appendStringInfoChar(&command, p[0]);
74  }
75 
76  fh = OpenPipeStream(command.data, "r");
77  if (fh == NULL)
78  {
79  ereport(loglevel,
81  errmsg("could not execute command \"%s\": %m",
82  command.data)));
83  goto error;
84  }
85 
86  if (!fgets(buf, size, fh))
87  {
88  if (ferror(fh))
89  {
90  explicit_bzero(buf, size);
91  ereport(loglevel,
93  errmsg("could not read from command \"%s\": %m",
94  command.data)));
95  goto error;
96  }
97  }
98 
99  pclose_rc = ClosePipeStream(fh);
100  if (pclose_rc == -1)
101  {
102  explicit_bzero(buf, size);
103  ereport(loglevel,
105  errmsg("could not close pipe to external command: %m")));
106  goto error;
107  }
108  else if (pclose_rc != 0)
109  {
110  explicit_bzero(buf, size);
111  ereport(loglevel,
113  errmsg("command \"%s\" failed",
114  command.data),
115  errdetail_internal("%s", wait_result_to_str(pclose_rc))));
116  goto error;
117  }
118 
119  /* strip trailing newline and carriage return */
120  len = pg_strip_crlf(buf);
121 
122 error:
123  pfree(command.data);
124  return len;
125 }
int pg_strip_crlf(char *str)
Definition: string.c:105
static void error(void)
Definition: sql-dyntest.c:147
#define LOG
Definition: elog.h:26
char * wait_result_to_str(int exitstatus)
Definition: wait_error.c:32
int ClosePipeStream(FILE *file)
Definition: fd.c:2731
int errdetail_internal(const char *fmt,...)
Definition: elog.c:1062
void pfree(void *pointer)
Definition: mcxt.c:1057
#define ERROR
Definition: elog.h:43
void appendStringInfoString(StringInfo str, const char *s)
Definition: stringinfo.c:176
static char * buf
Definition: pg_test_fsync.c:68
int errcode_for_file_access(void)
Definition: elog.c:714
FILE * OpenPipeStream(const char *command, const char *mode)
Definition: fd.c:2425
void appendStringInfoChar(StringInfo str, char ch)
Definition: stringinfo.c:188
void initStringInfo(StringInfo str)
Definition: stringinfo.c:59
#define ereport(elevel,...)
Definition: elog.h:155
#define Assert(condition)
Definition: c.h:800
int errmsg(const char *fmt,...)
Definition: elog.c:902
void explicit_bzero(void *buf, size_t len)
char * ssl_passphrase_command
Definition: be-secure.c:46

◆ secure_close()

void secure_close ( Port port)

Definition at line 133 of file be-secure.c.

References be_tls_close(), and Port::ssl_in_use.

Referenced by ConnFree(), and socket_close().

134 {
135 #ifdef USE_SSL
136  if (port->ssl_in_use)
137  be_tls_close(port);
138 #endif
139 }
bool ssl_in_use
Definition: libpq-be.h:190
void be_tls_close(Port *port)

◆ secure_destroy()

void secure_destroy ( void  )

Definition at line 90 of file be-secure.c.

References be_tls_destroy().

Referenced by SIGHUP_handler().

91 {
92 #ifdef USE_SSL
94 #endif
95 }
void be_tls_destroy(void)

◆ secure_initialize()

int secure_initialize ( bool  isServerStart)

Definition at line 77 of file be-secure.c.

References be_tls_init().

Referenced by BackendRun(), PostmasterMain(), and SIGHUP_handler().

78 {
79 #ifdef USE_SSL
80  return be_tls_init(isServerStart);
81 #else
82  return 0;
83 #endif
84 }
int be_tls_init(bool isServerStart)

◆ secure_loaded_verify_locations()

bool secure_loaded_verify_locations ( void  )

Definition at line 101 of file be-secure.c.

Referenced by ClientAuthentication().

102 {
103 #ifdef USE_SSL
104  return ssl_loaded_verify_locations;
105 #else
106  return false;
107 #endif
108 }

◆ secure_open_server()

int secure_open_server ( Port port)

Definition at line 114 of file be-secure.c.

References be_tls_open_server(), DEBUG2, ereport, errmsg(), and Port::peer_cn.

Referenced by ProcessStartupPacket().

115 {
116  int r = 0;
117 
118 #ifdef USE_SSL
119  r = be_tls_open_server(port);
120 
121  ereport(DEBUG2,
122  (errmsg("SSL connection from \"%s\"",
123  port->peer_cn ? port->peer_cn : "(anonymous)")));
124 #endif
125 
126  return r;
127 }
char * peer_cn
Definition: libpq-be.h:191
#define DEBUG2
Definition: elog.h:24
#define ereport(elevel,...)
Definition: elog.h:155
int be_tls_open_server(Port *port)
int errmsg(const char *fmt,...)
Definition: elog.c:902

◆ secure_raw_read()

ssize_t secure_raw_read ( Port port,
void *  ptr,
size_t  len 
)

Definition at line 234 of file be-secure.c.

References pgwin32_noblock, recv, and Port::sock.

Referenced by be_gssapi_read(), my_sock_read(), read_or_wait(), and secure_read().

235 {
236  ssize_t n;
237 
238  /*
239  * Try to read from the socket without blocking. If it succeeds we're
240  * done, otherwise we'll wait for the socket using the latch mechanism.
241  */
242 #ifdef WIN32
243  pgwin32_noblock = true;
244 #endif
245  n = recv(port->sock, ptr, len, 0);
246 #ifdef WIN32
247  pgwin32_noblock = false;
248 #endif
249 
250  return n;
251 }
int pgwin32_noblock
Definition: socket.c:28
#define recv(s, buf, len, flags)
Definition: win32_port.h:465
pgsocket sock
Definition: libpq-be.h:122

◆ secure_raw_write()

ssize_t secure_raw_write ( Port port,
const void *  ptr,
size_t  len 
)

Definition at line 330 of file be-secure.c.

References pgwin32_noblock, send, and Port::sock.

Referenced by be_gssapi_write(), my_sock_write(), secure_open_gssapi(), and secure_write().

331 {
332  ssize_t n;
333 
334 #ifdef WIN32
335  pgwin32_noblock = true;
336 #endif
337  n = send(port->sock, ptr, len, 0);
338 #ifdef WIN32
339  pgwin32_noblock = false;
340 #endif
341 
342  return n;
343 }
int pgwin32_noblock
Definition: socket.c:28
pgsocket sock
Definition: libpq-be.h:122
#define send(s, buf, len, flags)
Definition: win32_port.h:466

◆ secure_read()

ssize_t secure_read ( Port port,
void *  ptr,
size_t  len 
)

Definition at line 145 of file be-secure.c.

References Assert, be_gssapi_read(), be_tls_read(), EAGAIN, ereport, errcode(), errmsg(), WaitEvent::events, EWOULDBLOCK, FATAL, FeBeWaitSet, Port::gss, ModifyWaitEvent(), MyLatch, ProcessClientReadInterrupt(), ResetLatch(), secure_raw_read(), Port::ssl_in_use, WAIT_EVENT_CLIENT_READ, WaitEventSetWait(), WL_LATCH_SET, WL_POSTMASTER_DEATH, and WL_SOCKET_READABLE.

Referenced by pq_getbyte_if_available(), and pq_recvbuf().

146 {
147  ssize_t n;
148  int waitfor;
149 
150  /* Deal with any already-pending interrupt condition. */
152 
153 retry:
154 #ifdef USE_SSL
155  waitfor = 0;
156  if (port->ssl_in_use)
157  {
158  n = be_tls_read(port, ptr, len, &waitfor);
159  }
160  else
161 #endif
162 #ifdef ENABLE_GSS
163  if (port->gss->enc)
164  {
165  n = be_gssapi_read(port, ptr, len);
166  waitfor = WL_SOCKET_READABLE;
167  }
168  else
169 #endif
170  {
171  n = secure_raw_read(port, ptr, len);
172  waitfor = WL_SOCKET_READABLE;
173  }
174 
175  /* In blocking mode, wait until the socket is ready */
176  if (n < 0 && !port->noblock && (errno == EWOULDBLOCK || errno == EAGAIN))
177  {
178  WaitEvent event;
179 
180  Assert(waitfor);
181 
182  ModifyWaitEvent(FeBeWaitSet, 0, waitfor, NULL);
183 
184  WaitEventSetWait(FeBeWaitSet, -1 /* no timeout */ , &event, 1,
186 
187  /*
188  * If the postmaster has died, it's not safe to continue running,
189  * because it is the postmaster's job to kill us if some other backend
190  * exits uncleanly. Moreover, we won't run very well in this state;
191  * helper processes like walwriter and the bgwriter will exit, so
192  * performance may be poor. Finally, if we don't exit, pg_ctl will be
193  * unable to restart the postmaster without manual intervention, so no
194  * new connections can be accepted. Exiting clears the deck for a
195  * postmaster restart.
196  *
197  * (Note that we only make this check when we would otherwise sleep on
198  * our latch. We might still continue running for a while if the
199  * postmaster is killed in mid-query, or even through multiple queries
200  * if we never have to wait for read. We don't want to burn too many
201  * cycles checking for this very rare condition, and this should cause
202  * us to exit quickly in most cases.)
203  */
204  if (event.events & WL_POSTMASTER_DEATH)
205  ereport(FATAL,
206  (errcode(ERRCODE_ADMIN_SHUTDOWN),
207  errmsg("terminating connection due to unexpected postmaster exit")));
208 
209  /* Handle interrupt. */
210  if (event.events & WL_LATCH_SET)
211  {
214 
215  /*
216  * We'll retry the read. Most likely it will return immediately
217  * because there's still no data available, and we'll wait for the
218  * socket to become ready again.
219  */
220  }
221  goto retry;
222  }
223 
224  /*
225  * Process interrupts that happened during a successful (or non-blocking,
226  * or hard-failed) read.
227  */
229 
230  return n;
231 }
ssize_t be_tls_read(Port *port, void *ptr, size_t len, int *waitfor)
#define EAGAIN
Definition: win32_port.h:341
int errcode(int sqlerrcode)
Definition: elog.c:691
void ModifyWaitEvent(WaitEventSet *set, int pos, uint32 events, Latch *latch)
Definition: latch.c:887
bool ssl_in_use
Definition: libpq-be.h:190
#define WL_SOCKET_READABLE
Definition: latch.h:125
WaitEventSet * FeBeWaitSet
Definition: pqcomm.c:184
void ResetLatch(Latch *latch)
Definition: latch.c:588
#define FATAL
Definition: elog.h:52
uint32 events
Definition: latch.h:144
#define WL_POSTMASTER_DEATH
Definition: latch.h:128
void ProcessClientReadInterrupt(bool blocked)
Definition: postgres.c:526
#define ereport(elevel,...)
Definition: elog.h:155
ssize_t secure_raw_read(Port *port, void *ptr, size_t len)
Definition: be-secure.c:234
#define Assert(condition)
Definition: c.h:800
void * gss
Definition: libpq-be.h:184
int errmsg(const char *fmt,...)
Definition: elog.c:902
struct Latch * MyLatch
Definition: globals.c:54
#define EWOULDBLOCK
Definition: win32_port.h:349
#define WL_LATCH_SET
Definition: latch.h:124
int WaitEventSetWait(WaitEventSet *set, long timeout, WaitEvent *occurred_events, int nevents, uint32 wait_event_info)
Definition: latch.c:1231
ssize_t be_gssapi_read(Port *port, void *ptr, size_t len)

◆ secure_write()

ssize_t secure_write ( Port port,
void *  ptr,
size_t  len 
)

Definition at line 258 of file be-secure.c.

References Assert, be_gssapi_write(), be_tls_write(), EAGAIN, ereport, errcode(), errmsg(), WaitEvent::events, EWOULDBLOCK, FATAL, FeBeWaitSet, Port::gss, ModifyWaitEvent(), MyLatch, ProcessClientWriteInterrupt(), ResetLatch(), secure_raw_write(), Port::ssl_in_use, WAIT_EVENT_CLIENT_WRITE, WaitEventSetWait(), WL_LATCH_SET, WL_POSTMASTER_DEATH, and WL_SOCKET_WRITEABLE.

Referenced by internal_flush().

259 {
260  ssize_t n;
261  int waitfor;
262 
263  /* Deal with any already-pending interrupt condition. */
265 
266 retry:
267  waitfor = 0;
268 #ifdef USE_SSL
269  if (port->ssl_in_use)
270  {
271  n = be_tls_write(port, ptr, len, &waitfor);
272  }
273  else
274 #endif
275 #ifdef ENABLE_GSS
276  if (port->gss->enc)
277  {
278  n = be_gssapi_write(port, ptr, len);
279  waitfor = WL_SOCKET_WRITEABLE;
280  }
281  else
282 #endif
283  {
284  n = secure_raw_write(port, ptr, len);
285  waitfor = WL_SOCKET_WRITEABLE;
286  }
287 
288  if (n < 0 && !port->noblock && (errno == EWOULDBLOCK || errno == EAGAIN))
289  {
290  WaitEvent event;
291 
292  Assert(waitfor);
293 
294  ModifyWaitEvent(FeBeWaitSet, 0, waitfor, NULL);
295 
296  WaitEventSetWait(FeBeWaitSet, -1 /* no timeout */ , &event, 1,
298 
299  /* See comments in secure_read. */
300  if (event.events & WL_POSTMASTER_DEATH)
301  ereport(FATAL,
302  (errcode(ERRCODE_ADMIN_SHUTDOWN),
303  errmsg("terminating connection due to unexpected postmaster exit")));
304 
305  /* Handle interrupt. */
306  if (event.events & WL_LATCH_SET)
307  {
310 
311  /*
312  * We'll retry the write. Most likely it will return immediately
313  * because there's still no buffer space available, and we'll wait
314  * for the socket to become ready again.
315  */
316  }
317  goto retry;
318  }
319 
320  /*
321  * Process interrupts that happened during a successful (or non-blocking,
322  * or hard-failed) write.
323  */
325 
326  return n;
327 }
#define WL_SOCKET_WRITEABLE
Definition: latch.h:126
#define EAGAIN
Definition: win32_port.h:341
ssize_t secure_raw_write(Port *port, const void *ptr, size_t len)
Definition: be-secure.c:330
int errcode(int sqlerrcode)
Definition: elog.c:691
void ModifyWaitEvent(WaitEventSet *set, int pos, uint32 events, Latch *latch)
Definition: latch.c:887
bool ssl_in_use
Definition: libpq-be.h:190
WaitEventSet * FeBeWaitSet
Definition: pqcomm.c:184
void ResetLatch(Latch *latch)
Definition: latch.c:588
#define FATAL
Definition: elog.h:52
uint32 events
Definition: latch.h:144
ssize_t be_tls_write(Port *port, void *ptr, size_t len, int *waitfor)
#define WL_POSTMASTER_DEATH
Definition: latch.h:128
ssize_t be_gssapi_write(Port *port, void *ptr, size_t len)
#define ereport(elevel,...)
Definition: elog.h:155
#define Assert(condition)
Definition: c.h:800
void * gss
Definition: libpq-be.h:184
int errmsg(const char *fmt,...)
Definition: elog.c:902
struct Latch * MyLatch
Definition: globals.c:54
#define EWOULDBLOCK
Definition: win32_port.h:349
#define WL_LATCH_SET
Definition: latch.h:124
int WaitEventSetWait(WaitEventSet *set, long timeout, WaitEvent *occurred_events, int nevents, uint32 wait_event_info)
Definition: latch.c:1231
void ProcessClientWriteInterrupt(bool blocked)
Definition: postgres.c:572

◆ StreamClose()

void StreamClose ( pgsocket  sock)

Definition at line 853 of file pqcomm.c.

References closesocket.

Referenced by ClosePostmasterPorts(), CloseServerPorts(), ConnCreate(), and ServerLoop().

854 {
855  closesocket(sock);
856 }
#define closesocket
Definition: port.h:331

◆ StreamConnection()

int StreamConnection ( pgsocket  server_fd,
Port port 
)

Definition at line 724 of file pqcomm.c.

References accept, SockAddr::addr, elog, ereport, errcode_for_socket_access(), errmsg(), IS_AF_UNIX, Port::laddr, LOG, pg_usleep(), PGINVALID_SOCKET, PQ_SEND_BUFFER_SIZE, pq_setkeepalivescount(), pq_setkeepalivesidle(), pq_setkeepalivesinterval(), pq_settcpusertimeout(), Port::raddr, SockAddr::salen, Port::sock, STATUS_ERROR, STATUS_OK, tcp_keepalives_count, tcp_keepalives_idle, tcp_keepalives_interval, and tcp_user_timeout.

Referenced by ConnCreate().

725 {
726  /* accept connection and fill in the client (remote) address */
727  port->raddr.salen = sizeof(port->raddr.addr);
728  if ((port->sock = accept(server_fd,
729  (struct sockaddr *) &port->raddr.addr,
730  &port->raddr.salen)) == PGINVALID_SOCKET)
731  {
732  ereport(LOG,
734  errmsg("could not accept new connection: %m")));
735 
736  /*
737  * If accept() fails then postmaster.c will still see the server
738  * socket as read-ready, and will immediately try again. To avoid
739  * uselessly sucking lots of CPU, delay a bit before trying again.
740  * (The most likely reason for failure is being out of kernel file
741  * table slots; we can do little except hope some will get freed up.)
742  */
743  pg_usleep(100000L); /* wait 0.1 sec */
744  return STATUS_ERROR;
745  }
746 
747  /* fill in the server (local) address */
748  port->laddr.salen = sizeof(port->laddr.addr);
749  if (getsockname(port->sock,
750  (struct sockaddr *) &port->laddr.addr,
751  &port->laddr.salen) < 0)
752  {
753  elog(LOG, "getsockname() failed: %m");
754  return STATUS_ERROR;
755  }
756 
757  /* select NODELAY and KEEPALIVE options if it's a TCP connection */
758  if (!IS_AF_UNIX(port->laddr.addr.ss_family))
759  {
760  int on;
761 #ifdef WIN32
762  int oldopt;
763  int optlen;
764  int newopt;
765 #endif
766 
767 #ifdef TCP_NODELAY
768  on = 1;
769  if (setsockopt(port->sock, IPPROTO_TCP, TCP_NODELAY,
770  (char *) &on, sizeof(on)) < 0)
771  {
772  elog(LOG, "setsockopt(%s) failed: %m", "TCP_NODELAY");
773  return STATUS_ERROR;
774  }
775 #endif
776  on = 1;
777  if (setsockopt(port->sock, SOL_SOCKET, SO_KEEPALIVE,
778  (char *) &on, sizeof(on)) < 0)
779  {
780  elog(LOG, "setsockopt(%s) failed: %m", "SO_KEEPALIVE");
781  return STATUS_ERROR;
782  }
783 
784 #ifdef WIN32
785 
786  /*
787  * This is a Win32 socket optimization. The OS send buffer should be
788  * large enough to send the whole Postgres send buffer in one go, or
789  * performance suffers. The Postgres send buffer can be enlarged if a
790  * very large message needs to be sent, but we won't attempt to
791  * enlarge the OS buffer if that happens, so somewhat arbitrarily
792  * ensure that the OS buffer is at least PQ_SEND_BUFFER_SIZE * 4.
793  * (That's 32kB with the current default).
794  *
795  * The default OS buffer size used to be 8kB in earlier Windows
796  * versions, but was raised to 64kB in Windows 2012. So it shouldn't
797  * be necessary to change it in later versions anymore. Changing it
798  * unnecessarily can even reduce performance, because setting
799  * SO_SNDBUF in the application disables the "dynamic send buffering"
800  * feature that was introduced in Windows 7. So before fiddling with
801  * SO_SNDBUF, check if the current buffer size is already large enough
802  * and only increase it if necessary.
803  *
804  * See https://support.microsoft.com/kb/823764/EN-US/ and
805  * https://msdn.microsoft.com/en-us/library/bb736549%28v=vs.85%29.aspx
806  */
807  optlen = sizeof(oldopt);
808  if (getsockopt(port->sock, SOL_SOCKET, SO_SNDBUF, (char *) &oldopt,
809  &optlen) < 0)
810  {
811  elog(LOG, "getsockopt(%s) failed: %m", "SO_SNDBUF");
812  return STATUS_ERROR;
813  }
814  newopt = PQ_SEND_BUFFER_SIZE * 4;
815  if (oldopt < newopt)
816  {
817  if (setsockopt(port->sock, SOL_SOCKET, SO_SNDBUF, (char *) &newopt,
818  sizeof(newopt)) < 0)
819  {
820  elog(LOG, "setsockopt(%s) failed: %m", "SO_SNDBUF");
821  return STATUS_ERROR;
822  }
823  }
824 #endif
825 
826  /*
827  * Also apply the current keepalive parameters. If we fail to set a
828  * parameter, don't error out, because these aren't universally
829  * supported. (Note: you might think we need to reset the GUC
830  * variables to 0 in such a case, but it's not necessary because the
831  * show hooks for these variables report the truth anyway.)
832  */
837  }
838 
839  return STATUS_OK;
840 }
#define accept(s, addr, addrlen)
Definition: win32_port.h:462
int pq_setkeepalivesinterval(int interval, Port *port)
Definition: pqcomm.c:1809
struct sockaddr_storage addr
Definition: pqcomm.h:64
int tcp_user_timeout
Definition: guc.c:568
#define STATUS_ERROR
Definition: c.h:1167
#define LOG
Definition: elog.h:26
pgsocket sock
Definition: libpq-be.h:122
int tcp_keepalives_idle
Definition: guc.c:565
SockAddr raddr
Definition: libpq-be.h:126
void pg_usleep(long microsec)
Definition: signal.c:53
int pq_setkeepalivesidle(int idle, Port *port)
Definition: pqcomm.c:1727
#define IS_AF_UNIX(fam)
Definition: ip.h:24
ACCEPT_TYPE_ARG3 salen
Definition: pqcomm.h:65
#define STATUS_OK
Definition: c.h:1166
int tcp_keepalives_interval
Definition: guc.c:566
int errcode_for_socket_access(void)
Definition: elog.c:785
SockAddr laddr
Definition: libpq-be.h:125
#define PGINVALID_SOCKET
Definition: port.h:33
#define ereport(elevel,...)
Definition: elog.h:155
int pq_setkeepalivescount(int count, Port *port)
Definition: pqcomm.c:1885
int errmsg(const char *fmt,...)
Definition: elog.c:902
#define elog(elevel,...)
Definition: elog.h:228
int pq_settcpusertimeout(int timeout, Port *port)
Definition: pqcomm.c:1957
int tcp_keepalives_count
Definition: guc.c:567
#define PQ_SEND_BUFFER_SIZE
Definition: pqcomm.c:132

◆ StreamServerPort()

int StreamServerPort ( int  family,
const char *  hostName,
unsigned short  portNumber,
const char *  unixSocketDir,
pgsocket  ListenSocket[],
int  MaxListen 
)

Definition at line 328 of file pqcomm.c.

References _, addrinfo::ai_family, addrinfo::ai_flags, addrinfo::ai_next, AI_PASSIVE, addrinfo::ai_socktype, Assert, bind, closesocket, CreateSocketLockFile(), EADDRINUSE, elog, ereport, errcode_for_file_access(), errcode_for_socket_access(), errhint(), errmsg(), fd(), gai_strerror, IS_AF_UNIX, lappend(), listen, LOG, MaxBackends, MAXPGPATH, MemSet, NI_MAXHOST, NI_NUMERICHOST, pg_freeaddrinfo_all(), pg_getaddrinfo_all(), pg_getnameinfo_all(), PG_SOMAXCONN, PGINVALID_SOCKET, pstrdup(), snprintf, socket, STATUS_ERROR, STATUS_OK, Unix_socket_group, Unix_socket_permissions, UNIXSOCK_PATH, UNIXSOCK_PATH_BUFLEN, val, and WARNING.

Referenced by PostmasterMain().

331 {
332  pgsocket fd;
333  int err;
334  int maxconn;
335  int ret;
336  char portNumberStr[32];
337  const char *familyDesc;
338  char familyDescBuf[64];
339  const char *addrDesc;
340  char addrBuf[NI_MAXHOST];
341  char *service;
342  struct addrinfo *addrs = NULL,
343  *addr;
344  struct addrinfo hint;
345  int listen_index = 0;
346  int added = 0;
347 
348 #ifdef HAVE_UNIX_SOCKETS
349  char unixSocketPath[MAXPGPATH];
350 #endif
351 #if !defined(WIN32) || defined(IPV6_V6ONLY)
352  int one = 1;
353 #endif
354 
355  /* Initialize hint structure */
356  MemSet(&hint, 0, sizeof(hint));
357  hint.ai_family = family;
358  hint.ai_flags = AI_PASSIVE;
359  hint.ai_socktype = SOCK_STREAM;
360 
361 #ifdef HAVE_UNIX_SOCKETS
362  if (family == AF_UNIX)
363  {
364  /*
365  * Create unixSocketPath from portNumber and unixSocketDir and lock
366  * that file path
367  */
368  UNIXSOCK_PATH(unixSocketPath, portNumber, unixSocketDir);
369  if (strlen(unixSocketPath) >= UNIXSOCK_PATH_BUFLEN)
370  {
371  ereport(LOG,
372  (errmsg("Unix-domain socket path \"%s\" is too long (maximum %d bytes)",
373  unixSocketPath,
374  (int) (UNIXSOCK_PATH_BUFLEN - 1))));
375  return STATUS_ERROR;
376  }
377  if (Lock_AF_UNIX(unixSocketDir, unixSocketPath) != STATUS_OK)
378  return STATUS_ERROR;
379  service = unixSocketPath;
380  }
381  else
382 #endif /* HAVE_UNIX_SOCKETS */
383  {
384  snprintf(portNumberStr, sizeof(portNumberStr), "%d", portNumber);
385  service = portNumberStr;
386  }
387 
388  ret = pg_getaddrinfo_all(hostName, service, &hint, &addrs);
389  if (ret || !addrs)
390  {
391  if (hostName)
392  ereport(LOG,
393  (errmsg("could not translate host name \"%s\", service \"%s\" to address: %s",
394  hostName, service, gai_strerror(ret))));
395  else
396  ereport(LOG,
397  (errmsg("could not translate service \"%s\" to address: %s",
398  service, gai_strerror(ret))));
399  if (addrs)
400  pg_freeaddrinfo_all(hint.ai_family, addrs);
401  return STATUS_ERROR;
402  }
403 
404  for (addr = addrs; addr; addr = addr->ai_next)
405  {
406  if (!IS_AF_UNIX(family) && IS_AF_UNIX(addr->ai_family))
407  {
408  /*
409  * Only set up a unix domain socket when they really asked for it.
410  * The service/port is different in that case.
411  */
412  continue;
413  }
414 
415  /* See if there is still room to add 1 more socket. */
416  for (; listen_index < MaxListen; listen_index++)
417  {
418  if (ListenSocket[listen_index] == PGINVALID_SOCKET)
419  break;
420  }
421  if (listen_index >= MaxListen)
422  {
423  ereport(LOG,
424  (errmsg("could not bind to all requested addresses: MAXLISTEN (%d) exceeded",
425  MaxListen)));
426  break;
427  }
428 
429  /* set up address family name for log messages */
430  switch (addr->ai_family)
431  {
432  case AF_INET:
433  familyDesc = _("IPv4");
434  break;
435 #ifdef HAVE_IPV6
436  case AF_INET6:
437  familyDesc = _("IPv6");
438  break;
439 #endif
440 #ifdef HAVE_UNIX_SOCKETS
441  case AF_UNIX:
442  familyDesc = _("Unix");
443  break;
444 #endif
445  default:
446  snprintf(familyDescBuf, sizeof(familyDescBuf),
447  _("unrecognized address family %d"),
448  addr->ai_family);
449  familyDesc = familyDescBuf;
450  break;
451  }
452 
453  /* set up text form of address for log messages */
454 #ifdef HAVE_UNIX_SOCKETS
455  if (addr->ai_family == AF_UNIX)
456  addrDesc = unixSocketPath;
457  else
458 #endif
459  {
460  pg_getnameinfo_all((const struct sockaddr_storage *) addr->ai_addr,
461  addr->ai_addrlen,
462  addrBuf, sizeof(addrBuf),
463  NULL, 0,
465  addrDesc = addrBuf;
466  }
467 
468  if ((fd = socket(addr->ai_family, SOCK_STREAM, 0)) == PGINVALID_SOCKET)
469  {
470  ereport(LOG,
472  /* translator: first %s is IPv4, IPv6, or Unix */
473  errmsg("could not create %s socket for address \"%s\": %m",
474  familyDesc, addrDesc)));
475  continue;
476  }
477 
478 #ifndef WIN32
479 
480  /*
481  * Without the SO_REUSEADDR flag, a new postmaster can't be started
482  * right away after a stop or crash, giving "address already in use"
483  * error on TCP ports.
484  *
485  * On win32, however, this behavior only happens if the
486  * SO_EXCLUSIVEADDRUSE is set. With SO_REUSEADDR, win32 allows
487  * multiple servers to listen on the same address, resulting in
488  * unpredictable behavior. With no flags at all, win32 behaves as Unix
489  * with SO_REUSEADDR.
490  */
491  if (!IS_AF_UNIX(addr->ai_family))
492  {
493  if ((setsockopt(fd, SOL_SOCKET, SO_REUSEADDR,
494  (char *) &one, sizeof(one))) == -1)
495  {
496  ereport(LOG,
498  /* translator: first %s is IPv4, IPv6, or Unix */
499  errmsg("setsockopt(SO_REUSEADDR) failed for %s address \"%s\": %m",
500  familyDesc, addrDesc)));
501  closesocket(fd);
502  continue;
503  }
504  }
505 #endif
506 
507 #ifdef IPV6_V6ONLY
508  if (addr->ai_family == AF_INET6)
509  {
510  if (setsockopt(fd, IPPROTO_IPV6, IPV6_V6ONLY,
511  (char *) &one, sizeof(one)) == -1)
512  {
513  ereport(LOG,
515  /* translator: first %s is IPv4, IPv6, or Unix */
516  errmsg("setsockopt(IPV6_V6ONLY) failed for %s address \"%s\": %m",
517  familyDesc, addrDesc)));
518  closesocket(fd);
519  continue;
520  }
521  }
522 #endif
523 
524  /*
525  * Note: This might fail on some OS's, like Linux older than
526  * 2.4.21-pre3, that don't have the IPV6_V6ONLY socket option, and map
527  * ipv4 addresses to ipv6. It will show ::ffff:ipv4 for all ipv4
528  * connections.
529  */
530  err = bind(fd, addr->ai_addr, addr->ai_addrlen);
531  if (err < 0)
532  {
533  int saved_errno = errno;
534 
535  ereport(LOG,
537  /* translator: first %s is IPv4, IPv6, or Unix */
538  errmsg("could not bind %s address \"%s\": %m",
539  familyDesc, addrDesc),
540  saved_errno == EADDRINUSE ?
541  (IS_AF_UNIX(addr->ai_family) ?
542  errhint("Is another postmaster already running on port %d?",
543  (int) portNumber) :
544  errhint("Is another postmaster already running on port %d?"
545  " If not, wait a few seconds and retry.",
546  (int) portNumber)) : 0));
547  closesocket(fd);
548  continue;
549  }
550 
551 #ifdef HAVE_UNIX_SOCKETS
552  if (addr->ai_family == AF_UNIX)
553  {
554  if (Setup_AF_UNIX(service) != STATUS_OK)
555  {
556  closesocket(fd);
557  break;
558  }
559  }
560 #endif
561 
562  /*
563  * Select appropriate accept-queue length limit. PG_SOMAXCONN is only
564  * intended to provide a clamp on the request on platforms where an
565  * overly large request provokes a kernel error (are there any?).
566  */
567  maxconn = MaxBackends * 2;
568  if (maxconn > PG_SOMAXCONN)
569  maxconn = PG_SOMAXCONN;
570 
571  err = listen(fd, maxconn);
572  if (err < 0)
573  {
574  ereport(LOG,
576  /* translator: first %s is IPv4, IPv6, or Unix */
577  errmsg("could not listen on %s address \"%s\": %m",
578  familyDesc, addrDesc)));
579  closesocket(fd);
580  continue;
581  }
582 
583 #ifdef HAVE_UNIX_SOCKETS
584  if (addr->ai_family == AF_UNIX)
585  ereport(LOG,
586  (errmsg("listening on Unix socket \"%s\"",
587  addrDesc)));
588  else
589 #endif
590  ereport(LOG,
591  /* translator: first %s is IPv4 or IPv6 */
592  (errmsg("listening on %s address \"%s\", port %d",
593  familyDesc, addrDesc, (int) portNumber)));
594 
595  ListenSocket[listen_index] = fd;
596  added++;
597  }
598 
599  pg_freeaddrinfo_all(hint.ai_family, addrs);
600 
601  if (!added)
602  return STATUS_ERROR;
603 
604  return STATUS_OK;
605 }
void pg_freeaddrinfo_all(int hint_ai_family, struct addrinfo *ai)
Definition: ip.c:88
#define UNIXSOCK_PATH(path, port, sockdir)
Definition: pqcomm.h:70
int errhint(const char *fmt,...)
Definition: elog.c:1149
#define NI_NUMERICHOST
Definition: getaddrinfo.h:78
#define UNIXSOCK_PATH_BUFLEN
Definition: pqcomm.h:86
#define closesocket
Definition: port.h:331
#define STATUS_ERROR
Definition: c.h:1167
#define MemSet(start, val, len)
Definition: c.h:1004
#define LOG
Definition: elog.h:26
#define bind(s, addr, addrlen)
Definition: win32_port.h:460
static int fd(const char *x, int i)
Definition: preproc-init.c:105
#define gai_strerror
Definition: getaddrinfo.h:146
int pg_getaddrinfo_all(const char *hostname, const char *servname, const struct addrinfo *hintp, struct addrinfo **result)
Definition: ip.c:57
#define NI_MAXHOST
Definition: getaddrinfo.h:88
#define IS_AF_UNIX(fam)
Definition: ip.h:24
#define MAXPGPATH
int MaxBackends
Definition: globals.c:136
#define AI_PASSIVE
Definition: getaddrinfo.h:62
int pgsocket
Definition: port.h:31
#define STATUS_OK
Definition: c.h:1166
int errcode_for_socket_access(void)
Definition: elog.c:785
#define listen(s, backlog)
Definition: win32_port.h:461
static pgsocket ListenSocket[MAXLISTEN]
Definition: postmaster.c:220
#define socket(af, type, protocol)
Definition: win32_port.h:459
#define PGINVALID_SOCKET
Definition: port.h:33
#define PG_SOMAXCONN
#define ereport(elevel,...)
Definition: elog.h:155
int pg_getnameinfo_all(const struct sockaddr_storage *addr, int salen, char *node, int nodelen, char *service, int servicelen, int flags)
Definition: ip.c:122
#define EADDRINUSE
Definition: win32_port.h:369
struct addrinfo * ai_next
Definition: getaddrinfo.h:107
int errmsg(const char *fmt,...)
Definition: elog.c:902
#define snprintf
Definition: port.h:215
#define _(x)
Definition: elog.c:88

◆ TouchSocketFiles()

void TouchSocketFiles ( void  )

Definition at line 868 of file pqcomm.c.

References lfirst.

Referenced by ServerLoop().

869 {
870  ListCell *l;
871 
872  /* Loop through all created sockets... */
873  foreach(l, sock_paths)
874  {
875  char *sock_path = (char *) lfirst(l);
876 
877  /* Ignore errors; there's no point in complaining */
878  (void) utime(sock_path, NULL);
879  }
880 }
static List * sock_paths
Definition: pqcomm.c:123
#define lfirst(lc)
Definition: pg_list.h:169

Variable Documentation

◆ FeBeWaitSet

WaitEventSet* FeBeWaitSet

Definition at line 184 of file pqcomm.c.

Referenced by secure_read(), secure_write(), SwitchBackToLocalLatch(), and SwitchToSharedLatch().

◆ PqCommMethods

const PGDLLIMPORT PQcommMethods* PqCommMethods

Definition at line 182 of file pqcomm.c.

Referenced by pq_redirect_to_shm_mq(), and pq_set_parallel_leader().

◆ ssl_ca_file

char* ssl_ca_file

Definition at line 43 of file be-secure.c.

Referenced by be_tls_init().

◆ ssl_cert_file

char* ssl_cert_file

Definition at line 41 of file be-secure.c.

Referenced by be_tls_init().

◆ ssl_crl_file

char* ssl_crl_file

Definition at line 44 of file be-secure.c.

Referenced by be_tls_init().

◆ ssl_dh_params_file

char* ssl_dh_params_file

Definition at line 45 of file be-secure.c.

Referenced by initialize_dh().

◆ ssl_key_file

char* ssl_key_file

Definition at line 42 of file be-secure.c.

Referenced by be_tls_init().

◆ ssl_library

char* ssl_library

Definition at line 40 of file be-secure.c.

◆ ssl_max_protocol_version

int ssl_max_protocol_version

Definition at line 63 of file be-secure.c.

Referenced by be_tls_init(), and be_tls_open_server().

◆ ssl_min_protocol_version

int ssl_min_protocol_version

Definition at line 62 of file be-secure.c.

Referenced by be_tls_init(), and be_tls_open_server().

◆ ssl_passphrase_command

PGDLLIMPORT char* ssl_passphrase_command

Definition at line 46 of file be-secure.c.

Referenced by default_openssl_tls_init(), run_ssl_passphrase_command(), and set_rot13().

◆ ssl_passphrase_command_supports_reload

PGDLLIMPORT bool ssl_passphrase_command_supports_reload

Definition at line 47 of file be-secure.c.

Referenced by default_openssl_tls_init().

◆ SSLCipherSuites

char* SSLCipherSuites

Definition at line 54 of file be-secure.c.

Referenced by be_tls_init().

◆ SSLECDHCurve

char* SSLECDHCurve

Definition at line 57 of file be-secure.c.

Referenced by initialize_ecdh().

◆ SSLPreferServerCiphers

bool SSLPreferServerCiphers

Definition at line 60 of file be-secure.c.

Referenced by be_tls_init().