From 6fb2aa609348ad7df6f9c12da60c07aa96243965 Mon Sep 17 00:00:00 2001 From: Michael Paquier Date: Tue, 29 Nov 2022 15:17:27 +0900 Subject: [PATCH v9] Make the pg_receivewal compression parsing function common Also and relax parsing errors in the helper functions and re-introduce those as an independed function. As it is shown in the rest of the patch series, there is a lot of duplication between pg_dump's parsing of compression options and pg_receivewal's. Now the core work is done in common. However pg_dump would not error out if the requested compression algorithm is not supported by the build, whereas other callers will error out. Also it seems a bit weird for only one of the parsing functions for compressions to error out on missing support and that one to not be the one responsible for identifying the compression algorithm. A new function is added to test the support of the algorithm allowing the user to tune the behaviour. --- src/include/common/compression.h | 2 + src/common/compression.c | 63 +++++++++++++++++++++++++++ src/bin/pg_basebackup/pg_basebackup.c | 49 ++++----------------- src/bin/pg_basebackup/pg_receivewal.c | 61 -------------------------- 4 files changed, 73 insertions(+), 102 deletions(-) diff --git a/src/include/common/compression.h b/src/include/common/compression.h index 5d680058ed..46855b1a3b 100644 --- a/src/include/common/compression.h +++ b/src/include/common/compression.h @@ -33,6 +33,8 @@ typedef struct pg_compress_specification char *parse_error; /* NULL if parsing was OK, else message */ } pg_compress_specification; +extern void parse_compress_options(const char *option, char **algorithm, + char **detail); extern bool parse_compress_algorithm(char *name, pg_compress_algorithm *algorithm); extern const char *get_compress_algorithm_name(pg_compress_algorithm algorithm); diff --git a/src/common/compression.c b/src/common/compression.c index df5b627834..5274ba5ba8 100644 --- a/src/common/compression.c +++ b/src/common/compression.c @@ -356,3 +356,66 @@ validate_compress_specification(pg_compress_specification *spec) return NULL; } + +#ifdef FRONTEND + +/* + * Basic parsing of a value specified through a command-line option, commonly + * -Z/--compress. + * + * The parsing consists of a METHOD:DETAIL string fed later to + * parse_compress_specification(). This only extracts METHOD and DETAIL. + * If only an integer is found, the method is implied by the value specified. + */ +void +parse_compress_options(const char *option, char **algorithm, char **detail) +{ + char *sep; + char *endp; + long result; + + /* + * Check whether the compression specification consists of a bare integer. + * + * For backward-compatibility, assume "none" if the integer found is zero + * and "gzip" otherwise. + */ + result = strtol(option, &endp, 10); + if (*endp == '\0') + { + if (result == 0) + { + *algorithm = pstrdup("none"); + *detail = NULL; + } + else + { + *algorithm = pstrdup("gzip"); + *detail = pstrdup(option); + } + return; + } + + /* + * Check whether there is a compression detail following the algorithm + * name. + */ + sep = strchr(option, ':'); + if (sep == NULL) + { + *algorithm = pstrdup(option); + *detail = NULL; + } + else + { + char *alg; + + alg = palloc((sep - option) + 1); + memcpy(alg, option, sep - option); + alg[sep - option] = '\0'; + + *algorithm = alg; + *detail = pstrdup(sep + 1); + } +} +#endif /* FRONTEND */ diff --git a/src/bin/pg_basebackup/pg_basebackup.c b/src/bin/pg_basebackup/pg_basebackup.c index 22836ca01a..4f56c9f464 100644 --- a/src/bin/pg_basebackup/pg_basebackup.c +++ b/src/bin/pg_basebackup/pg_basebackup.c @@ -956,27 +956,13 @@ parse_max_rate(char *src) * at a later stage. */ static void -parse_compress_options(char *option, char **algorithm, char **detail, - CompressionLocation *locationres) +backup_parse_compress_options(char *option, char **algorithm, char **detail, + CompressionLocation *locationres) { - char *sep; - char *endp; - /* - * Check whether the compression specification consists of a bare integer. - * - * If so, for backward compatibility, assume gzip. + * Strip off any "client-" or "server-" prefix, calculating the + * location. */ - (void) strtol(option, &endp, 10); - if (*endp == '\0') - { - *locationres = COMPRESS_LOCATION_UNSPECIFIED; - *algorithm = pstrdup("gzip"); - *detail = pstrdup(option); - return; - } - - /* Strip off any "client-" or "server-" prefix. */ if (strncmp(option, "server-", 7) == 0) { *locationres = COMPRESS_LOCATION_SERVER; @@ -990,27 +976,8 @@ parse_compress_options(char *option, char **algorithm, char **detail, else *locationres = COMPRESS_LOCATION_UNSPECIFIED; - /* - * Check whether there is a compression detail following the algorithm - * name. - */ - sep = strchr(option, ':'); - if (sep == NULL) - { - *algorithm = pstrdup(option); - *detail = NULL; - } - else - { - char *alg; - - alg = palloc((sep - option) + 1); - memcpy(alg, option, sep - option); - alg[sep - option] = '\0'; - - *algorithm = alg; - *detail = pstrdup(sep + 1); - } + /* fallback to the common parsing for the algorithm and detail */ + parse_compress_options(option, algorithm, detail); } /* @@ -2411,8 +2378,8 @@ main(int argc, char **argv) compressloc = COMPRESS_LOCATION_UNSPECIFIED; break; case 'Z': - parse_compress_options(optarg, &compression_algorithm, - &compression_detail, &compressloc); + backup_parse_compress_options(optarg, &compression_algorithm, + &compression_detail, &compressloc); break; case 'c': if (pg_strcasecmp(optarg, "fast") == 0) diff --git a/src/bin/pg_basebackup/pg_receivewal.c b/src/bin/pg_basebackup/pg_receivewal.c index 63207ca025..c7a46b8a2a 100644 --- a/src/bin/pg_basebackup/pg_receivewal.c +++ b/src/bin/pg_basebackup/pg_receivewal.c @@ -57,8 +57,6 @@ static XLogRecPtr endpos = InvalidXLogRecPtr; static void usage(void); -static void parse_compress_options(char *option, char **algorithm, - char **detail); static DIR *get_destination_dir(char *dest_folder); static void close_destination_dir(DIR *dest_dir, char *dest_folder); static XLogRecPtr FindStreamingStart(uint32 *tli); @@ -109,65 +107,6 @@ usage(void) printf(_("%s home page: <%s>\n"), PACKAGE_NAME, PACKAGE_URL); } -/* - * Basic parsing of a value specified for -Z/--compress - * - * The parsing consists of a METHOD:DETAIL string fed later on to a more - * advanced routine in charge of proper validation checks. This only extracts - * METHOD and DETAIL. If only an integer is found, the method is implied by - * the value specified. - */ -static void -parse_compress_options(char *option, char **algorithm, char **detail) -{ - char *sep; - char *endp; - long result; - - /* - * Check whether the compression specification consists of a bare integer. - * - * For backward-compatibility, assume "none" if the integer found is zero - * and "gzip" otherwise. - */ - result = strtol(option, &endp, 10); - if (*endp == '\0') - { - if (result == 0) - { - *algorithm = pstrdup("none"); - *detail = NULL; - } - else - { - *algorithm = pstrdup("gzip"); - *detail = pstrdup(option); - } - return; - } - - /* - * Check whether there is a compression detail following the algorithm - * name. - */ - sep = strchr(option, ':'); - if (sep == NULL) - { - *algorithm = pstrdup(option); - *detail = NULL; - } - else - { - char *alg; - - alg = palloc((sep - option) + 1); - memcpy(alg, option, sep - option); - alg[sep - option] = '\0'; - - *algorithm = alg; - *detail = pstrdup(sep + 1); - } -} /* * Check if the filename looks like a WAL file, letting caller know if this -- 2.38.1