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 110 of file be-secure-common.c.

111 {
112  int loglevel = isServerStart ? FATAL : LOG;
113  struct stat buf;
114 
115  if (stat(ssl_key_file, &buf) != 0)
116  {
117  ereport(loglevel,
119  errmsg("could not access private key file \"%s\": %m",
120  ssl_key_file)));
121  return false;
122  }
123 
124  /* Key file must be a regular file */
125  if (!S_ISREG(buf.st_mode))
126  {
127  ereport(loglevel,
128  (errcode(ERRCODE_CONFIG_FILE_ERROR),
129  errmsg("private key file \"%s\" is not a regular file",
130  ssl_key_file)));
131  return false;
132  }
133 
134  /*
135  * Refuse to load key files owned by users other than us or root, and
136  * require no public access to the key file. If the file is owned by us,
137  * require mode 0600 or less. If owned by root, require 0640 or less to
138  * allow read access through either our gid or a supplementary gid that
139  * allows us to read system-wide certificates.
140  *
141  * Note that roughly similar checks are performed in
142  * src/interfaces/libpq/fe-secure-openssl.c so any changes here may need
143  * to be made there as well. The environment is different though; this
144  * code can assume that we're not running as root.
145  *
146  * Ideally we would do similar permissions checks on Windows, but it is
147  * not clear how that would work since Unix-style permissions may not be
148  * available.
149  */
150 #if !defined(WIN32) && !defined(__CYGWIN__)
151  if (buf.st_uid != geteuid() && buf.st_uid != 0)
152  {
153  ereport(loglevel,
154  (errcode(ERRCODE_CONFIG_FILE_ERROR),
155  errmsg("private key file \"%s\" must be owned by the database user or root",
156  ssl_key_file)));
157  return false;
158  }
159 
160  if ((buf.st_uid == geteuid() && buf.st_mode & (S_IRWXG | S_IRWXO)) ||
161  (buf.st_uid == 0 && buf.st_mode & (S_IWGRP | S_IXGRP | S_IRWXO)))
162  {
163  ereport(loglevel,
164  (errcode(ERRCODE_CONFIG_FILE_ERROR),
165  errmsg("private key file \"%s\" has group or world access",
166  ssl_key_file),
167  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.")));
168  return false;
169  }
170 #endif
171 
172  return true;
173 }
char * ssl_key_file
Definition: be-secure.c:40
int errcode_for_file_access(void)
Definition: elog.c:881
int errdetail(const char *fmt,...)
Definition: elog.c:1202
int errcode(int sqlerrcode)
Definition: elog.c:858
int errmsg(const char *fmt,...)
Definition: elog.c:1069
#define LOG
Definition: elog.h:31
#define FATAL
Definition: elog.h:41
#define ereport(elevel,...)
Definition: elog.h:149
static char * buf
Definition: pg_test_fsync.c:67
#define S_IXGRP
Definition: win32_port.h:307
#define stat
Definition: win32_port.h:284
#define S_IRWXG
Definition: win32_port.h:310
#define S_IRWXO
Definition: win32_port.h:322
#define S_ISREG(m)
Definition: win32_port.h:328
#define S_IWGRP
Definition: win32_port.h:304

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 1137 of file pqcomm.c.

1138 {
1139  return (PqRecvPointer < PqRecvLength);
1140 }
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 2033 of file pqcomm.c.

2034 {
2035  WaitEvent events[FeBeWaitSetNEvents];
2036  int rc;
2037 
2038  /*
2039  * It's OK to modify the socket event filter without restoring, because
2040  * all FeBeWaitSet socket wait sites do the same.
2041  */
2043 
2044 retry:
2045  rc = WaitEventSetWait(FeBeWaitSet, 0, events, lengthof(events), 0);
2046  for (int i = 0; i < rc; ++i)
2047  {
2048  if (events[i].events & WL_SOCKET_CLOSED)
2049  return false;
2050  if (events[i].events & WL_LATCH_SET)
2051  {
2052  /*
2053  * A latch event might be preventing other events from being
2054  * reported. Reset it and poll again. No need to restore it
2055  * because no code should expect latches to survive across
2056  * CHECK_FOR_INTERRUPTS().
2057  */
2059  goto retry;
2060  }
2061  }
2062 
2063  return true;
2064 }
#define lengthof(array)
Definition: c.h:777
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:1006
int WaitEventSetWait(WaitEventSet *set, long timeout, WaitEvent *occurred_events, int nevents, uint32 wait_event_info)
Definition: latch.c:1381
void ResetLatch(Latch *latch)
Definition: latch.c:697
#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 1174 of file pqcomm.c.

1175 {
1177 
1178  PqCommReadingMsg = false;
1179 }
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 980 of file pqcomm.c.

981 {
983 
984  while (PqRecvPointer >= PqRecvLength)
985  {
986  if (pq_recvbuf()) /* If nothing in buffer, then recv some */
987  return EOF; /* Failed to recv data */
988  }
989  return (unsigned char) PqRecvBuffer[PqRecvPointer++];
990 }
static int pq_recvbuf(void)
Definition: pqcomm.c:919
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 1020 of file pqcomm.c.

1021 {
1022  int r;
1023 
1025 
1027  {
1029  return 1;
1030  }
1031 
1032  /* Put the socket into non-blocking mode */
1033  socket_set_nonblocking(true);
1034 
1035  r = secure_read(MyProcPort, c, 1);
1036  if (r < 0)
1037  {
1038  /*
1039  * Ok if no data available without blocking or interrupted (though
1040  * EINTR really shouldn't happen with a non-blocking socket). Report
1041  * other errors.
1042  */
1043  if (errno == EAGAIN || errno == EWOULDBLOCK || errno == EINTR)
1044  r = 0;
1045  else
1046  {
1047  /*
1048  * Careful: an ereport() that tries to write to the client would
1049  * cause recursion to here, leading to stack overflow and core
1050  * dump! This message must go *only* to the postmaster log.
1051  */
1054  errmsg("could not receive data from client: %m")));
1055  r = EOF;
1056  }
1057  }
1058  else if (r == 0)
1059  {
1060  /* EOF detected */
1061  r = EOF;
1062  }
1063 
1064  return r;
1065 }
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:952
#define COMMERROR
Definition: elog.h:33
struct Port * MyProcPort
Definition: globals.c:47
static void socket_set_nonblocking(bool nonblocking)
Definition: pqcomm.c:902
char * c
#define EINTR
Definition: win32_port.h:374
#define EWOULDBLOCK
Definition: win32_port.h:380
#define EAGAIN
Definition: win32_port.h:372

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 1074 of file pqcomm.c.

1075 {
1076  size_t amount;
1077 
1079 
1080  while (len > 0)
1081  {
1082  while (PqRecvPointer >= PqRecvLength)
1083  {
1084  if (pq_recvbuf()) /* If nothing in buffer, then recv some */
1085  return EOF; /* Failed to recv data */
1086  }
1087  amount = PqRecvLength - PqRecvPointer;
1088  if (amount > len)
1089  amount = len;
1090  memcpy(s, PqRecvBuffer + PqRecvPointer, amount);
1091  PqRecvPointer += amount;
1092  s += amount;
1093  len -= amount;
1094  }
1095  return 0;
1096 }
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 1212 of file pqcomm.c.

1213 {
1214  int32 len;
1215 
1217 
1218  resetStringInfo(s);
1219 
1220  /* Read message length word */
1221  if (pq_getbytes((char *) &len, 4) == EOF)
1222  {
1224  (errcode(ERRCODE_PROTOCOL_VIOLATION),
1225  errmsg("unexpected EOF within message length word")));
1226  return EOF;
1227  }
1228 
1229  len = pg_ntoh32(len);
1230 
1231  if (len < 4 || len > maxlen)
1232  {
1234  (errcode(ERRCODE_PROTOCOL_VIOLATION),
1235  errmsg("invalid message length")));
1236  return EOF;
1237  }
1238 
1239  len -= 4; /* discount length itself */
1240 
1241  if (len > 0)
1242  {
1243  /*
1244  * Allocate space for message. If we run out of room (ridiculously
1245  * large message), we will elog(ERROR), but we want to discard the
1246  * message body so as not to lose communication sync.
1247  */
1248  PG_TRY();
1249  {
1250  enlargeStringInfo(s, len);
1251  }
1252  PG_CATCH();
1253  {
1254  if (pq_discardbytes(len) == EOF)
1256  (errcode(ERRCODE_PROTOCOL_VIOLATION),
1257  errmsg("incomplete message from client")));
1258 
1259  /* we discarded the rest of the message so we're back in sync. */
1260  PqCommReadingMsg = false;
1261  PG_RE_THROW();
1262  }
1263  PG_END_TRY();
1264 
1265  /* And grab the message */
1266  if (pq_getbytes(s->data, len) == EOF)
1267  {
1269  (errcode(ERRCODE_PROTOCOL_VIOLATION),
1270  errmsg("incomplete message from client")));
1271  return EOF;
1272  }
1273  s->len = len;
1274  /* Place a trailing null per StringInfo convention */
1275  s->data[len] = '\0';
1276  }
1277 
1278  /* finished reading the message. */
1279  PqCommReadingMsg = false;
1280 
1281  return 0;
1282 }
signed int int32
Definition: c.h:483
#define PG_RE_THROW()
Definition: elog.h:411
#define PG_TRY(...)
Definition: elog.h:370
#define PG_END_TRY(...)
Definition: elog.h:395
#define PG_CATCH(...)
Definition: elog.h:380
#define pg_ntoh32(x)
Definition: pg_bswap.h:125
static int pq_discardbytes(size_t len)
Definition: pqcomm.c:1108
int pq_getbytes(char *s, size_t len)
Definition: pqcomm.c:1074
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 
203 #ifndef WIN32
204 
205  /* Don't give the socket to any subprograms we execute. */
206  if (fcntl(MyProcPort->sock, F_SETFD, FD_CLOEXEC) < 0)
207  elog(FATAL, "fcntl(F_SETFD) failed on socket: %m");
208 #endif
209 
212  MyProcPort->sock, NULL, NULL);
214  MyLatch, NULL);
216  NULL, NULL);
217 
218  /*
219  * The event positions match the order we added them, but let's sanity
220  * check them to be sure.
221  */
222  Assert(socket_pos == FeBeWaitSetSocketPos);
223  Assert(latch_pos == FeBeWaitSetLatchPos);
224 }
#define PG_USED_FOR_ASSERTS_ONLY
Definition: c.h:171
void on_proc_exit(pg_on_exit_callback function, Datum arg)
Definition: ipc.c:305
WaitEventSet * CreateWaitEventSet(MemoryContext context, int nevents)
Definition: latch.c:721
int AddWaitEventToSet(WaitEventSet *set, uint32 events, pgsocket fd, Latch *latch, void *user_data)
Definition: latch.c:920
#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:141
void * MemoryContextAlloc(MemoryContext context, Size size)
Definition: mcxt.c:1021
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:250
static int PqSendBufferSize
Definition: pqcomm.c:123
pgsocket sock
Definition: libpq-be.h:148

References AddWaitEventToSet(), Assert(), COMMERROR, CreateWaitEventSet(), elog(), ereport, errmsg(), FATAL, 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 1190 of file pqcomm.c.

1191 {
1192  return PqCommReadingMsg;
1193 }

References PqCommReadingMsg.

Referenced by PostgresMain().

◆ pq_peekbyte()

int pq_peekbyte ( void  )

Definition at line 999 of file pqcomm.c.

1000 {
1002 
1003  while (PqRecvPointer >= PqRecvLength)
1004  {
1005  if (pq_recvbuf()) /* If nothing in buffer, then recv some */
1006  return EOF; /* Failed to recv data */
1007  }
1008  return (unsigned char) PqRecvBuffer[PqRecvPointer];
1009 }

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 1538 of file pqcomm.c.

1539 {
1540  Assert(msgtype != 0);
1541 
1542  if (PqCommBusy)
1543  return 0;
1544  PqCommBusy = true;
1545  if (internal_putbytes(&msgtype, 1))
1546  goto fail;
1547 
1548  if (internal_putbytes(s, len))
1549  goto fail;
1550  PqCommBusy = false;
1551  return 0;
1552 
1553 fail:
1554  PqCommBusy = false;
1555  return EOF;
1556 }
static int internal_putbytes(const char *s, size_t len)
Definition: pqcomm.c:1286

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

Referenced by send_message_to_frontend().

◆ pq_startmsgread()

void pq_startmsgread ( void  )

Definition at line 1150 of file pqcomm.c.

1151 {
1152  /*
1153  * There shouldn't be a read active already, but let's check just to be
1154  * sure.
1155  */
1156  if (PqCommReadingMsg)
1157  ereport(FATAL,
1158  (errcode(ERRCODE_PROTOCOL_VIOLATION),
1159  errmsg("terminating connection because protocol synchronization was lost")));
1160 
1161  PqCommReadingMsg = true;
1162 }

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 869 of file pqcomm.c.

870 {
871  ListCell *l;
872 
873  /* Loop through all created sockets... */
874  foreach(l, sock_paths)
875  {
876  char *sock_path = (char *) lfirst(l);
877 
878  /* Ignore any error. */
879  (void) unlink(sock_path);
880  }
881  /* Since we're about to exit, no need to reclaim storage */
882  sock_paths = NIL;
883 }
#define lfirst(lc)
Definition: pg_list.h:172
#define NIL
Definition: pg_list.h:68
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 40 of file be-secure-common.c.

41 {
42  int loglevel = is_server_start ? ERROR : LOG;
43  char *command;
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  command = replace_percent_placeholders(ssl_passphrase_command, "ssl_passphrase_command", "p", prompt);
53 
54  fh = OpenPipeStream(command, "r");
55  if (fh == NULL)
56  {
57  ereport(loglevel,
59  errmsg("could not execute command \"%s\": %m",
60  command)));
61  goto error;
62  }
63 
64  if (!fgets(buf, size, fh))
65  {
66  if (ferror(fh))
67  {
68  explicit_bzero(buf, size);
69  ereport(loglevel,
71  errmsg("could not read from command \"%s\": %m",
72  command)));
73  goto error;
74  }
75  }
76 
77  pclose_rc = ClosePipeStream(fh);
78  if (pclose_rc == -1)
79  {
80  explicit_bzero(buf, size);
81  ereport(loglevel,
83  errmsg("could not close pipe to external command: %m")));
84  goto error;
85  }
86  else if (pclose_rc != 0)
87  {
88  explicit_bzero(buf, size);
89  ereport(loglevel,
91  errmsg("command \"%s\" failed",
92  command),
93  errdetail_internal("%s", wait_result_to_str(pclose_rc))));
94  goto error;
95  }
96 
97  /* strip trailing newline and carriage return */
99 
100 error:
101  pfree(command);
102  return len;
103 }
char * ssl_passphrase_command
Definition: be-secure.c:45
int errdetail_internal(const char *fmt,...)
Definition: elog.c:1229
#define ERROR
Definition: elog.h:39
int ClosePipeStream(FILE *file)
Definition: fd.c:2936
FILE * OpenPipeStream(const char *command, const char *mode)
Definition: fd.c:2631
void pfree(void *pointer)
Definition: mcxt.c:1456
char * replace_percent_placeholders(const char *instr, const char *param_name, const char *letters,...)
Definition: percentrepl.c:59
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
char * wait_result_to_str(int exitstatus)
Definition: wait_error.c:33

References Assert(), buf, ClosePipeStream(), ereport, errcode_for_file_access(), errdetail_internal(), errmsg(), ERROR, error(), explicit_bzero(), len, LOG, OpenPipeStream(), pfree(), pg_strip_crlf(), replace_percent_placeholders(), 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:109

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

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

◆ 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:1156
#define DEBUG2
Definition: elog.h:29

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

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

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,
185  WAIT_EVENT_CLIENT_READ);
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:507
uint32 events
Definition: latch.h:153

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(), 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,
297  WAIT_EVENT_CLIENT_WRITE);
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:553

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(), WaitEventSetWait(), WL_LATCH_SET, WL_POSTMASTER_DEATH, and WL_SOCKET_WRITEABLE.

Referenced by internal_flush().

◆ StreamClose()

void StreamClose ( pgsocket  sock)

Definition at line 835 of file pqcomm.c.

836 {
837  if (closesocket(sock) != 0)
838  elog(LOG, "could not close client or listen socket: %m");
839 }
#define closesocket
Definition: port.h:349

References closesocket, elog(), and LOG.

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

◆ StreamConnection()

int StreamConnection ( pgsocket  server_fd,
Port port 
)

Definition at line 701 of file pqcomm.c.

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

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 321 of file pqcomm.c.

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

References _, bind, closesocket, EADDRINUSE, elog(), ereport, err(), errcode_for_socket_access(), errhint(), errmsg(), FATAL, 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 851 of file pqcomm.c.

852 {
853  ListCell *l;
854 
855  /* Loop through all created sockets... */
856  foreach(l, sock_paths)
857  {
858  char *sock_path = (char *) lfirst(l);
859 
860  /* Ignore errors; there's no point in complaining */
861  (void) utime(sock_path, NULL);
862  }
863 }

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