Add support to make cluster for valgrind (#689)

You can run cluster using valgrind with:
```
make cluster VALGRIND=1
```

Author: JelteF

.gitignore

@@ -50,3 +50,4 @@ docs/tikz/*.png
 
 # Exclude our demo/test tmux directory
 tmux/
+valgrind/

Dockerfile

@@ -31,6 +31,7 @@ RUN apt-get update \
     watch \
     lsof \
     psutils \
+	valgrind \
     postgresql-common \
     postgresql-server-dev-${PGVERSION} \
 	&& rm -rf /var/lib/apt/lists/*

Makefile

@@ -55,7 +55,15 @@ FSM = docs/fsm.png
 PDF = ./docs/_build/latex/pg_auto_failover.pdf
 
 # Command line with DEBUG facilities
-PG_AUTOCTL = PG_AUTOCTL_DEBUG=1 ./src/bin/pg_autoctl/pg_autoctl
+VALGRIND ?=
+ifeq ($(VALGRIND),)
+	BINPATH = ./src/bin/pg_autoctl/pg_autoctl
+	PG_AUTOCTL = PG_AUTOCTL_DEBUG=1 ./src/bin/pg_autoctl/pg_autoctl
+else
+	BINPATH = ./src/tools/pg_autoctl.valgrind
+	PG_AUTOCTL = PG_AUTOCTL_DEBUG=1 ./src/tools/pg_autoctl.valgrind
+endif
+
 
 NODES ?= 2						# total count of Postgres nodes
 NODES_ASYNC ?= 0				# count of replication-quorum false nodes
@@ -181,6 +189,7 @@ $(TMUX_SCRIPT): bin
          --node-priorities $(NODES_PRIOS) \
          --sync-standbys $(NODES_SYNC_SB) \
          $(CLUSTER_OPTS)                  \
+         --binpath $(BINPATH)             \
 		 --layout $(TMUX_LAYOUT) > $@
 
 tmux-script: $(TMUX_SCRIPT) ;
@@ -200,6 +209,7 @@ cluster: install tmux-clean
          --node-priorities $(NODES_PRIOS) \
          --sync-standbys $(NODES_SYNC_SB) \
          $(CLUSTER_OPTS)                  \
+         --binpath $(BINPATH)             \
          --layout $(TMUX_LAYOUT)
 
 

src/bin/pg_autoctl/cli_do_root.c

@@ -223,7 +223,8 @@ CommandLine do_tmux_script =
 				 "  --node-priorities list of nodes priorities (50)\n"
 				 "  --sync-standbys   number-sync-standbys to set (0 or 1)\n"
 				 "  --skip-pg-hba     use --skip-pg-hba when creating nodes\n"
-				 "  --layout          tmux layout to use (even-vertical)",
+				 "  --layout          tmux layout to use (even-vertical)\n"
+				 "  --binpath         path to the pg_autoctl binary (current binary path)",
 				 cli_do_tmux_script_getopts,
 				 cli_do_tmux_script);
 
@@ -238,7 +239,8 @@ CommandLine do_tmux_session =
 				 "  --node-priorities list of nodes priorities (50)\n"
 				 "  --sync-standbys   number-sync-standbys to set (0 or 1)\n"
 				 "  --skip-pg-hba     use --skip-pg-hba when creating nodes\n"
-				 "  --layout          tmux layout to use (even-vertical)",
+				 "  --layout          tmux layout to use (even-vertical)\n"
+				 "  --binpath         path to the pg_autoctl binary (current binary path)",
 				 cli_do_tmux_script_getopts,
 				 cli_do_tmux_session);
 

src/bin/pg_autoctl/cli_do_tmux.c

@@ -212,6 +212,7 @@ cli_do_tmux_script_getopts(int argc, char **argv)
 		{ "sync-standbys", required_argument, NULL, 's' },
 		{ "skip-pg-hba", required_argument, NULL, 'S' },
 		{ "layout", required_argument, NULL, 'l' },
+		{ "binpath", required_argument, NULL, 'b' },
 		{ "version", no_argument, NULL, 'V' },
 		{ "verbose", no_argument, NULL, 'v' },
 		{ "quiet", no_argument, NULL, 'q' },
@@ -229,6 +230,7 @@ cli_do_tmux_script_getopts(int argc, char **argv)
 	options.skipHBA = false;
 	strlcpy(options.root, "/tmp/pgaf/tmux", sizeof(options.root));
 	strlcpy(options.layout, "even-vertical", sizeof(options.layout));
+	strlcpy(options.binpath, pg_autoctl_argv0, sizeof(options.binpath));
 
 	if (!parseCandidatePriorities("", options.priorities))
 	{
@@ -345,6 +347,13 @@ cli_do_tmux_script_getopts(int argc, char **argv)
 				break;
 			}
 
+			case 'b':
+			{
+				strlcpy(options.binpath, optarg, MAXPGPATH);
+				log_trace("--binpath %s", options.binpath);
+				break;
+			}
+
 			case 'h':
 			{
 				commandline_help(stderr);
@@ -406,6 +415,7 @@ cli_do_tmux_script_getopts(int argc, char **argv)
 		exit(EXIT_CODE_BAD_ARGS);
 	}
 
+
 	if (errors > 0)
 	{
 		commandline_help(stderr);
@@ -622,6 +632,7 @@ tmux_add_new_session(PQExpBuffer script, const char *root, int pgport)
 void
 tmux_pg_autoctl_create_monitor(PQExpBuffer script,
 							   const char *root,
+							   const char *binpath,
 							   int pgport,
 							   bool skipHBA)
 {
@@ -637,7 +648,7 @@ tmux_pg_autoctl_create_monitor(PQExpBuffer script,
 
 	tmux_add_send_keys_command(script,
 							   "%s create monitor %s --run",
-							   pg_autoctl_argv0,
+							   binpath,
 							   pg_ctl_opts);
 }
 
@@ -649,6 +660,7 @@ tmux_pg_autoctl_create_monitor(PQExpBuffer script,
 void
 tmux_pg_autoctl_create_postgres(PQExpBuffer script,
 								const char *root,
+								const char *binpath,
 								int pgport,
 								const char *name,
 								bool replicationQuorum,
@@ -665,7 +677,7 @@ tmux_pg_autoctl_create_postgres(PQExpBuffer script,
 
 	sformat(monitor, sizeof(monitor),
 			"$(%s show uri --pgdata %s/monitor --formation monitor)",
-			pg_autoctl_argv0,
+			binpath,
 			root);
 
 	tmux_add_send_keys_command(script,
@@ -681,7 +693,7 @@ tmux_pg_autoctl_create_postgres(PQExpBuffer script,
 							   "--replication-quorum %s "
 							   "--candidate-priority %d "
 							   "--run",
-							   pg_autoctl_argv0,
+							   binpath,
 							   pg_ctl_opts,
 							   monitor,
 							   name,
@@ -712,7 +724,8 @@ prepare_tmux_script(TmuxOptions *options, PQExpBuffer script)
 
 	/* start a monitor */
 	(void) tmux_add_xdg_environment(script);
-	tmux_pg_autoctl_create_monitor(script, root, pgport++, options->skipHBA);
+	tmux_pg_autoctl_create_monitor(script, root, options->binpath, pgport++,
+								   options->skipHBA);
 
 	/* start the Postgres nodes, using the monitor URI */
 	sformat(previousName, sizeof(previousName), "monitor");
@@ -733,12 +746,13 @@ prepare_tmux_script(TmuxOptions *options, PQExpBuffer script)
 		tmux_add_send_keys_command(script,
 								   "PG_AUTOCTL_DEBUG=1 "
 								   "%s do tmux wait --root %s %s",
-								   pg_autoctl_argv0,
+								   options->binpath,
 								   options->root,
 								   previousName);
 
 		tmux_pg_autoctl_create_postgres(script,
 										root,
+										options->binpath,
 										node->pgport,
 										node->name,
 										node->replicationQuorum,
@@ -757,12 +771,12 @@ prepare_tmux_script(TmuxOptions *options, PQExpBuffer script)
 	tmux_add_send_keys_command(script,
 							   "PG_AUTOCTL_DEBUG=1 "
 							   "%s do tmux wait --root %s %s",
-							   pg_autoctl_argv0,
+							   options->binpath,
 							   options->root,
 							   "monitor");
 	tmux_add_send_keys_command(script,
 							   "watch -n 0.2 %s show state",
-							   pg_autoctl_argv0);
+							   options->binpath);
 
 	/* add a window for interactive pg_autoctl commands */
 	tmux_add_command(script, "split-window -v");
@@ -785,15 +799,15 @@ prepare_tmux_script(TmuxOptions *options, PQExpBuffer script)
 		tmux_add_send_keys_command(script,
 								   "PG_AUTOCTL_DEBUG=1 "
 								   "%s do tmux wait --root %s %s %s",
-								   pg_autoctl_argv0,
+								   options->binpath,
 								   options->root,
 								   firstNode,
 								   NodeStateToString(targetPrimaryState));
 
 		/* PGDATA has just been exported, rely on it */
 		tmux_add_send_keys_command(script,
 								   "%s set formation number-sync-standbys %d",
-								   pg_autoctl_argv0,
+								   options->binpath,
 								   options->numSync);
 	}
 

src/bin/pg_autoctl/cli_do_tmux.h

@@ -38,6 +38,7 @@ typedef struct TmuxOptions
 	int numSync;                /* number-sync-standbys */
 	bool skipHBA;               /* do we want to use --skip-pg-hba? */
 	char layout[BUFSIZE];
+	char binpath[MAXPGPATH];
 } TmuxOptions;
 
 typedef struct TmuxNode
@@ -78,11 +79,13 @@ bool tmux_prepare_XDG_environment(const char *root,
 
 void tmux_pg_autoctl_create_monitor(PQExpBuffer script,
 									const char *root,
+									const char *binpath,
 									int pgport,
 									bool skipHBA);
 
 void tmux_pg_autoctl_create_postgres(PQExpBuffer script,
 									 const char *root,
+									 const char *binpath,
 									 int pgport,
 									 const char *name,
 									 bool replicationQuorum,

src/tools/pg_autoctl.valgrind

@@ -0,0 +1,7 @@
+#!/bin/bash
+set -euo pipefail
+script_dir="${0%/*}"
+pid=$$
+mkdir -p valgrind
+exec /usr/bin/valgrind --quiet --leak-check=yes --error-markers=VALGRINDERROR-BEGIN,VALGRINDERROR-END --max-stackframe=16000000 --log-file=./valgrind/log.${pid} "${script_dir}/../bin/pg_autoctl/pg_autoctl" "$@"
+