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_SMALL_MESSAGE_LIMIT   10000
 
#define PQ_LARGE_MESSAGE_LIMIT   (MaxAllocSize - 1)
 
#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 FeBeWaitSetSocketPos   0
 
#define FeBeWaitSetLatchPos   1
 
#define FeBeWaitSetNEvents   3
 

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)
 
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)
 
bool pq_buffer_has_data (void)
 
int pq_putmessage_v2 (char msgtype, const char *s, size_t len)
 
bool pq_check_connection (void)
 
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
 
PGDLLIMPORT WaitEventSetFeBeWaitSet
 
PGDLLIMPORT char * ssl_library
 
PGDLLIMPORT char * ssl_cert_file
 
PGDLLIMPORT char * ssl_key_file
 
PGDLLIMPORT char * ssl_ca_file
 
PGDLLIMPORT char * ssl_crl_file
 
PGDLLIMPORT char * ssl_crl_dir
 
PGDLLIMPORT char * ssl_dh_params_file
 
PGDLLIMPORT char * ssl_passphrase_command
 
PGDLLIMPORT bool ssl_passphrase_command_supports_reload
 
PGDLLIMPORT char * SSLCipherSuites
 
PGDLLIMPORT char * SSLECDHCurve
 
PGDLLIMPORT bool SSLPreferServerCiphers
 
PGDLLIMPORT int ssl_min_protocol_version
 
PGDLLIMPORT int ssl_max_protocol_version
 

Macro Definition Documentation

◆ FeBeWaitSetLatchPos

#define FeBeWaitSetLatchPos   1

Definition at line 64 of file libpq.h.

◆ FeBeWaitSetNEvents

#define FeBeWaitSetNEvents   3

Definition at line 65 of file libpq.h.

◆ FeBeWaitSetSocketPos

#define FeBeWaitSetSocketPos   0

Definition at line 63 of file libpq.h.

◆ pq_comm_reset

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

Definition at line 45 of file libpq.h.

◆ pq_flush

#define pq_flush ( )    (PqCommMethods->flush())

Definition at line 46 of file libpq.h.

◆ pq_flush_if_writable

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

Definition at line 47 of file libpq.h.

◆ pq_is_send_pending

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

Definition at line 48 of file libpq.h.

◆ PQ_LARGE_MESSAGE_LIMIT

#define PQ_LARGE_MESSAGE_LIMIT   (MaxAllocSize - 1)

Definition at line 31 of file libpq.h.

◆ pq_putmessage

#define pq_putmessage (   msgtype,
  s,
  len 
)     (PqCommMethods->putmessage(msgtype, s, len))

Definition at line 49 of file libpq.h.

◆ pq_putmessage_noblock

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

Definition at line 51 of file libpq.h.

◆ PQ_SMALL_MESSAGE_LIMIT

#define PQ_SMALL_MESSAGE_LIMIT   10000

Definition at line 30 of file libpq.h.

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 127 of file libpq.h.

128 {
129  PG_TLS_ANY = 0,
134 };
@ PG_TLS1_VERSION
Definition: libpq.h:130
@ PG_TLS1_3_VERSION
Definition: libpq.h:133
@ PG_TLS1_1_VERSION
Definition: libpq.h:131
@ PG_TLS1_2_VERSION
Definition: libpq.h:132
@ PG_TLS_ANY
Definition: libpq.h:129

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.

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  /* Key file must be a regular file */
147  if (!S_ISREG(buf.st_mode))
148  {
149  ereport(loglevel,
150  (errcode(ERRCODE_CONFIG_FILE_ERROR),
151  errmsg("private key file \"%s\" is not a regular file",
152  ssl_key_file)));
153  return false;
154  }
155 
156  /*
157  * Refuse to load key files owned by users other than us or root, and
158  * require no public access to the key file. If the file is owned by us,
159  * require mode 0600 or less. If owned by root, require 0640 or less to
160  * allow read access through either our gid or a supplementary gid that
161  * allows us to read system-wide certificates.
162  *
163  * Note that roughly similar checks are performed in
164  * src/interfaces/libpq/fe-secure-openssl.c so any changes here may need
165  * to be made there as well. The environment is different though; this
166  * code can assume that we're not running as root.
167  *
168  * Ideally we would do similar permissions checks on Windows, but it is
169  * not clear how that would work since Unix-style permissions may not be
170  * available.
171  */
172 #if !defined(WIN32) && !defined(__CYGWIN__)
173  if (buf.st_uid != geteuid() && buf.st_uid != 0)
174  {
175  ereport(loglevel,
176  (errcode(ERRCODE_CONFIG_FILE_ERROR),
177  errmsg("private key file \"%s\" must be owned by the database user or root",
178  ssl_key_file)));
179  return false;
180  }
181 
182  if ((buf.st_uid == geteuid() && buf.st_mode & (S_IRWXG | S_IRWXO)) ||
183  (buf.st_uid == 0 && buf.st_mode & (S_IWGRP | S_IXGRP | S_IRWXO)))
184  {
185  ereport(loglevel,
186  (errcode(ERRCODE_CONFIG_FILE_ERROR),
187  errmsg("private key file \"%s\" has group or world access",
188  ssl_key_file),
189  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.")));
190  return false;
191  }
192 #endif
193 
194  return true;
195 }
char * ssl_key_file
Definition: be-secure.c:40
int errcode_for_file_access(void)
Definition: elog.c:758
int errdetail(const char *fmt,...)
Definition: elog.c:1079
int errcode(int sqlerrcode)
Definition: elog.c:735
int errmsg(const char *fmt,...)
Definition: elog.c:946
#define LOG
Definition: elog.h:27
#define FATAL
Definition: elog.h:37
#define ereport(elevel,...)
Definition: elog.h:145
static char * buf
Definition: pg_test_fsync.c:67
#define S_IXGRP
Definition: win32_port.h:309
#define stat
Definition: win32_port.h:286
#define S_IRWXG
Definition: win32_port.h:312
#define S_IRWXO
Definition: win32_port.h:324
#define S_ISREG(m)
Definition: win32_port.h:330
#define S_IWGRP
Definition: win32_port.h:306

References buf, ereport, errcode(), errcode_for_file_access(), errdetail(), errmsg(), FATAL, LOG, S_IRWXG, S_IRWXO, S_ISREG, S_IWGRP, S_IXGRP, ssl_key_file, and stat.

Referenced by be_tls_init().

◆ pq_buffer_has_data()

bool pq_buffer_has_data ( void  )

Definition at line 1127 of file pqcomm.c.

1128 {
1129  return (PqRecvPointer < PqRecvLength);
1130 }
static int PqRecvLength
Definition: pqcomm.c:129
static int PqRecvPointer
Definition: pqcomm.c:128

References PqRecvLength, and PqRecvPointer.

Referenced by ProcessStartupPacket().

◆ pq_check_connection()

bool pq_check_connection ( void  )

Definition at line 2023 of file pqcomm.c.

2024 {
2025  WaitEvent events[FeBeWaitSetNEvents];
2026  int rc;
2027 
2028  /*
2029  * It's OK to modify the socket event filter without restoring, because
2030  * all FeBeWaitSet socket wait sites do the same.
2031  */
2033 
2034 retry:
2035  rc = WaitEventSetWait(FeBeWaitSet, 0, events, lengthof(events), 0);
2036  for (int i = 0; i < rc; ++i)
2037  {
2038  if (events[i].events & WL_SOCKET_CLOSED)
2039  return false;
2040  if (events[i].events & WL_LATCH_SET)
2041  {
2042  /*
2043  * A latch event might be preventing other events from being
2044  * reported. Reset it and poll again. No need to restore it
2045  * because no code should expect latches to survive across
2046  * CHECK_FOR_INTERRUPTS().
2047  */
2049  goto retry;
2050  }
2051  }
2052 
2053  return true;
2054 }
#define lengthof(array)
Definition: c.h:724
struct Latch * MyLatch
Definition: globals.c:58
int i
Definition: isn.c:73
void ModifyWaitEvent(WaitEventSet *set, int pos, uint32 events, Latch *latch)
Definition: latch.c:972
int WaitEventSetWait(WaitEventSet *set, long timeout, WaitEvent *occurred_events, int nevents, uint32 wait_event_info)
Definition: latch.c:1345
void ResetLatch(Latch *latch)
Definition: latch.c:683
#define WL_SOCKET_CLOSED
Definition: latch.h:137
#define WL_LATCH_SET
Definition: latch.h:125
#define FeBeWaitSetNEvents
Definition: libpq.h:65
#define FeBeWaitSetSocketPos
Definition: libpq.h:63
WaitEventSet * FeBeWaitSet
Definition: pqcomm.c:164

References FeBeWaitSet, FeBeWaitSetNEvents, FeBeWaitSetSocketPos, i, lengthof, ModifyWaitEvent(), MyLatch, ResetLatch(), WaitEventSetWait(), WL_LATCH_SET, and WL_SOCKET_CLOSED.

Referenced by ProcessInterrupts().

◆ pq_endmsgread()

void pq_endmsgread ( void  )

Definition at line 1164 of file pqcomm.c.

1165 {
1167 
1168  PqCommReadingMsg = false;
1169 }
Assert(fmt[strlen(fmt) - 1] !='\n')
static bool PqCommReadingMsg
Definition: pqcomm.c:135

References Assert(), and PqCommReadingMsg.

Referenced by ProcessRepliesIfAny(), and ProcessStartupPacket().

◆ pq_getbyte()

int pq_getbyte ( void  )

Definition at line 970 of file pqcomm.c.

971 {
973 
974  while (PqRecvPointer >= PqRecvLength)
975  {
976  if (pq_recvbuf()) /* If nothing in buffer, then recv some */
977  return EOF; /* Failed to recv data */
978  }
979  return (unsigned char) PqRecvBuffer[PqRecvPointer++];
980 }
static int pq_recvbuf(void)
Definition: pqcomm.c:909
static char PqRecvBuffer[PQ_RECV_BUFFER_SIZE]
Definition: pqcomm.c:127

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

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

◆ pq_getbyte_if_available()

int pq_getbyte_if_available ( unsigned char *  c)

Definition at line 1010 of file pqcomm.c.

1011 {
1012  int r;
1013 
1015 
1017  {
1019  return 1;
1020  }
1021 
1022  /* Put the socket into non-blocking mode */
1023  socket_set_nonblocking(true);
1024 
1025  r = secure_read(MyProcPort, c, 1);
1026  if (r < 0)
1027  {
1028  /*
1029  * Ok if no data available without blocking or interrupted (though
1030  * EINTR really shouldn't happen with a non-blocking socket). Report
1031  * other errors.
1032  */
1033  if (errno == EAGAIN || errno == EWOULDBLOCK || errno == EINTR)
1034  r = 0;
1035  else
1036  {
1037  /*
1038  * Careful: an ereport() that tries to write to the client would
1039  * cause recursion to here, leading to stack overflow and core
1040  * dump! This message must go *only* to the postmaster log.
1041  */
1044  errmsg("could not receive data from client: %m")));
1045  r = EOF;
1046  }
1047  }
1048  else if (r == 0)
1049  {
1050  /* EOF detected */
1051  r = EOF;
1052  }
1053 
1054  return r;
1055 }
ssize_t secure_read(Port *port, void *ptr, size_t len)
Definition: be-secure.c:145
int errcode_for_socket_access(void)
Definition: elog.c:829
#define COMMERROR
Definition: elog.h:29
struct Port * MyProcPort
Definition: globals.c:47
static void socket_set_nonblocking(bool nonblocking)
Definition: pqcomm.c:892
char * c
#define EINTR
Definition: win32_port.h:369
#define EWOULDBLOCK
Definition: win32_port.h:375
#define EAGAIN
Definition: win32_port.h:367

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().

◆ pq_getbytes()

int pq_getbytes ( char *  s,
size_t  len 
)

Definition at line 1064 of file pqcomm.c.

1065 {
1066  size_t amount;
1067 
1069 
1070  while (len > 0)
1071  {
1072  while (PqRecvPointer >= PqRecvLength)
1073  {
1074  if (pq_recvbuf()) /* If nothing in buffer, then recv some */
1075  return EOF; /* Failed to recv data */
1076  }
1077  amount = PqRecvLength - PqRecvPointer;
1078  if (amount > len)
1079  amount = len;
1080  memcpy(s, PqRecvBuffer + PqRecvPointer, amount);
1081  PqRecvPointer += amount;
1082  s += amount;
1083  len -= amount;
1084  }
1085  return 0;
1086 }
const void size_t len

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

Referenced by pq_getmessage(), and ProcessStartupPacket().

◆ pq_getmessage()

int pq_getmessage ( StringInfo  s,
int  maxlen 
)

Definition at line 1202 of file pqcomm.c.

1203 {
1204  int32 len;
1205 
1207 
1208  resetStringInfo(s);
1209 
1210  /* Read message length word */
1211  if (pq_getbytes((char *) &len, 4) == EOF)
1212  {
1214  (errcode(ERRCODE_PROTOCOL_VIOLATION),
1215  errmsg("unexpected EOF within message length word")));
1216  return EOF;
1217  }
1218 
1219  len = pg_ntoh32(len);
1220 
1221  if (len < 4 || len > maxlen)
1222  {
1224  (errcode(ERRCODE_PROTOCOL_VIOLATION),
1225  errmsg("invalid message length")));
1226  return EOF;
1227  }
1228 
1229  len -= 4; /* discount length itself */
1230 
1231  if (len > 0)
1232  {
1233  /*
1234  * Allocate space for message. If we run out of room (ridiculously
1235  * large message), we will elog(ERROR), but we want to discard the
1236  * message body so as not to lose communication sync.
1237  */
1238  PG_TRY();
1239  {
1240  enlargeStringInfo(s, len);
1241  }
1242  PG_CATCH();
1243  {
1244  if (pq_discardbytes(len) == EOF)
1246  (errcode(ERRCODE_PROTOCOL_VIOLATION),
1247  errmsg("incomplete message from client")));
1248 
1249  /* we discarded the rest of the message so we're back in sync. */
1250  PqCommReadingMsg = false;
1251  PG_RE_THROW();
1252  }
1253  PG_END_TRY();
1254 
1255  /* And grab the message */
1256  if (pq_getbytes(s->data, len) == EOF)
1257  {
1259  (errcode(ERRCODE_PROTOCOL_VIOLATION),
1260  errmsg("incomplete message from client")));
1261  return EOF;
1262  }
1263  s->len = len;
1264  /* Place a trailing null per StringInfo convention */
1265  s->data[len] = '\0';
1266  }
1267 
1268  /* finished reading the message. */
1269  PqCommReadingMsg = false;
1270 
1271  return 0;
1272 }
signed int int32
Definition: c.h:430
#define PG_RE_THROW()
Definition: elog.h:350
#define PG_TRY(...)
Definition: elog.h:309
#define PG_END_TRY(...)
Definition: elog.h:334
#define PG_CATCH(...)
Definition: elog.h:319
#define pg_ntoh32(x)
Definition: pg_bswap.h:125
static int pq_discardbytes(size_t len)
Definition: pqcomm.c:1098
int pq_getbytes(char *s, size_t len)
Definition: pqcomm.c:1064
void resetStringInfo(StringInfo str)
Definition: stringinfo.c:75
void enlargeStringInfo(StringInfo str, int needed)
Definition: stringinfo.c:283

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

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

◆ pq_init()

void pq_init ( void  )

Definition at line 172 of file pqcomm.c.

173 {
174  int socket_pos PG_USED_FOR_ASSERTS_ONLY;
175  int latch_pos PG_USED_FOR_ASSERTS_ONLY;
176 
177  /* initialize state variables */
181  PqCommBusy = false;
182  PqCommReadingMsg = false;
183 
184  /* set up process-exit hook to close the socket */
186 
187  /*
188  * In backends (as soon as forked) we operate the underlying socket in
189  * nonblocking mode and use latches to implement blocking semantics if
190  * needed. That allows us to provide safely interruptible reads and
191  * writes.
192  *
193  * Use COMMERROR on failure, because ERROR would try to send the error to
194  * the client, which might require changing the mode again, leading to
195  * infinite recursion.
196  */
197 #ifndef WIN32
200  (errmsg("could not set socket to nonblocking mode: %m")));
201 #endif
202 
205  MyProcPort->sock, NULL, NULL);
207  MyLatch, NULL);
209  NULL, NULL);
210 
211  /*
212  * The event positions match the order we added them, but let's sanity
213  * check them to be sure.
214  */
215  Assert(socket_pos == FeBeWaitSetSocketPos);
216  Assert(latch_pos == FeBeWaitSetLatchPos);
217 }
#define PG_USED_FOR_ASSERTS_ONLY
Definition: c.h:166
void on_proc_exit(pg_on_exit_callback function, Datum arg)
Definition: ipc.c:305
WaitEventSet * CreateWaitEventSet(MemoryContext context, int nevents)
Definition: latch.c:707
int AddWaitEventToSet(WaitEventSet *set, uint32 events, pgsocket fd, Latch *latch, void *user_data)
Definition: latch.c:886
#define WL_POSTMASTER_DEATH
Definition: latch.h:129
#define WL_SOCKET_WRITEABLE
Definition: latch.h:127
#define FeBeWaitSetLatchPos
Definition: libpq.h:64
MemoryContext TopMemoryContext
Definition: mcxt.c:130
void * MemoryContextAlloc(MemoryContext context, Size size)
Definition: mcxt.c:994
bool pg_set_noblock(pgsocket sock)
Definition: noblock.c:25
#define PGINVALID_SOCKET
Definition: port.h:31
static int PqSendStart
Definition: pqcomm.c:125
static int PqSendPointer
Definition: pqcomm.c:124
#define PQ_SEND_BUFFER_SIZE
Definition: pqcomm.c:119
static char * PqSendBuffer
Definition: pqcomm.c:122
static bool PqCommBusy
Definition: pqcomm.c:134
static void socket_close(int code, Datum arg)
Definition: pqcomm.c:243
static int PqSendBufferSize
Definition: pqcomm.c:123
pgsocket sock
Definition: libpq-be.h:147

References AddWaitEventToSet(), Assert(), COMMERROR, CreateWaitEventSet(), ereport, errmsg(), FeBeWaitSet, FeBeWaitSetLatchPos, FeBeWaitSetNEvents, FeBeWaitSetSocketPos, MemoryContextAlloc(), MyLatch, MyProcPort, on_proc_exit(), pg_set_noblock(), PG_USED_FOR_ASSERTS_ONLY, PGINVALID_SOCKET, 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().

◆ pq_is_reading_msg()

bool pq_is_reading_msg ( void  )

Definition at line 1180 of file pqcomm.c.

1181 {
1182  return PqCommReadingMsg;
1183 }

References PqCommReadingMsg.

Referenced by PostgresMain().

◆ pq_peekbyte()

int pq_peekbyte ( void  )

Definition at line 989 of file pqcomm.c.

990 {
992 
993  while (PqRecvPointer >= PqRecvLength)
994  {
995  if (pq_recvbuf()) /* If nothing in buffer, then recv some */
996  return EOF; /* Failed to recv data */
997  }
998  return (unsigned char) PqRecvBuffer[PqRecvPointer];
999 }

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

◆ pq_putmessage_v2()

int pq_putmessage_v2 ( char  msgtype,
const char *  s,
size_t  len 
)

Definition at line 1528 of file pqcomm.c.

1529 {
1530  Assert(msgtype != 0);
1531 
1532  if (PqCommBusy)
1533  return 0;
1534  PqCommBusy = true;
1535  if (internal_putbytes(&msgtype, 1))
1536  goto fail;
1537 
1538  if (internal_putbytes(s, len))
1539  goto fail;
1540  PqCommBusy = false;
1541  return 0;
1542 
1543 fail:
1544  PqCommBusy = false;
1545  return EOF;
1546 }
static int internal_putbytes(const char *s, size_t len)
Definition: pqcomm.c:1276

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

Referenced by send_message_to_frontend().

◆ pq_startmsgread()

void pq_startmsgread ( void  )

Definition at line 1140 of file pqcomm.c.

1141 {
1142  /*
1143  * There shouldn't be a read active already, but let's check just to be
1144  * sure.
1145  */
1146  if (PqCommReadingMsg)
1147  ereport(FATAL,
1148  (errcode(ERRCODE_PROTOCOL_VIOLATION),
1149  errmsg("terminating connection because protocol synchronization was lost")));
1150 
1151  PqCommReadingMsg = true;
1152 }

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

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

◆ RemoveSocketFiles()

void RemoveSocketFiles ( void  )

Definition at line 859 of file pqcomm.c.

860 {
861  ListCell *l;
862 
863  /* Loop through all created sockets... */
864  foreach(l, sock_paths)
865  {
866  char *sock_path = (char *) lfirst(l);
867 
868  /* Ignore any error. */
869  (void) unlink(sock_path);
870  }
871  /* Since we're about to exit, no need to reclaim storage */
872  sock_paths = NIL;
873 }
#define lfirst(lc)
Definition: pg_list.h:170
#define NIL
Definition: pg_list.h:66
static List * sock_paths
Definition: pqcomm.c:110

References lfirst, NIL, and sock_paths.

Referenced by CloseServerPorts().

◆ 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.

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 }
char * ssl_passphrase_command
Definition: be-secure.c:45
int errdetail_internal(const char *fmt,...)
Definition: elog.c:1106
#define ERROR
Definition: elog.h:35
int ClosePipeStream(FILE *file)
Definition: fd.c:2791
FILE * OpenPipeStream(const char *command, const char *mode)
Definition: fd.c:2486
void pfree(void *pointer)
Definition: mcxt.c:1306
void explicit_bzero(void *buf, size_t len)
static void error(void)
Definition: sql-dyntest.c:147
int pg_strip_crlf(char *str)
Definition: string.c:155
void appendStringInfoString(StringInfo str, const char *s)
Definition: stringinfo.c:176
void appendStringInfoChar(StringInfo str, char ch)
Definition: stringinfo.c:188
void initStringInfo(StringInfo str)
Definition: stringinfo.c:59
char * wait_result_to_str(int exitstatus)
Definition: wait_error.c:33

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

Referenced by ssl_external_passwd_cb().

◆ secure_close()

void secure_close ( Port port)

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

134 {
135 #ifdef USE_SSL
136  if (port->ssl_in_use)
138 #endif
139 }
void be_tls_close(Port *port)
static int port
Definition: pg_regress.c:90

References be_tls_close(), and port.

Referenced by socket_close().

◆ secure_destroy()

void secure_destroy ( void  )

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

90 {
91 #ifdef USE_SSL
93 #endif
94 }
void be_tls_destroy(void)

References be_tls_destroy().

Referenced by SIGHUP_handler().

◆ secure_initialize()

int secure_initialize ( bool  isServerStart)

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

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

References be_tls_init().

Referenced by PostmasterMain(), and SIGHUP_handler().

◆ secure_loaded_verify_locations()

bool secure_loaded_verify_locations ( void  )

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

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

Referenced by ClientAuthentication().

◆ secure_open_server()

int secure_open_server ( Port port)

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

114 {
115  int r = 0;
116 
117 #ifdef USE_SSL
119 
120  ereport(DEBUG2,
121  (errmsg_internal("SSL connection from DN:\"%s\" CN:\"%s\"",
122  port->peer_dn ? port->peer_dn : "(anonymous)",
123  port->peer_cn ? port->peer_cn : "(anonymous)")));
124 #endif
125 
126  return r;
127 }
int be_tls_open_server(Port *port)
int errmsg_internal(const char *fmt,...)
Definition: elog.c:1033
#define DEBUG2
Definition: elog.h:25

References be_tls_open_server(), DEBUG2, ereport, errmsg_internal(), and port.

Referenced by ProcessStartupPacket().

◆ secure_raw_read()

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

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

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:493

References len, pgwin32_noblock, port, and recv.

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

◆ 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.

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 }
#define send(s, buf, len, flags)
Definition: win32_port.h:494

References len, pgwin32_noblock, port, and send.

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

◆ secure_read()

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

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

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 && 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 
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_gssapi_read(Port *port, void *ptr, size_t len)
ssize_t be_tls_read(Port *port, void *ptr, size_t len, int *waitfor)
ssize_t secure_raw_read(Port *port, void *ptr, size_t len)
Definition: be-secure.c:234
#define WL_SOCKET_READABLE
Definition: latch.h:126
void ProcessClientReadInterrupt(bool blocked)
Definition: postgres.c:476
uint32 events
Definition: latch.h:146
@ WAIT_EVENT_CLIENT_READ
Definition: wait_event.h:62

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

Referenced by pq_getbyte_if_available(), and pq_recvbuf().

◆ secure_write()

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

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

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 && 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 
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 }
ssize_t be_gssapi_write(Port *port, void *ptr, size_t len)
ssize_t be_tls_write(Port *port, void *ptr, size_t len, int *waitfor)
ssize_t secure_raw_write(Port *port, const void *ptr, size_t len)
Definition: be-secure.c:330
void ProcessClientWriteInterrupt(bool blocked)
Definition: postgres.c:522
@ WAIT_EVENT_CLIENT_WRITE
Definition: wait_event.h:63

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

Referenced by internal_flush().

◆ StreamClose()

void StreamClose ( pgsocket  sock)

Definition at line 826 of file pqcomm.c.

827 {
828  closesocket(sock);
829 }
#define closesocket
Definition: port.h:349

References closesocket.

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

◆ StreamConnection()

int StreamConnection ( pgsocket  server_fd,
Port port 
)

Definition at line 692 of file pqcomm.c.

693 {
694  /* accept connection and fill in the client (remote) address */
695  port->raddr.salen = sizeof(port->raddr.addr);
696  if ((port->sock = accept(server_fd,
697  (struct sockaddr *) &port->raddr.addr,
698  &port->raddr.salen)) == PGINVALID_SOCKET)
699  {
700  ereport(LOG,
702  errmsg("could not accept new connection: %m")));
703 
704  /*
705  * If accept() fails then postmaster.c will still see the server
706  * socket as read-ready, and will immediately try again. To avoid
707  * uselessly sucking lots of CPU, delay a bit before trying again.
708  * (The most likely reason for failure is being out of kernel file
709  * table slots; we can do little except hope some will get freed up.)
710  */
711  pg_usleep(100000L); /* wait 0.1 sec */
712  return STATUS_ERROR;
713  }
714 
715  /* fill in the server (local) address */
716  port->laddr.salen = sizeof(port->laddr.addr);
717  if (getsockname(port->sock,
718  (struct sockaddr *) &port->laddr.addr,
719  &port->laddr.salen) < 0)
720  {
721  ereport(LOG,
722  (errmsg("%s() failed: %m", "getsockname")));
723  return STATUS_ERROR;
724  }
725 
726  /* select NODELAY and KEEPALIVE options if it's a TCP connection */
727  if (port->laddr.addr.ss_family != AF_UNIX)
728  {
729  int on;
730 #ifdef WIN32
731  int oldopt;
732  int optlen;
733  int newopt;
734 #endif
735 
736 #ifdef TCP_NODELAY
737  on = 1;
738  if (setsockopt(port->sock, IPPROTO_TCP, TCP_NODELAY,
739  (char *) &on, sizeof(on)) < 0)
740  {
741  ereport(LOG,
742  (errmsg("%s(%s) failed: %m", "setsockopt", "TCP_NODELAY")));
743  return STATUS_ERROR;
744  }
745 #endif
746  on = 1;
747  if (setsockopt(port->sock, SOL_SOCKET, SO_KEEPALIVE,
748  (char *) &on, sizeof(on)) < 0)
749  {
750  ereport(LOG,
751  (errmsg("%s(%s) failed: %m", "setsockopt", "SO_KEEPALIVE")));
752  return STATUS_ERROR;
753  }
754 
755 #ifdef WIN32
756 
757  /*
758  * This is a Win32 socket optimization. The OS send buffer should be
759  * large enough to send the whole Postgres send buffer in one go, or
760  * performance suffers. The Postgres send buffer can be enlarged if a
761  * very large message needs to be sent, but we won't attempt to
762  * enlarge the OS buffer if that happens, so somewhat arbitrarily
763  * ensure that the OS buffer is at least PQ_SEND_BUFFER_SIZE * 4.
764  * (That's 32kB with the current default).
765  *
766  * The default OS buffer size used to be 8kB in earlier Windows
767  * versions, but was raised to 64kB in Windows 2012. So it shouldn't
768  * be necessary to change it in later versions anymore. Changing it
769  * unnecessarily can even reduce performance, because setting
770  * SO_SNDBUF in the application disables the "dynamic send buffering"
771  * feature that was introduced in Windows 7. So before fiddling with
772  * SO_SNDBUF, check if the current buffer size is already large enough
773  * and only increase it if necessary.
774  *
775  * See https://support.microsoft.com/kb/823764/EN-US/ and
776  * https://msdn.microsoft.com/en-us/library/bb736549%28v=vs.85%29.aspx
777  */
778  optlen = sizeof(oldopt);
779  if (getsockopt(port->sock, SOL_SOCKET, SO_SNDBUF, (char *) &oldopt,
780  &optlen) < 0)
781  {
782  ereport(LOG,
783  (errmsg("%s(%s) failed: %m", "getsockopt", "SO_SNDBUF")));
784  return STATUS_ERROR;
785  }
786  newopt = PQ_SEND_BUFFER_SIZE * 4;
787  if (oldopt < newopt)
788  {
789  if (setsockopt(port->sock, SOL_SOCKET, SO_SNDBUF, (char *) &newopt,
790  sizeof(newopt)) < 0)
791  {
792  ereport(LOG,
793  (errmsg("%s(%s) failed: %m", "setsockopt", "SO_SNDBUF")));
794  return STATUS_ERROR;
795  }
796  }
797 #endif
798 
799  /*
800  * Also apply the current keepalive parameters. If we fail to set a
801  * parameter, don't error out, because these aren't universally
802  * supported. (Note: you might think we need to reset the GUC
803  * variables to 0 in such a case, but it's not necessary because the
804  * show hooks for these variables report the truth anyway.)
805  */
810  }
811 
812  return STATUS_OK;
813 }
#define STATUS_OK
Definition: c.h:1108
#define STATUS_ERROR
Definition: c.h:1109
int tcp_keepalives_idle
Definition: guc_tables.c:512
int tcp_keepalives_interval
Definition: guc_tables.c:513
int tcp_keepalives_count
Definition: guc_tables.c:514
int tcp_user_timeout
Definition: guc_tables.c:515
int pq_setkeepalivesinterval(int interval, Port *port)
Definition: pqcomm.c:1719
int pq_settcpusertimeout(int timeout, Port *port)
Definition: pqcomm.c:1873
int pq_setkeepalivesidle(int idle, Port *port)
Definition: pqcomm.c:1634
int pq_setkeepalivescount(int count, Port *port)
Definition: pqcomm.c:1798
void pg_usleep(long microsec)
Definition: signal.c:53
#define accept(s, addr, addrlen)
Definition: win32_port.h:490

References accept, ereport, errcode_for_socket_access(), errmsg(), LOG, pg_usleep(), PGINVALID_SOCKET, port, PQ_SEND_BUFFER_SIZE, pq_setkeepalivescount(), pq_setkeepalivesidle(), pq_setkeepalivesinterval(), pq_settcpusertimeout(), STATUS_ERROR, STATUS_OK, tcp_keepalives_count, tcp_keepalives_idle, tcp_keepalives_interval, and tcp_user_timeout.

Referenced by ConnCreate().

◆ StreamServerPort()

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

Definition at line 314 of file pqcomm.c.

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

References _, bind, closesocket, EADDRINUSE, ereport, errcode_for_socket_access(), errhint(), errmsg(), fd(), listen, ListenSocket, Lock_AF_UNIX(), LOG, MaxConnections, MAXPGPATH, MemSet, pg_freeaddrinfo_all(), pg_getaddrinfo_all(), pg_getnameinfo_all(), PGINVALID_SOCKET, Setup_AF_UNIX(), snprintf, socket, STATUS_ERROR, STATUS_OK, UNIXSOCK_PATH, and UNIXSOCK_PATH_BUFLEN.

Referenced by PostmasterMain().

◆ TouchSocketFiles()

void TouchSocketFiles ( void  )

Definition at line 841 of file pqcomm.c.

842 {
843  ListCell *l;
844 
845  /* Loop through all created sockets... */
846  foreach(l, sock_paths)
847  {
848  char *sock_path = (char *) lfirst(l);
849 
850  /* Ignore errors; there's no point in complaining */
851  (void) utime(sock_path, NULL);
852  }
853 }

References lfirst, and sock_paths.

Referenced by ServerLoop().

Variable Documentation

◆ FeBeWaitSet

◆ PqCommMethods

const PGDLLIMPORT PQcommMethods* PqCommMethods
extern

Definition at line 162 of file pqcomm.c.

Referenced by pq_redirect_to_shm_mq(), and pq_set_parallel_leader().

◆ ssl_ca_file

PGDLLIMPORT char* ssl_ca_file
extern

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

Referenced by be_tls_init().

◆ ssl_cert_file

PGDLLIMPORT char* ssl_cert_file
extern

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

Referenced by be_tls_init().

◆ ssl_crl_dir

PGDLLIMPORT char* ssl_crl_dir
extern

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

Referenced by be_tls_init().

◆ ssl_crl_file

PGDLLIMPORT char* ssl_crl_file
extern

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

Referenced by be_tls_init().

◆ ssl_dh_params_file

PGDLLIMPORT char* ssl_dh_params_file
extern

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

Referenced by initialize_dh().

◆ ssl_key_file

PGDLLIMPORT char* ssl_key_file
extern

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

Referenced by be_tls_init(), and check_ssl_key_file_permissions().

◆ ssl_library

PGDLLIMPORT char* ssl_library
extern

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

◆ ssl_max_protocol_version

PGDLLIMPORT int ssl_max_protocol_version
extern

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

Referenced by be_tls_init(), and be_tls_open_server().

◆ ssl_min_protocol_version

PGDLLIMPORT int ssl_min_protocol_version
extern

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

Referenced by be_tls_init(), and be_tls_open_server().

◆ ssl_passphrase_command

PGDLLIMPORT char* ssl_passphrase_command
extern

Definition at line 45 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
extern

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

Referenced by default_openssl_tls_init().

◆ SSLCipherSuites

PGDLLIMPORT char* SSLCipherSuites
extern

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

Referenced by be_tls_init().

◆ SSLECDHCurve

PGDLLIMPORT char* SSLECDHCurve
extern

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

Referenced by initialize_ecdh().

◆ SSLPreferServerCiphers

PGDLLIMPORT bool SSLPreferServerCiphers
extern

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

Referenced by be_tls_init().