PostgreSQL Source Code  git master
exec.c File Reference
#include "postgres_fe.h"
#include <fcntl.h>
#include "common/string.h"
#include "pg_upgrade.h"
Include dependency graph for exec.c:

Go to the source code of this file.

Macros

#define MAXCMDLEN   (2 * MAXPGPATH)
 

Functions

static void check_data_dir (ClusterInfo *cluster)
 
static void check_bin_dir (ClusterInfo *cluster, bool check_versions)
 
static void get_bin_version (ClusterInfo *cluster)
 
static void check_exec (const char *dir, const char *program, bool check_version)
 
bool exec_prog (const char *log_filename, const char *opt_log_file, bool report_error, bool exit_on_error, const char *fmt,...)
 
bool pid_lock_file_exists (const char *datadir)
 
void verify_directories (void)
 
static void check_single_dir (const char *pg_data, const char *subdir)
 

Macro Definition Documentation

◆ MAXCMDLEN

#define MAXCMDLEN   (2 * MAXPGPATH)

Function Documentation

◆ check_bin_dir()

static void check_bin_dir ( ClusterInfo cluster,
bool  check_versions 
)
static

Definition at line 374 of file exec.c.

375 {
376  struct stat statBuf;
377 
378  /* check bindir */
379  if (stat(cluster->bindir, &statBuf) != 0)
380  report_status(PG_FATAL, "check for \"%s\" failed: %s\n",
381  cluster->bindir, strerror(errno));
382  else if (!S_ISDIR(statBuf.st_mode))
383  report_status(PG_FATAL, "\"%s\" is not a directory\n",
384  cluster->bindir);
385 
386  check_exec(cluster->bindir, "postgres", check_versions);
387  check_exec(cluster->bindir, "pg_controldata", check_versions);
388  check_exec(cluster->bindir, "pg_ctl", check_versions);
389 
390  /*
391  * Fetch the binary version after checking for the existence of pg_ctl.
392  * This way we report a useful error if the pg_ctl binary used for version
393  * fetching is missing/broken.
394  */
396 
397  /* pg_resetxlog has been renamed to pg_resetwal in version 10 */
398  if (GET_MAJOR_VERSION(cluster->bin_version) <= 906)
399  check_exec(cluster->bindir, "pg_resetxlog", check_versions);
400  else
401  check_exec(cluster->bindir, "pg_resetwal", check_versions);
402 
403  if (cluster == &new_cluster)
404  {
405  /*
406  * These binaries are only needed for the target version. pg_dump and
407  * pg_dumpall are used to dump the old cluster, but must be of the
408  * target version.
409  */
410  check_exec(cluster->bindir, "initdb", check_versions);
411  check_exec(cluster->bindir, "pg_dump", check_versions);
412  check_exec(cluster->bindir, "pg_dumpall", check_versions);
413  check_exec(cluster->bindir, "pg_restore", check_versions);
414  check_exec(cluster->bindir, "psql", check_versions);
415  check_exec(cluster->bindir, "vacuumdb", check_versions);
416  }
417 }
static void check_exec(const char *dir, const char *program, bool check_version)
Definition: exec.c:420
static void get_bin_version(ClusterInfo *cluster)
Definition: exec.c:33
void cluster(ParseState *pstate, ClusterStmt *stmt, bool isTopLevel)
Definition: cluster.c:108
ClusterInfo new_cluster
Definition: pg_upgrade.c:63
@ PG_FATAL
Definition: pg_upgrade.h:241
#define GET_MAJOR_VERSION(v)
Definition: pg_upgrade.h:26
void report_status(eLogType type, const char *fmt,...) pg_attribute_printf(2
#define strerror
Definition: port.h:238
#define stat
Definition: win32_port.h:283
#define S_ISDIR(m)
Definition: win32_port.h:324

References check_exec(), cluster(), get_bin_version(), GET_MAJOR_VERSION, new_cluster, PG_FATAL, report_status(), S_ISDIR, stat::st_mode, stat, and strerror.

Referenced by verify_directories().

◆ check_data_dir()

static void check_data_dir ( ClusterInfo cluster)
static

Definition at line 332 of file exec.c.

333 {
334  const char *pg_data = cluster->pgdata;
335 
336  /* get the cluster version */
337  cluster->major_version = get_major_server_version(cluster);
338 
340  check_single_dir(pg_data, "base");
341  check_single_dir(pg_data, "global");
342  check_single_dir(pg_data, "pg_multixact");
343  check_single_dir(pg_data, "pg_subtrans");
344  check_single_dir(pg_data, "pg_tblspc");
345  check_single_dir(pg_data, "pg_twophase");
346 
347  /* pg_xlog has been renamed to pg_wal in v10 */
348  if (GET_MAJOR_VERSION(cluster->major_version) <= 906)
349  check_single_dir(pg_data, "pg_xlog");
350  else
351  check_single_dir(pg_data, "pg_wal");
352 
353  /* pg_clog has been renamed to pg_xact in v10 */
354  if (GET_MAJOR_VERSION(cluster->major_version) <= 906)
355  check_single_dir(pg_data, "pg_clog");
356  else
357  check_single_dir(pg_data, "pg_xact");
358 }
static void check_single_dir(const char *pg_data, const char *subdir)
Definition: exec.c:303
static char * pg_data
Definition: initdb.c:126
uint32 get_major_server_version(ClusterInfo *cluster)
Definition: server.c:159

References check_single_dir(), cluster(), get_major_server_version(), GET_MAJOR_VERSION, and pg_data.

Referenced by verify_directories().

◆ check_exec()

static void check_exec ( const char *  dir,
const char *  program,
bool  check_version 
)
static

Definition at line 420 of file exec.c.

421 {
422  char path[MAXPGPATH];
423  char line[MAXPGPATH];
424  char cmd[MAXPGPATH];
425  char versionstr[128];
426  int ret;
427 
428  snprintf(path, sizeof(path), "%s/%s", dir, program);
429 
430  ret = validate_exec(path);
431 
432  if (ret == -1)
433  pg_fatal("check for \"%s\" failed: not a regular file\n",
434  path);
435  else if (ret == -2)
436  pg_fatal("check for \"%s\" failed: cannot execute (permission denied)\n",
437  path);
438 
439  snprintf(cmd, sizeof(cmd), "\"%s\" -V", path);
440 
441  if (!pipe_read_line(cmd, line, sizeof(line)))
442  pg_fatal("check for \"%s\" failed: cannot execute\n",
443  path);
444 
445  if (check_version)
446  {
447  pg_strip_crlf(line);
448 
449  snprintf(versionstr, sizeof(versionstr), "%s (PostgreSQL) " PG_VERSION, program);
450 
451  if (strcmp(line, versionstr) != 0)
452  pg_fatal("check for \"%s\" failed: incorrect version: found \"%s\", expected \"%s\"\n",
453  path, line, versionstr);
454  }
455 }
int validate_exec(const char *path)
Definition: exec.c:79
char * pipe_read_line(char *cmd, char *line, int maxsize)
Definition: exec.c:371
#define pg_fatal(...)
#define MAXPGPATH
#define snprintf
Definition: port.h:225
int pg_strip_crlf(char *str)
Definition: string.c:121

References MAXPGPATH, pg_fatal, pg_strip_crlf(), pipe_read_line(), snprintf, and validate_exec().

Referenced by check_bin_dir().

◆ check_single_dir()

static void check_single_dir ( const char *  pg_data,
const char *  subdir 
)
static

Definition at line 303 of file exec.c.

304 {
305  struct stat statBuf;
306  char subDirName[MAXPGPATH];
307 
308  snprintf(subDirName, sizeof(subDirName), "%s%s%s", pg_data,
309  /* Win32 can't stat() a directory with a trailing slash. */
310  *subdir ? "/" : "",
311  subdir);
312 
313  if (stat(subDirName, &statBuf) != 0)
314  report_status(PG_FATAL, "check for \"%s\" failed: %s\n",
315  subDirName, strerror(errno));
316  else if (!S_ISDIR(statBuf.st_mode))
317  report_status(PG_FATAL, "\"%s\" is not a directory\n",
318  subDirName);
319 }

References MAXPGPATH, pg_data, PG_FATAL, report_status(), S_ISDIR, snprintf, stat::st_mode, stat, and strerror.

Referenced by check_data_dir().

◆ exec_prog()

bool exec_prog ( const char *  log_filename,
const char *  opt_log_file,
bool  report_error,
bool  exit_on_error,
const char *  fmt,
  ... 
)

Definition at line 81 of file exec.c.

83 {
84  int result = 0;
85  int written;
86  char log_file[MAXPGPATH];
87 
88 #define MAXCMDLEN (2 * MAXPGPATH)
89  char cmd[MAXCMDLEN];
90  FILE *log;
91  va_list ap;
92 
93 #ifdef WIN32
94  static DWORD mainThreadId = 0;
95 
96  /* We assume we are called from the primary thread first */
97  if (mainThreadId == 0)
98  mainThreadId = GetCurrentThreadId();
99 #endif
100 
101  snprintf(log_file, MAXPGPATH, "%s/%s", log_opts.logdir, log_filename);
102 
103  written = 0;
104  va_start(ap, fmt);
105  written += vsnprintf(cmd + written, MAXCMDLEN - written, fmt, ap);
106  va_end(ap);
107  if (written >= MAXCMDLEN)
108  pg_fatal("command too long\n");
109  written += snprintf(cmd + written, MAXCMDLEN - written,
110  " >> \"%s\" 2>&1", log_file);
111  if (written >= MAXCMDLEN)
112  pg_fatal("command too long\n");
113 
114  pg_log(PG_VERBOSE, "%s\n", cmd);
115 
116 #ifdef WIN32
117 
118  /*
119  * For some reason, Windows issues a file-in-use error if we write data to
120  * the log file from a non-primary thread just before we create a
121  * subprocess that also writes to the same log file. One fix is to sleep
122  * for 100ms. A cleaner fix is to write to the log file _after_ the
123  * subprocess has completed, so we do this only when writing from a
124  * non-primary thread. fflush(), running system() twice, and pre-creating
125  * the file do not see to help.
126  */
127  if (mainThreadId != GetCurrentThreadId())
128  result = system(cmd);
129 #endif
130 
131  log = fopen(log_file, "a");
132 
133 #ifdef WIN32
134  {
135  /*
136  * "pg_ctl -w stop" might have reported that the server has stopped
137  * because the postmaster.pid file has been removed, but "pg_ctl -w
138  * start" might still be in the process of closing and might still be
139  * holding its stdout and -l log file descriptors open. Therefore,
140  * try to open the log file a few more times.
141  */
142  int iter;
143 
144  for (iter = 0; iter < 4 && log == NULL; iter++)
145  {
146  pg_usleep(1000000); /* 1 sec */
147  log = fopen(log_file, "a");
148  }
149  }
150 #endif
151 
152  if (log == NULL)
153  pg_fatal("could not open log file \"%s\": %m\n", log_file);
154 
155 #ifdef WIN32
156  /* Are we printing "command:" before its output? */
157  if (mainThreadId == GetCurrentThreadId())
158  fprintf(log, "\n\n");
159 #endif
160  fprintf(log, "command: %s\n", cmd);
161 #ifdef WIN32
162  /* Are we printing "command:" after its output? */
163  if (mainThreadId != GetCurrentThreadId())
164  fprintf(log, "\n\n");
165 #endif
166 
167  /*
168  * In Windows, we must close the log file at this point so the file is not
169  * open while the command is running, or we get a share violation.
170  */
171  fclose(log);
172 
173 #ifdef WIN32
174  /* see comment above */
175  if (mainThreadId == GetCurrentThreadId())
176 #endif
177  result = system(cmd);
178 
179  if (result != 0 && report_error)
180  {
181  /* we might be in on a progress status line, so go to the next line */
182  report_status(PG_REPORT, "\n*failure*");
183  fflush(stdout);
184 
185  pg_log(PG_VERBOSE, "There were problems executing \"%s\"\n", cmd);
186  if (opt_log_file)
187  pg_log(exit_on_error ? PG_FATAL : PG_REPORT,
188  "Consult the last few lines of \"%s\" or \"%s\" for\n"
189  "the probable cause of the failure.\n",
190  log_file, opt_log_file);
191  else
192  pg_log(exit_on_error ? PG_FATAL : PG_REPORT,
193  "Consult the last few lines of \"%s\" for\n"
194  "the probable cause of the failure.\n",
195  log_file);
196  }
197 
198 #ifndef WIN32
199 
200  /*
201  * We can't do this on Windows because it will keep the "pg_ctl start"
202  * output filename open until the server stops, so we do the \n\n above on
203  * that platform. We use a unique filename for "pg_ctl start" that is
204  * never reused while the server is running, so it works fine. We could
205  * log these commands to a third file, but that just adds complexity.
206  */
207  if ((log = fopen(log_file, "a")) == NULL)
208  pg_fatal("could not write to log file \"%s\": %m\n", log_file);
209  fprintf(log, "\n\n");
210  fclose(log);
211 #endif
212 
213  return result == 0;
214 }
#define MAXCMDLEN
static void const char fflush(stdout)
va_end(args)
static void const char * fmt
va_start(args, fmt)
static char * log_file
Definition: pg_ctl.c:91
void void pg_log(eLogType type, const char *fmt,...) pg_attribute_printf(2
LogOpts log_opts
Definition: util.c:17
@ PG_VERBOSE
Definition: pg_upgrade.h:237
@ PG_REPORT
Definition: pg_upgrade.h:239
#define vsnprintf
Definition: port.h:224
#define fprintf
Definition: port.h:229
void pg_usleep(long microsec)
Definition: signal.c:53
char * logdir
Definition: pg_upgrade.h:284

References fflush(), fmt, fprintf, log_file, log_opts, LogOpts::logdir, MAXCMDLEN, MAXPGPATH, pg_fatal, PG_FATAL, pg_log(), PG_REPORT, pg_usleep(), PG_VERBOSE, report_status(), snprintf, generate_unaccent_rules::stdout, va_end(), va_start(), and vsnprintf.

Referenced by copy_subdir_files(), copy_xact_xlog_xid(), create_new_objects(), generate_old_dump(), main(), parallel_exec_prog(), prepare_new_cluster(), prepare_new_globals(), start_postmaster(), and stop_postmaster().

◆ get_bin_version()

static void get_bin_version ( ClusterInfo cluster)
static

Definition at line 33 of file exec.c.

34 {
35  char cmd[MAXPGPATH],
36  cmd_output[MAX_STRING];
37  FILE *output;
38  int v1 = 0,
39  v2 = 0;
40 
41  snprintf(cmd, sizeof(cmd), "\"%s/pg_ctl\" --version", cluster->bindir);
42 
43  if ((output = popen(cmd, "r")) == NULL ||
44  fgets(cmd_output, sizeof(cmd_output), output) == NULL)
45  pg_fatal("could not get pg_ctl version data using %s: %s\n",
46  cmd, strerror(errno));
47 
48  pclose(output);
49 
50  if (sscanf(cmd_output, "%*s %*s %d.%d", &v1, &v2) < 1)
51  pg_fatal("could not get pg_ctl version output from %s\n", cmd);
52 
53  if (v1 < 10)
54  {
55  /* old style, e.g. 9.6.1 */
56  cluster->bin_version = v1 * 10000 + v2 * 100;
57  }
58  else
59  {
60  /* new style, e.g. 10.1 */
61  cluster->bin_version = v1 * 10000;
62  }
63 }
static void output(uint64 loop_count)
#define MAX_STRING
Definition: pg_upgrade.h:21

References cluster(), MAX_STRING, MAXPGPATH, output(), pg_fatal, snprintf, and strerror.

Referenced by check_bin_dir().

◆ pid_lock_file_exists()

bool pid_lock_file_exists ( const char *  datadir)

Definition at line 223 of file exec.c.

224 {
225  char path[MAXPGPATH];
226  int fd;
227 
228  snprintf(path, sizeof(path), "%s/postmaster.pid", datadir);
229 
230  if ((fd = open(path, O_RDONLY, 0)) < 0)
231  {
232  /* ENOTDIR means we will throw a more useful error later */
233  if (errno != ENOENT && errno != ENOTDIR)
234  pg_fatal("could not open file \"%s\" for reading: %s\n",
235  path, strerror(errno));
236 
237  return false;
238  }
239 
240  close(fd);
241  return true;
242 }
#define close(a)
Definition: win32.h:12
char * datadir
static int fd(const char *x, int i)
Definition: preproc-init.c:105

References close, datadir, fd(), MAXPGPATH, pg_fatal, snprintf, and strerror.

Referenced by setup().

◆ verify_directories()

void verify_directories ( void  )

Definition at line 254 of file exec.c.

255 {
256 #ifndef WIN32
257  if (access(".", R_OK | W_OK | X_OK) != 0)
258 #else
259  if (win32_check_directory_write_permissions() != 0)
260 #endif
261  pg_fatal("You must have read and write access in the current directory.\n");
262 
263  check_bin_dir(&old_cluster, false);
265  check_bin_dir(&new_cluster, true);
267 }
static void check_bin_dir(ClusterInfo *cluster, bool check_versions)
Definition: exec.c:374
static void check_data_dir(ClusterInfo *cluster)
Definition: exec.c:332
ClusterInfo old_cluster
Definition: pg_upgrade.c:62

References check_bin_dir(), check_data_dir(), new_cluster, old_cluster, and pg_fatal.

Referenced by setup().