Age Owner Branch data TLA Line data Source code
1 : : /*
2 : : * server.c
3 : : *
4 : : * database server functions
5 : : *
6 : : * Copyright (c) 2010-2024, PostgreSQL Global Development Group
7 : : * src/bin/pg_upgrade/server.c
8 : : */
9 : :
10 : : #include "postgres_fe.h"
11 : :
12 : : #include "common/connect.h"
13 : : #include "fe_utils/string_utils.h"
14 : : #include "libpq/pqcomm.h"
15 : : #include "pg_upgrade.h"
16 : :
17 : : static PGconn *get_db_conn(ClusterInfo *cluster, const char *db_name);
18 : :
19 : :
20 : : /*
21 : : * connectToServer()
22 : : *
23 : : * Connects to the desired database on the designated server.
24 : : * If the connection attempt fails, this function logs an error
25 : : * message and calls exit() to kill the program.
26 : : */
27 : : PGconn *
4852 bruce@momjian.us 28 :CBC 295 : connectToServer(ClusterInfo *cluster, const char *db_name)
29 : : {
4737 30 : 295 : PGconn *conn = get_db_conn(cluster, db_name);
31 : :
5086 32 [ + - + + ]: 295 : if (conn == NULL || PQstatus(conn) != CONNECTION_OK)
33 : : {
1178 tgl@sss.pgh.pa.us 34 : 1 : pg_log(PG_REPORT, "%s", PQerrorMessage(conn));
35 : :
5086 bruce@momjian.us 36 [ + - ]: 1 : if (conn)
37 : 1 : PQfinish(conn);
38 : :
2739 peter_e@gmx.net 39 : 1 : printf(_("Failure, exiting\n"));
4757 40 : 1 : exit(1);
41 : : }
42 : :
2239 noah@leadboat.com 43 : 294 : PQclear(executeQueryOrDie(conn, ALWAYS_SECURE_SEARCH_PATH_SQL));
44 : :
5086 bruce@momjian.us 45 : 294 : return conn;
46 : : }
47 : :
48 : :
49 : : /*
50 : : * get_db_conn()
51 : : *
52 : : * get database connection, using named database + standard params for cluster
53 : : *
54 : : * Caller must check for connection failure!
55 : : */
56 : : static PGconn *
4737 57 : 317 : get_db_conn(ClusterInfo *cluster, const char *db_name)
58 : : {
59 : : PQExpBufferData conn_opts;
60 : : PGconn *conn;
61 : :
62 : : /* Build connection string with proper quoting */
2806 noah@leadboat.com 63 : 317 : initPQExpBuffer(&conn_opts);
64 : 317 : appendPQExpBufferStr(&conn_opts, "dbname=");
65 : 317 : appendConnStrVal(&conn_opts, db_name);
66 : 317 : appendPQExpBufferStr(&conn_opts, " user=");
67 : 317 : appendConnStrVal(&conn_opts, os_info.user);
68 : 317 : appendPQExpBuffer(&conn_opts, " port=%d", cluster->port);
4241 tgl@sss.pgh.pa.us 69 [ + - ]: 317 : if (cluster->sockdir)
70 : : {
2806 noah@leadboat.com 71 : 317 : appendPQExpBufferStr(&conn_opts, " host=");
72 : 317 : appendConnStrVal(&conn_opts, cluster->sockdir);
73 : : }
74 : :
75 : 317 : conn = PQconnectdb(conn_opts.data);
76 : 317 : termPQExpBuffer(&conn_opts);
77 : 317 : return conn;
78 : : }
79 : :
80 : :
81 : : /*
82 : : * cluster_conn_opts()
83 : : *
84 : : * Return standard command-line options for connecting to this cluster when
85 : : * using psql, pg_dump, etc. Ideally this would match what get_db_conn()
86 : : * sets, but the utilities we need aren't very consistent about the treatment
87 : : * of database name options, so we leave that out.
88 : : *
89 : : * Result is valid until the next call to this function.
90 : : */
91 : : char *
4241 tgl@sss.pgh.pa.us 92 : 35 : cluster_conn_opts(ClusterInfo *cluster)
93 : : {
94 : : static PQExpBuffer buf;
95 : :
2806 noah@leadboat.com 96 [ + + ]: 35 : if (buf == NULL)
97 : 4 : buf = createPQExpBuffer();
98 : : else
99 : 31 : resetPQExpBuffer(buf);
100 : :
101 [ + - ]: 35 : if (cluster->sockdir)
102 : : {
103 : 35 : appendPQExpBufferStr(buf, "--host ");
104 : 35 : appendShellString(buf, cluster->sockdir);
105 : 35 : appendPQExpBufferChar(buf, ' ');
106 : : }
107 : 35 : appendPQExpBuffer(buf, "--port %d --username ", cluster->port);
108 : 35 : appendShellString(buf, os_info.user);
109 : :
110 : 35 : return buf->data;
111 : : }
112 : :
113 : :
114 : : /*
115 : : * executeQueryOrDie()
116 : : *
117 : : * Formats a query string from the given arguments and executes the
118 : : * resulting query. If the query fails, this function logs an error
119 : : * message and calls exit() to kill the program.
120 : : */
121 : : PGresult *
4926 bruce@momjian.us 122 : 646 : executeQueryOrDie(PGconn *conn, const char *fmt,...)
123 : : {
124 : : static char query[QUERY_ALLOC];
125 : : va_list args;
126 : : PGresult *result;
127 : : ExecStatusType status;
128 : :
5086 129 : 646 : va_start(args, fmt);
3525 130 : 646 : vsnprintf(query, sizeof(query), fmt, args);
5086 131 : 646 : va_end(args);
132 : :
642 tgl@sss.pgh.pa.us 133 : 646 : pg_log(PG_VERBOSE, "executing: %s", query);
3525 bruce@momjian.us 134 : 646 : result = PQexec(conn, query);
5086 135 : 646 : status = PQresultStatus(result);
136 : :
137 [ + + - + ]: 646 : if ((status != PGRES_TUPLES_OK) && (status != PGRES_COMMAND_OK))
138 : : {
2427 peter_e@gmx.net 139 :UBC 0 : pg_log(PG_REPORT, "SQL command failed\n%s\n%s", query,
140 : : PQerrorMessage(conn));
5086 bruce@momjian.us 141 : 0 : PQclear(result);
142 : 0 : PQfinish(conn);
2739 peter_e@gmx.net 143 : 0 : printf(_("Failure, exiting\n"));
4757 144 : 0 : exit(1);
145 : : }
146 : : else
5086 bruce@momjian.us 147 :CBC 646 : return result;
148 : : }
149 : :
150 : :
151 : : /*
152 : : * get_major_server_version()
153 : : *
154 : : * gets the version (in unsigned int form) for the given datadir. Assumes
155 : : * that datadir is an absolute path to a valid pgdata directory. The version
156 : : * is retrieved by reading the PG_VERSION file.
157 : : */
158 : : uint32
4852 159 : 18 : get_major_server_version(ClusterInfo *cluster)
160 : : {
161 : : FILE *version_fd;
162 : : char ver_filename[MAXPGPATH];
2351 tgl@sss.pgh.pa.us 163 : 18 : int v1 = 0,
164 : 18 : v2 = 0;
165 : :
4579 bruce@momjian.us 166 : 18 : snprintf(ver_filename, sizeof(ver_filename), "%s/PG_VERSION",
167 : : cluster->pgdata);
4852 168 [ - + ]: 18 : if ((version_fd = fopen(ver_filename, "r")) == NULL)
642 tgl@sss.pgh.pa.us 169 :UBC 0 : pg_fatal("could not open version file \"%s\": %m", ver_filename);
170 : :
4852 bruce@momjian.us 171 [ + - ]:CBC 18 : if (fscanf(version_fd, "%63s", cluster->major_version_str) == 0 ||
2351 tgl@sss.pgh.pa.us 172 [ - + ]: 18 : sscanf(cluster->major_version_str, "%d.%d", &v1, &v2) < 1)
642 tgl@sss.pgh.pa.us 173 :UBC 0 : pg_fatal("could not parse version file \"%s\"", ver_filename);
174 : :
4786 bruce@momjian.us 175 :CBC 18 : fclose(version_fd);
176 : :
2351 tgl@sss.pgh.pa.us 177 [ - + ]: 18 : if (v1 < 10)
178 : : {
179 : : /* old style, e.g. 9.6.1 */
2351 tgl@sss.pgh.pa.us 180 :UBC 0 : return v1 * 10000 + v2 * 100;
181 : : }
182 : : else
183 : : {
184 : : /* new style, e.g. 10.1 */
2351 tgl@sss.pgh.pa.us 185 :CBC 18 : return v1 * 10000;
186 : : }
187 : : }
188 : :
189 : :
190 : : static void
4757 peter_e@gmx.net 191 : 9 : stop_postmaster_atexit(void)
192 : : {
4738 bruce@momjian.us 193 : 9 : stop_postmaster(true);
4757 peter_e@gmx.net 194 : 9 : }
195 : :
196 : :
197 : : bool
2288 bruce@momjian.us 198 : 22 : start_postmaster(ClusterInfo *cluster, bool report_and_exit_on_error)
199 : : {
200 : : char cmd[MAXPGPATH * 4 + 1000];
201 : : PGconn *conn;
4248 alvherre@alvh.no-ip. 202 : 22 : bool pg_ctl_return = false;
203 : : char socket_string[MAXPGPATH + 200];
204 : : PQExpBufferData pgoptions;
205 : :
206 : : static bool exit_hook_registered = false;
207 : :
4757 peter_e@gmx.net 208 [ + + ]: 22 : if (!exit_hook_registered)
209 : : {
210 : 9 : atexit(stop_postmaster_atexit);
211 : 9 : exit_hook_registered = true;
212 : : }
213 : :
1525 michael@paquier.xyz 214 : 22 : socket_string[0] = '\0';
215 : :
216 : : #if !defined(WIN32)
217 : : /* prevent TCP/IP connections, restrict socket access */
218 : 22 : strcat(socket_string,
219 : : " -c listen_addresses='' -c unix_socket_permissions=0700");
220 : :
221 : : /* Have a sockdir? Tell the postmaster. */
222 [ + - ]: 22 : if (cluster->sockdir)
1525 michael@paquier.xyz 223 :UBC 0 : snprintf(socket_string + strlen(socket_string),
1525 michael@paquier.xyz 224 :CBC 22 : sizeof(socket_string) - strlen(socket_string),
225 : : " -c %s='%s'",
1286 bruce@momjian.us 226 [ - + ]: 22 : (GET_MAJOR_VERSION(cluster->major_version) <= 902) ?
227 : : "unix_socket_directory" : "unix_socket_directories",
228 : : cluster->sockdir);
229 : : #endif
230 : :
171 akapila@postgresql.o 231 :GNC 22 : initPQExpBuffer(&pgoptions);
232 : :
233 : : /*
234 : : * Construct a parameter string which is passed to the server process.
235 : : *
236 : : * Turn off durability requirements to improve object creation speed, and
237 : : * we only modify the new cluster, so only use it there. If there is a
238 : : * crash, the new cluster has to be recreated anyway. fsync=off is a big
239 : : * win on ext4.
240 : : */
241 [ + + ]: 22 : if (cluster == &new_cluster)
242 : 13 : appendPQExpBufferStr(&pgoptions, " -c synchronous_commit=off -c fsync=off -c full_page_writes=off");
243 : :
244 : : /*
245 : : * Use max_slot_wal_keep_size as -1 to prevent the WAL removal by the
246 : : * checkpointer process. If WALs required by logical replication slots
247 : : * are removed, the slots are unusable. This setting prevents the
248 : : * invalidation of slots during the upgrade. We set this option when
249 : : * cluster is PG17 or later because logical replication slots can only be
250 : : * migrated since then. Besides, max_slot_wal_keep_size is added in PG13.
251 : : */
252 [ + - ]: 22 : if (GET_MAJOR_VERSION(cluster->major_version) >= 1700)
93 michael@paquier.xyz 253 : 22 : appendPQExpBufferStr(&pgoptions, " -c max_slot_wal_keep_size=-1");
254 : :
255 : : /*
256 : : * Use -b to disable autovacuum and logical replication launcher
257 : : * (effective in PG17 or later for the latter).
258 : : */
1525 michael@paquier.xyz 259 [ + + ]:LBC (7) : snprintf(cmd, sizeof(cmd),
260 : : "\"%s/pg_ctl\" -w -l \"%s/%s\" -D \"%s\" -o \"-p %d -b%s %s%s\" start",
261 : : cluster->bindir,
262 : : log_opts.logdir,
798 michael@paquier.xyz 263 :CBC 22 : SERVER_LOG_FILE, cluster->pgconfig, cluster->port,
264 : : pgoptions.data,
1525 265 [ - + ]: 22 : cluster->pgopts ? cluster->pgopts : "", socket_string);
266 : :
171 akapila@postgresql.o 267 :GNC 22 : termPQExpBuffer(&pgoptions);
268 : :
269 : : /*
270 : : * Don't throw an error right away, let connecting throw the error because
271 : : * it might supply a reason for the failure.
272 : : */
4248 alvherre@alvh.no-ip. 273 :CBC 22 : pg_ctl_return = exec_prog(SERVER_START_LOG_FILE,
274 : : /* pass both file names if they differ */
275 : : (strcmp(SERVER_LOG_FILE,
276 : : SERVER_START_LOG_FILE) != 0) ?
277 : : SERVER_LOG_FILE : NULL,
278 : : report_and_exit_on_error, false,
279 : : "%s", cmd);
280 : :
281 : : /* Did it fail and we are just testing if the server could be started? */
2288 bruce@momjian.us 282 [ - + - - ]: 22 : if (!pg_ctl_return && !report_and_exit_on_error)
4098 bruce@momjian.us 283 :UBC 0 : return false;
284 : :
285 : : /*
286 : : * We set this here to make sure atexit() shuts down the server, but only
287 : : * if we started the server successfully. We do it before checking for
288 : : * connectivity in case the server started but there is a connectivity
289 : : * failure. If pg_ctl did not return success, we will exit below.
290 : : *
291 : : * Pre-9.1 servers do not have PQping(), so we could be leaving the server
292 : : * running if authentication was misconfigured, so someday we might went
293 : : * to be more aggressive about doing server shutdowns even if pg_ctl
294 : : * fails, but now (2013-08-14) it seems prudent to be cautious. We don't
295 : : * want to shutdown a server that might have been accidentally started
296 : : * during the upgrade.
297 : : */
3894 bruce@momjian.us 298 [ + - ]:CBC 22 : if (pg_ctl_return)
299 : 22 : os_info.running_cluster = cluster;
300 : :
301 : : /*
302 : : * pg_ctl -w might have failed because the server couldn't be started, or
303 : : * there might have been a connection problem in _checking_ if the server
304 : : * has started. Therefore, even if pg_ctl failed, we continue and test
305 : : * for connectivity in case we get a connection reason for the failure.
306 : : */
4737 307 [ + - - + ]: 44 : if ((conn = get_db_conn(cluster, "template1")) == NULL ||
308 : 22 : PQstatus(conn) != CONNECTION_OK)
309 : : {
1178 tgl@sss.pgh.pa.us 310 :UBC 0 : pg_log(PG_REPORT, "\n%s", PQerrorMessage(conn));
4693 bruce@momjian.us 311 [ # # ]: 0 : if (conn)
4737 312 : 0 : PQfinish(conn);
2466 alvherre@alvh.no-ip. 313 [ # # ]: 0 : if (cluster == &old_cluster)
314 : 0 : pg_fatal("could not connect to source postmaster started with the command:\n"
315 : : "%s",
316 : : cmd);
317 : : else
318 : 0 : pg_fatal("could not connect to target postmaster started with the command:\n"
319 : : "%s",
320 : : cmd);
321 : : }
4737 bruce@momjian.us 322 :CBC 22 : PQfinish(conn);
323 : :
324 : : /*
325 : : * If pg_ctl failed, and the connection didn't fail, and
326 : : * report_and_exit_on_error is enabled, fail now. This could happen if
327 : : * the server was already running.
328 : : */
4248 alvherre@alvh.no-ip. 329 [ - + ]: 22 : if (!pg_ctl_return)
330 : : {
2291 bruce@momjian.us 331 [ # # ]:UBC 0 : if (cluster == &old_cluster)
642 tgl@sss.pgh.pa.us 332 : 0 : pg_fatal("pg_ctl failed to start the source server, or connection failed");
333 : : else
334 : 0 : pg_fatal("pg_ctl failed to start the target server, or connection failed");
335 : : }
336 : :
4098 bruce@momjian.us 337 :CBC 22 : return true;
338 : : }
339 : :
340 : :
341 : : void
2288 342 : 26 : stop_postmaster(bool in_atexit)
343 : : {
344 : : ClusterInfo *cluster;
345 : :
4852 346 [ + + ]: 26 : if (os_info.running_cluster == &old_cluster)
4570 347 : 9 : cluster = &old_cluster;
4852 348 [ + + ]: 17 : else if (os_info.running_cluster == &new_cluster)
4570 349 : 13 : cluster = &new_cluster;
350 : : else
4326 351 : 4 : return; /* no cluster running */
352 : :
2288 353 [ + + ]: 44 : exec_prog(SERVER_STOP_LOG_FILE, NULL, !in_atexit, !in_atexit,
354 : : "\"%s/pg_ctl\" -w -D \"%s\" -o \"%s\" %s stop",
355 : : cluster->bindir, cluster->pgconfig,
4248 alvherre@alvh.no-ip. 356 [ - + ]: 22 : cluster->pgopts ? cluster->pgopts : "",
2288 bruce@momjian.us 357 : 22 : in_atexit ? "-m fast" : "-m smart");
358 : :
4852 359 : 22 : os_info.running_cluster = NULL;
360 : : }
361 : :
362 : :
363 : : /*
364 : : * check_pghost_envvar()
365 : : *
366 : : * Tests that PGHOST does not point to a non-local server
367 : : */
368 : : void
4717 369 : 10 : check_pghost_envvar(void)
370 : : {
371 : : PQconninfoOption *option;
372 : : PQconninfoOption *start;
373 : :
374 : : /* Get valid libpq env vars from the PQconndefaults function */
375 : :
4756 peter_e@gmx.net 376 : 10 : start = PQconndefaults();
377 : :
3785 bruce@momjian.us 378 [ - + ]: 10 : if (!start)
642 tgl@sss.pgh.pa.us 379 :UBC 0 : pg_fatal("out of memory");
380 : :
4756 peter_e@gmx.net 381 [ + + ]:CBC 420 : for (option = start; option->keyword != NULL; option++)
382 : : {
4717 bruce@momjian.us 383 [ + + + + ]: 410 : if (option->envvar && (strcmp(option->envvar, "PGHOST") == 0 ||
4693 384 [ + + ]: 320 : strcmp(option->envvar, "PGHOSTADDR") == 0))
385 : : {
4717 386 : 20 : const char *value = getenv(option->envvar);
387 : :
388 [ + + + - ]: 20 : if (value && strlen(value) > 0 &&
389 : : /* check for 'local' host values */
390 [ + - + - ]: 10 : (strcmp(value, "localhost") != 0 && strcmp(value, "127.0.0.1") != 0 &&
774 michael@paquier.xyz 391 [ + - - + ]: 10 : strcmp(value, "::1") != 0 && !is_unixsock_path(value)))
642 tgl@sss.pgh.pa.us 392 :UBC 0 : pg_fatal("libpq environment variable %s has a non-local server value: %s",
393 : : option->envvar, value);
394 : : }
395 : : }
396 : :
397 : : /* Free the memory that libpq allocated on our behalf */
5086 bruce@momjian.us 398 :CBC 10 : PQconninfoFree(start);
399 : 10 : }
|
