4 * controldata functions
6 * Copyright (c) 2010-2017, PostgreSQL Global Development Group
7 * src/bin/pg_upgrade/controldata.c
10 #include "postgres_fe.h"
12 #include "pg_upgrade.h"
19 * gets pg_control information in "ctrl". Assumes that bindir and
20 * datadir are valid absolute paths to postgresql bin and pgdata
21 * directories respectively *and* pg_resetxlog is version compatible
22 * with datadir. The main purpose of this function is to get pg_control
23 * data in a version independent manner.
25 * The approach taken here is to invoke pg_resetxlog with -n option
26 * and then pipe its output. With little string parsing we get the
27 * pg_control data. pg_resetxlog cannot be run while the server is running
28 * so we use pg_controldata; pg_controldata doesn't provide all the fields
29 * we need to actually perform the upgrade, but it provides enough for
30 * check mode. We do not implement pg_resetxlog -n because it is hard to
31 * return valid xid data for a running server.
34 get_control_data(ClusterInfo *cluster, bool live_check)
37 char bufin[MAX_STRING];
41 bool got_log_id = false;
42 bool got_log_seg = false;
45 bool got_multi = false;
46 bool got_oldestmulti = false;
47 bool got_mxoff = false;
48 bool got_nextxlogfile = false;
49 bool got_float8_pass_by_value = false;
50 bool got_align = false;
51 bool got_blocksz = false;
52 bool got_largesz = false;
53 bool got_walsz = false;
54 bool got_walseg = false;
55 bool got_ident = false;
56 bool got_index = false;
57 bool got_toast = false;
58 bool got_large_object = false;
59 bool got_date_is_int = false;
60 bool got_data_checksum_version = false;
61 char *lc_collate = NULL;
62 char *lc_ctype = NULL;
63 char *lc_monetary = NULL;
64 char *lc_numeric = NULL;
67 char *language = NULL;
69 char *lc_messages = NULL;
76 * Because we test the pg_resetxlog output as strings, it has to be in
77 * English. Copied from pg_regress.c.
79 if (getenv("LC_COLLATE"))
80 lc_collate = pg_strdup(getenv("LC_COLLATE"));
81 if (getenv("LC_CTYPE"))
82 lc_ctype = pg_strdup(getenv("LC_CTYPE"));
83 if (getenv("LC_MONETARY"))
84 lc_monetary = pg_strdup(getenv("LC_MONETARY"));
85 if (getenv("LC_NUMERIC"))
86 lc_numeric = pg_strdup(getenv("LC_NUMERIC"));
87 if (getenv("LC_TIME"))
88 lc_time = pg_strdup(getenv("LC_TIME"));
90 lang = pg_strdup(getenv("LANG"));
91 if (getenv("LANGUAGE"))
92 language = pg_strdup(getenv("LANGUAGE"));
94 lc_all = pg_strdup(getenv("LC_ALL"));
95 if (getenv("LC_MESSAGES"))
96 lc_messages = pg_strdup(getenv("LC_MESSAGES"));
98 pg_putenv("LC_COLLATE", NULL);
99 pg_putenv("LC_CTYPE", NULL);
100 pg_putenv("LC_MONETARY", NULL);
101 pg_putenv("LC_NUMERIC", NULL);
102 pg_putenv("LC_TIME", NULL);
107 /* On Windows the default locale cannot be English, so force it */
110 pg_putenv("LANGUAGE", NULL);
111 pg_putenv("LC_ALL", NULL);
112 pg_putenv("LC_MESSAGES", "C");
114 snprintf(cmd, sizeof(cmd), "\"%s/%s \"%s\"",
116 live_check ? "pg_controldata\"" : "pg_resetxlog\" -n",
121 if ((output = popen(cmd, "r")) == NULL)
122 pg_fatal("could not get control data using %s: %s\n",
123 cmd, strerror(errno));
126 if (GET_MAJOR_VERSION(cluster->major_version) <= 902)
128 cluster->controldata.data_checksum_version = 0;
129 got_data_checksum_version = true;
132 /* we have the result of cmd in "output". so parse it line by line now */
133 while (fgets(bufin, sizeof(bufin), output))
135 pg_log(PG_VERBOSE, "%s", bufin);
137 if ((p = strstr(bufin, "pg_control version number:")) != NULL)
141 if (p == NULL || strlen(p) <= 1)
142 pg_fatal("%d: pg_resetxlog problem\n", __LINE__);
144 p++; /* remove ':' char */
145 cluster->controldata.ctrl_ver = str2uint(p);
147 else if ((p = strstr(bufin, "Catalog version number:")) != NULL)
151 if (p == NULL || strlen(p) <= 1)
152 pg_fatal("%d: controldata retrieval problem\n", __LINE__);
154 p++; /* remove ':' char */
155 cluster->controldata.cat_ver = str2uint(p);
157 else if ((p = strstr(bufin, "Latest checkpoint's TimeLineID:")) != NULL)
161 if (p == NULL || strlen(p) <= 1)
162 pg_fatal("%d: controldata retrieval problem\n", __LINE__);
164 p++; /* remove ':' char */
168 else if ((p = strstr(bufin, "First log file ID after reset:")) != NULL)
172 if (p == NULL || strlen(p) <= 1)
173 pg_fatal("%d: controldata retrieval problem\n", __LINE__);
175 p++; /* remove ':' char */
179 else if ((p = strstr(bufin, "First log file segment after reset:")) != NULL)
183 if (p == NULL || strlen(p) <= 1)
184 pg_fatal("%d: controldata retrieval problem\n", __LINE__);
186 p++; /* remove ':' char */
190 else if ((p = strstr(bufin, "Latest checkpoint's NextXID:")) != NULL)
194 if (p == NULL || strlen(p) <= 1)
195 pg_fatal("%d: controldata retrieval problem\n", __LINE__);
197 p++; /* remove ':' char */
198 cluster->controldata.chkpnt_nxtepoch = str2uint(p);
201 * Delimiter changed from '/' to ':' in 9.6. We don't test for
202 * the catalog version of the change because the catalog version
203 * is pulled from pg_controldata too, and it isn't worth adding an
204 * order dependency for this --- we just check the string.
206 if (strchr(p, '/') != NULL)
208 else if (GET_MAJOR_VERSION(cluster->major_version) >= 906)
213 if (p == NULL || strlen(p) <= 1)
214 pg_fatal("%d: controldata retrieval problem\n", __LINE__);
216 p++; /* remove '/' or ':' char */
217 cluster->controldata.chkpnt_nxtxid = str2uint(p);
220 else if ((p = strstr(bufin, "Latest checkpoint's NextOID:")) != NULL)
224 if (p == NULL || strlen(p) <= 1)
225 pg_fatal("%d: controldata retrieval problem\n", __LINE__);
227 p++; /* remove ':' char */
228 cluster->controldata.chkpnt_nxtoid = str2uint(p);
231 else if ((p = strstr(bufin, "Latest checkpoint's NextMultiXactId:")) != NULL)
235 if (p == NULL || strlen(p) <= 1)
236 pg_fatal("%d: controldata retrieval problem\n", __LINE__);
238 p++; /* remove ':' char */
239 cluster->controldata.chkpnt_nxtmulti = str2uint(p);
242 else if ((p = strstr(bufin, "Latest checkpoint's oldestMultiXid:")) != NULL)
246 if (p == NULL || strlen(p) <= 1)
247 pg_fatal("%d: controldata retrieval problem\n", __LINE__);
249 p++; /* remove ':' char */
250 cluster->controldata.chkpnt_oldstMulti = str2uint(p);
251 got_oldestmulti = true;
253 else if ((p = strstr(bufin, "Latest checkpoint's NextMultiOffset:")) != NULL)
257 if (p == NULL || strlen(p) <= 1)
258 pg_fatal("%d: controldata retrieval problem\n", __LINE__);
260 p++; /* remove ':' char */
261 cluster->controldata.chkpnt_nxtmxoff = str2uint(p);
264 else if ((p = strstr(bufin, "First log segment after reset:")) != NULL)
266 /* Skip the colon and any whitespace after it */
268 if (p == NULL || strlen(p) <= 1)
269 pg_fatal("%d: controldata retrieval problem\n", __LINE__);
270 p = strpbrk(p, "01234567890ABCDEF");
271 if (p == NULL || strlen(p) <= 1)
272 pg_fatal("%d: controldata retrieval problem\n", __LINE__);
274 /* Make sure it looks like a valid WAL file name */
275 if (strspn(p, "0123456789ABCDEF") != 24)
276 pg_fatal("%d: controldata retrieval problem\n", __LINE__);
278 strlcpy(cluster->controldata.nextxlogfile, p, 25);
279 got_nextxlogfile = true;
281 else if ((p = strstr(bufin, "Float8 argument passing:")) != NULL)
285 if (p == NULL || strlen(p) <= 1)
286 pg_fatal("%d: controldata retrieval problem\n", __LINE__);
288 p++; /* remove ':' char */
289 /* used later for contrib check */
290 cluster->controldata.float8_pass_by_value = strstr(p, "by value") != NULL;
291 got_float8_pass_by_value = true;
293 else if ((p = strstr(bufin, "Maximum data alignment:")) != NULL)
297 if (p == NULL || strlen(p) <= 1)
298 pg_fatal("%d: controldata retrieval problem\n", __LINE__);
300 p++; /* remove ':' char */
301 cluster->controldata.align = str2uint(p);
304 else if ((p = strstr(bufin, "Database block size:")) != NULL)
308 if (p == NULL || strlen(p) <= 1)
309 pg_fatal("%d: controldata retrieval problem\n", __LINE__);
311 p++; /* remove ':' char */
312 cluster->controldata.blocksz = str2uint(p);
315 else if ((p = strstr(bufin, "Blocks per segment of large relation:")) != NULL)
319 if (p == NULL || strlen(p) <= 1)
320 pg_fatal("%d: controldata retrieval problem\n", __LINE__);
322 p++; /* remove ':' char */
323 cluster->controldata.largesz = str2uint(p);
326 else if ((p = strstr(bufin, "WAL block size:")) != NULL)
330 if (p == NULL || strlen(p) <= 1)
331 pg_fatal("%d: controldata retrieval problem\n", __LINE__);
333 p++; /* remove ':' char */
334 cluster->controldata.walsz = str2uint(p);
337 else if ((p = strstr(bufin, "Bytes per WAL segment:")) != NULL)
341 if (p == NULL || strlen(p) <= 1)
342 pg_fatal("%d: controldata retrieval problem\n", __LINE__);
344 p++; /* remove ':' char */
345 cluster->controldata.walseg = str2uint(p);
348 else if ((p = strstr(bufin, "Maximum length of identifiers:")) != NULL)
352 if (p == NULL || strlen(p) <= 1)
353 pg_fatal("%d: controldata retrieval problem\n", __LINE__);
355 p++; /* remove ':' char */
356 cluster->controldata.ident = str2uint(p);
359 else if ((p = strstr(bufin, "Maximum columns in an index:")) != NULL)
363 if (p == NULL || strlen(p) <= 1)
364 pg_fatal("%d: controldata retrieval problem\n", __LINE__);
366 p++; /* remove ':' char */
367 cluster->controldata.index = str2uint(p);
370 else if ((p = strstr(bufin, "Maximum size of a TOAST chunk:")) != NULL)
374 if (p == NULL || strlen(p) <= 1)
375 pg_fatal("%d: controldata retrieval problem\n", __LINE__);
377 p++; /* remove ':' char */
378 cluster->controldata.toast = str2uint(p);
381 else if ((p = strstr(bufin, "Size of a large-object chunk:")) != NULL)
385 if (p == NULL || strlen(p) <= 1)
386 pg_fatal("%d: controldata retrieval problem\n", __LINE__);
388 p++; /* remove ':' char */
389 cluster->controldata.large_object = str2uint(p);
390 got_large_object = true;
392 else if ((p = strstr(bufin, "Date/time type storage:")) != NULL)
396 if (p == NULL || strlen(p) <= 1)
397 pg_fatal("%d: controldata retrieval problem\n", __LINE__);
399 p++; /* remove ':' char */
400 cluster->controldata.date_is_int = strstr(p, "64-bit integers") != NULL;
401 got_date_is_int = true;
403 else if ((p = strstr(bufin, "checksum")) != NULL)
407 if (p == NULL || strlen(p) <= 1)
408 pg_fatal("%d: controldata retrieval problem\n", __LINE__);
410 p++; /* remove ':' char */
411 /* used later for contrib check */
412 cluster->controldata.data_checksum_version = str2uint(p);
413 got_data_checksum_version = true;
420 * Restore environment variables
422 pg_putenv("LC_COLLATE", lc_collate);
423 pg_putenv("LC_CTYPE", lc_ctype);
424 pg_putenv("LC_MONETARY", lc_monetary);
425 pg_putenv("LC_NUMERIC", lc_numeric);
426 pg_putenv("LC_TIME", lc_time);
427 pg_putenv("LANG", lang);
428 pg_putenv("LANGUAGE", language);
429 pg_putenv("LC_ALL", lc_all);
430 pg_putenv("LC_MESSAGES", lc_messages);
434 pg_free(lc_monetary);
440 pg_free(lc_messages);
443 * Before 9.3, pg_resetxlog reported the xlogid and segno of the first log
444 * file after reset as separate lines. Starting with 9.3, it reports the
445 * WAL file name. If the old cluster is older than 9.3, we construct the
446 * WAL file name from the xlogid and segno.
448 if (GET_MAJOR_VERSION(cluster->major_version) <= 902)
450 if (got_tli && got_log_id && got_log_seg)
452 snprintf(cluster->controldata.nextxlogfile, 25, "%08X%08X%08X",
454 got_nextxlogfile = true;
458 /* verify that we got all the mandatory pg_control data */
459 if (!got_xid || !got_oid ||
462 cluster->controldata.cat_ver >= MULTIXACT_FORMATCHANGE_CAT_VER) ||
463 !got_mxoff || (!live_check && !got_nextxlogfile) ||
464 !got_float8_pass_by_value || !got_align || !got_blocksz ||
465 !got_largesz || !got_walsz || !got_walseg || !got_ident ||
466 !got_index || !got_toast ||
467 (!got_large_object &&
468 cluster->controldata.ctrl_ver >= LARGE_OBJECT_SIZE_PG_CONTROL_VER) ||
469 !got_date_is_int || !got_data_checksum_version)
472 "The %s cluster lacks some required control information:\n",
473 CLUSTER_NAME(cluster));
476 pg_log(PG_REPORT, " checkpoint next XID\n");
479 pg_log(PG_REPORT, " latest checkpoint next OID\n");
482 pg_log(PG_REPORT, " latest checkpoint next MultiXactId\n");
484 if (!got_oldestmulti &&
485 cluster->controldata.cat_ver >= MULTIXACT_FORMATCHANGE_CAT_VER)
486 pg_log(PG_REPORT, " latest checkpoint oldest MultiXactId\n");
489 pg_log(PG_REPORT, " latest checkpoint next MultiXactOffset\n");
491 if (!live_check && !got_nextxlogfile)
492 pg_log(PG_REPORT, " first WAL segment after reset\n");
494 if (!got_float8_pass_by_value)
495 pg_log(PG_REPORT, " float8 argument passing method\n");
498 pg_log(PG_REPORT, " maximum alignment\n");
501 pg_log(PG_REPORT, " block size\n");
504 pg_log(PG_REPORT, " large relation segment size\n");
507 pg_log(PG_REPORT, " WAL block size\n");
510 pg_log(PG_REPORT, " WAL segment size\n");
513 pg_log(PG_REPORT, " maximum identifier length\n");
516 pg_log(PG_REPORT, " maximum number of indexed columns\n");
519 pg_log(PG_REPORT, " maximum TOAST chunk size\n");
521 if (!got_large_object &&
522 cluster->controldata.ctrl_ver >= LARGE_OBJECT_SIZE_PG_CONTROL_VER)
523 pg_log(PG_REPORT, " large-object chunk size\n");
525 if (!got_date_is_int)
526 pg_log(PG_REPORT, " dates/times are integers?\n");
528 /* value added in Postgres 9.3 */
529 if (!got_data_checksum_version)
530 pg_log(PG_REPORT, " data checksum version\n");
532 pg_fatal("Cannot continue without required control information, terminating\n");
538 * check_control_data()
540 * check to make sure the control data settings are compatible
543 check_control_data(ControlData *oldctrl,
544 ControlData *newctrl)
546 if (oldctrl->align == 0 || oldctrl->align != newctrl->align)
547 pg_fatal("old and new pg_controldata alignments are invalid or do not match\n"
548 "Likely one cluster is a 32-bit install, the other 64-bit\n");
550 if (oldctrl->blocksz == 0 || oldctrl->blocksz != newctrl->blocksz)
551 pg_fatal("old and new pg_controldata block sizes are invalid or do not match\n");
553 if (oldctrl->largesz == 0 || oldctrl->largesz != newctrl->largesz)
554 pg_fatal("old and new pg_controldata maximum relation segment sizes are invalid or do not match\n");
556 if (oldctrl->walsz == 0 || oldctrl->walsz != newctrl->walsz)
557 pg_fatal("old and new pg_controldata WAL block sizes are invalid or do not match\n");
559 if (oldctrl->walseg == 0 || oldctrl->walseg != newctrl->walseg)
560 pg_fatal("old and new pg_controldata WAL segment sizes are invalid or do not match\n");
562 if (oldctrl->ident == 0 || oldctrl->ident != newctrl->ident)
563 pg_fatal("old and new pg_controldata maximum identifier lengths are invalid or do not match\n");
565 if (oldctrl->index == 0 || oldctrl->index != newctrl->index)
566 pg_fatal("old and new pg_controldata maximum indexed columns are invalid or do not match\n");
568 if (oldctrl->toast == 0 || oldctrl->toast != newctrl->toast)
569 pg_fatal("old and new pg_controldata maximum TOAST chunk sizes are invalid or do not match\n");
571 /* large_object added in 9.5, so it might not exist in the old cluster */
572 if (oldctrl->large_object != 0 &&
573 oldctrl->large_object != newctrl->large_object)
574 pg_fatal("old and new pg_controldata large-object chunk sizes are invalid or do not match\n");
576 if (oldctrl->date_is_int != newctrl->date_is_int)
577 pg_fatal("old and new pg_controldata date/time storage types do not match\n");
580 * float8_pass_by_value does not need to match, but is used in
581 * check_for_isn_and_int8_passing_mismatch().
585 * We might eventually allow upgrades from checksum to no-checksum
588 if (oldctrl->data_checksum_version == 0 &&
589 newctrl->data_checksum_version != 0)
590 pg_fatal("old cluster does not use data checksums but the new one does\n");
591 else if (oldctrl->data_checksum_version != 0 &&
592 newctrl->data_checksum_version == 0)
593 pg_fatal("old cluster uses data checksums but the new one does not\n");
594 else if (oldctrl->data_checksum_version != newctrl->data_checksum_version)
595 pg_fatal("old and new cluster pg_controldata checksum versions do not match\n");
600 disable_old_cluster(void)
602 char old_path[MAXPGPATH],
605 /* rename pg_control so old server cannot be accidentally started */
606 prep_status("Adding \".old\" suffix to old global/pg_control");
608 snprintf(old_path, sizeof(old_path), "%s/global/pg_control", old_cluster.pgdata);
609 snprintf(new_path, sizeof(new_path), "%s/global/pg_control.old", old_cluster.pgdata);
610 if (pg_mv_file(old_path, new_path) != 0)
611 pg_fatal("Unable to rename %s to %s.\n", old_path, new_path);
614 pg_log(PG_REPORT, "\n"
615 "If you want to start the old cluster, you will need to remove\n"
616 "the \".old\" suffix from %s/global/pg_control.old.\n"
617 "Because \"link\" mode was used, the old cluster cannot be safely\n"
618 "started once the new cluster has been started.\n\n", old_cluster.pgdata);