PostgreSQL Source Code  git master
pg_ctl.c File Reference
#include "postgres_fe.h"
#include <fcntl.h>
#include <signal.h>
#include <time.h>
#include <sys/stat.h>
#include <sys/wait.h>
#include <unistd.h>
#include "catalog/pg_control.h"
#include "common/controldata_utils.h"
#include "common/file_perm.h"
#include "common/logging.h"
#include "common/string.h"
#include "getopt_long.h"
#include "utils/pidfile.h"
Include dependency graph for pg_ctl.c:

Go to the source code of this file.

Macros

#define DEFAULT_WAIT   60
 
#define USEC_PER_SEC   1000000
 
#define WAITS_PER_SEC   10 /* should divide USEC_PER_SEC evenly */
 

Typedefs

typedef long pgpid_t
 

Enumerations

enum  ShutdownMode { SMART_MODE, FAST_MODE, IMMEDIATE_MODE }
 
enum  WaitPMResult { POSTMASTER_READY, POSTMASTER_STILL_STARTING, POSTMASTER_FAILED }
 
enum  CtlCommand {
  NO_COMMAND = 0, INIT_COMMAND, START_COMMAND, STOP_COMMAND,
  RESTART_COMMAND, RELOAD_COMMAND, STATUS_COMMAND, PROMOTE_COMMAND,
  LOGROTATE_COMMAND, KILL_COMMAND, REGISTER_COMMAND, UNREGISTER_COMMAND,
  RUN_AS_SERVICE_COMMAND
}
 

Functions

static void write_stderr (const char *fmt,...) pg_attribute_printf(1
 
static void static void do_advice (void)
 
static void do_help (void)
 
static void set_mode (char *modeopt)
 
static void set_sig (char *signame)
 
static void do_init (void)
 
static void do_start (void)
 
static void do_stop (void)
 
static void do_restart (void)
 
static void do_reload (void)
 
static void do_status (void)
 
static void do_promote (void)
 
static void do_logrotate (void)
 
static void do_kill (pgpid_t pid)
 
static void print_msg (const char *msg)
 
static void adjust_data_dir (void)
 
static pgpid_t get_pgpid (bool is_status_request)
 
static char ** readfile (const char *path, int *numlines)
 
static void free_readfile (char **optlines)
 
static pgpid_t start_postmaster (void)
 
static void read_post_opts (void)
 
static WaitPMResult wait_for_postmaster (pgpid_t pm_pid, bool do_checkpoint)
 
static bool postmaster_is_alive (pid_t pid)
 
static DBState get_control_dbstate (void)
 
static void trap_sigint_during_startup (int sig)
 
static char * find_other_exec_or_die (const char *argv0, const char *target, const char *versionstr)
 
int main (int argc, char **argv)
 

Variables

static bool do_wait = true
 
static int wait_seconds = DEFAULT_WAIT
 
static bool wait_seconds_arg = false
 
static bool silent_mode = false
 
static ShutdownMode shutdown_mode = FAST_MODE
 
static int sig = SIGINT
 
static CtlCommand ctl_command = NO_COMMAND
 
static char * pg_data = NULL
 
static char * pg_config = NULL
 
static char * pgdata_opt = NULL
 
static char * post_opts = NULL
 
static const char * progname
 
static char * log_file = NULL
 
static char * exec_path = NULL
 
static char * event_source = NULL
 
static char * register_servicename = "PostgreSQL"
 
static char * register_username = NULL
 
static char * register_password = NULL
 
static char * argv0 = NULL
 
static bool allow_core_files = false
 
static time_t start_time
 
static char postopts_file [MAXPGPATH]
 
static char version_file [MAXPGPATH]
 
static char pid_file [MAXPGPATH]
 
static char backup_file [MAXPGPATH]
 
static char promote_file [MAXPGPATH]
 
static char logrotate_file [MAXPGPATH]
 
static volatile pgpid_t postmasterPID = -1
 

Macro Definition Documentation

◆ DEFAULT_WAIT

#define DEFAULT_WAIT   60

Definition at line 73 of file pg_ctl.c.

Referenced by do_kill().

◆ USEC_PER_SEC

#define USEC_PER_SEC   1000000

Definition at line 75 of file pg_ctl.c.

Referenced by do_promote(), do_restart(), do_stop(), and wait_for_postmaster().

◆ WAITS_PER_SEC

#define WAITS_PER_SEC   10 /* should divide USEC_PER_SEC evenly */

Definition at line 77 of file pg_ctl.c.

Referenced by do_promote(), do_restart(), do_stop(), and wait_for_postmaster().

Typedef Documentation

◆ pgpid_t

typedef long pgpid_t

Definition at line 39 of file pg_ctl.c.

Enumeration Type Documentation

◆ CtlCommand

enum CtlCommand
Enumerator
NO_COMMAND 
INIT_COMMAND 
START_COMMAND 
STOP_COMMAND 
RESTART_COMMAND 
RELOAD_COMMAND 
STATUS_COMMAND 
PROMOTE_COMMAND 
LOGROTATE_COMMAND 
KILL_COMMAND 
REGISTER_COMMAND 
UNREGISTER_COMMAND 
RUN_AS_SERVICE_COMMAND 

Definition at line 56 of file pg_ctl.c.

◆ ShutdownMode

Enumerator
SMART_MODE 
FAST_MODE 
IMMEDIATE_MODE 

Definition at line 42 of file pg_ctl.c.

43 {
44  SMART_MODE,
45  FAST_MODE,
47 } ShutdownMode;
ShutdownMode
Definition: pg_ctl.c:42

◆ WaitPMResult

Enumerator
POSTMASTER_READY 
POSTMASTER_STILL_STARTING 
POSTMASTER_FAILED 

Definition at line 49 of file pg_ctl.c.

Function Documentation

◆ adjust_data_dir()

static void adjust_data_dir ( void  )
static

Definition at line 2168 of file pg_ctl.c.

References _, argv0, canonicalize_path(), exec_path, fd(), filename, find_other_exec_or_die(), free, MAXPGPATH, my_exec_path, PG_BACKEND_VERSIONSTR, pg_config, pg_data, pg_strdup(), pg_strip_crlf(), pgdata_opt, post_opts, progname, snprintf, and write_stderr().

Referenced by main().

2169 {
2170  char cmd[MAXPGPATH],
2172  *my_exec_path;
2173  FILE *fd;
2174 
2175  /* do nothing if we're working without knowledge of data dir */
2176  if (pg_config == NULL)
2177  return;
2178 
2179  /* If there is no postgresql.conf, it can't be a config-only dir */
2180  snprintf(filename, sizeof(filename), "%s/postgresql.conf", pg_config);
2181  if ((fd = fopen(filename, "r")) == NULL)
2182  return;
2183  fclose(fd);
2184 
2185  /* If PG_VERSION exists, it can't be a config-only dir */
2186  snprintf(filename, sizeof(filename), "%s/PG_VERSION", pg_config);
2187  if ((fd = fopen(filename, "r")) != NULL)
2188  {
2189  fclose(fd);
2190  return;
2191  }
2192 
2193  /* Must be a configuration directory, so find the data directory */
2194 
2195  /* we use a private my_exec_path to avoid interfering with later uses */
2196  if (exec_path == NULL)
2197  my_exec_path = find_other_exec_or_die(argv0, "postgres", PG_BACKEND_VERSIONSTR);
2198  else
2199  my_exec_path = pg_strdup(exec_path);
2200 
2201  /* it's important for -C to be the first option, see main.c */
2202  snprintf(cmd, MAXPGPATH, "\"%s\" -C data_directory %s%s",
2203  my_exec_path,
2204  pgdata_opt ? pgdata_opt : "",
2205  post_opts ? post_opts : "");
2206 
2207  fd = popen(cmd, "r");
2208  if (fd == NULL || fgets(filename, sizeof(filename), fd) == NULL)
2209  {
2210  write_stderr(_("%s: could not determine the data directory using command \"%s\"\n"), progname, cmd);
2211  exit(1);
2212  }
2213  pclose(fd);
2214  free(my_exec_path);
2215 
2216  /* strip trailing newline and carriage return */
2217  (void) pg_strip_crlf(filename);
2218 
2219  free(pg_data);
2220  pg_data = pg_strdup(filename);
2222 }
static char * argv0
Definition: pg_ctl.c:97
int pg_strip_crlf(char *str)
Definition: string.c:105
static char * post_opts
Definition: pg_ctl.c:89
void canonicalize_path(char *path)
Definition: path.c:254
static int fd(const char *x, int i)
Definition: preproc-init.c:105
static char * pg_data
Definition: pg_ctl.c:86
#define MAXPGPATH
char * pg_strdup(const char *in)
Definition: fe_memutils.c:85
char my_exec_path[MAXPGPATH]
Definition: globals.c:72
static char * pgdata_opt
Definition: pg_ctl.c:88
#define PG_BACKEND_VERSIONSTR
Definition: port.h:111
#define free(a)
Definition: header.h:65
static char * exec_path
Definition: pg_ctl.c:92
static const char * progname
Definition: pg_ctl.c:90
static void write_stderr(const char *fmt,...) pg_attribute_printf(1
Definition: pg_ctl.c:205
static char * filename
Definition: pg_dumpall.c:90
#define snprintf
Definition: port.h:192
#define _(x)
Definition: elog.c:87
static char * find_other_exec_or_die(const char *argv0, const char *target, const char *versionstr)
Definition: pg_ctl.c:784
static char * pg_config
Definition: pg_ctl.c:87

◆ do_advice()

static void do_advice ( void  )
static

Definition at line 2009 of file pg_ctl.c.

References _, progname, and write_stderr().

Referenced by main(), set_mode(), and set_sig().

2010 {
2011  write_stderr(_("Try \"%s --help\" for more information.\n"), progname);
2012 }
static const char * progname
Definition: pg_ctl.c:90
static void write_stderr(const char *fmt,...) pg_attribute_printf(1
Definition: pg_ctl.c:205
#define _(x)
Definition: elog.c:87

◆ do_help()

static void do_help ( void  )
static

Definition at line 2017 of file pg_ctl.c.

References _, printf, and progname.

Referenced by main().

2018 {
2019  printf(_("%s is a utility to initialize, start, stop, or control a PostgreSQL server.\n\n"), progname);
2020  printf(_("Usage:\n"));
2021  printf(_(" %s init[db] [-D DATADIR] [-s] [-o OPTIONS]\n"), progname);
2022  printf(_(" %s start [-D DATADIR] [-l FILENAME] [-W] [-t SECS] [-s]\n"
2023  " [-o OPTIONS] [-p PATH] [-c]\n"), progname);
2024  printf(_(" %s stop [-D DATADIR] [-m SHUTDOWN-MODE] [-W] [-t SECS] [-s]\n"), progname);
2025  printf(_(" %s restart [-D DATADIR] [-m SHUTDOWN-MODE] [-W] [-t SECS] [-s]\n"
2026  " [-o OPTIONS] [-c]\n"), progname);
2027  printf(_(" %s reload [-D DATADIR] [-s]\n"), progname);
2028  printf(_(" %s status [-D DATADIR]\n"), progname);
2029  printf(_(" %s promote [-D DATADIR] [-W] [-t SECS] [-s]\n"), progname);
2030  printf(_(" %s logrotate [-D DATADIR] [-s]\n"), progname);
2031  printf(_(" %s kill SIGNALNAME PID\n"), progname);
2032 #ifdef WIN32
2033  printf(_(" %s register [-D DATADIR] [-N SERVICENAME] [-U USERNAME] [-P PASSWORD]\n"
2034  " [-S START-TYPE] [-e SOURCE] [-W] [-t SECS] [-s] [-o OPTIONS]\n"), progname);
2035  printf(_(" %s unregister [-N SERVICENAME]\n"), progname);
2036 #endif
2037 
2038  printf(_("\nCommon options:\n"));
2039  printf(_(" -D, --pgdata=DATADIR location of the database storage area\n"));
2040 #ifdef WIN32
2041  printf(_(" -e SOURCE event source for logging when running as a service\n"));
2042 #endif
2043  printf(_(" -s, --silent only print errors, no informational messages\n"));
2044  printf(_(" -t, --timeout=SECS seconds to wait when using -w option\n"));
2045  printf(_(" -V, --version output version information, then exit\n"));
2046  printf(_(" -w, --wait wait until operation completes (default)\n"));
2047  printf(_(" -W, --no-wait do not wait until operation completes\n"));
2048  printf(_(" -?, --help show this help, then exit\n"));
2049  printf(_("If the -D option is omitted, the environment variable PGDATA is used.\n"));
2050 
2051  printf(_("\nOptions for start or restart:\n"));
2052 #if defined(HAVE_GETRLIMIT) && defined(RLIMIT_CORE)
2053  printf(_(" -c, --core-files allow postgres to produce core files\n"));
2054 #else
2055  printf(_(" -c, --core-files not applicable on this platform\n"));
2056 #endif
2057  printf(_(" -l, --log=FILENAME write (or append) server log to FILENAME\n"));
2058  printf(_(" -o, --options=OPTIONS command line options to pass to postgres\n"
2059  " (PostgreSQL server executable) or initdb\n"));
2060  printf(_(" -p PATH-TO-POSTGRES normally not necessary\n"));
2061  printf(_("\nOptions for stop or restart:\n"));
2062  printf(_(" -m, --mode=MODE MODE can be \"smart\", \"fast\", or \"immediate\"\n"));
2063 
2064  printf(_("\nShutdown modes are:\n"));
2065  printf(_(" smart quit after all clients have disconnected\n"));
2066  printf(_(" fast quit directly, with proper shutdown (default)\n"));
2067  printf(_(" immediate quit without complete shutdown; will lead to recovery on restart\n"));
2068 
2069  printf(_("\nAllowed signal names for kill:\n"));
2070  printf(" ABRT HUP INT KILL QUIT TERM USR1 USR2\n");
2071 
2072 #ifdef WIN32
2073  printf(_("\nOptions for register and unregister:\n"));
2074  printf(_(" -N SERVICENAME service name with which to register PostgreSQL server\n"));
2075  printf(_(" -P PASSWORD password of account to register PostgreSQL server\n"));
2076  printf(_(" -U USERNAME user name of account to register PostgreSQL server\n"));
2077  printf(_(" -S START-TYPE service start type to register PostgreSQL server\n"));
2078 
2079  printf(_("\nStart types are:\n"));
2080  printf(_(" auto start service automatically during system startup (default)\n"));
2081  printf(_(" demand start service on demand\n"));
2082 #endif
2083 
2084  printf(_("\nReport bugs to <pgsql-bugs@lists.postgresql.org>.\n"));
2085 }
#define printf(...)
Definition: port.h:198
static const char * progname
Definition: pg_ctl.c:90
#define _(x)
Definition: elog.c:87

◆ do_init()

static void do_init ( void  )
static

Definition at line 816 of file pg_ctl.c.

References _, argv0, DEVNULL, exec_path, find_other_exec_or_die(), MAXPGPATH, pgdata_opt, post_opts, progname, silent_mode, snprintf, and write_stderr().

Referenced by main().

817 {
818  char cmd[MAXPGPATH];
819 
820  if (exec_path == NULL)
821  exec_path = find_other_exec_or_die(argv0, "initdb", "initdb (PostgreSQL) " PG_VERSION "\n");
822 
823  if (pgdata_opt == NULL)
824  pgdata_opt = "";
825 
826  if (post_opts == NULL)
827  post_opts = "";
828 
829  if (!silent_mode)
830  snprintf(cmd, MAXPGPATH, "\"%s\" %s%s",
832  else
833  snprintf(cmd, MAXPGPATH, "\"%s\" %s%s > \"%s\"",
835 
836  if (system(cmd) != 0)
837  {
838  write_stderr(_("%s: database system initialization failed\n"), progname);
839  exit(1);
840  }
841 }
static char * argv0
Definition: pg_ctl.c:97
static char * post_opts
Definition: pg_ctl.c:89
#define MAXPGPATH
#define DEVNULL
Definition: port.h:123
static char * pgdata_opt
Definition: pg_ctl.c:88
static char * exec_path
Definition: pg_ctl.c:92
static const char * progname
Definition: pg_ctl.c:90
static void write_stderr(const char *fmt,...) pg_attribute_printf(1
Definition: pg_ctl.c:205
#define snprintf
Definition: port.h:192
#define _(x)
Definition: elog.c:87
static char * find_other_exec_or_die(const char *argv0, const char *target, const char *versionstr)
Definition: pg_ctl.c:784
static bool silent_mode
Definition: pg_ctl.c:82

◆ do_kill()

static void do_kill ( pgpid_t  pid)
static

Definition at line 1392 of file pg_ctl.c.

References _, AddUserToTokenDacl(), appendPQExpBuffer(), appendPQExpBufferStr(), argv0, createPQExpBuffer(), PQExpBufferData::data, DEFAULT_WAIT, do_wait, event_source, find_my_exec(), find_other_exec(), free, i, kill, make_absolute_path(), make_native_path(), MAXPGPATH, MCXT_ALLOC_NO_OOM, PG_BACKEND_VERSIONSTR, pg_config, pg_malloc_extended(), pg_strcasecmp(), post_opts, POSTMASTER_READY, postmasterPID, progname, read_post_opts(), register_password, register_servicename, register_username, sig, SIGHUP, silent_mode, snprintf, sprintf, status(), strerror, wait_for_postmaster(), wait_seconds, wait_seconds_arg, and write_stderr().

Referenced by main().

1393 {
1394  if (kill((pid_t) pid, sig) != 0)
1395  {
1396  write_stderr(_("%s: could not send signal %d (PID: %ld): %s\n"),
1397  progname, sig, pid, strerror(errno));
1398  exit(1);
1399  }
1400 }
#define kill(pid, sig)
Definition: win32_port.h:426
static int sig
Definition: pg_ctl.c:84
#define strerror
Definition: port.h:205
static const char * progname
Definition: pg_ctl.c:90
static void write_stderr(const char *fmt,...) pg_attribute_printf(1
Definition: pg_ctl.c:205
#define _(x)
Definition: elog.c:87

◆ do_logrotate()

static void do_logrotate ( void  )
static

Definition at line 1254 of file pg_ctl.c.

References _, get_pgpid(), kill, logrotate_file, MAXPGPATH, pg_data, pid_file, print_msg(), progname, sig, SIGUSR1, snprintf, strerror, and write_stderr().

Referenced by main().

1255 {
1256  FILE *logrotatefile;
1257  pgpid_t pid;
1258 
1259  pid = get_pgpid(false);
1260 
1261  if (pid == 0) /* no pid file */
1262  {
1263  write_stderr(_("%s: PID file \"%s\" does not exist\n"), progname, pid_file);
1264  write_stderr(_("Is server running?\n"));
1265  exit(1);
1266  }
1267  else if (pid < 0) /* standalone backend, not postmaster */
1268  {
1269  pid = -pid;
1270  write_stderr(_("%s: cannot rotate log file; "
1271  "single-user server is running (PID: %ld)\n"),
1272  progname, pid);
1273  exit(1);
1274  }
1275 
1276  snprintf(logrotate_file, MAXPGPATH, "%s/logrotate", pg_data);
1277 
1278  if ((logrotatefile = fopen(logrotate_file, "w")) == NULL)
1279  {
1280  write_stderr(_("%s: could not create log rotation signal file \"%s\": %s\n"),
1281  progname, logrotate_file, strerror(errno));
1282  exit(1);
1283  }
1284  if (fclose(logrotatefile))
1285  {
1286  write_stderr(_("%s: could not write log rotation signal file \"%s\": %s\n"),
1287  progname, logrotate_file, strerror(errno));
1288  exit(1);
1289  }
1290 
1291  sig = SIGUSR1;
1292  if (kill((pid_t) pid, sig) != 0)
1293  {
1294  write_stderr(_("%s: could not send log rotation signal (PID: %ld): %s\n"),
1295  progname, pid, strerror(errno));
1296  if (unlink(logrotate_file) != 0)
1297  write_stderr(_("%s: could not remove log rotation signal file \"%s\": %s\n"),
1298  progname, logrotate_file, strerror(errno));
1299  exit(1);
1300  }
1301 
1302  print_msg(_("server signaled to rotate log file\n"));
1303 }
static char logrotate_file[MAXPGPATH]
Definition: pg_ctl.c:106
#define SIGUSR1
Definition: win32_port.h:166
#define kill(pid, sig)
Definition: win32_port.h:426
static char * pg_data
Definition: pg_ctl.c:86
static char pid_file[MAXPGPATH]
Definition: pg_ctl.c:103
long pgpid_t
Definition: pg_ctl.c:39
#define MAXPGPATH
static pgpid_t get_pgpid(bool is_status_request)
Definition: pg_ctl.c:249
static int sig
Definition: pg_ctl.c:84
#define strerror
Definition: port.h:205
static const char * progname
Definition: pg_ctl.c:90
static void write_stderr(const char *fmt,...) pg_attribute_printf(1
Definition: pg_ctl.c:205
#define snprintf
Definition: port.h:192
static void print_msg(const char *msg)
Definition: pg_ctl.c:239
#define _(x)
Definition: elog.c:87

◆ do_promote()

static void do_promote ( void  )
static

Definition at line 1155 of file pg_ctl.c.

References _, DB_IN_ARCHIVE_RECOVERY, DB_IN_PRODUCTION, DB_STARTUP, do_wait, get_control_dbstate(), get_pgpid(), kill, MAXPGPATH, pg_data, pg_usleep(), pid_file, print_msg(), progname, promote_file, sig, SIGUSR1, snprintf, strerror, USEC_PER_SEC, wait_seconds, WAITS_PER_SEC, and write_stderr().

Referenced by main().

1156 {
1157  FILE *prmfile;
1158  pgpid_t pid;
1159 
1160  pid = get_pgpid(false);
1161 
1162  if (pid == 0) /* no pid file */
1163  {
1164  write_stderr(_("%s: PID file \"%s\" does not exist\n"), progname, pid_file);
1165  write_stderr(_("Is server running?\n"));
1166  exit(1);
1167  }
1168  else if (pid < 0) /* standalone backend, not postmaster */
1169  {
1170  pid = -pid;
1171  write_stderr(_("%s: cannot promote server; "
1172  "single-user server is running (PID: %ld)\n"),
1173  progname, pid);
1174  exit(1);
1175  }
1176 
1178  {
1179  write_stderr(_("%s: cannot promote server; "
1180  "server is not in standby mode\n"),
1181  progname);
1182  exit(1);
1183  }
1184 
1185  /*
1186  * For 9.3 onwards, "fast" promotion is performed. Promotion with a full
1187  * checkpoint is still possible by writing a file called
1188  * "fallback_promote" instead of "promote"
1189  */
1190  snprintf(promote_file, MAXPGPATH, "%s/promote", pg_data);
1191 
1192  if ((prmfile = fopen(promote_file, "w")) == NULL)
1193  {
1194  write_stderr(_("%s: could not create promote signal file \"%s\": %s\n"),
1195  progname, promote_file, strerror(errno));
1196  exit(1);
1197  }
1198  if (fclose(prmfile))
1199  {
1200  write_stderr(_("%s: could not write promote signal file \"%s\": %s\n"),
1201  progname, promote_file, strerror(errno));
1202  exit(1);
1203  }
1204 
1205  sig = SIGUSR1;
1206  if (kill((pid_t) pid, sig) != 0)
1207  {
1208  write_stderr(_("%s: could not send promote signal (PID: %ld): %s\n"),
1209  progname, pid, strerror(errno));
1210  if (unlink(promote_file) != 0)
1211  write_stderr(_("%s: could not remove promote signal file \"%s\": %s\n"),
1212  progname, promote_file, strerror(errno));
1213  exit(1);
1214  }
1215 
1216  if (do_wait)
1217  {
1219  int cnt;
1220 
1221  print_msg(_("waiting for server to promote..."));
1222  for (cnt = 0; cnt < wait_seconds * WAITS_PER_SEC; cnt++)
1223  {
1224  state = get_control_dbstate();
1225  if (state == DB_IN_PRODUCTION)
1226  break;
1227 
1228  if (cnt % WAITS_PER_SEC == 0)
1229  print_msg(".");
1230  pg_usleep(USEC_PER_SEC / WAITS_PER_SEC);
1231  }
1232  if (state == DB_IN_PRODUCTION)
1233  {
1234  print_msg(_(" done\n"));
1235  print_msg(_("server promoted\n"));
1236  }
1237  else
1238  {
1239  print_msg(_(" stopped waiting\n"));
1240  write_stderr(_("%s: server did not promote in time\n"),
1241  progname);
1242  exit(1);
1243  }
1244  }
1245  else
1246  print_msg(_("server promoting\n"));
1247 }
static int wait_seconds
Definition: pg_ctl.c:80
#define SIGUSR1
Definition: win32_port.h:166
#define kill(pid, sig)
Definition: win32_port.h:426
static char * pg_data
Definition: pg_ctl.c:86
void pg_usleep(long microsec)
Definition: signal.c:53
static char pid_file[MAXPGPATH]
Definition: pg_ctl.c:103
long pgpid_t
Definition: pg_ctl.c:39
#define MAXPGPATH
#define USEC_PER_SEC
Definition: pg_ctl.c:75
DBState
Definition: pg_control.h:85
static pgpid_t get_pgpid(bool is_status_request)
Definition: pg_ctl.c:249
static int sig
Definition: pg_ctl.c:84
Definition: regguts.h:298
#define strerror
Definition: port.h:205
static const char * progname
Definition: pg_ctl.c:90
static void write_stderr(const char *fmt,...) pg_attribute_printf(1
Definition: pg_ctl.c:205
static char promote_file[MAXPGPATH]
Definition: pg_ctl.c:105
static bool do_wait
Definition: pg_ctl.c:79
static DBState get_control_dbstate(void)
Definition: pg_ctl.c:2226
#define snprintf
Definition: port.h:192
static void print_msg(const char *msg)
Definition: pg_ctl.c:239
#define _(x)
Definition: elog.c:87
#define WAITS_PER_SEC
Definition: pg_ctl.c:77

◆ do_reload()

static void do_reload ( void  )
static

Definition at line 1118 of file pg_ctl.c.

References _, get_pgpid(), kill, pid_file, print_msg(), progname, sig, strerror, and write_stderr().

Referenced by main().

1119 {
1120  pgpid_t pid;
1121 
1122  pid = get_pgpid(false);
1123  if (pid == 0) /* no pid file */
1124  {
1125  write_stderr(_("%s: PID file \"%s\" does not exist\n"), progname, pid_file);
1126  write_stderr(_("Is server running?\n"));
1127  exit(1);
1128  }
1129  else if (pid < 0) /* standalone backend, not postmaster */
1130  {
1131  pid = -pid;
1132  write_stderr(_("%s: cannot reload server; "
1133  "single-user server is running (PID: %ld)\n"),
1134  progname, pid);
1135  write_stderr(_("Please terminate the single-user server and try again.\n"));
1136  exit(1);
1137  }
1138 
1139  if (kill((pid_t) pid, sig) != 0)
1140  {
1141  write_stderr(_("%s: could not send reload signal (PID: %ld): %s\n"),
1142  progname, pid, strerror(errno));
1143  exit(1);
1144  }
1145 
1146  print_msg(_("server signaled\n"));
1147 }
#define kill(pid, sig)
Definition: win32_port.h:426
static char pid_file[MAXPGPATH]
Definition: pg_ctl.c:103
long pgpid_t
Definition: pg_ctl.c:39
static pgpid_t get_pgpid(bool is_status_request)
Definition: pg_ctl.c:249
static int sig
Definition: pg_ctl.c:84
#define strerror
Definition: port.h:205
static const char * progname
Definition: pg_ctl.c:90
static void write_stderr(const char *fmt,...) pg_attribute_printf(1
Definition: pg_ctl.c:205
static void print_msg(const char *msg)
Definition: pg_ctl.c:239
#define _(x)
Definition: elog.c:87

◆ do_restart()

static void do_restart ( void  )
static

Definition at line 1024 of file pg_ctl.c.

References _, backup_file, DB_IN_ARCHIVE_RECOVERY, do_start(), get_control_dbstate(), get_pgpid(), kill, pg_usleep(), pid_file, postmaster_is_alive(), print_msg(), progname, shutdown_mode, sig, SMART_MODE, stat, strerror, USEC_PER_SEC, wait_seconds, WAITS_PER_SEC, and write_stderr().

Referenced by main().

1025 {
1026  int cnt;
1027  pgpid_t pid;
1028  struct stat statbuf;
1029 
1030  pid = get_pgpid(false);
1031 
1032  if (pid == 0) /* no pid file */
1033  {
1034  write_stderr(_("%s: PID file \"%s\" does not exist\n"),
1035  progname, pid_file);
1036  write_stderr(_("Is server running?\n"));
1037  write_stderr(_("trying to start server anyway\n"));
1038  do_start();
1039  return;
1040  }
1041  else if (pid < 0) /* standalone backend, not postmaster */
1042  {
1043  pid = -pid;
1044  if (postmaster_is_alive((pid_t) pid))
1045  {
1046  write_stderr(_("%s: cannot restart server; "
1047  "single-user server is running (PID: %ld)\n"),
1048  progname, pid);
1049  write_stderr(_("Please terminate the single-user server and try again.\n"));
1050  exit(1);
1051  }
1052  }
1053 
1054  if (postmaster_is_alive((pid_t) pid))
1055  {
1056  if (kill((pid_t) pid, sig) != 0)
1057  {
1058  write_stderr(_("%s: could not send stop signal (PID: %ld): %s\n"), progname, pid,
1059  strerror(errno));
1060  exit(1);
1061  }
1062 
1063  /*
1064  * If backup_label exists, an online backup is running. Warn the user
1065  * that smart shutdown will wait for it to finish. However, if the
1066  * server is in archive recovery, we're recovering from an online
1067  * backup instead of performing one.
1068  */
1069  if (shutdown_mode == SMART_MODE &&
1070  stat(backup_file, &statbuf) == 0 &&
1072  {
1073  print_msg(_("WARNING: online backup mode is active\n"
1074  "Shutdown will not complete until pg_stop_backup() is called.\n\n"));
1075  }
1076 
1077  print_msg(_("waiting for server to shut down..."));
1078 
1079  /* always wait for restart */
1080 
1081  for (cnt = 0; cnt < wait_seconds * WAITS_PER_SEC; cnt++)
1082  {
1083  if ((pid = get_pgpid(false)) != 0)
1084  {
1085  if (cnt % WAITS_PER_SEC == 0)
1086  print_msg(".");
1087  pg_usleep(USEC_PER_SEC / WAITS_PER_SEC);
1088  }
1089  else
1090  break;
1091  }
1092 
1093  if (pid != 0) /* pid file still exists */
1094  {
1095  print_msg(_(" failed\n"));
1096 
1097  write_stderr(_("%s: server does not shut down\n"), progname);
1098  if (shutdown_mode == SMART_MODE)
1099  write_stderr(_("HINT: The \"-m fast\" option immediately disconnects sessions rather than\n"
1100  "waiting for session-initiated disconnection.\n"));
1101  exit(1);
1102  }
1103 
1104  print_msg(_(" done\n"));
1105  print_msg(_("server stopped\n"));
1106  }
1107  else
1108  {
1109  write_stderr(_("%s: old server process (PID: %ld) seems to be gone\n"),
1110  progname, pid);
1111  write_stderr(_("starting server anyway\n"));
1112  }
1113 
1114  do_start();
1115 }
static int wait_seconds
Definition: pg_ctl.c:80
#define kill(pid, sig)
Definition: win32_port.h:426
static ShutdownMode shutdown_mode
Definition: pg_ctl.c:83
void pg_usleep(long microsec)
Definition: signal.c:53
static char pid_file[MAXPGPATH]
Definition: pg_ctl.c:103
long pgpid_t
Definition: pg_ctl.c:39
static char backup_file[MAXPGPATH]
Definition: pg_ctl.c:104
static void do_start(void)
Definition: pg_ctl.c:844
#define USEC_PER_SEC
Definition: pg_ctl.c:75
#define stat(a, b)
Definition: win32_port.h:255
static pgpid_t get_pgpid(bool is_status_request)
Definition: pg_ctl.c:249
static int sig
Definition: pg_ctl.c:84
#define strerror
Definition: port.h:205
static bool postmaster_is_alive(pid_t pid)
Definition: pg_ctl.c:1311
static const char * progname
Definition: pg_ctl.c:90
static void write_stderr(const char *fmt,...) pg_attribute_printf(1
Definition: pg_ctl.c:205
static DBState get_control_dbstate(void)
Definition: pg_ctl.c:2226
static void print_msg(const char *msg)
Definition: pg_ctl.c:239
#define _(x)
Definition: elog.c:87
#define WAITS_PER_SEC
Definition: pg_ctl.c:77

◆ do_start()

static void do_start ( void  )
static

Definition at line 844 of file pg_ctl.c.

References _, allow_core_files, argv0, ctl_command, do_wait, exec_path, find_other_exec_or_die(), get_pgpid(), PG_BACKEND_VERSIONSTR, pgdata_opt, POSTMASTER_FAILED, POSTMASTER_READY, POSTMASTER_STILL_STARTING, postmasterPID, pqsignal(), print_msg(), progname, putenv, read_post_opts(), RESTART_COMMAND, snprintf, start_postmaster(), trap_sigint_during_startup(), wait_for_postmaster(), and write_stderr().

Referenced by do_restart(), and main().

845 {
846  pgpid_t old_pid = 0;
847  pgpid_t pm_pid;
848 
850  {
851  old_pid = get_pgpid(false);
852  if (old_pid != 0)
853  write_stderr(_("%s: another server might be running; "
854  "trying to start server anyway\n"),
855  progname);
856  }
857 
858  read_post_opts();
859 
860  /* No -D or -D already added during server start */
861  if (ctl_command == RESTART_COMMAND || pgdata_opt == NULL)
862  pgdata_opt = "";
863 
864  if (exec_path == NULL)
866 
867 #if defined(HAVE_GETRLIMIT) && defined(RLIMIT_CORE)
868  if (allow_core_files)
869  unlimit_core_size();
870 #endif
871 
872  /*
873  * If possible, tell the postmaster our parent shell's PID (see the
874  * comments in CreateLockFile() for motivation). Windows hasn't got
875  * getppid() unfortunately.
876  */
877 #ifndef WIN32
878  {
879  static char env_var[32];
880 
881  snprintf(env_var, sizeof(env_var), "PG_GRANDPARENT_PID=%d",
882  (int) getppid());
883  putenv(env_var);
884  }
885 #endif
886 
887  pm_pid = start_postmaster();
888 
889  if (do_wait)
890  {
891  /*
892  * If the user interrupts the startup (e.g. with CTRL-C), we'd like to
893  * abort the server launch. Install a signal handler that will
894  * forward SIGINT to the postmaster process, while we wait.
895  *
896  * (We don't bother to reset the signal handler after the launch, as
897  * we're about to exit, anyway.)
898  */
899  postmasterPID = pm_pid;
901 
902  print_msg(_("waiting for server to start..."));
903 
904  switch (wait_for_postmaster(pm_pid, false))
905  {
906  case POSTMASTER_READY:
907  print_msg(_(" done\n"));
908  print_msg(_("server started\n"));
909  break;
911  print_msg(_(" stopped waiting\n"));
912  write_stderr(_("%s: server did not start in time\n"),
913  progname);
914  exit(1);
915  break;
916  case POSTMASTER_FAILED:
917  print_msg(_(" stopped waiting\n"));
918  write_stderr(_("%s: could not start server\n"
919  "Examine the log output.\n"),
920  progname);
921  exit(1);
922  break;
923  }
924  }
925  else
926  print_msg(_("server starting\n"));
927 
928 #ifdef WIN32
929  /* Now we don't need the handle to the shell process anymore */
930  CloseHandle(postmasterProcess);
931  postmasterProcess = INVALID_HANDLE_VALUE;
932 #endif
933 }
static char * argv0
Definition: pg_ctl.c:97
static void read_post_opts(void)
Definition: pg_ctl.c:711
long pgpid_t
Definition: pg_ctl.c:39
static void trap_sigint_during_startup(int sig)
Definition: pg_ctl.c:766
static pgpid_t get_pgpid(bool is_status_request)
Definition: pg_ctl.c:249
static volatile pgpid_t postmasterPID
Definition: pg_ctl.c:108
static char * pgdata_opt
Definition: pg_ctl.c:88
#define PG_BACKEND_VERSIONSTR
Definition: port.h:111
pqsigfunc pqsignal(int signum, pqsigfunc handler)
Definition: signal.c:170
static WaitPMResult wait_for_postmaster(pgpid_t pm_pid, bool do_checkpoint)
Definition: pg_ctl.c:579
static bool allow_core_files
Definition: pg_ctl.c:98
static char * exec_path
Definition: pg_ctl.c:92
#define putenv(x)
Definition: win32_port.h:474
static const char * progname
Definition: pg_ctl.c:90
static pgpid_t start_postmaster(void)
Definition: pg_ctl.c:443
static void write_stderr(const char *fmt,...) pg_attribute_printf(1
Definition: pg_ctl.c:205
static bool do_wait
Definition: pg_ctl.c:79
#define snprintf
Definition: port.h:192
static CtlCommand ctl_command
Definition: pg_ctl.c:85
static void print_msg(const char *msg)
Definition: pg_ctl.c:239
#define _(x)
Definition: elog.c:87
static char * find_other_exec_or_die(const char *argv0, const char *target, const char *versionstr)
Definition: pg_ctl.c:784

◆ do_status()

static void do_status ( void  )
static

Definition at line 1335 of file pg_ctl.c.

References _, free_readfile(), get_pgpid(), postmaster_is_alive(), postopts_file, printf, progname, and readfile().

Referenced by main().

1336 {
1337  pgpid_t pid;
1338 
1339  pid = get_pgpid(true);
1340  /* Is there a pid file? */
1341  if (pid != 0)
1342  {
1343  /* standalone backend? */
1344  if (pid < 0)
1345  {
1346  pid = -pid;
1347  if (postmaster_is_alive((pid_t) pid))
1348  {
1349  printf(_("%s: single-user server is running (PID: %ld)\n"),
1350  progname, pid);
1351  return;
1352  }
1353  }
1354  else
1355  /* must be a postmaster */
1356  {
1357  if (postmaster_is_alive((pid_t) pid))
1358  {
1359  char **optlines;
1360  char **curr_line;
1361  int numlines;
1362 
1363  printf(_("%s: server is running (PID: %ld)\n"),
1364  progname, pid);
1365 
1366  optlines = readfile(postopts_file, &numlines);
1367  if (optlines != NULL)
1368  {
1369  for (curr_line = optlines; *curr_line != NULL; curr_line++)
1370  puts(*curr_line);
1371 
1372  /* Free the results of readfile */
1373  free_readfile(optlines);
1374  }
1375  return;
1376  }
1377  }
1378  }
1379  printf(_("%s: no server running\n"), progname);
1380 
1381  /*
1382  * The Linux Standard Base Core Specification 3.1 says this should return
1383  * '3, program is not running'
1384  * https://refspecs.linuxbase.org/LSB_3.1.0/LSB-Core-generic/LSB-Core-generic/iniscrptact.html
1385  */
1386  exit(3);
1387 }
#define printf(...)
Definition: port.h:198
static char ** readfile(const char *path, int *numlines)
Definition: pg_ctl.c:317
long pgpid_t
Definition: pg_ctl.c:39
static pgpid_t get_pgpid(bool is_status_request)
Definition: pg_ctl.c:249
static char postopts_file[MAXPGPATH]
Definition: pg_ctl.c:101
static void free_readfile(char **optlines)
Definition: pg_ctl.c:413
static bool postmaster_is_alive(pid_t pid)
Definition: pg_ctl.c:1311
static const char * progname
Definition: pg_ctl.c:90
#define _(x)
Definition: elog.c:87

◆ do_stop()

static void do_stop ( void  )
static

Definition at line 937 of file pg_ctl.c.

References _, backup_file, DB_IN_ARCHIVE_RECOVERY, do_wait, get_control_dbstate(), get_pgpid(), kill, pg_usleep(), pid_file, print_msg(), progname, shutdown_mode, sig, SMART_MODE, stat, strerror, USEC_PER_SEC, wait_seconds, WAITS_PER_SEC, and write_stderr().

Referenced by main().

938 {
939  int cnt;
940  pgpid_t pid;
941  struct stat statbuf;
942 
943  pid = get_pgpid(false);
944 
945  if (pid == 0) /* no pid file */
946  {
947  write_stderr(_("%s: PID file \"%s\" does not exist\n"), progname, pid_file);
948  write_stderr(_("Is server running?\n"));
949  exit(1);
950  }
951  else if (pid < 0) /* standalone backend, not postmaster */
952  {
953  pid = -pid;
954  write_stderr(_("%s: cannot stop server; "
955  "single-user server is running (PID: %ld)\n"),
956  progname, pid);
957  exit(1);
958  }
959 
960  if (kill((pid_t) pid, sig) != 0)
961  {
962  write_stderr(_("%s: could not send stop signal (PID: %ld): %s\n"), progname, pid,
963  strerror(errno));
964  exit(1);
965  }
966 
967  if (!do_wait)
968  {
969  print_msg(_("server shutting down\n"));
970  return;
971  }
972  else
973  {
974  /*
975  * If backup_label exists, an online backup is running. Warn the user
976  * that smart shutdown will wait for it to finish. However, if the
977  * server is in archive recovery, we're recovering from an online
978  * backup instead of performing one.
979  */
980  if (shutdown_mode == SMART_MODE &&
981  stat(backup_file, &statbuf) == 0 &&
983  {
984  print_msg(_("WARNING: online backup mode is active\n"
985  "Shutdown will not complete until pg_stop_backup() is called.\n\n"));
986  }
987 
988  print_msg(_("waiting for server to shut down..."));
989 
990  for (cnt = 0; cnt < wait_seconds * WAITS_PER_SEC; cnt++)
991  {
992  if ((pid = get_pgpid(false)) != 0)
993  {
994  if (cnt % WAITS_PER_SEC == 0)
995  print_msg(".");
996  pg_usleep(USEC_PER_SEC / WAITS_PER_SEC);
997  }
998  else
999  break;
1000  }
1001 
1002  if (pid != 0) /* pid file still exists */
1003  {
1004  print_msg(_(" failed\n"));
1005 
1006  write_stderr(_("%s: server does not shut down\n"), progname);
1007  if (shutdown_mode == SMART_MODE)
1008  write_stderr(_("HINT: The \"-m fast\" option immediately disconnects sessions rather than\n"
1009  "waiting for session-initiated disconnection.\n"));
1010  exit(1);
1011  }
1012  print_msg(_(" done\n"));
1013 
1014  print_msg(_("server stopped\n"));
1015  }
1016 }
static int wait_seconds
Definition: pg_ctl.c:80
#define kill(pid, sig)
Definition: win32_port.h:426
static ShutdownMode shutdown_mode
Definition: pg_ctl.c:83
void pg_usleep(long microsec)
Definition: signal.c:53
static char pid_file[MAXPGPATH]
Definition: pg_ctl.c:103
long pgpid_t
Definition: pg_ctl.c:39
static char backup_file[MAXPGPATH]
Definition: pg_ctl.c:104
#define USEC_PER_SEC
Definition: pg_ctl.c:75
#define stat(a, b)
Definition: win32_port.h:255
static pgpid_t get_pgpid(bool is_status_request)
Definition: pg_ctl.c:249
static int sig
Definition: pg_ctl.c:84
#define strerror
Definition: port.h:205
static const char * progname
Definition: pg_ctl.c:90
static void write_stderr(const char *fmt,...) pg_attribute_printf(1
Definition: pg_ctl.c:205
static bool do_wait
Definition: pg_ctl.c:79
static DBState get_control_dbstate(void)
Definition: pg_ctl.c:2226
static void print_msg(const char *msg)
Definition: pg_ctl.c:239
#define _(x)
Definition: elog.c:87
#define WAITS_PER_SEC
Definition: pg_ctl.c:77

◆ find_other_exec_or_die()

static char* find_other_exec_or_die ( const char *  argv0,
const char *  target,
const char *  versionstr 
)
static

Definition at line 784 of file pg_ctl.c.

References _, find_my_exec(), find_other_exec(), MAXPGPATH, pg_malloc(), progname, strlcpy(), and write_stderr().

Referenced by adjust_data_dir(), do_init(), and do_start().

785 {
786  int ret;
787  char *found_path;
788 
789  found_path = pg_malloc(MAXPGPATH);
790 
791  if ((ret = find_other_exec(argv0, target, versionstr, found_path)) < 0)
792  {
793  char full_path[MAXPGPATH];
794 
795  if (find_my_exec(argv0, full_path) < 0)
796  strlcpy(full_path, progname, sizeof(full_path));
797 
798  if (ret == -1)
799  write_stderr(_("The program \"%s\" is needed by %s "
800  "but was not found in the\n"
801  "same directory as \"%s\".\n"
802  "Check your installation.\n"),
803  target, progname, full_path);
804  else
805  write_stderr(_("The program \"%s\" was found by \"%s\"\n"
806  "but was not the same version as %s.\n"
807  "Check your installation.\n"),
808  target, full_path, progname);
809  exit(1);
810  }
811 
812  return found_path;
813 }
int find_other_exec(const char *argv0, const char *target, const char *versionstr, char *retpath)
Definition: exec.c:324
static char * argv0
Definition: pg_ctl.c:97
void * pg_malloc(size_t size)
Definition: fe_memutils.c:47
#define MAXPGPATH
int find_my_exec(const char *argv0, char *retpath)
Definition: exec.c:129
size_t strlcpy(char *dst, const char *src, size_t siz)
Definition: strlcpy.c:45
static const char * progname
Definition: pg_ctl.c:90
static void write_stderr(const char *fmt,...) pg_attribute_printf(1
Definition: pg_ctl.c:205
#define _(x)
Definition: elog.c:87

◆ free_readfile()

static void free_readfile ( char **  optlines)
static

Definition at line 413 of file pg_ctl.c.

References free, and i.

Referenced by do_status(), read_post_opts(), and wait_for_postmaster().

414 {
415  char *curr_line = NULL;
416  int i = 0;
417 
418  if (!optlines)
419  return;
420 
421  while ((curr_line = optlines[i++]))
422  free(curr_line);
423 
424  free(optlines);
425 }
#define free(a)
Definition: header.h:65
int i

◆ get_control_dbstate()

static DBState get_control_dbstate ( void  )
static

Definition at line 2226 of file pg_ctl.c.

References _, get_controlfile(), pfree(), pg_data, progname, ControlFileData::state, and write_stderr().

Referenced by do_promote(), do_restart(), and do_stop().

2227 {
2228  DBState ret;
2229  bool crc_ok;
2230  ControlFileData *control_file_data = get_controlfile(pg_data, &crc_ok);
2231 
2232  if (!crc_ok)
2233  {
2234  write_stderr(_("%s: control file appears to be corrupt\n"), progname);
2235  exit(1);
2236  }
2237 
2238  ret = control_file_data->state;
2239  pfree(control_file_data);
2240  return ret;
2241 }
static char * pg_data
Definition: pg_ctl.c:86
void pfree(void *pointer)
Definition: mcxt.c:1056
DBState
Definition: pg_control.h:85
ControlFileData * get_controlfile(const char *DataDir, bool *crc_ok_p)
static const char * progname
Definition: pg_ctl.c:90
static void write_stderr(const char *fmt,...) pg_attribute_printf(1
Definition: pg_ctl.c:205
#define _(x)
Definition: elog.c:87

◆ get_pgpid()

static pgpid_t get_pgpid ( bool  is_status_request)
static

Definition at line 249 of file pg_ctl.c.

References _, pg_data, pid_file, progname, stat, strerror, version_file, and write_stderr().

Referenced by do_logrotate(), do_promote(), do_reload(), do_restart(), do_start(), do_status(), and do_stop().

250 {
251  FILE *pidf;
252  long pid;
253  struct stat statbuf;
254 
255  if (stat(pg_data, &statbuf) != 0)
256  {
257  if (errno == ENOENT)
258  write_stderr(_("%s: directory \"%s\" does not exist\n"), progname,
259  pg_data);
260  else
261  write_stderr(_("%s: could not access directory \"%s\": %s\n"), progname,
262  pg_data, strerror(errno));
263 
264  /*
265  * The Linux Standard Base Core Specification 3.1 says this should
266  * return '4, program or service status is unknown'
267  * https://refspecs.linuxbase.org/LSB_3.1.0/LSB-Core-generic/LSB-Core-generic/iniscrptact.html
268  */
269  exit(is_status_request ? 4 : 1);
270  }
271 
272  if (stat(version_file, &statbuf) != 0 && errno == ENOENT)
273  {
274  write_stderr(_("%s: directory \"%s\" is not a database cluster directory\n"),
275  progname, pg_data);
276  exit(is_status_request ? 4 : 1);
277  }
278 
279  pidf = fopen(pid_file, "r");
280  if (pidf == NULL)
281  {
282  /* No pid file, not an error on startup */
283  if (errno == ENOENT)
284  return 0;
285  else
286  {
287  write_stderr(_("%s: could not open PID file \"%s\": %s\n"),
288  progname, pid_file, strerror(errno));
289  exit(1);
290  }
291  }
292  if (fscanf(pidf, "%ld", &pid) != 1)
293  {
294  /* Is the file empty? */
295  if (ftell(pidf) == 0 && feof(pidf))
296  write_stderr(_("%s: the PID file \"%s\" is empty\n"),
297  progname, pid_file);
298  else
299  write_stderr(_("%s: invalid data in PID file \"%s\"\n"),
300  progname, pid_file);
301  exit(1);
302  }
303  fclose(pidf);
304  return (pgpid_t) pid;
305 }
static char * pg_data
Definition: pg_ctl.c:86
static char pid_file[MAXPGPATH]
Definition: pg_ctl.c:103
long pgpid_t
Definition: pg_ctl.c:39
#define stat(a, b)
Definition: win32_port.h:255
#define strerror
Definition: port.h:205
static const char * progname
Definition: pg_ctl.c:90
static void write_stderr(const char *fmt,...) pg_attribute_printf(1
Definition: pg_ctl.c:205
static char version_file[MAXPGPATH]
Definition: pg_ctl.c:102
#define _(x)
Definition: elog.c:87

◆ main()

int main ( int  argc,
char **  argv 
)

Definition at line 2245 of file pg_ctl.c.

References _, adjust_data_dir(), allow_core_files, argv0, backup_file, canonicalize_path(), ctl_command, do_advice(), do_help(), do_init(), do_kill(), do_logrotate(), do_promote(), do_reload(), do_restart(), do_start(), do_status(), do_stop(), do_wait, event_source, exec_path, free, get_progname(), GetDataDirectoryCreatePerm(), getopt_long(), INIT_COMMAND, KILL_COMMAND, log_file, LOGROTATE_COMMAND, MAXPGPATH, no_argument, NO_COMMAND, optarg, optind, pg_config, pg_data, pg_logging_init(), pg_mode_mask, PG_MODE_MASK_OWNER, pg_strdup(), PG_TEXTDOMAIN, pgdata_opt, pid_file, post_opts, postopts_file, progname, PROMOTE_COMMAND, psprintf(), putenv, REGISTER_COMMAND, register_password, register_servicename, register_username, RELOAD_COMMAND, required_argument, RESTART_COMMAND, RUN_AS_SERVICE_COMMAND, set_mode(), set_pglocale_pgservice(), set_sig(), sig, SIGHUP, silent_mode, snprintf, START_COMMAND, start_time, STATUS_COMMAND, STOP_COMMAND, UNREGISTER_COMMAND, version_file, wait_seconds, wait_seconds_arg, and write_stderr().

2246 {
2247  static struct option long_options[] = {
2248  {"help", no_argument, NULL, '?'},
2249  {"version", no_argument, NULL, 'V'},
2250  {"log", required_argument, NULL, 'l'},
2251  {"mode", required_argument, NULL, 'm'},
2252  {"pgdata", required_argument, NULL, 'D'},
2253  {"options", required_argument, NULL, 'o'},
2254  {"silent", no_argument, NULL, 's'},
2255  {"timeout", required_argument, NULL, 't'},
2256  {"core-files", no_argument, NULL, 'c'},
2257  {"wait", no_argument, NULL, 'w'},
2258  {"no-wait", no_argument, NULL, 'W'},
2259  {NULL, 0, NULL, 0}
2260  };
2261 
2262  char *env_wait;
2263  int option_index;
2264  int c;
2265  pgpid_t killproc = 0;
2266 
2267  pg_logging_init(argv[0]);
2268  progname = get_progname(argv[0]);
2269  set_pglocale_pgservice(argv[0], PG_TEXTDOMAIN("pg_ctl"));
2270  start_time = time(NULL);
2271 
2272  /*
2273  * save argv[0] so do_start() can look for the postmaster if necessary. we
2274  * don't look for postmaster here because in many cases we won't need it.
2275  */
2276  argv0 = argv[0];
2277 
2278  /* Set restrictive mode mask until PGDATA permissions are checked */
2279  umask(PG_MODE_MASK_OWNER);
2280 
2281  /* support --help and --version even if invoked as root */
2282  if (argc > 1)
2283  {
2284  if (strcmp(argv[1], "--help") == 0 || strcmp(argv[1], "-?") == 0)
2285  {
2286  do_help();
2287  exit(0);
2288  }
2289  else if (strcmp(argv[1], "--version") == 0 || strcmp(argv[1], "-V") == 0)
2290  {
2291  puts("pg_ctl (PostgreSQL) " PG_VERSION);
2292  exit(0);
2293  }
2294  }
2295 
2296  /*
2297  * Disallow running as root, to forestall any possible security holes.
2298  */
2299 #ifndef WIN32
2300  if (geteuid() == 0)
2301  {
2302  write_stderr(_("%s: cannot be run as root\n"
2303  "Please log in (using, e.g., \"su\") as the "
2304  "(unprivileged) user that will\n"
2305  "own the server process.\n"),
2306  progname);
2307  exit(1);
2308  }
2309 #endif
2310 
2311  env_wait = getenv("PGCTLTIMEOUT");
2312  if (env_wait != NULL)
2313  wait_seconds = atoi(env_wait);
2314 
2315  /*
2316  * 'Action' can be before or after args so loop over both. Some
2317  * getopt_long() implementations will reorder argv[] to place all flags
2318  * first (GNU?), but we don't rely on it. Our /port version doesn't do
2319  * that.
2320  */
2321  optind = 1;
2322 
2323  /* process command-line options */
2324  while (optind < argc)
2325  {
2326  while ((c = getopt_long(argc, argv, "cD:e:l:m:N:o:p:P:sS:t:U:wW",
2327  long_options, &option_index)) != -1)
2328  {
2329  switch (c)
2330  {
2331  case 'D':
2332  {
2333  char *pgdata_D;
2334  char *env_var;
2335 
2336  pgdata_D = pg_strdup(optarg);
2337  canonicalize_path(pgdata_D);
2338  env_var = psprintf("PGDATA=%s", pgdata_D);
2339  putenv(env_var);
2340 
2341  /*
2342  * We could pass PGDATA just in an environment
2343  * variable but we do -D too for clearer postmaster
2344  * 'ps' display
2345  */
2346  pgdata_opt = psprintf("-D \"%s\" ", pgdata_D);
2347  break;
2348  }
2349  case 'e':
2351  break;
2352  case 'l':
2354  break;
2355  case 'm':
2356  set_mode(optarg);
2357  break;
2358  case 'N':
2360  break;
2361  case 'o':
2362  /* append option? */
2363  if (!post_opts)
2365  else
2366  {
2367  char *old_post_opts = post_opts;
2368 
2369  post_opts = psprintf("%s %s", old_post_opts, optarg);
2370  free(old_post_opts);
2371  }
2372  break;
2373  case 'p':
2375  break;
2376  case 'P':
2378  break;
2379  case 's':
2380  silent_mode = true;
2381  break;
2382  case 'S':
2383 #ifdef WIN32
2384  set_starttype(optarg);
2385 #else
2386  write_stderr(_("%s: -S option not supported on this platform\n"),
2387  progname);
2388  exit(1);
2389 #endif
2390  break;
2391  case 't':
2392  wait_seconds = atoi(optarg);
2393  wait_seconds_arg = true;
2394  break;
2395  case 'U':
2396  if (strchr(optarg, '\\'))
2398  else
2399  /* Prepend .\ for local accounts */
2400  register_username = psprintf(".\\%s", optarg);
2401  break;
2402  case 'w':
2403  do_wait = true;
2404  break;
2405  case 'W':
2406  do_wait = false;
2407  break;
2408  case 'c':
2409  allow_core_files = true;
2410  break;
2411  default:
2412  /* getopt_long already issued a suitable error message */
2413  do_advice();
2414  exit(1);
2415  }
2416  }
2417 
2418  /* Process an action */
2419  if (optind < argc)
2420  {
2421  if (ctl_command != NO_COMMAND)
2422  {
2423  write_stderr(_("%s: too many command-line arguments (first is \"%s\")\n"), progname, argv[optind]);
2424  do_advice();
2425  exit(1);
2426  }
2427 
2428  if (strcmp(argv[optind], "init") == 0
2429  || strcmp(argv[optind], "initdb") == 0)
2431  else if (strcmp(argv[optind], "start") == 0)
2433  else if (strcmp(argv[optind], "stop") == 0)
2435  else if (strcmp(argv[optind], "restart") == 0)
2437  else if (strcmp(argv[optind], "reload") == 0)
2439  else if (strcmp(argv[optind], "status") == 0)
2441  else if (strcmp(argv[optind], "promote") == 0)
2443  else if (strcmp(argv[optind], "logrotate") == 0)
2445  else if (strcmp(argv[optind], "kill") == 0)
2446  {
2447  if (argc - optind < 3)
2448  {
2449  write_stderr(_("%s: missing arguments for kill mode\n"), progname);
2450  do_advice();
2451  exit(1);
2452  }
2454  set_sig(argv[++optind]);
2455  killproc = atol(argv[++optind]);
2456  }
2457 #ifdef WIN32
2458  else if (strcmp(argv[optind], "register") == 0)
2460  else if (strcmp(argv[optind], "unregister") == 0)
2462  else if (strcmp(argv[optind], "runservice") == 0)
2464 #endif
2465  else
2466  {
2467  write_stderr(_("%s: unrecognized operation mode \"%s\"\n"), progname, argv[optind]);
2468  do_advice();
2469  exit(1);
2470  }
2471  optind++;
2472  }
2473  }
2474 
2475  if (ctl_command == NO_COMMAND)
2476  {
2477  write_stderr(_("%s: no operation specified\n"), progname);
2478  do_advice();
2479  exit(1);
2480  }
2481 
2482  /* Note we put any -D switch into the env var above */
2483  pg_config = getenv("PGDATA");
2484  if (pg_config)
2485  {
2489  }
2490 
2491  /* -D might point at config-only directory; if so find the real PGDATA */
2492  adjust_data_dir();
2493 
2494  /* Complain if -D needed and not provided */
2495  if (pg_config == NULL &&
2497  {
2498  write_stderr(_("%s: no database directory specified and environment variable PGDATA unset\n"),
2499  progname);
2500  do_advice();
2501  exit(1);
2502  }
2503 
2504  if (ctl_command == RELOAD_COMMAND)
2505  {
2506  sig = SIGHUP;
2507  do_wait = false;
2508  }
2509 
2510  if (pg_data)
2511  {
2512  snprintf(postopts_file, MAXPGPATH, "%s/postmaster.opts", pg_data);
2513  snprintf(version_file, MAXPGPATH, "%s/PG_VERSION", pg_data);
2514  snprintf(pid_file, MAXPGPATH, "%s/postmaster.pid", pg_data);
2515  snprintf(backup_file, MAXPGPATH, "%s/backup_label", pg_data);
2516 
2517  /*
2518  * Set mask based on PGDATA permissions,
2519  *
2520  * Don't error here if the data directory cannot be stat'd. This is
2521  * handled differently based on the command and we don't want to
2522  * interfere with that logic.
2523  */
2525  umask(pg_mode_mask);
2526  }
2527 
2528  switch (ctl_command)
2529  {
2530  case INIT_COMMAND:
2531  do_init();
2532  break;
2533  case STATUS_COMMAND:
2534  do_status();
2535  break;
2536  case START_COMMAND:
2537  do_start();
2538  break;
2539  case STOP_COMMAND:
2540  do_stop();
2541  break;
2542  case RESTART_COMMAND:
2543  do_restart();
2544  break;
2545  case RELOAD_COMMAND:
2546  do_reload();
2547  break;
2548  case PROMOTE_COMMAND:
2549  do_promote();
2550  break;
2551  case LOGROTATE_COMMAND:
2552  do_logrotate();
2553  break;
2554  case KILL_COMMAND:
2555  do_kill(killproc);
2556  break;
2557 #ifdef WIN32
2558  case REGISTER_COMMAND:
2559  pgwin32_doRegister();
2560  break;
2561  case UNREGISTER_COMMAND:
2562  pgwin32_doUnregister();
2563  break;
2565  pgwin32_doRunAsService();
2566  break;
2567 #endif
2568  default:
2569  break;
2570  }
2571 
2572  exit(0);
2573 }
static char * argv0
Definition: pg_ctl.c:97
static int wait_seconds
Definition: pg_ctl.c:80
const char * get_progname(const char *argv0)
Definition: path.c:453
int getopt_long(int argc, char *const argv[], const char *optstring, const struct option *longopts, int *longindex)
Definition: getopt_long.c:57
static char * log_file
Definition: pg_ctl.c:91
void pg_logging_init(const char *argv0)
Definition: logging.c:39
char * psprintf(const char *fmt,...)
Definition: psprintf.c:46
static void do_help(void)
Definition: pg_ctl.c:2017
static char * post_opts
Definition: pg_ctl.c:89
static void do_stop(void)
Definition: pg_ctl.c:937
void canonicalize_path(char *path)
Definition: path.c:254
static void adjust_data_dir(void)
Definition: pg_ctl.c:2168
static char * pg_data
Definition: pg_ctl.c:86
static time_t start_time
Definition: pg_ctl.c:99
static char * register_password
Definition: pg_ctl.c:96
#define required_argument
Definition: getopt_long.h:25
int optind
Definition: getopt.c:50
static void do_logrotate(void)
Definition: pg_ctl.c:1254
static char pid_file[MAXPGPATH]
Definition: pg_ctl.c:103
long pgpid_t
Definition: pg_ctl.c:39
static char backup_file[MAXPGPATH]
Definition: pg_ctl.c:104
#define MAXPGPATH
static char * register_username
Definition: pg_ctl.c:95
static char * register_servicename
Definition: pg_ctl.c:94
char * c
static void do_start(void)
Definition: pg_ctl.c:844
#define SIGHUP
Definition: win32_port.h:154
char * pg_strdup(const char *in)
Definition: fe_memutils.c:85
static void do_kill(pgpid_t pid)
Definition: pg_ctl.c:1392
static void do_restart(void)
Definition: pg_ctl.c:1024
static void do_status(void)
Definition: pg_ctl.c:1335
#define no_argument
Definition: getopt_long.h:24
#define PG_TEXTDOMAIN(domain)
Definition: c.h:1165
static char * pgdata_opt
Definition: pg_ctl.c:88
#define PG_MODE_MASK_OWNER
Definition: file_perm.h:24
static char postopts_file[MAXPGPATH]
Definition: pg_ctl.c:101
static int sig
Definition: pg_ctl.c:84
#define free(a)
Definition: header.h:65
static void do_promote(void)
Definition: pg_ctl.c:1155
static bool allow_core_files
Definition: pg_ctl.c:98
static char * exec_path
Definition: pg_ctl.c:92
static void do_init(void)
Definition: pg_ctl.c:816
#define putenv(x)
Definition: win32_port.h:474
static char * event_source
Definition: pg_ctl.c:93
static const char * progname
Definition: pg_ctl.c:90
static bool wait_seconds_arg
Definition: pg_ctl.c:81
static void write_stderr(const char *fmt,...) pg_attribute_printf(1
Definition: pg_ctl.c:205
bool GetDataDirectoryCreatePerm(const char *dataDir)
void set_pglocale_pgservice(const char *argv0, const char *app)
Definition: exec.c:565
static bool do_wait
Definition: pg_ctl.c:79
static void set_mode(char *modeopt)
Definition: pg_ctl.c:2090
static void do_reload(void)
Definition: pg_ctl.c:1118
char * optarg
Definition: getopt.c:52
static void static void do_advice(void)
Definition: pg_ctl.c:2009
static char version_file[MAXPGPATH]
Definition: pg_ctl.c:102
#define snprintf
Definition: port.h:192
static CtlCommand ctl_command
Definition: pg_ctl.c:85
#define _(x)
Definition: elog.c:87
int pg_mode_mask
Definition: file_perm.c:25
static void set_sig(char *signame)
Definition: pg_ctl.c:2118
static bool silent_mode
Definition: pg_ctl.c:82
static char * pg_config
Definition: pg_ctl.c:87

◆ postmaster_is_alive()

static bool postmaster_is_alive ( pid_t  pid)
static

Definition at line 1311 of file pg_ctl.c.

References kill.

Referenced by do_restart(), and do_status().

1312 {
1313  /*
1314  * Test to see if the process is still there. Note that we do not
1315  * consider an EPERM failure to mean that the process is still there;
1316  * EPERM must mean that the given PID belongs to some other userid, and
1317  * considering the permissions on $PGDATA, that means it's not the
1318  * postmaster we are after.
1319  *
1320  * Don't believe that our own PID or parent shell's PID is the postmaster,
1321  * either. (Windows hasn't got getppid(), though.)
1322  */
1323  if (pid == getpid())
1324  return false;
1325 #ifndef WIN32
1326  if (pid == getppid())
1327  return false;
1328 #endif
1329  if (kill(pid, 0) == 0)
1330  return true;
1331  return false;
1332 }
#define kill(pid, sig)
Definition: win32_port.h:426

◆ print_msg()

static void print_msg ( const char *  msg)
static

Definition at line 239 of file pg_ctl.c.

References silent_mode, and generate_unaccent_rules::stdout.

Referenced by do_logrotate(), do_promote(), do_reload(), do_restart(), do_start(), do_stop(), and wait_for_postmaster().

240 {
241  if (!silent_mode)
242  {
243  fputs(msg, stdout);
244  fflush(stdout);
245  }
246 }
static bool silent_mode
Definition: pg_ctl.c:82

◆ read_post_opts()

static void read_post_opts ( void  )
static

Definition at line 711 of file pg_ctl.c.

References _, ctl_command, exec_path, free_readfile(), pg_strdup(), post_opts, postopts_file, progname, readfile(), RESTART_COMMAND, and write_stderr().

Referenced by do_kill(), and do_start().

712 {
713  if (post_opts == NULL)
714  {
715  post_opts = ""; /* default */
717  {
718  char **optlines;
719  int numlines;
720 
721  optlines = readfile(postopts_file, &numlines);
722  if (optlines == NULL)
723  {
724  write_stderr(_("%s: could not read file \"%s\"\n"), progname, postopts_file);
725  exit(1);
726  }
727  else if (numlines != 1)
728  {
729  write_stderr(_("%s: option file \"%s\" must have exactly one line\n"),
731  exit(1);
732  }
733  else
734  {
735  char *optline;
736  char *arg1;
737 
738  optline = optlines[0];
739 
740  /*
741  * Are we at the first option, as defined by space and
742  * double-quote?
743  */
744  if ((arg1 = strstr(optline, " \"")) != NULL)
745  {
746  *arg1 = '\0'; /* terminate so we get only program name */
747  post_opts = pg_strdup(arg1 + 1); /* point past whitespace */
748  }
749  if (exec_path == NULL)
750  exec_path = pg_strdup(optline);
751  }
752 
753  /* Free the results of readfile. */
754  free_readfile(optlines);
755  }
756  }
757 }
static char * post_opts
Definition: pg_ctl.c:89
static char ** readfile(const char *path, int *numlines)
Definition: pg_ctl.c:317
char * pg_strdup(const char *in)
Definition: fe_memutils.c:85
static char postopts_file[MAXPGPATH]
Definition: pg_ctl.c:101
static void free_readfile(char **optlines)
Definition: pg_ctl.c:413
static char * exec_path
Definition: pg_ctl.c:92
static const char * progname
Definition: pg_ctl.c:90
static void write_stderr(const char *fmt,...) pg_attribute_printf(1
Definition: pg_ctl.c:205
static CtlCommand ctl_command
Definition: pg_ctl.c:85
#define _(x)
Definition: elog.c:87

◆ readfile()

static char ** readfile ( const char *  path,
int *  numlines 
)
static

Definition at line 317 of file pg_ctl.c.

References close, fd(), free, i, PG_BINARY, pg_malloc(), read, and stat.

Referenced by do_status(), read_post_opts(), and wait_for_postmaster().

318 {
319  int fd;
320  int nlines;
321  char **result;
322  char *buffer;
323  char *linebegin;
324  int i;
325  int n;
326  int len;
327  struct stat statbuf;
328 
329  *numlines = 0; /* in case of failure or empty file */
330 
331  /*
332  * Slurp the file into memory.
333  *
334  * The file can change concurrently, so we read the whole file into memory
335  * with a single read() call. That's not guaranteed to get an atomic
336  * snapshot, but in practice, for a small file, it's close enough for the
337  * current use.
338  */
339  fd = open(path, O_RDONLY | PG_BINARY, 0);
340  if (fd < 0)
341  return NULL;
342  if (fstat(fd, &statbuf) < 0)
343  {
344  close(fd);
345  return NULL;
346  }
347  if (statbuf.st_size == 0)
348  {
349  /* empty file */
350  close(fd);
351  result = (char **) pg_malloc(sizeof(char *));
352  *result = NULL;
353  return result;
354  }
355  buffer = pg_malloc(statbuf.st_size + 1);
356 
357  len = read(fd, buffer, statbuf.st_size + 1);
358  close(fd);
359  if (len != statbuf.st_size)
360  {
361  /* oops, the file size changed between fstat and read */
362  free(buffer);
363  return NULL;
364  }
365 
366  /*
367  * Count newlines. We expect there to be a newline after each full line,
368  * including one at the end of file. If there isn't a newline at the end,
369  * any characters after the last newline will be ignored.
370  */
371  nlines = 0;
372  for (i = 0; i < len; i++)
373  {
374  if (buffer[i] == '\n')
375  nlines++;
376  }
377 
378  /* set up the result buffer */
379  result = (char **) pg_malloc((nlines + 1) * sizeof(char *));
380  *numlines = nlines;
381 
382  /* now split the buffer into lines */
383  linebegin = buffer;
384  n = 0;
385  for (i = 0; i < len; i++)
386  {
387  if (buffer[i] == '\n')
388  {
389  int slen = &buffer[i] - linebegin;
390  char *linebuf = pg_malloc(slen + 1);
391 
392  memcpy(linebuf, linebegin, slen);
393  /* we already dropped the \n, but get rid of any \r too */
394  if (slen > 0 && linebuf[slen - 1] == '\r')
395  slen--;
396  linebuf[slen] = '\0';
397  result[n++] = linebuf;
398  linebegin = &buffer[i + 1];
399  }
400  }
401  result[n] = NULL;
402 
403  free(buffer);
404 
405  return result;
406 }
void * pg_malloc(size_t size)
Definition: fe_memutils.c:47
static int fd(const char *x, int i)
Definition: preproc-init.c:105
#define PG_BINARY
Definition: c.h:1221
#define stat(a, b)
Definition: win32_port.h:255
#define free(a)
Definition: header.h:65
int i
#define close(a)
Definition: win32.h:12
#define read(a, b, c)
Definition: win32.h:13

◆ set_mode()

static void set_mode ( char *  modeopt)
static

Definition at line 2090 of file pg_ctl.c.

References _, do_advice(), FAST_MODE, IMMEDIATE_MODE, progname, shutdown_mode, sig, SIGQUIT, SMART_MODE, and write_stderr().

Referenced by main().

2091 {
2092  if (strcmp(modeopt, "s") == 0 || strcmp(modeopt, "smart") == 0)
2093  {
2095  sig = SIGTERM;
2096  }
2097  else if (strcmp(modeopt, "f") == 0 || strcmp(modeopt, "fast") == 0)
2098  {
2100  sig = SIGINT;
2101  }
2102  else if (strcmp(modeopt, "i") == 0 || strcmp(modeopt, "immediate") == 0)
2103  {
2105  sig = SIGQUIT;
2106  }
2107  else
2108  {
2109  write_stderr(_("%s: unrecognized shutdown mode \"%s\"\n"), progname, modeopt);
2110  do_advice();
2111  exit(1);
2112  }
2113 }
#define SIGQUIT
Definition: win32_port.h:155
static ShutdownMode shutdown_mode
Definition: pg_ctl.c:83
static int sig
Definition: pg_ctl.c:84
static const char * progname
Definition: pg_ctl.c:90
static void write_stderr(const char *fmt,...) pg_attribute_printf(1
Definition: pg_ctl.c:205
static void static void do_advice(void)
Definition: pg_ctl.c:2009
#define _(x)
Definition: elog.c:87

◆ set_sig()

static void set_sig ( char *  signame)
static

Definition at line 2118 of file pg_ctl.c.

References _, do_advice(), progname, sig, SIGABRT, SIGHUP, SIGKILL, SIGQUIT, SIGUSR1, SIGUSR2, and write_stderr().

Referenced by main().

2119 {
2120  if (strcmp(signame, "HUP") == 0)
2121  sig = SIGHUP;
2122  else if (strcmp(signame, "INT") == 0)
2123  sig = SIGINT;
2124  else if (strcmp(signame, "QUIT") == 0)
2125  sig = SIGQUIT;
2126  else if (strcmp(signame, "ABRT") == 0)
2127  sig = SIGABRT;
2128  else if (strcmp(signame, "KILL") == 0)
2129  sig = SIGKILL;
2130  else if (strcmp(signame, "TERM") == 0)
2131  sig = SIGTERM;
2132  else if (strcmp(signame, "USR1") == 0)
2133  sig = SIGUSR1;
2134  else if (strcmp(signame, "USR2") == 0)
2135  sig = SIGUSR2;
2136  else
2137  {
2138  write_stderr(_("%s: unrecognized signal name \"%s\"\n"), progname, signame);
2139  do_advice();
2140  exit(1);
2141  }
2142 }
#define SIGQUIT
Definition: win32_port.h:155
#define SIGUSR1
Definition: win32_port.h:166
#define SIGUSR2
Definition: win32_port.h:167
#define SIGABRT
Definition: win32_port.h:157
#define SIGKILL
Definition: win32_port.h:158
#define SIGHUP
Definition: win32_port.h:154
static int sig
Definition: pg_ctl.c:84
static const char * progname
Definition: pg_ctl.c:90
static void write_stderr(const char *fmt,...) pg_attribute_printf(1
Definition: pg_ctl.c:205
static void static void do_advice(void)
Definition: pg_ctl.c:2009
#define _(x)
Definition: elog.c:87

◆ start_postmaster()

static pgpid_t start_postmaster ( void  )
static

Definition at line 443 of file pg_ctl.c.

References _, DEVNULL, exec_path, fd(), log_file, MAXPGPATH, pgdata_opt, post_opts, progname, snprintf, generate_unaccent_rules::stdout, strerror, and write_stderr().

Referenced by check_and_dump_old_cluster(), do_start(), issue_warnings_and_set_wal_level(), main(), and setup().

444 {
445  char cmd[MAXPGPATH];
446 
447 #ifndef WIN32
448  pgpid_t pm_pid;
449 
450  /* Flush stdio channels just before fork, to avoid double-output problems */
451  fflush(stdout);
452  fflush(stderr);
453 
454  pm_pid = fork();
455  if (pm_pid < 0)
456  {
457  /* fork failed */
458  write_stderr(_("%s: could not start server: %s\n"),
459  progname, strerror(errno));
460  exit(1);
461  }
462  if (pm_pid > 0)
463  {
464  /* fork succeeded, in parent */
465  return pm_pid;
466  }
467 
468  /* fork succeeded, in child */
469 
470  /*
471  * If possible, detach the postmaster process from the launching process
472  * group and make it a group leader, so that it doesn't get signaled along
473  * with the current group that launched it.
474  */
475 #ifdef HAVE_SETSID
476  if (setsid() < 0)
477  {
478  write_stderr(_("%s: could not start server due to setsid() failure: %s\n"),
479  progname, strerror(errno));
480  exit(1);
481  }
482 #endif
483 
484  /*
485  * Since there might be quotes to handle here, it is easier simply to pass
486  * everything to a shell to process them. Use exec so that the postmaster
487  * has the same PID as the current child process.
488  */
489  if (log_file != NULL)
490  snprintf(cmd, MAXPGPATH, "exec \"%s\" %s%s < \"%s\" >> \"%s\" 2>&1",
492  DEVNULL, log_file);
493  else
494  snprintf(cmd, MAXPGPATH, "exec \"%s\" %s%s < \"%s\" 2>&1",
496 
497  (void) execl("/bin/sh", "/bin/sh", "-c", cmd, (char *) NULL);
498 
499  /* exec failed */
500  write_stderr(_("%s: could not start server: %s\n"),
501  progname, strerror(errno));
502  exit(1);
503 
504  return 0; /* keep dumb compilers quiet */
505 
506 #else /* WIN32 */
507 
508  /*
509  * As with the Unix case, it's easiest to use the shell (CMD.EXE) to
510  * handle redirection etc. Unfortunately CMD.EXE lacks any equivalent of
511  * "exec", so we don't get to find out the postmaster's PID immediately.
512  */
513  PROCESS_INFORMATION pi;
514  const char *comspec;
515 
516  /* Find CMD.EXE location using COMSPEC, if it's set */
517  comspec = getenv("COMSPEC");
518  if (comspec == NULL)
519  comspec = "CMD";
520 
521  if (log_file != NULL)
522  {
523  /*
524  * First, touch the log file. The main value of this is that if the
525  * file is still locked by a previous postmaster run, we'll wait until
526  * it comes free, instead of failing with ERROR_SHARING_VIOLATION.
527  * (It'd be better to open the file in a sharing-friendly mode, but we
528  * can't use CMD.EXE to do that, so work around it. Note that the
529  * previous postmaster will still have the file open for a short time
530  * after removing postmaster.pid.)
531  */
532  FILE *fd = fopen(log_file, "a");
533 
534  if (fd == NULL)
535  {
536  write_stderr(_("%s: could not create log file \"%s\": %s\n"),
537  progname, log_file, strerror(errno));
538  exit(1);
539  }
540  fclose(fd);
541 
542  snprintf(cmd, MAXPGPATH, "\"%s\" /C \"\"%s\" %s%s < \"%s\" >> \"%s\" 2>&1\"",
544  }
545  else
546  snprintf(cmd, MAXPGPATH, "\"%s\" /C \"\"%s\" %s%s < \"%s\" 2>&1\"",
547  comspec, exec_path, pgdata_opt, post_opts, DEVNULL);
548 
549  if (!CreateRestrictedProcess(cmd, &pi, false))
550  {
551  write_stderr(_("%s: could not start server: error code %lu\n"),
552  progname, (unsigned long) GetLastError());
553  exit(1);
554  }
555  /* Don't close command process handle here; caller must do so */
556  postmasterProcess = pi.hProcess;
557  CloseHandle(pi.hThread);
558  return pi.dwProcessId; /* Shell's PID, not postmaster's! */
559 #endif /* WIN32 */
560 }
static char * log_file
Definition: pg_ctl.c:91
static char * post_opts
Definition: pg_ctl.c:89
static int fd(const char *x, int i)
Definition: preproc-init.c:105
long pgpid_t
Definition: pg_ctl.c:39
#define MAXPGPATH
#define DEVNULL
Definition: port.h:123
static char * pgdata_opt
Definition: pg_ctl.c:88
#define strerror
Definition: port.h:205
static char * exec_path
Definition: pg_ctl.c:92
static const char * progname
Definition: pg_ctl.c:90
static void write_stderr(const char *fmt,...) pg_attribute_printf(1
Definition: pg_ctl.c:205
#define snprintf
Definition: port.h:192
#define _(x)
Definition: elog.c:87

◆ trap_sigint_during_startup()

static void trap_sigint_during_startup ( int  sig)
static

Definition at line 766 of file pg_ctl.c.

References _, kill, postmasterPID, pqsignal(), progname, SIG_DFL, strerror, and write_stderr().

Referenced by do_start().

767 {
768  if (postmasterPID != -1)
769  {
770  if (kill(postmasterPID, SIGINT) != 0)
771  write_stderr(_("%s: could not send stop signal (PID: %ld): %s\n"),
773  }
774 
775  /*
776  * Clear the signal handler, and send the signal again, to terminate the
777  * process as normal.
778  */
779  pqsignal(SIGINT, SIG_DFL);
780  raise(SIGINT);
781 }
#define kill(pid, sig)
Definition: win32_port.h:426
long pgpid_t
Definition: pg_ctl.c:39
static volatile pgpid_t postmasterPID
Definition: pg_ctl.c:108
pqsigfunc pqsignal(int signum, pqsigfunc handler)
Definition: signal.c:170
#define SIG_DFL
Definition: win32_port.h:149
#define strerror
Definition: port.h:205
static const char * progname
Definition: pg_ctl.c:90
static void write_stderr(const char *fmt,...) pg_attribute_printf(1
Definition: pg_ctl.c:205
#define _(x)
Definition: elog.c:87

◆ wait_for_postmaster()

static WaitPMResult wait_for_postmaster ( pgpid_t  pm_pid,
bool  do_checkpoint 
)
static

Definition at line 579 of file pg_ctl.c.

References _, free_readfile(), i, LOCK_FILE_LINE_PID, LOCK_FILE_LINE_PM_STATUS, LOCK_FILE_LINE_START_TIME, pg_usleep(), pid_file, PM_STATUS_READY, PM_STATUS_STANDBY, POSTMASTER_FAILED, POSTMASTER_READY, POSTMASTER_STILL_STARTING, print_msg(), progname, readfile(), start_time, status(), USEC_PER_SEC, wait_seconds, WAITS_PER_SEC, and write_stderr().

Referenced by do_kill(), and do_start().

580 {
581  int i;
582 
583  for (i = 0; i < wait_seconds * WAITS_PER_SEC; i++)
584  {
585  char **optlines;
586  int numlines;
587 
588  /*
589  * Try to read the postmaster.pid file. If it's not valid, or if the
590  * status line isn't there yet, just keep waiting.
591  */
592  if ((optlines = readfile(pid_file, &numlines)) != NULL &&
593  numlines >= LOCK_FILE_LINE_PM_STATUS)
594  {
595  /* File is complete enough for us, parse it */
596  pgpid_t pmpid;
597  time_t pmstart;
598 
599  /*
600  * Make sanity checks. If it's for the wrong PID, or the recorded
601  * start time is before pg_ctl started, then either we are looking
602  * at the wrong data directory, or this is a pre-existing pidfile
603  * that hasn't (yet?) been overwritten by our child postmaster.
604  * Allow 2 seconds slop for possible cross-process clock skew.
605  */
606  pmpid = atol(optlines[LOCK_FILE_LINE_PID - 1]);
607  pmstart = atol(optlines[LOCK_FILE_LINE_START_TIME - 1]);
608  if (pmstart >= start_time - 2 &&
609 #ifndef WIN32
610  pmpid == pm_pid
611 #else
612  /* Windows can only reject standalone-backend PIDs */
613  pmpid > 0
614 #endif
615  )
616  {
617  /*
618  * OK, seems to be a valid pidfile from our child. Check the
619  * status line (this assumes a v10 or later server).
620  */
621  char *pmstatus = optlines[LOCK_FILE_LINE_PM_STATUS - 1];
622 
623  if (strcmp(pmstatus, PM_STATUS_READY) == 0 ||
624  strcmp(pmstatus, PM_STATUS_STANDBY) == 0)
625  {
626  /* postmaster is done starting up */
627  free_readfile(optlines);
628  return POSTMASTER_READY;
629  }
630  }
631  }
632 
633  /*
634  * Free the results of readfile.
635  *
636  * This is safe to call even if optlines is NULL.
637  */
638  free_readfile(optlines);
639 
640  /*
641  * Check whether the child postmaster process is still alive. This
642  * lets us exit early if the postmaster fails during startup.
643  *
644  * On Windows, we may be checking the postmaster's parent shell, but
645  * that's fine for this purpose.
646  */
647 #ifndef WIN32
648  {
649  int exitstatus;
650 
651  if (waitpid((pid_t) pm_pid, &exitstatus, WNOHANG) == (pid_t) pm_pid)
652  return POSTMASTER_FAILED;
653  }
654 #else
655  if (WaitForSingleObject(postmasterProcess, 0) == WAIT_OBJECT_0)
656  return POSTMASTER_FAILED;
657 #endif
658 
659  /* Startup still in process; wait, printing a dot once per second */
660  if (i % WAITS_PER_SEC == 0)
661  {
662 #ifdef WIN32
663  if (do_checkpoint)
664  {
665  /*
666  * Increment the wait hint by 6 secs (connection timeout +
667  * sleep). We must do this to indicate to the SCM that our
668  * startup time is changing, otherwise it'll usually send a
669  * stop signal after 20 seconds, despite incrementing the
670  * checkpoint counter.
671  */
672  status.dwWaitHint += 6000;
673  status.dwCheckPoint++;
674  SetServiceStatus(hStatus, (LPSERVICE_STATUS) &status);
675  }
676  else
677 #endif
678  print_msg(".");
679  }
680 
681  pg_usleep(USEC_PER_SEC / WAITS_PER_SEC);
682  }
683 
684  /* out of patience; report that postmaster is still starting up */
686 }
#define LOCK_FILE_LINE_PID
Definition: pidfile.h:37
static int wait_seconds
Definition: pg_ctl.c:80
static char ** readfile(const char *path, int *numlines)
Definition: pg_ctl.c:317
#define LOCK_FILE_LINE_START_TIME
Definition: pidfile.h:39
static time_t start_time
Definition: pg_ctl.c:99
void pg_usleep(long microsec)
Definition: signal.c:53
static char pid_file[MAXPGPATH]
Definition: pg_ctl.c:103
long pgpid_t
Definition: pg_ctl.c:39
#define PM_STATUS_READY
Definition: pidfile.h:53
#define USEC_PER_SEC
Definition: pg_ctl.c:75
static void free_readfile(char **optlines)
Definition: pg_ctl.c:413
#define PM_STATUS_STANDBY
Definition: pidfile.h:54
int i
static void static void status(const char *fmt,...) pg_attribute_printf(1
Definition: pg_regress.c:226
#define LOCK_FILE_LINE_PM_STATUS
Definition: pidfile.h:44
static void print_msg(const char *msg)
Definition: pg_ctl.c:239
#define WAITS_PER_SEC
Definition: pg_ctl.c:77

◆ write_stderr()

static void write_stderr ( const char *  fmt,
  ... 
)
static

Definition at line 205 of file pg_ctl.c.

References pgwin32_is_service(), vfprintf, and vsnprintf.

Referenced by adjust_data_dir(), do_advice(), do_init(), do_kill(), do_logrotate(), do_promote(), do_reload(), do_restart(), do_start(), do_stop(), find_other_exec_or_die(), get_control_dbstate(), get_pgpid(), main(), read_post_opts(), set_mode(), set_sig(), start_postmaster(), trap_sigint_during_startup(), and wait_for_postmaster().

206 {
207  va_list ap;
208 
209  va_start(ap, fmt);
210 #ifndef WIN32
211  /* On Unix, we just fprintf to stderr */
212  vfprintf(stderr, fmt, ap);
213 #else
214 
215  /*
216  * On Win32, we print to stderr if running on a console, or write to
217  * eventlog if running as a service
218  */
219  if (pgwin32_is_service()) /* Running as a service */
220  {
221  char errbuf[2048]; /* Arbitrary size? */
222 
223  vsnprintf(errbuf, sizeof(errbuf), fmt, ap);
224 
225  write_eventlog(EVENTLOG_ERROR_TYPE, errbuf);
226  }
227  else
228  /* Not running as service, write to stderr */
229  vfprintf(stderr, fmt, ap);
230 #endif
231  va_end(ap);
232 }
#define vsnprintf
Definition: port.h:191
int pgwin32_is_service(void)
#define vfprintf
Definition: port.h:195

Variable Documentation

◆ allow_core_files

bool allow_core_files = false
static

Definition at line 98 of file pg_ctl.c.

Referenced by do_start(), and main().

◆ argv0

char* argv0 = NULL
static

Definition at line 97 of file pg_ctl.c.

Referenced by adjust_data_dir(), do_init(), do_kill(), do_start(), and main().

◆ backup_file

char backup_file[MAXPGPATH]
static

Definition at line 104 of file pg_ctl.c.

Referenced by do_restart(), do_stop(), and main().

◆ ctl_command

CtlCommand ctl_command = NO_COMMAND
static

Definition at line 85 of file pg_ctl.c.

Referenced by do_start(), main(), and read_post_opts().

◆ do_wait

bool do_wait = true
static

Definition at line 79 of file pg_ctl.c.

Referenced by do_kill(), do_promote(), do_start(), do_stop(), main(), and WaitForWorkers().

◆ event_source

char* event_source = NULL
static

Definition at line 93 of file pg_ctl.c.

Referenced by do_kill(), and main().

◆ exec_path

char* exec_path = NULL
static

◆ log_file

char* log_file = NULL
static

Definition at line 91 of file pg_ctl.c.

Referenced by main(), and start_postmaster().

◆ logrotate_file

char logrotate_file[MAXPGPATH]
static

Definition at line 106 of file pg_ctl.c.

Referenced by do_logrotate().

◆ pg_config

char* pg_config = NULL
static

Definition at line 87 of file pg_ctl.c.

Referenced by adjust_data_dir(), do_kill(), and main().

◆ pg_data

char* pg_data = NULL
static

Definition at line 86 of file pg_ctl.c.

Referenced by adjust_data_dir(), do_logrotate(), do_promote(), get_control_dbstate(), get_pgpid(), and main().

◆ pgdata_opt

char* pgdata_opt = NULL
static

Definition at line 88 of file pg_ctl.c.

Referenced by adjust_data_dir(), do_init(), do_start(), main(), and start_postmaster().

◆ pid_file

char pid_file[MAXPGPATH]
static

◆ post_opts

char* post_opts = NULL
static

Definition at line 89 of file pg_ctl.c.

Referenced by adjust_data_dir(), do_init(), do_kill(), main(), read_post_opts(), and start_postmaster().

◆ postmasterPID

volatile pgpid_t postmasterPID = -1
static

Definition at line 108 of file pg_ctl.c.

Referenced by do_kill(), do_start(), and trap_sigint_during_startup().

◆ postopts_file

char postopts_file[MAXPGPATH]
static

Definition at line 101 of file pg_ctl.c.

Referenced by do_status(), main(), and read_post_opts().

◆ progname

◆ promote_file

char promote_file[MAXPGPATH]
static

Definition at line 105 of file pg_ctl.c.

Referenced by do_promote(), and pg_promote().

◆ register_password

char* register_password = NULL
static

Definition at line 96 of file pg_ctl.c.

Referenced by do_kill(), and main().

◆ register_servicename

char* register_servicename = "PostgreSQL"
static

Definition at line 94 of file pg_ctl.c.

Referenced by do_kill(), and main().

◆ register_username

char* register_username = NULL
static

Definition at line 95 of file pg_ctl.c.

Referenced by do_kill(), and main().

◆ shutdown_mode

ShutdownMode shutdown_mode = FAST_MODE
static

Definition at line 83 of file pg_ctl.c.

Referenced by do_restart(), do_stop(), and set_mode().

◆ sig

◆ silent_mode

bool silent_mode = false
static

Definition at line 82 of file pg_ctl.c.

Referenced by do_init(), do_kill(), main(), and print_msg().

◆ start_time

◆ version_file

char version_file[MAXPGPATH]
static

Definition at line 102 of file pg_ctl.c.

Referenced by get_pgpid(), main(), and write_version_file().

◆ wait_seconds

int wait_seconds = DEFAULT_WAIT
static

◆ wait_seconds_arg

bool wait_seconds_arg = false
static

Definition at line 81 of file pg_ctl.c.

Referenced by do_kill(), and main().