Age Owner Branch data TLA Line data Source code
1 : : /*
2 : : * server.c
3 : : *
4 : : * database server functions
5 : : *
6 : : * Copyright (c) 2010-2025, 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 *
5413 bruce@momjian.us 28 :CBC 267 : connectToServer(ClusterInfo *cluster, const char *db_name)
29 : : {
5298 30 : 267 : PGconn *conn = get_db_conn(cluster, db_name);
31 : :
5647 32 [ + - - + ]: 267 : if (conn == NULL || PQstatus(conn) != CONNECTION_OK)
33 : : {
1739 tgl@sss.pgh.pa.us 34 :UBC 0 : pg_log(PG_REPORT, "%s", PQerrorMessage(conn));
35 : :
5647 bruce@momjian.us 36 [ # # ]: 0 : if (conn)
37 : 0 : PQfinish(conn);
38 : :
3300 peter_e@gmx.net 39 : 0 : printf(_("Failure, exiting\n"));
5318 40 : 0 : exit(1);
41 : : }
42 : :
2800 noah@leadboat.com 43 :CBC 267 : PQclear(executeQueryOrDie(conn, ALWAYS_SECURE_SEARCH_PATH_SQL));
44 : :
5647 bruce@momjian.us 45 : 267 : 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 *
5298 57 : 314 : 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 */
3367 noah@leadboat.com 63 : 314 : initPQExpBuffer(&conn_opts);
64 : 314 : appendPQExpBufferStr(&conn_opts, "dbname=");
65 : 314 : appendConnStrVal(&conn_opts, db_name);
66 : 314 : appendPQExpBufferStr(&conn_opts, " user=");
67 : 314 : appendConnStrVal(&conn_opts, os_info.user);
68 : 314 : appendPQExpBuffer(&conn_opts, " port=%d", cluster->port);
4802 tgl@sss.pgh.pa.us 69 [ + - ]: 314 : if (cluster->sockdir)
70 : : {
3367 noah@leadboat.com 71 : 314 : appendPQExpBufferStr(&conn_opts, " host=");
72 : 314 : appendConnStrVal(&conn_opts, cluster->sockdir);
73 : : }
74 : :
75 : 314 : conn = PQconnectdb(conn_opts.data);
76 : 314 : termPQExpBuffer(&conn_opts);
77 : 314 : 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 *
4802 tgl@sss.pgh.pa.us 92 : 96 : cluster_conn_opts(ClusterInfo *cluster)
93 : : {
94 : : static PQExpBuffer buf;
95 : :
3367 noah@leadboat.com 96 [ + + ]: 96 : if (buf == NULL)
97 : 10 : buf = createPQExpBuffer();
98 : : else
99 : 86 : resetPQExpBuffer(buf);
100 : :
101 [ + - ]: 96 : if (cluster->sockdir)
102 : : {
103 : 96 : appendPQExpBufferStr(buf, "--host ");
104 : 96 : appendShellString(buf, cluster->sockdir);
105 : 96 : appendPQExpBufferChar(buf, ' ');
106 : : }
107 : 96 : appendPQExpBuffer(buf, "--port %d --username ", cluster->port);
108 : 96 : appendShellString(buf, os_info.user);
109 : :
110 : 96 : 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 *
5487 bruce@momjian.us 122 : 608 : executeQueryOrDie(PGconn *conn, const char *fmt,...)
123 : : {
124 : : static char query[QUERY_ALLOC];
125 : : va_list args;
126 : : PGresult *result;
127 : : ExecStatusType status;
128 : :
5647 129 : 608 : va_start(args, fmt);
4086 130 : 608 : vsnprintf(query, sizeof(query), fmt, args);
5647 131 : 608 : va_end(args);
132 : :
1203 tgl@sss.pgh.pa.us 133 : 608 : pg_log(PG_VERBOSE, "executing: %s", query);
4086 bruce@momjian.us 134 : 608 : result = PQexec(conn, query);
5647 135 : 608 : status = PQresultStatus(result);
136 : :
137 [ + + - + ]: 608 : if ((status != PGRES_TUPLES_OK) && (status != PGRES_COMMAND_OK))
138 : : {
2988 peter_e@gmx.net 139 :UBC 0 : pg_log(PG_REPORT, "SQL command failed\n%s\n%s", query,
140 : : PQerrorMessage(conn));
5647 bruce@momjian.us 141 : 0 : PQclear(result);
142 : 0 : PQfinish(conn);
3300 peter_e@gmx.net 143 : 0 : printf(_("Failure, exiting\n"));
5318 144 : 0 : exit(1);
145 : : }
146 : : else
5647 bruce@momjian.us 147 :CBC 608 : return result;
148 : : }
149 : :
150 : :
151 : : static void
5318 peter_e@gmx.net 152 : 16 : stop_postmaster_atexit(void)
153 : : {
5299 bruce@momjian.us 154 : 16 : stop_postmaster(true);
5318 peter_e@gmx.net 155 : 16 : }
156 : :
157 : :
158 : : bool
2849 bruce@momjian.us 159 : 47 : start_postmaster(ClusterInfo *cluster, bool report_and_exit_on_error)
160 : : {
161 : : char cmd[MAXPGPATH * 4 + 1000];
162 : : PGconn *conn;
4809 alvherre@alvh.no-ip. 163 : 47 : bool pg_ctl_return = false;
164 : : char socket_string[MAXPGPATH + 200];
165 : : PQExpBufferData pgoptions;
166 : :
167 : : static bool exit_hook_registered = false;
168 : :
5318 peter_e@gmx.net 169 [ + + ]: 47 : if (!exit_hook_registered)
170 : : {
171 : 16 : atexit(stop_postmaster_atexit);
172 : 16 : exit_hook_registered = true;
173 : : }
174 : :
2086 michael@paquier.xyz 175 : 47 : socket_string[0] = '\0';
176 : :
177 : : #if !defined(WIN32)
178 : : /* prevent TCP/IP connections, restrict socket access */
179 : 47 : strcat(socket_string,
180 : : " -c listen_addresses='' -c unix_socket_permissions=0700");
181 : :
182 : : /* Have a sockdir? Tell the postmaster. */
183 [ + - ]: 47 : if (cluster->sockdir)
184 : 47 : snprintf(socket_string + strlen(socket_string),
185 : 47 : sizeof(socket_string) - strlen(socket_string),
186 : : " -c %s='%s'",
1847 bruce@momjian.us 187 [ - + ]: 47 : (GET_MAJOR_VERSION(cluster->major_version) <= 902) ?
188 : : "unix_socket_directory" : "unix_socket_directories",
189 : : cluster->sockdir);
190 : : #endif
191 : :
732 akapila@postgresql.o 192 : 47 : initPQExpBuffer(&pgoptions);
193 : :
194 : : /*
195 : : * Construct a parameter string which is passed to the server process.
196 : : *
197 : : * Turn off durability requirements to improve object creation speed, and
198 : : * we only modify the new cluster, so only use it there. If there is a
199 : : * crash, the new cluster has to be recreated anyway. fsync=off is a big
200 : : * win on ext4.
201 : : */
202 [ + + ]: 47 : if (cluster == &new_cluster)
203 : 31 : appendPQExpBufferStr(&pgoptions, " -c synchronous_commit=off -c fsync=off -c full_page_writes=off");
204 : :
205 : : /*
206 : : * Use -b to disable autovacuum and logical replication launcher
207 : : * (effective in PG17 or later for the latter).
208 : : */
2086 michael@paquier.xyz 209 : 47 : snprintf(cmd, sizeof(cmd),
210 : : "\"%s/pg_ctl\" -w -l \"%s/%s\" -D \"%s\" -o \"-p %d -b%s %s%s\" start",
211 : : cluster->bindir,
212 : : log_opts.logdir,
1359 213 : 47 : SERVER_LOG_FILE, cluster->pgconfig, cluster->port,
214 : : pgoptions.data,
2086 215 [ - + ]: 47 : cluster->pgopts ? cluster->pgopts : "", socket_string);
216 : :
732 akapila@postgresql.o 217 : 47 : termPQExpBuffer(&pgoptions);
218 : :
219 : : /*
220 : : * Don't throw an error right away, let connecting throw the error because
221 : : * it might supply a reason for the failure.
222 : : */
4809 alvherre@alvh.no-ip. 223 : 47 : pg_ctl_return = exec_prog(SERVER_START_LOG_FILE,
224 : : /* pass both file names if they differ */
225 : : (strcmp(SERVER_LOG_FILE,
226 : : SERVER_START_LOG_FILE) != 0) ?
227 : : SERVER_LOG_FILE : NULL,
228 : : report_and_exit_on_error, false,
229 : : "%s", cmd);
230 : :
231 : : /* Did it fail and we are just testing if the server could be started? */
2849 bruce@momjian.us 232 [ - + - - ]: 47 : if (!pg_ctl_return && !report_and_exit_on_error)
4659 bruce@momjian.us 233 :UBC 0 : return false;
234 : :
235 : : /*
236 : : * We set this here to make sure atexit() shuts down the server, but only
237 : : * if we started the server successfully. We do it before checking for
238 : : * connectivity in case the server started but there is a connectivity
239 : : * failure. If pg_ctl did not return success, we will exit below.
240 : : *
241 : : * Pre-9.1 servers do not have PQping(), so we could be leaving the server
242 : : * running if authentication was misconfigured, so someday we might went
243 : : * to be more aggressive about doing server shutdowns even if pg_ctl
244 : : * fails, but now (2013-08-14) it seems prudent to be cautious. We don't
245 : : * want to shutdown a server that might have been accidentally started
246 : : * during the upgrade.
247 : : */
4455 bruce@momjian.us 248 [ + - ]:CBC 47 : if (pg_ctl_return)
249 : 47 : os_info.running_cluster = cluster;
250 : :
251 : : /*
252 : : * pg_ctl -w might have failed because the server couldn't be started, or
253 : : * there might have been a connection problem in _checking_ if the server
254 : : * has started. Therefore, even if pg_ctl failed, we continue and test
255 : : * for connectivity in case we get a connection reason for the failure.
256 : : */
5298 257 [ + - - + ]: 94 : if ((conn = get_db_conn(cluster, "template1")) == NULL ||
258 : 47 : PQstatus(conn) != CONNECTION_OK)
259 : : {
1739 tgl@sss.pgh.pa.us 260 :UBC 0 : pg_log(PG_REPORT, "\n%s", PQerrorMessage(conn));
5254 bruce@momjian.us 261 [ # # ]: 0 : if (conn)
5298 262 : 0 : PQfinish(conn);
3027 alvherre@alvh.no-ip. 263 [ # # ]: 0 : if (cluster == &old_cluster)
264 : 0 : pg_fatal("could not connect to source postmaster started with the command:\n"
265 : : "%s",
266 : : cmd);
267 : : else
268 : 0 : pg_fatal("could not connect to target postmaster started with the command:\n"
269 : : "%s",
270 : : cmd);
271 : : }
5298 bruce@momjian.us 272 :CBC 47 : PQfinish(conn);
273 : :
274 : : /*
275 : : * If pg_ctl failed, and the connection didn't fail, and
276 : : * report_and_exit_on_error is enabled, fail now. This could happen if
277 : : * the server was already running.
278 : : */
4809 alvherre@alvh.no-ip. 279 [ - + ]: 47 : if (!pg_ctl_return)
280 : : {
2852 bruce@momjian.us 281 [ # # ]:UBC 0 : if (cluster == &old_cluster)
1203 tgl@sss.pgh.pa.us 282 : 0 : pg_fatal("pg_ctl failed to start the source server, or connection failed");
283 : : else
284 : 0 : pg_fatal("pg_ctl failed to start the target server, or connection failed");
285 : : }
286 : :
4659 bruce@momjian.us 287 :CBC 47 : return true;
288 : : }
289 : :
290 : :
291 : : void
2849 292 : 56 : stop_postmaster(bool in_atexit)
293 : : {
294 : : ClusterInfo *cluster;
295 : :
5413 296 [ + + ]: 56 : if (os_info.running_cluster == &old_cluster)
5131 297 : 16 : cluster = &old_cluster;
5413 298 [ + + ]: 40 : else if (os_info.running_cluster == &new_cluster)
5131 299 : 31 : cluster = &new_cluster;
300 : : else
4887 301 : 9 : return; /* no cluster running */
302 : :
2849 303 [ + + ]: 94 : exec_prog(SERVER_STOP_LOG_FILE, NULL, !in_atexit, !in_atexit,
304 : : "\"%s/pg_ctl\" -w -D \"%s\" -o \"%s\" %s stop",
305 : : cluster->bindir, cluster->pgconfig,
4809 alvherre@alvh.no-ip. 306 [ - + ]: 47 : cluster->pgopts ? cluster->pgopts : "",
2849 bruce@momjian.us 307 : 47 : in_atexit ? "-m fast" : "-m smart");
308 : :
5413 309 : 47 : os_info.running_cluster = NULL;
310 : : }
311 : :
312 : :
313 : : /*
314 : : * check_pghost_envvar()
315 : : *
316 : : * Tests that PGHOST does not point to a non-local server
317 : : */
318 : : void
5278 319 : 18 : check_pghost_envvar(void)
320 : : {
321 : : PQconninfoOption *option;
322 : : PQconninfoOption *start;
323 : :
324 : : /* Get valid libpq env vars from the PQconndefaults function */
325 : :
5317 peter_e@gmx.net 326 : 18 : start = PQconndefaults();
327 : :
4346 bruce@momjian.us 328 [ - + ]: 18 : if (!start)
1203 tgl@sss.pgh.pa.us 329 :UBC 0 : pg_fatal("out of memory");
330 : :
5317 peter_e@gmx.net 331 [ + + ]:CBC 936 : for (option = start; option->keyword != NULL; option++)
332 : : {
5278 bruce@momjian.us 333 [ + + + + ]: 918 : if (option->envvar && (strcmp(option->envvar, "PGHOST") == 0 ||
5254 334 [ + + ]: 630 : strcmp(option->envvar, "PGHOSTADDR") == 0))
335 : : {
5278 336 : 36 : const char *value = getenv(option->envvar);
337 : :
338 [ + + + - ]: 36 : if (value && strlen(value) > 0 &&
339 : : /* check for 'local' host values */
340 [ + - + - ]: 18 : (strcmp(value, "localhost") != 0 && strcmp(value, "127.0.0.1") != 0 &&
1335 michael@paquier.xyz 341 [ + - - + ]: 18 : strcmp(value, "::1") != 0 && !is_unixsock_path(value)))
1203 tgl@sss.pgh.pa.us 342 :UBC 0 : pg_fatal("libpq environment variable %s has a non-local server value: %s",
343 : : option->envvar, value);
344 : : }
345 : : }
346 : :
347 : : /* Free the memory that libpq allocated on our behalf */
5647 bruce@momjian.us 348 :CBC 18 : PQconninfoFree(start);
349 : 18 : }
|
