Line data Source code
1 : /*
2 : * pgbench.c
3 : *
4 : * A simple benchmark program for PostgreSQL
5 : * Originally written by Tatsuo Ishii and enhanced by many contributors.
6 : *
7 : * src/bin/pgbench/pgbench.c
8 : * Copyright (c) 2000-2025, PostgreSQL Global Development Group
9 : * ALL RIGHTS RESERVED;
10 : *
11 : * Permission to use, copy, modify, and distribute this software and its
12 : * documentation for any purpose, without fee, and without a written agreement
13 : * is hereby granted, provided that the above copyright notice and this
14 : * paragraph and the following two paragraphs appear in all copies.
15 : *
16 : * IN NO EVENT SHALL THE AUTHOR OR DISTRIBUTORS BE LIABLE TO ANY PARTY FOR
17 : * DIRECT, INDIRECT, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES, INCLUDING
18 : * LOST PROFITS, ARISING OUT OF THE USE OF THIS SOFTWARE AND ITS
19 : * DOCUMENTATION, EVEN IF THE AUTHOR OR DISTRIBUTORS HAVE BEEN ADVISED OF THE
20 : * POSSIBILITY OF SUCH DAMAGE.
21 : *
22 : * THE AUTHOR AND DISTRIBUTORS SPECIFICALLY DISCLAIMS ANY WARRANTIES,
23 : * INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY
24 : * AND FITNESS FOR A PARTICULAR PURPOSE. THE SOFTWARE PROVIDED HEREUNDER IS
25 : * ON AN "AS IS" BASIS, AND THE AUTHOR AND DISTRIBUTORS HAS NO OBLIGATIONS TO
26 : * PROVIDE MAINTENANCE, SUPPORT, UPDATES, ENHANCEMENTS, OR MODIFICATIONS.
27 : *
28 : */
29 :
30 : #if defined(WIN32) && FD_SETSIZE < 1024
31 : #error FD_SETSIZE needs to have been increased
32 : #endif
33 :
34 : #include "postgres_fe.h"
35 :
36 : #include <ctype.h>
37 : #include <float.h>
38 : #include <limits.h>
39 : #include <math.h>
40 : #include <signal.h>
41 : #include <time.h>
42 : #include <sys/time.h>
43 : #include <sys/resource.h> /* for getrlimit */
44 :
45 : /* For testing, PGBENCH_USE_SELECT can be defined to force use of that code */
46 : #if defined(HAVE_PPOLL) && !defined(PGBENCH_USE_SELECT)
47 : #define POLL_USING_PPOLL
48 : #ifdef HAVE_POLL_H
49 : #include <poll.h>
50 : #endif
51 : #else /* no ppoll(), so use select() */
52 : #define POLL_USING_SELECT
53 : #include <sys/select.h>
54 : #endif
55 :
56 : #include "catalog/pg_class_d.h"
57 : #include "common/int.h"
58 : #include "common/logging.h"
59 : #include "common/pg_prng.h"
60 : #include "common/string.h"
61 : #include "common/username.h"
62 : #include "fe_utils/cancel.h"
63 : #include "fe_utils/conditional.h"
64 : #include "fe_utils/option_utils.h"
65 : #include "fe_utils/string_utils.h"
66 : #include "getopt_long.h"
67 : #include "libpq-fe.h"
68 : #include "pgbench.h"
69 : #include "port/pg_bitutils.h"
70 : #include "portability/instr_time.h"
71 :
72 : /* X/Open (XSI) requires <math.h> to provide M_PI, but core POSIX does not */
73 : #ifndef M_PI
74 : #define M_PI 3.14159265358979323846
75 : #endif
76 :
77 : #define ERRCODE_T_R_SERIALIZATION_FAILURE "40001"
78 : #define ERRCODE_T_R_DEADLOCK_DETECTED "40P01"
79 : #define ERRCODE_UNDEFINED_TABLE "42P01"
80 :
81 : /*
82 : * Hashing constants
83 : */
84 : #define FNV_PRIME UINT64CONST(0x100000001b3)
85 : #define FNV_OFFSET_BASIS UINT64CONST(0xcbf29ce484222325)
86 : #define MM2_MUL UINT64CONST(0xc6a4a7935bd1e995)
87 : #define MM2_MUL_TIMES_8 UINT64CONST(0x35253c9ade8f4ca8)
88 : #define MM2_ROT 47
89 :
90 : /*
91 : * Multi-platform socket set implementations
92 : */
93 :
94 : #ifdef POLL_USING_PPOLL
95 : #define SOCKET_WAIT_METHOD "ppoll"
96 :
97 : typedef struct socket_set
98 : {
99 : int maxfds; /* allocated length of pollfds[] array */
100 : int curfds; /* number currently in use */
101 : struct pollfd pollfds[FLEXIBLE_ARRAY_MEMBER];
102 : } socket_set;
103 :
104 : #endif /* POLL_USING_PPOLL */
105 :
106 : #ifdef POLL_USING_SELECT
107 : #define SOCKET_WAIT_METHOD "select"
108 :
109 : typedef struct socket_set
110 : {
111 : int maxfd; /* largest FD currently set in fds */
112 : fd_set fds;
113 : } socket_set;
114 :
115 : #endif /* POLL_USING_SELECT */
116 :
117 : /*
118 : * Multi-platform thread implementations
119 : */
120 :
121 : #ifdef WIN32
122 : /* Use Windows threads */
123 : #include <windows.h>
124 : #define GETERRNO() (_dosmaperr(GetLastError()), errno)
125 : #define THREAD_T HANDLE
126 : #define THREAD_FUNC_RETURN_TYPE unsigned
127 : #define THREAD_FUNC_RETURN return 0
128 : #define THREAD_FUNC_CC __stdcall
129 : #define THREAD_CREATE(handle, function, arg) \
130 : ((*(handle) = (HANDLE) _beginthreadex(NULL, 0, (function), (arg), 0, NULL)) == 0 ? errno : 0)
131 : #define THREAD_JOIN(handle) \
132 : (WaitForSingleObject(handle, INFINITE) != WAIT_OBJECT_0 ? \
133 : GETERRNO() : CloseHandle(handle) ? 0 : GETERRNO())
134 : #define THREAD_BARRIER_T SYNCHRONIZATION_BARRIER
135 : #define THREAD_BARRIER_INIT(barrier, n) \
136 : (InitializeSynchronizationBarrier((barrier), (n), 0) ? 0 : GETERRNO())
137 : #define THREAD_BARRIER_WAIT(barrier) \
138 : EnterSynchronizationBarrier((barrier), \
139 : SYNCHRONIZATION_BARRIER_FLAGS_BLOCK_ONLY)
140 : #define THREAD_BARRIER_DESTROY(barrier)
141 : #else
142 : /* Use POSIX threads */
143 : #include "port/pg_pthread.h"
144 : #define THREAD_T pthread_t
145 : #define THREAD_FUNC_RETURN_TYPE void *
146 : #define THREAD_FUNC_RETURN return NULL
147 : #define THREAD_FUNC_CC
148 : #define THREAD_CREATE(handle, function, arg) \
149 : pthread_create((handle), NULL, (function), (arg))
150 : #define THREAD_JOIN(handle) \
151 : pthread_join((handle), NULL)
152 : #define THREAD_BARRIER_T pthread_barrier_t
153 : #define THREAD_BARRIER_INIT(barrier, n) \
154 : pthread_barrier_init((barrier), NULL, (n))
155 : #define THREAD_BARRIER_WAIT(barrier) pthread_barrier_wait((barrier))
156 : #define THREAD_BARRIER_DESTROY(barrier) pthread_barrier_destroy((barrier))
157 : #endif
158 :
159 :
160 : /********************************************************************
161 : * some configurable parameters */
162 :
163 : #define DEFAULT_INIT_STEPS "dtgvp" /* default -I setting */
164 : #define ALL_INIT_STEPS "dtgGvpf" /* all possible steps */
165 :
166 : #define LOG_STEP_SECONDS 5 /* seconds between log messages */
167 : #define DEFAULT_NXACTS 10 /* default nxacts */
168 :
169 : #define MIN_GAUSSIAN_PARAM 2.0 /* minimum parameter for gauss */
170 :
171 : #define MIN_ZIPFIAN_PARAM 1.001 /* minimum parameter for zipfian */
172 : #define MAX_ZIPFIAN_PARAM 1000.0 /* maximum parameter for zipfian */
173 :
174 : static int nxacts = 0; /* number of transactions per client */
175 : static int duration = 0; /* duration in seconds */
176 : static int64 end_time = 0; /* when to stop in micro seconds, under -T */
177 :
178 : /*
179 : * scaling factor. for example, scale = 10 will make 1000000 tuples in
180 : * pgbench_accounts table.
181 : */
182 : static int scale = 1;
183 :
184 : /*
185 : * fillfactor. for example, fillfactor = 90 will use only 90 percent
186 : * space during inserts and leave 10 percent free.
187 : */
188 : static int fillfactor = 100;
189 :
190 : /*
191 : * use unlogged tables?
192 : */
193 : static bool unlogged_tables = false;
194 :
195 : /*
196 : * log sampling rate (1.0 = log everything, 0.0 = option not given)
197 : */
198 : static double sample_rate = 0.0;
199 :
200 : /*
201 : * When threads are throttled to a given rate limit, this is the target delay
202 : * to reach that rate in usec. 0 is the default and means no throttling.
203 : */
204 : static double throttle_delay = 0;
205 :
206 : /*
207 : * Transactions which take longer than this limit (in usec) are counted as
208 : * late, and reported as such, although they are completed anyway. When
209 : * throttling is enabled, execution time slots that are more than this late
210 : * are skipped altogether, and counted separately.
211 : */
212 : static int64 latency_limit = 0;
213 :
214 : /*
215 : * tablespace selection
216 : */
217 : static char *tablespace = NULL;
218 : static char *index_tablespace = NULL;
219 :
220 : /*
221 : * Number of "pgbench_accounts" partitions. 0 is the default and means no
222 : * partitioning.
223 : */
224 : static int partitions = 0;
225 :
226 : /* partitioning strategy for "pgbench_accounts" */
227 : typedef enum
228 : {
229 : PART_NONE, /* no partitioning */
230 : PART_RANGE, /* range partitioning */
231 : PART_HASH, /* hash partitioning */
232 : } partition_method_t;
233 :
234 : static partition_method_t partition_method = PART_NONE;
235 : static const char *const PARTITION_METHOD[] = {"none", "range", "hash"};
236 :
237 : /* random seed used to initialize base_random_sequence */
238 : static int64 random_seed = -1;
239 :
240 : /*
241 : * end of configurable parameters
242 : *********************************************************************/
243 :
244 : #define nbranches 1 /* Makes little sense to change this. Change
245 : * -s instead */
246 : #define ntellers 10
247 : #define naccounts 100000
248 :
249 : /*
250 : * The scale factor at/beyond which 32bit integers are incapable of storing
251 : * 64bit values.
252 : *
253 : * Although the actual threshold is 21474, we use 20000 because it is easier to
254 : * document and remember, and isn't that far away from the real threshold.
255 : */
256 : #define SCALE_32BIT_THRESHOLD 20000
257 :
258 : static bool use_log; /* log transaction latencies to a file */
259 : static bool use_quiet; /* quiet logging onto stderr */
260 : static int agg_interval; /* log aggregates instead of individual
261 : * transactions */
262 : static bool per_script_stats = false; /* whether to collect stats per script */
263 : static int progress = 0; /* thread progress report every this seconds */
264 : static bool progress_timestamp = false; /* progress report with Unix time */
265 : static int nclients = 1; /* number of clients */
266 : static int nthreads = 1; /* number of threads */
267 : static bool is_connect; /* establish connection for each transaction */
268 : static bool report_per_command = false; /* report per-command latencies,
269 : * retries after errors and failures
270 : * (errors without retrying) */
271 : static int main_pid; /* main process id used in log filename */
272 :
273 : /*
274 : * There are different types of restrictions for deciding that the current
275 : * transaction with a serialization/deadlock error can no longer be retried and
276 : * should be reported as failed:
277 : * - max_tries (--max-tries) can be used to limit the number of tries;
278 : * - latency_limit (-L) can be used to limit the total time of tries;
279 : * - duration (-T) can be used to limit the total benchmark time.
280 : *
281 : * They can be combined together, and you need to use at least one of them to
282 : * retry the transactions with serialization/deadlock errors. If none of them is
283 : * used, the default value of max_tries is 1 and such transactions will not be
284 : * retried.
285 : */
286 :
287 : /*
288 : * We cannot retry a transaction after the serialization/deadlock error if its
289 : * number of tries reaches this maximum; if its value is zero, it is not used.
290 : */
291 : static uint32 max_tries = 1;
292 :
293 : static bool failures_detailed = false; /* whether to group failures in
294 : * reports or logs by basic types */
295 :
296 : static const char *pghost = NULL;
297 : static const char *pgport = NULL;
298 : static const char *username = NULL;
299 : static const char *dbName = NULL;
300 : static char *logfile_prefix = NULL;
301 : static const char *progname;
302 :
303 : #define WSEP '@' /* weight separator */
304 :
305 : static volatile sig_atomic_t timer_exceeded = false; /* flag from signal
306 : * handler */
307 :
308 : /*
309 : * We don't want to allocate variables one by one; for efficiency, add a
310 : * constant margin each time it overflows.
311 : */
312 : #define VARIABLES_ALLOC_MARGIN 8
313 :
314 : /*
315 : * Variable definitions.
316 : *
317 : * If a variable only has a string value, "svalue" is that value, and value is
318 : * "not set". If the value is known, "value" contains the value (in any
319 : * variant).
320 : *
321 : * In this case "svalue" contains the string equivalent of the value, if we've
322 : * had occasion to compute that, or NULL if we haven't.
323 : */
324 : typedef struct
325 : {
326 : char *name; /* variable's name */
327 : char *svalue; /* its value in string form, if known */
328 : PgBenchValue value; /* actual variable's value */
329 : } Variable;
330 :
331 : /*
332 : * Data structure for client variables.
333 : */
334 : typedef struct
335 : {
336 : Variable *vars; /* array of variable definitions */
337 : int nvars; /* number of variables */
338 :
339 : /*
340 : * The maximum number of variables that we can currently store in 'vars'
341 : * without having to reallocate more space. We must always have max_vars
342 : * >= nvars.
343 : */
344 : int max_vars;
345 :
346 : bool vars_sorted; /* are variables sorted by name? */
347 : } Variables;
348 :
349 : #define MAX_SCRIPTS 128 /* max number of SQL scripts allowed */
350 : #define SHELL_COMMAND_SIZE 256 /* maximum size allowed for shell command */
351 :
352 : /*
353 : * Simple data structure to keep stats about something.
354 : *
355 : * XXX probably the first value should be kept and used as an offset for
356 : * better numerical stability...
357 : */
358 : typedef struct SimpleStats
359 : {
360 : int64 count; /* how many values were encountered */
361 : double min; /* the minimum seen */
362 : double max; /* the maximum seen */
363 : double sum; /* sum of values */
364 : double sum2; /* sum of squared values */
365 : } SimpleStats;
366 :
367 : /*
368 : * The instr_time type is expensive when dealing with time arithmetic. Define
369 : * a type to hold microseconds instead. Type int64 is good enough for about
370 : * 584500 years.
371 : */
372 : typedef int64 pg_time_usec_t;
373 :
374 : /*
375 : * Data structure to hold various statistics: per-thread and per-script stats
376 : * are maintained and merged together.
377 : */
378 : typedef struct StatsData
379 : {
380 : pg_time_usec_t start_time; /* interval start time, for aggregates */
381 :
382 : /*----------
383 : * Transactions are counted depending on their execution and outcome.
384 : * First a transaction may have started or not: skipped transactions occur
385 : * under --rate and --latency-limit when the client is too late to execute
386 : * them. Secondly, a started transaction may ultimately succeed or fail,
387 : * possibly after some retries when --max-tries is not one. Thus
388 : *
389 : * the number of all transactions =
390 : * 'skipped' (it was too late to execute them) +
391 : * 'cnt' (the number of successful transactions) +
392 : * 'failed' (the number of failed transactions).
393 : *
394 : * A successful transaction can have several unsuccessful tries before a
395 : * successful run. Thus
396 : *
397 : * 'cnt' (the number of successful transactions) =
398 : * successfully retried transactions (they got a serialization or a
399 : * deadlock error(s), but were
400 : * successfully retried from the very
401 : * beginning) +
402 : * directly successful transactions (they were successfully completed on
403 : * the first try).
404 : *
405 : * A failed transaction is defined as unsuccessfully retried transactions.
406 : * It can be one of two types:
407 : *
408 : * failed (the number of failed transactions) =
409 : * 'serialization_failures' (they got a serialization error and were not
410 : * successfully retried) +
411 : * 'deadlock_failures' (they got a deadlock error and were not
412 : * successfully retried).
413 : *
414 : * If the transaction was retried after a serialization or a deadlock
415 : * error this does not guarantee that this retry was successful. Thus
416 : *
417 : * 'retries' (number of retries) =
418 : * number of retries in all retried transactions =
419 : * number of retries in (successfully retried transactions +
420 : * failed transactions);
421 : *
422 : * 'retried' (number of all retried transactions) =
423 : * successfully retried transactions +
424 : * failed transactions.
425 : *----------
426 : */
427 : int64 cnt; /* number of successful transactions, not
428 : * including 'skipped' */
429 : int64 skipped; /* number of transactions skipped under --rate
430 : * and --latency-limit */
431 : int64 retries; /* number of retries after a serialization or
432 : * a deadlock error in all the transactions */
433 : int64 retried; /* number of all transactions that were
434 : * retried after a serialization or a deadlock
435 : * error (perhaps the last try was
436 : * unsuccessful) */
437 : int64 serialization_failures; /* number of transactions that were
438 : * not successfully retried after a
439 : * serialization error */
440 : int64 deadlock_failures; /* number of transactions that were not
441 : * successfully retried after a deadlock
442 : * error */
443 : SimpleStats latency;
444 : SimpleStats lag;
445 : } StatsData;
446 :
447 : /*
448 : * For displaying Unix epoch timestamps, as some time functions may have
449 : * another reference.
450 : */
451 : static pg_time_usec_t epoch_shift;
452 :
453 : /*
454 : * Error status for errors during script execution.
455 : */
456 : typedef enum EStatus
457 : {
458 : ESTATUS_NO_ERROR = 0,
459 : ESTATUS_META_COMMAND_ERROR,
460 :
461 : /* SQL errors */
462 : ESTATUS_SERIALIZATION_ERROR,
463 : ESTATUS_DEADLOCK_ERROR,
464 : ESTATUS_OTHER_SQL_ERROR,
465 : } EStatus;
466 :
467 : /*
468 : * Transaction status at the end of a command.
469 : */
470 : typedef enum TStatus
471 : {
472 : TSTATUS_IDLE,
473 : TSTATUS_IN_BLOCK,
474 : TSTATUS_CONN_ERROR,
475 : TSTATUS_OTHER_ERROR,
476 : } TStatus;
477 :
478 : /* Various random sequences are initialized from this one. */
479 : static pg_prng_state base_random_sequence;
480 :
481 : /* Synchronization barrier for start and connection */
482 : static THREAD_BARRIER_T barrier;
483 :
484 : /*
485 : * Connection state machine states.
486 : */
487 : typedef enum
488 : {
489 : /*
490 : * The client must first choose a script to execute. Once chosen, it can
491 : * either be throttled (state CSTATE_PREPARE_THROTTLE under --rate), start
492 : * right away (state CSTATE_START_TX) or not start at all if the timer was
493 : * exceeded (state CSTATE_FINISHED).
494 : */
495 : CSTATE_CHOOSE_SCRIPT,
496 :
497 : /*
498 : * CSTATE_START_TX performs start-of-transaction processing. Establishes
499 : * a new connection for the transaction in --connect mode, records the
500 : * transaction start time, and proceed to the first command.
501 : *
502 : * Note: once a script is started, it will either error or run till its
503 : * end, where it may be interrupted. It is not interrupted while running,
504 : * so pgbench --time is to be understood as tx are allowed to start in
505 : * that time, and will finish when their work is completed.
506 : */
507 : CSTATE_START_TX,
508 :
509 : /*
510 : * In CSTATE_PREPARE_THROTTLE state, we calculate when to begin the next
511 : * transaction, and advance to CSTATE_THROTTLE. CSTATE_THROTTLE state
512 : * sleeps until that moment, then advances to CSTATE_START_TX, or
513 : * CSTATE_FINISHED if the next transaction would start beyond the end of
514 : * the run.
515 : */
516 : CSTATE_PREPARE_THROTTLE,
517 : CSTATE_THROTTLE,
518 :
519 : /*
520 : * We loop through these states, to process each command in the script:
521 : *
522 : * CSTATE_START_COMMAND starts the execution of a command. On a SQL
523 : * command, the command is sent to the server, and we move to
524 : * CSTATE_WAIT_RESULT state unless in pipeline mode. On a \sleep
525 : * meta-command, the timer is set, and we enter the CSTATE_SLEEP state to
526 : * wait for it to expire. Other meta-commands are executed immediately. If
527 : * the command about to start is actually beyond the end of the script,
528 : * advance to CSTATE_END_TX.
529 : *
530 : * CSTATE_WAIT_RESULT waits until we get a result set back from the server
531 : * for the current command.
532 : *
533 : * CSTATE_SLEEP waits until the end of \sleep.
534 : *
535 : * CSTATE_END_COMMAND records the end-of-command timestamp, increments the
536 : * command counter, and loops back to CSTATE_START_COMMAND state.
537 : *
538 : * CSTATE_SKIP_COMMAND is used by conditional branches which are not
539 : * executed. It quickly skip commands that do not need any evaluation.
540 : * This state can move forward several commands, till there is something
541 : * to do or the end of the script.
542 : */
543 : CSTATE_START_COMMAND,
544 : CSTATE_WAIT_RESULT,
545 : CSTATE_SLEEP,
546 : CSTATE_END_COMMAND,
547 : CSTATE_SKIP_COMMAND,
548 :
549 : /*
550 : * States for failed commands.
551 : *
552 : * If the SQL/meta command fails, in CSTATE_ERROR clean up after an error:
553 : * (1) clear the conditional stack; (2) if we have an unterminated
554 : * (possibly failed) transaction block, send the rollback command to the
555 : * server and wait for the result in CSTATE_WAIT_ROLLBACK_RESULT. If
556 : * something goes wrong with rolling back, go to CSTATE_ABORTED.
557 : *
558 : * But if everything is ok we are ready for future transactions: if this
559 : * is a serialization or deadlock error and we can re-execute the
560 : * transaction from the very beginning, go to CSTATE_RETRY; otherwise go
561 : * to CSTATE_FAILURE.
562 : *
563 : * In CSTATE_RETRY report an error, set the same parameters for the
564 : * transaction execution as in the previous tries and process the first
565 : * transaction command in CSTATE_START_COMMAND.
566 : *
567 : * In CSTATE_FAILURE report a failure, set the parameters for the
568 : * transaction execution as they were before the first run of this
569 : * transaction (except for a random state) and go to CSTATE_END_TX to
570 : * complete this transaction.
571 : */
572 : CSTATE_ERROR,
573 : CSTATE_WAIT_ROLLBACK_RESULT,
574 : CSTATE_RETRY,
575 : CSTATE_FAILURE,
576 :
577 : /*
578 : * CSTATE_END_TX performs end-of-transaction processing. It calculates
579 : * latency, and logs the transaction. In --connect mode, it closes the
580 : * current connection.
581 : *
582 : * Then either starts over in CSTATE_CHOOSE_SCRIPT, or enters
583 : * CSTATE_FINISHED if we have no more work to do.
584 : */
585 : CSTATE_END_TX,
586 :
587 : /*
588 : * Final states. CSTATE_ABORTED means that the script execution was
589 : * aborted because a command failed, CSTATE_FINISHED means success.
590 : */
591 : CSTATE_ABORTED,
592 : CSTATE_FINISHED,
593 : } ConnectionStateEnum;
594 :
595 : /*
596 : * Connection state.
597 : */
598 : typedef struct
599 : {
600 : PGconn *con; /* connection handle to DB */
601 : int id; /* client No. */
602 : ConnectionStateEnum state; /* state machine's current state. */
603 : ConditionalStack cstack; /* enclosing conditionals state */
604 :
605 : /*
606 : * Separate randomness for each client. This is used for random functions
607 : * PGBENCH_RANDOM_* during the execution of the script.
608 : */
609 : pg_prng_state cs_func_rs;
610 :
611 : int use_file; /* index in sql_script for this client */
612 : int command; /* command number in script */
613 : int num_syncs; /* number of ongoing sync commands */
614 :
615 : /* client variables */
616 : Variables variables;
617 :
618 : /* various times about current transaction in microseconds */
619 : pg_time_usec_t txn_scheduled; /* scheduled start time of transaction */
620 : pg_time_usec_t sleep_until; /* scheduled start time of next cmd */
621 : pg_time_usec_t txn_begin; /* used for measuring schedule lag times */
622 : pg_time_usec_t stmt_begin; /* used for measuring statement latencies */
623 :
624 : /* whether client prepared each command of each script */
625 : bool **prepared;
626 :
627 : /*
628 : * For processing failures and repeating transactions with serialization
629 : * or deadlock errors:
630 : */
631 : EStatus estatus; /* the error status of the current transaction
632 : * execution; this is ESTATUS_NO_ERROR if
633 : * there were no errors */
634 : pg_prng_state random_state; /* random state */
635 : uint32 tries; /* how many times have we already tried the
636 : * current transaction? */
637 :
638 : /* per client collected stats */
639 : int64 cnt; /* client transaction count, for -t; skipped
640 : * and failed transactions are also counted
641 : * here */
642 : } CState;
643 :
644 : /*
645 : * Thread state
646 : */
647 : typedef struct
648 : {
649 : int tid; /* thread id */
650 : THREAD_T thread; /* thread handle */
651 : CState *state; /* array of CState */
652 : int nstate; /* length of state[] */
653 :
654 : /*
655 : * Separate randomness for each thread. Each thread option uses its own
656 : * random state to make all of them independent of each other and
657 : * therefore deterministic at the thread level.
658 : */
659 : pg_prng_state ts_choose_rs; /* random state for selecting a script */
660 : pg_prng_state ts_throttle_rs; /* random state for transaction throttling */
661 : pg_prng_state ts_sample_rs; /* random state for log sampling */
662 :
663 : int64 throttle_trigger; /* previous/next throttling (us) */
664 : FILE *logfile; /* where to log, or NULL */
665 :
666 : /* per thread collected stats in microseconds */
667 : pg_time_usec_t create_time; /* thread creation time */
668 : pg_time_usec_t started_time; /* thread is running */
669 : pg_time_usec_t bench_start; /* thread is benchmarking */
670 : pg_time_usec_t conn_duration; /* cumulated connection and disconnection
671 : * delays */
672 :
673 : StatsData stats;
674 : int64 latency_late; /* count executed but late transactions */
675 : } TState;
676 :
677 : /*
678 : * queries read from files
679 : */
680 : #define SQL_COMMAND 1
681 : #define META_COMMAND 2
682 :
683 : /*
684 : * max number of backslash command arguments or SQL variables,
685 : * including the command or SQL statement itself
686 : */
687 : #define MAX_ARGS 256
688 :
689 : typedef enum MetaCommand
690 : {
691 : META_NONE, /* not a known meta-command */
692 : META_SET, /* \set */
693 : META_SETSHELL, /* \setshell */
694 : META_SHELL, /* \shell */
695 : META_SLEEP, /* \sleep */
696 : META_GSET, /* \gset */
697 : META_ASET, /* \aset */
698 : META_IF, /* \if */
699 : META_ELIF, /* \elif */
700 : META_ELSE, /* \else */
701 : META_ENDIF, /* \endif */
702 : META_STARTPIPELINE, /* \startpipeline */
703 : META_SYNCPIPELINE, /* \syncpipeline */
704 : META_ENDPIPELINE, /* \endpipeline */
705 : } MetaCommand;
706 :
707 : typedef enum QueryMode
708 : {
709 : QUERY_SIMPLE, /* simple query */
710 : QUERY_EXTENDED, /* extended query */
711 : QUERY_PREPARED, /* extended query with prepared statements */
712 : NUM_QUERYMODE
713 : } QueryMode;
714 :
715 : static QueryMode querymode = QUERY_SIMPLE;
716 : static const char *const QUERYMODE[] = {"simple", "extended", "prepared"};
717 :
718 : /*
719 : * struct Command represents one command in a script.
720 : *
721 : * lines The raw, possibly multi-line command text. Variable substitution
722 : * not applied.
723 : * first_line A short, single-line extract of 'lines', for error reporting.
724 : * type SQL_COMMAND or META_COMMAND
725 : * meta The type of meta-command, with META_NONE/GSET/ASET if command
726 : * is SQL.
727 : * argc Number of arguments of the command, 0 if not yet processed.
728 : * argv Command arguments, the first of which is the command or SQL
729 : * string itself. For SQL commands, after post-processing
730 : * argv[0] is the same as 'lines' with variables substituted.
731 : * prepname The name that this command is prepared under, in prepare mode
732 : * varprefix SQL commands terminated with \gset or \aset have this set
733 : * to a non NULL value. If nonempty, it's used to prefix the
734 : * variable name that receives the value.
735 : * aset do gset on all possible queries of a combined query (\;).
736 : * expr Parsed expression, if needed.
737 : * stats Time spent in this command.
738 : * retries Number of retries after a serialization or deadlock error in the
739 : * current command.
740 : * failures Number of errors in the current command that were not retried.
741 : */
742 : typedef struct Command
743 : {
744 : PQExpBufferData lines;
745 : char *first_line;
746 : int type;
747 : MetaCommand meta;
748 : int argc;
749 : char *argv[MAX_ARGS];
750 : char *prepname;
751 : char *varprefix;
752 : PgBenchExpr *expr;
753 : SimpleStats stats;
754 : int64 retries;
755 : int64 failures;
756 : } Command;
757 :
758 : typedef struct ParsedScript
759 : {
760 : const char *desc; /* script descriptor (eg, file name) */
761 : int weight; /* selection weight */
762 : Command **commands; /* NULL-terminated array of Commands */
763 : StatsData stats; /* total time spent in script */
764 : } ParsedScript;
765 :
766 : static ParsedScript sql_script[MAX_SCRIPTS]; /* SQL script files */
767 : static int num_scripts; /* number of scripts in sql_script[] */
768 : static int64 total_weight = 0;
769 :
770 : static bool verbose_errors = false; /* print verbose messages of all errors */
771 :
772 : static bool exit_on_abort = false; /* exit when any client is aborted */
773 :
774 : /* Builtin test scripts */
775 : typedef struct BuiltinScript
776 : {
777 : const char *name; /* very short name for -b ... */
778 : const char *desc; /* short description */
779 : const char *script; /* actual pgbench script */
780 : } BuiltinScript;
781 :
782 : static const BuiltinScript builtin_script[] =
783 : {
784 : {
785 : "tpcb-like",
786 : "<builtin: TPC-B (sort of)>",
787 : "\\set aid random(1, " CppAsString2(naccounts) " * :scale)\n"
788 : "\\set bid random(1, " CppAsString2(nbranches) " * :scale)\n"
789 : "\\set tid random(1, " CppAsString2(ntellers) " * :scale)\n"
790 : "\\set delta random(-5000, 5000)\n"
791 : "BEGIN;\n"
792 : "UPDATE pgbench_accounts SET abalance = abalance + :delta WHERE aid = :aid;\n"
793 : "SELECT abalance FROM pgbench_accounts WHERE aid = :aid;\n"
794 : "UPDATE pgbench_tellers SET tbalance = tbalance + :delta WHERE tid = :tid;\n"
795 : "UPDATE pgbench_branches SET bbalance = bbalance + :delta WHERE bid = :bid;\n"
796 : "INSERT INTO pgbench_history (tid, bid, aid, delta, mtime) VALUES (:tid, :bid, :aid, :delta, CURRENT_TIMESTAMP);\n"
797 : "END;\n"
798 : },
799 : {
800 : "simple-update",
801 : "<builtin: simple update>",
802 : "\\set aid random(1, " CppAsString2(naccounts) " * :scale)\n"
803 : "\\set bid random(1, " CppAsString2(nbranches) " * :scale)\n"
804 : "\\set tid random(1, " CppAsString2(ntellers) " * :scale)\n"
805 : "\\set delta random(-5000, 5000)\n"
806 : "BEGIN;\n"
807 : "UPDATE pgbench_accounts SET abalance = abalance + :delta WHERE aid = :aid;\n"
808 : "SELECT abalance FROM pgbench_accounts WHERE aid = :aid;\n"
809 : "INSERT INTO pgbench_history (tid, bid, aid, delta, mtime) VALUES (:tid, :bid, :aid, :delta, CURRENT_TIMESTAMP);\n"
810 : "END;\n"
811 : },
812 : {
813 : "select-only",
814 : "<builtin: select only>",
815 : "\\set aid random(1, " CppAsString2(naccounts) " * :scale)\n"
816 : "SELECT abalance FROM pgbench_accounts WHERE aid = :aid;\n"
817 : }
818 : };
819 :
820 :
821 : /* Function prototypes */
822 : static void setNullValue(PgBenchValue *pv);
823 : static void setBoolValue(PgBenchValue *pv, bool bval);
824 : static void setIntValue(PgBenchValue *pv, int64 ival);
825 : static void setDoubleValue(PgBenchValue *pv, double dval);
826 : static bool evaluateExpr(CState *st, PgBenchExpr *expr,
827 : PgBenchValue *retval);
828 : static ConnectionStateEnum executeMetaCommand(CState *st, pg_time_usec_t *now);
829 : static void doLog(TState *thread, CState *st,
830 : StatsData *agg, bool skipped, double latency, double lag);
831 : static void processXactStats(TState *thread, CState *st, pg_time_usec_t *now,
832 : bool skipped, StatsData *agg);
833 : static void addScript(const ParsedScript *script);
834 : static THREAD_FUNC_RETURN_TYPE THREAD_FUNC_CC threadRun(void *arg);
835 : static void finishCon(CState *st);
836 : static void setalarm(int seconds);
837 : static socket_set *alloc_socket_set(int count);
838 : static void free_socket_set(socket_set *sa);
839 : static void clear_socket_set(socket_set *sa);
840 : static void add_socket_to_set(socket_set *sa, int fd, int idx);
841 : static int wait_on_socket_set(socket_set *sa, int64 usecs);
842 : static bool socket_has_input(socket_set *sa, int fd, int idx);
843 :
844 : /* callback used to build rows for COPY during data loading */
845 : typedef void (*initRowMethod) (PQExpBufferData *sql, int64 curr);
846 :
847 : /* callback functions for our flex lexer */
848 : static const PsqlScanCallbacks pgbench_callbacks = {
849 : NULL, /* don't need get_variable functionality */
850 : };
851 :
852 : static char
853 12 : get_table_relkind(PGconn *con, const char *table)
854 : {
855 : PGresult *res;
856 : char *val;
857 : char relkind;
858 12 : const char *params[1] = {table};
859 12 : const char *sql =
860 : "SELECT relkind FROM pg_catalog.pg_class WHERE oid=$1::pg_catalog.regclass";
861 :
862 12 : res = PQexecParams(con, sql, 1, NULL, params, NULL, NULL, 0);
863 12 : if (PQresultStatus(res) != PGRES_TUPLES_OK)
864 : {
865 0 : pg_log_error("query failed: %s", PQerrorMessage(con));
866 0 : pg_log_error_detail("Query was: %s", sql);
867 0 : exit(1);
868 : }
869 12 : val = PQgetvalue(res, 0, 0);
870 : Assert(strlen(val) == 1);
871 12 : relkind = val[0];
872 12 : PQclear(res);
873 :
874 12 : return relkind;
875 : }
876 :
877 : static inline pg_time_usec_t
878 23778 : pg_time_now(void)
879 : {
880 : instr_time now;
881 :
882 23778 : INSTR_TIME_SET_CURRENT(now);
883 :
884 23778 : return (pg_time_usec_t) INSTR_TIME_GET_MICROSEC(now);
885 : }
886 :
887 : static inline void
888 21492 : pg_time_now_lazy(pg_time_usec_t *now)
889 : {
890 21492 : if ((*now) == 0)
891 19448 : (*now) = pg_time_now();
892 21492 : }
893 :
894 : #define PG_TIME_GET_DOUBLE(t) (0.000001 * (t))
895 :
896 : static void
897 2 : usage(void)
898 : {
899 2 : printf("%s is a benchmarking tool for PostgreSQL.\n\n"
900 : "Usage:\n"
901 : " %s [OPTION]... [DBNAME]\n"
902 : "\nInitialization options:\n"
903 : " -i, --initialize invokes initialization mode\n"
904 : " -I, --init-steps=[" ALL_INIT_STEPS "]+ (default \"" DEFAULT_INIT_STEPS "\")\n"
905 : " run selected initialization steps, in the specified order\n"
906 : " d: drop any existing pgbench tables\n"
907 : " t: create the tables used by the standard pgbench scenario\n"
908 : " g: generate data, client-side\n"
909 : " G: generate data, server-side\n"
910 : " v: invoke VACUUM on the standard tables\n"
911 : " p: create primary key indexes on the standard tables\n"
912 : " f: create foreign keys between the standard tables\n"
913 : " -F, --fillfactor=NUM set fill factor\n"
914 : " -n, --no-vacuum do not run VACUUM during initialization\n"
915 : " -q, --quiet quiet logging (one message each 5 seconds)\n"
916 : " -s, --scale=NUM scaling factor\n"
917 : " --foreign-keys create foreign key constraints between tables\n"
918 : " --index-tablespace=TABLESPACE\n"
919 : " create indexes in the specified tablespace\n"
920 : " --partition-method=(range|hash)\n"
921 : " partition pgbench_accounts with this method (default: range)\n"
922 : " --partitions=NUM partition pgbench_accounts into NUM parts (default: 0)\n"
923 : " --tablespace=TABLESPACE create tables in the specified tablespace\n"
924 : " --unlogged-tables create tables as unlogged tables\n"
925 : "\nOptions to select what to run:\n"
926 : " -b, --builtin=NAME[@W] add builtin script NAME weighted at W (default: 1)\n"
927 : " (use \"-b list\" to list available scripts)\n"
928 : " -f, --file=FILENAME[@W] add script FILENAME weighted at W (default: 1)\n"
929 : " -N, --skip-some-updates skip updates of pgbench_tellers and pgbench_branches\n"
930 : " (same as \"-b simple-update\")\n"
931 : " -S, --select-only perform SELECT-only transactions\n"
932 : " (same as \"-b select-only\")\n"
933 : "\nBenchmarking options:\n"
934 : " -c, --client=NUM number of concurrent database clients (default: 1)\n"
935 : " -C, --connect establish new connection for each transaction\n"
936 : " -D, --define=VARNAME=VALUE\n"
937 : " define variable for use by custom script\n"
938 : " -j, --jobs=NUM number of threads (default: 1)\n"
939 : " -l, --log write transaction times to log file\n"
940 : " -L, --latency-limit=NUM count transactions lasting more than NUM ms as late\n"
941 : " -M, --protocol=simple|extended|prepared\n"
942 : " protocol for submitting queries (default: simple)\n"
943 : " -n, --no-vacuum do not run VACUUM before tests\n"
944 : " -P, --progress=NUM show thread progress report every NUM seconds\n"
945 : " -r, --report-per-command report latencies, failures, and retries per command\n"
946 : " -R, --rate=NUM target rate in transactions per second\n"
947 : " -s, --scale=NUM report this scale factor in output\n"
948 : " -t, --transactions=NUM number of transactions each client runs (default: 10)\n"
949 : " -T, --time=NUM duration of benchmark test in seconds\n"
950 : " -v, --vacuum-all vacuum all four standard tables before tests\n"
951 : " --aggregate-interval=NUM aggregate data over NUM seconds\n"
952 : " --exit-on-abort exit when any client is aborted\n"
953 : " --failures-detailed report the failures grouped by basic types\n"
954 : " --log-prefix=PREFIX prefix for transaction time log file\n"
955 : " (default: \"pgbench_log\")\n"
956 : " --max-tries=NUM max number of tries to run transaction (default: 1)\n"
957 : " --progress-timestamp use Unix epoch timestamps for progress\n"
958 : " --random-seed=SEED set random seed (\"time\", \"rand\", integer)\n"
959 : " --sampling-rate=NUM fraction of transactions to log (e.g., 0.01 for 1%%)\n"
960 : " --show-script=NAME show builtin script code, then exit\n"
961 : " --verbose-errors print messages of all errors\n"
962 : "\nCommon options:\n"
963 : " --debug print debugging output\n"
964 : " -d, --dbname=DBNAME database name to connect to\n"
965 : " -h, --host=HOSTNAME database server host or socket directory\n"
966 : " -p, --port=PORT database server port number\n"
967 : " -U, --username=USERNAME connect as specified database user\n"
968 : " -V, --version output version information, then exit\n"
969 : " -?, --help show this help, then exit\n"
970 : "\n"
971 : "Report bugs to <%s>.\n"
972 : "%s home page: <%s>\n",
973 : progname, progname, PACKAGE_BUGREPORT, PACKAGE_NAME, PACKAGE_URL);
974 2 : }
975 :
976 : /* return whether str matches "^\s*[-+]?[0-9]+$" */
977 : static bool
978 1012 : is_an_int(const char *str)
979 : {
980 1012 : const char *ptr = str;
981 :
982 : /* skip leading spaces; cast is consistent with strtoint64 */
983 1012 : while (*ptr && isspace((unsigned char) *ptr))
984 0 : ptr++;
985 :
986 : /* skip sign */
987 1012 : if (*ptr == '+' || *ptr == '-')
988 6 : ptr++;
989 :
990 : /* at least one digit */
991 1012 : if (*ptr && !isdigit((unsigned char) *ptr))
992 4 : return false;
993 :
994 : /* eat all digits */
995 2126 : while (*ptr && isdigit((unsigned char) *ptr))
996 1118 : ptr++;
997 :
998 : /* must have reached end of string */
999 1008 : return *ptr == '\0';
1000 : }
1001 :
1002 :
1003 : /*
1004 : * strtoint64 -- convert a string to 64-bit integer
1005 : *
1006 : * This function is a slightly modified version of pg_strtoint64() from
1007 : * src/backend/utils/adt/numutils.c.
1008 : *
1009 : * The function returns whether the conversion worked, and if so
1010 : * "*result" is set to the result.
1011 : *
1012 : * If not errorOK, an error message is also printed out on errors.
1013 : */
1014 : bool
1015 2600 : strtoint64(const char *str, bool errorOK, int64 *result)
1016 : {
1017 2600 : const char *ptr = str;
1018 2600 : int64 tmp = 0;
1019 2600 : bool neg = false;
1020 :
1021 : /*
1022 : * Do our own scan, rather than relying on sscanf which might be broken
1023 : * for long long.
1024 : *
1025 : * As INT64_MIN can't be stored as a positive 64 bit integer, accumulate
1026 : * value as a negative number.
1027 : */
1028 :
1029 : /* skip leading spaces */
1030 2600 : while (*ptr && isspace((unsigned char) *ptr))
1031 0 : ptr++;
1032 :
1033 : /* handle sign */
1034 2600 : if (*ptr == '-')
1035 : {
1036 4 : ptr++;
1037 4 : neg = true;
1038 : }
1039 2596 : else if (*ptr == '+')
1040 0 : ptr++;
1041 :
1042 : /* require at least one digit */
1043 2600 : if (unlikely(!isdigit((unsigned char) *ptr)))
1044 0 : goto invalid_syntax;
1045 :
1046 : /* process digits */
1047 7806 : while (*ptr && isdigit((unsigned char) *ptr))
1048 : {
1049 5208 : int8 digit = (*ptr++ - '0');
1050 :
1051 5208 : if (unlikely(pg_mul_s64_overflow(tmp, 10, &tmp)) ||
1052 5206 : unlikely(pg_sub_s64_overflow(tmp, digit, &tmp)))
1053 2 : goto out_of_range;
1054 : }
1055 :
1056 : /* allow trailing whitespace, but not other trailing chars */
1057 2598 : while (*ptr != '\0' && isspace((unsigned char) *ptr))
1058 0 : ptr++;
1059 :
1060 2598 : if (unlikely(*ptr != '\0'))
1061 0 : goto invalid_syntax;
1062 :
1063 2598 : if (!neg)
1064 : {
1065 2594 : if (unlikely(tmp == PG_INT64_MIN))
1066 0 : goto out_of_range;
1067 2594 : tmp = -tmp;
1068 : }
1069 :
1070 2598 : *result = tmp;
1071 2598 : return true;
1072 :
1073 2 : out_of_range:
1074 2 : if (!errorOK)
1075 0 : pg_log_error("value \"%s\" is out of range for type bigint", str);
1076 2 : return false;
1077 :
1078 0 : invalid_syntax:
1079 0 : if (!errorOK)
1080 0 : pg_log_error("invalid input syntax for type bigint: \"%s\"", str);
1081 0 : return false;
1082 : }
1083 :
1084 : /* convert string to double, detecting overflows/underflows */
1085 : bool
1086 132 : strtodouble(const char *str, bool errorOK, double *dv)
1087 : {
1088 : char *end;
1089 :
1090 132 : errno = 0;
1091 132 : *dv = strtod(str, &end);
1092 :
1093 132 : if (unlikely(errno != 0))
1094 : {
1095 4 : if (!errorOK)
1096 0 : pg_log_error("value \"%s\" is out of range for type double", str);
1097 4 : return false;
1098 : }
1099 :
1100 128 : if (unlikely(end == str || *end != '\0'))
1101 : {
1102 4 : if (!errorOK)
1103 0 : pg_log_error("invalid input syntax for type double: \"%s\"", str);
1104 4 : return false;
1105 : }
1106 124 : return true;
1107 : }
1108 :
1109 : /*
1110 : * Initialize a prng state struct.
1111 : *
1112 : * We derive the seed from base_random_sequence, which must be set up already.
1113 : */
1114 : static void
1115 786 : initRandomState(pg_prng_state *state)
1116 : {
1117 786 : pg_prng_seed(state, pg_prng_uint64(&base_random_sequence));
1118 786 : }
1119 :
1120 :
1121 : /*
1122 : * random number generator: uniform distribution from min to max inclusive.
1123 : *
1124 : * Although the limits are expressed as int64, you can't generate the full
1125 : * int64 range in one call, because the difference of the limits mustn't
1126 : * overflow int64. This is not checked.
1127 : */
1128 : static int64
1129 5742 : getrand(pg_prng_state *state, int64 min, int64 max)
1130 : {
1131 5742 : return min + (int64) pg_prng_uint64_range(state, 0, max - min);
1132 : }
1133 :
1134 : /*
1135 : * random number generator: exponential distribution from min to max inclusive.
1136 : * the parameter is so that the density of probability for the last cut-off max
1137 : * value is exp(-parameter).
1138 : */
1139 : static int64
1140 6 : getExponentialRand(pg_prng_state *state, int64 min, int64 max,
1141 : double parameter)
1142 : {
1143 : double cut,
1144 : uniform,
1145 : rand;
1146 :
1147 : /* abort if wrong parameter, but must really be checked beforehand */
1148 : Assert(parameter > 0.0);
1149 6 : cut = exp(-parameter);
1150 : /* pg_prng_double value in [0, 1), uniform in (0, 1] */
1151 6 : uniform = 1.0 - pg_prng_double(state);
1152 :
1153 : /*
1154 : * inner expression in (cut, 1] (if parameter > 0), rand in [0, 1)
1155 : */
1156 : Assert((1.0 - cut) != 0.0);
1157 6 : rand = -log(cut + (1.0 - cut) * uniform) / parameter;
1158 : /* return int64 random number within between min and max */
1159 6 : return min + (int64) ((max - min + 1) * rand);
1160 : }
1161 :
1162 : /* random number generator: gaussian distribution from min to max inclusive */
1163 : static int64
1164 6 : getGaussianRand(pg_prng_state *state, int64 min, int64 max,
1165 : double parameter)
1166 : {
1167 : double stdev;
1168 : double rand;
1169 :
1170 : /* abort if parameter is too low, but must really be checked beforehand */
1171 : Assert(parameter >= MIN_GAUSSIAN_PARAM);
1172 :
1173 : /*
1174 : * Get normally-distributed random number in the range -parameter <= stdev
1175 : * < parameter.
1176 : *
1177 : * This loop is executed until the number is in the expected range.
1178 : *
1179 : * As the minimum parameter is 2.0, the probability of looping is low:
1180 : * sqrt(-2 ln(r)) <= 2 => r >= e^{-2} ~ 0.135, then when taking the
1181 : * average sinus multiplier as 2/pi, we have a 8.6% looping probability in
1182 : * the worst case. For a parameter value of 5.0, the looping probability
1183 : * is about e^{-5} * 2 / pi ~ 0.43%.
1184 : */
1185 : do
1186 : {
1187 6 : stdev = pg_prng_double_normal(state);
1188 : }
1189 6 : while (stdev < -parameter || stdev >= parameter);
1190 :
1191 : /* stdev is in [-parameter, parameter), normalization to [0,1) */
1192 6 : rand = (stdev + parameter) / (parameter * 2.0);
1193 :
1194 : /* return int64 random number within between min and max */
1195 6 : return min + (int64) ((max - min + 1) * rand);
1196 : }
1197 :
1198 : /*
1199 : * random number generator: generate a value, such that the series of values
1200 : * will approximate a Poisson distribution centered on the given value.
1201 : *
1202 : * Individual results are rounded to integers, though the center value need
1203 : * not be one.
1204 : */
1205 : static int64
1206 420 : getPoissonRand(pg_prng_state *state, double center)
1207 : {
1208 : /*
1209 : * Use inverse transform sampling to generate a value > 0, such that the
1210 : * expected (i.e. average) value is the given argument.
1211 : */
1212 : double uniform;
1213 :
1214 : /* pg_prng_double value in [0, 1), uniform in (0, 1] */
1215 420 : uniform = 1.0 - pg_prng_double(state);
1216 :
1217 420 : return (int64) (-log(uniform) * center + 0.5);
1218 : }
1219 :
1220 : /*
1221 : * Computing zipfian using rejection method, based on
1222 : * "Non-Uniform Random Variate Generation",
1223 : * Luc Devroye, p. 550-551, Springer 1986.
1224 : *
1225 : * This works for s > 1.0, but may perform badly for s very close to 1.0.
1226 : */
1227 : static int64
1228 6 : computeIterativeZipfian(pg_prng_state *state, int64 n, double s)
1229 : {
1230 6 : double b = pow(2.0, s - 1.0);
1231 : double x,
1232 : t,
1233 : u,
1234 : v;
1235 :
1236 : /* Ensure n is sane */
1237 6 : if (n <= 1)
1238 0 : return 1;
1239 :
1240 : while (true)
1241 : {
1242 : /* random variates */
1243 6 : u = pg_prng_double(state);
1244 6 : v = pg_prng_double(state);
1245 :
1246 6 : x = floor(pow(u, -1.0 / (s - 1.0)));
1247 :
1248 6 : t = pow(1.0 + 1.0 / x, s - 1.0);
1249 : /* reject if too large or out of bound */
1250 6 : if (v * x * (t - 1.0) / (b - 1.0) <= t / b && x <= n)
1251 6 : break;
1252 : }
1253 6 : return (int64) x;
1254 : }
1255 :
1256 : /* random number generator: zipfian distribution from min to max inclusive */
1257 : static int64
1258 6 : getZipfianRand(pg_prng_state *state, int64 min, int64 max, double s)
1259 : {
1260 6 : int64 n = max - min + 1;
1261 :
1262 : /* abort if parameter is invalid */
1263 : Assert(MIN_ZIPFIAN_PARAM <= s && s <= MAX_ZIPFIAN_PARAM);
1264 :
1265 6 : return min - 1 + computeIterativeZipfian(state, n, s);
1266 : }
1267 :
1268 : /*
1269 : * FNV-1a hash function
1270 : */
1271 : static int64
1272 2 : getHashFnv1a(int64 val, uint64 seed)
1273 : {
1274 : int64 result;
1275 : int i;
1276 :
1277 2 : result = FNV_OFFSET_BASIS ^ seed;
1278 18 : for (i = 0; i < 8; ++i)
1279 : {
1280 16 : int32 octet = val & 0xff;
1281 :
1282 16 : val = val >> 8;
1283 16 : result = result ^ octet;
1284 16 : result = result * FNV_PRIME;
1285 : }
1286 :
1287 2 : return result;
1288 : }
1289 :
1290 : /*
1291 : * Murmur2 hash function
1292 : *
1293 : * Based on original work of Austin Appleby
1294 : * https://github.com/aappleby/smhasher/blob/master/src/MurmurHash2.cpp
1295 : */
1296 : static int64
1297 10 : getHashMurmur2(int64 val, uint64 seed)
1298 : {
1299 10 : uint64 result = seed ^ MM2_MUL_TIMES_8; /* sizeof(int64) */
1300 10 : uint64 k = (uint64) val;
1301 :
1302 10 : k *= MM2_MUL;
1303 10 : k ^= k >> MM2_ROT;
1304 10 : k *= MM2_MUL;
1305 :
1306 10 : result ^= k;
1307 10 : result *= MM2_MUL;
1308 :
1309 10 : result ^= result >> MM2_ROT;
1310 10 : result *= MM2_MUL;
1311 10 : result ^= result >> MM2_ROT;
1312 :
1313 10 : return (int64) result;
1314 : }
1315 :
1316 : /*
1317 : * Pseudorandom permutation function
1318 : *
1319 : * For small sizes, this generates each of the (size!) possible permutations
1320 : * of integers in the range [0, size) with roughly equal probability. Once
1321 : * the size is larger than 20, the number of possible permutations exceeds the
1322 : * number of distinct states of the internal pseudorandom number generator,
1323 : * and so not all possible permutations can be generated, but the permutations
1324 : * chosen should continue to give the appearance of being random.
1325 : *
1326 : * THIS FUNCTION IS NOT CRYPTOGRAPHICALLY SECURE.
1327 : * DO NOT USE FOR SUCH PURPOSE.
1328 : */
1329 : static int64
1330 90 : permute(const int64 val, const int64 isize, const int64 seed)
1331 : {
1332 : /* using a high-end PRNG is probably overkill */
1333 : pg_prng_state state;
1334 : uint64 size;
1335 : uint64 v;
1336 : int masklen;
1337 : uint64 mask;
1338 : int i;
1339 :
1340 90 : if (isize < 2)
1341 2 : return 0; /* nothing to permute */
1342 :
1343 : /* Initialize prng state using the seed */
1344 88 : pg_prng_seed(&state, (uint64) seed);
1345 :
1346 : /* Computations are performed on unsigned values */
1347 88 : size = (uint64) isize;
1348 88 : v = (uint64) val % size;
1349 :
1350 : /* Mask to work modulo largest power of 2 less than or equal to size */
1351 88 : masklen = pg_leftmost_one_pos64(size);
1352 88 : mask = (((uint64) 1) << masklen) - 1;
1353 :
1354 : /*
1355 : * Permute the input value by applying several rounds of pseudorandom
1356 : * bijective transformations. The intention here is to distribute each
1357 : * input uniformly randomly across the range, and separate adjacent inputs
1358 : * approximately uniformly randomly from each other, leading to a fairly
1359 : * random overall choice of permutation.
1360 : *
1361 : * To separate adjacent inputs, we multiply by a random number modulo
1362 : * (mask + 1), which is a power of 2. For this to be a bijection, the
1363 : * multiplier must be odd. Since this is known to lead to less randomness
1364 : * in the lower bits, we also apply a rotation that shifts the topmost bit
1365 : * into the least significant bit. In the special cases where size <= 3,
1366 : * mask = 1 and each of these operations is actually a no-op, so we also
1367 : * XOR the value with a different random number to inject additional
1368 : * randomness. Since the size is generally not a power of 2, we apply
1369 : * this bijection on overlapping upper and lower halves of the input.
1370 : *
1371 : * To distribute the inputs uniformly across the range, we then also apply
1372 : * a random offset modulo the full range.
1373 : *
1374 : * Taken together, these operations resemble a modified linear
1375 : * congruential generator, as is commonly used in pseudorandom number
1376 : * generators. The number of rounds is fairly arbitrary, but six has been
1377 : * found empirically to give a fairly good tradeoff between performance
1378 : * and uniform randomness. For small sizes it selects each of the (size!)
1379 : * possible permutations with roughly equal probability. For larger
1380 : * sizes, not all permutations can be generated, but the intended random
1381 : * spread is still produced.
1382 : */
1383 616 : for (i = 0; i < 6; i++)
1384 : {
1385 : uint64 m,
1386 : r,
1387 : t;
1388 :
1389 : /* Random multiply (by an odd number), XOR and rotate of lower half */
1390 528 : m = (pg_prng_uint64(&state) & mask) | 1;
1391 528 : r = pg_prng_uint64(&state) & mask;
1392 528 : if (v <= mask)
1393 : {
1394 438 : v = ((v * m) ^ r) & mask;
1395 438 : v = ((v << 1) & mask) | (v >> (masklen - 1));
1396 : }
1397 :
1398 : /* Random multiply (by an odd number), XOR and rotate of upper half */
1399 528 : m = (pg_prng_uint64(&state) & mask) | 1;
1400 528 : r = pg_prng_uint64(&state) & mask;
1401 528 : t = size - 1 - v;
1402 528 : if (t <= mask)
1403 : {
1404 470 : t = ((t * m) ^ r) & mask;
1405 470 : t = ((t << 1) & mask) | (t >> (masklen - 1));
1406 470 : v = size - 1 - t;
1407 : }
1408 :
1409 : /* Random offset */
1410 528 : r = pg_prng_uint64_range(&state, 0, size - 1);
1411 528 : v = (v + r) % size;
1412 : }
1413 :
1414 88 : return (int64) v;
1415 : }
1416 :
1417 : /*
1418 : * Initialize the given SimpleStats struct to all zeroes
1419 : */
1420 : static void
1421 4096 : initSimpleStats(SimpleStats *ss)
1422 : {
1423 4096 : memset(ss, 0, sizeof(SimpleStats));
1424 4096 : }
1425 :
1426 : /*
1427 : * Accumulate one value into a SimpleStats struct.
1428 : */
1429 : static void
1430 19290 : addToSimpleStats(SimpleStats *ss, double val)
1431 : {
1432 19290 : if (ss->count == 0 || val < ss->min)
1433 382 : ss->min = val;
1434 19290 : if (ss->count == 0 || val > ss->max)
1435 984 : ss->max = val;
1436 19290 : ss->count++;
1437 19290 : ss->sum += val;
1438 19290 : ss->sum2 += val * val;
1439 19290 : }
1440 :
1441 : /*
1442 : * Merge two SimpleStats objects
1443 : */
1444 : static void
1445 344 : mergeSimpleStats(SimpleStats *acc, SimpleStats *ss)
1446 : {
1447 344 : if (acc->count == 0 || ss->min < acc->min)
1448 344 : acc->min = ss->min;
1449 344 : if (acc->count == 0 || ss->max > acc->max)
1450 344 : acc->max = ss->max;
1451 344 : acc->count += ss->count;
1452 344 : acc->sum += ss->sum;
1453 344 : acc->sum2 += ss->sum2;
1454 344 : }
1455 :
1456 : /*
1457 : * Initialize a StatsData struct to mostly zeroes, with its start time set to
1458 : * the given value.
1459 : */
1460 : static void
1461 1092 : initStats(StatsData *sd, pg_time_usec_t start)
1462 : {
1463 1092 : sd->start_time = start;
1464 1092 : sd->cnt = 0;
1465 1092 : sd->skipped = 0;
1466 1092 : sd->retries = 0;
1467 1092 : sd->retried = 0;
1468 1092 : sd->serialization_failures = 0;
1469 1092 : sd->deadlock_failures = 0;
1470 1092 : initSimpleStats(&sd->latency);
1471 1092 : initSimpleStats(&sd->lag);
1472 1092 : }
1473 :
1474 : /*
1475 : * Accumulate one additional item into the given stats object.
1476 : */
1477 : static void
1478 18104 : accumStats(StatsData *stats, bool skipped, double lat, double lag,
1479 : EStatus estatus, int64 tries)
1480 : {
1481 : /* Record the skipped transaction */
1482 18104 : if (skipped)
1483 : {
1484 : /* no latency to record on skipped transactions */
1485 18 : stats->skipped++;
1486 18 : return;
1487 : }
1488 :
1489 : /*
1490 : * Record the number of retries regardless of whether the transaction was
1491 : * successful or failed.
1492 : */
1493 18086 : if (tries > 1)
1494 : {
1495 4 : stats->retries += (tries - 1);
1496 4 : stats->retried++;
1497 : }
1498 :
1499 18086 : switch (estatus)
1500 : {
1501 : /* Record the successful transaction */
1502 18086 : case ESTATUS_NO_ERROR:
1503 18086 : stats->cnt++;
1504 :
1505 18086 : addToSimpleStats(&stats->latency, lat);
1506 :
1507 : /* and possibly the same for schedule lag */
1508 18086 : if (throttle_delay)
1509 402 : addToSimpleStats(&stats->lag, lag);
1510 18086 : break;
1511 :
1512 : /* Record the failed transaction */
1513 0 : case ESTATUS_SERIALIZATION_ERROR:
1514 0 : stats->serialization_failures++;
1515 0 : break;
1516 0 : case ESTATUS_DEADLOCK_ERROR:
1517 0 : stats->deadlock_failures++;
1518 0 : break;
1519 0 : default:
1520 : /* internal error which should never occur */
1521 0 : pg_fatal("unexpected error status: %d", estatus);
1522 : }
1523 : }
1524 :
1525 : /* call PQexec() and exit() on failure */
1526 : static void
1527 118 : executeStatement(PGconn *con, const char *sql)
1528 : {
1529 : PGresult *res;
1530 :
1531 118 : res = PQexec(con, sql);
1532 118 : if (PQresultStatus(res) != PGRES_COMMAND_OK)
1533 : {
1534 0 : pg_log_error("query failed: %s", PQerrorMessage(con));
1535 0 : pg_log_error_detail("Query was: %s", sql);
1536 0 : exit(1);
1537 : }
1538 118 : PQclear(res);
1539 118 : }
1540 :
1541 : /* call PQexec() and complain, but without exiting, on failure */
1542 : static void
1543 66 : tryExecuteStatement(PGconn *con, const char *sql)
1544 : {
1545 : PGresult *res;
1546 :
1547 66 : res = PQexec(con, sql);
1548 66 : if (PQresultStatus(res) != PGRES_COMMAND_OK)
1549 : {
1550 0 : pg_log_error("%s", PQerrorMessage(con));
1551 0 : pg_log_error_detail("(ignoring this error and continuing anyway)");
1552 : }
1553 66 : PQclear(res);
1554 66 : }
1555 :
1556 : /* set up a connection to the backend */
1557 : static PGconn *
1558 644 : doConnect(void)
1559 : {
1560 : PGconn *conn;
1561 : bool new_pass;
1562 : static char *password = NULL;
1563 :
1564 : /*
1565 : * Start the connection. Loop until we have a password if requested by
1566 : * backend.
1567 : */
1568 : do
1569 : {
1570 : #define PARAMS_ARRAY_SIZE 7
1571 :
1572 : const char *keywords[PARAMS_ARRAY_SIZE];
1573 : const char *values[PARAMS_ARRAY_SIZE];
1574 :
1575 644 : keywords[0] = "host";
1576 644 : values[0] = pghost;
1577 644 : keywords[1] = "port";
1578 644 : values[1] = pgport;
1579 644 : keywords[2] = "user";
1580 644 : values[2] = username;
1581 644 : keywords[3] = "password";
1582 644 : values[3] = password;
1583 644 : keywords[4] = "dbname";
1584 644 : values[4] = dbName;
1585 644 : keywords[5] = "fallback_application_name";
1586 644 : values[5] = progname;
1587 644 : keywords[6] = NULL;
1588 644 : values[6] = NULL;
1589 :
1590 644 : new_pass = false;
1591 :
1592 644 : conn = PQconnectdbParams(keywords, values, true);
1593 :
1594 644 : if (!conn)
1595 : {
1596 0 : pg_log_error("connection to database \"%s\" failed", dbName);
1597 0 : return NULL;
1598 : }
1599 :
1600 646 : if (PQstatus(conn) == CONNECTION_BAD &&
1601 2 : PQconnectionNeedsPassword(conn) &&
1602 0 : !password)
1603 : {
1604 0 : PQfinish(conn);
1605 0 : password = simple_prompt("Password: ", false);
1606 0 : new_pass = true;
1607 : }
1608 644 : } while (new_pass);
1609 :
1610 : /* check to see that the backend connection was successfully made */
1611 644 : if (PQstatus(conn) == CONNECTION_BAD)
1612 : {
1613 2 : pg_log_error("%s", PQerrorMessage(conn));
1614 2 : PQfinish(conn);
1615 2 : return NULL;
1616 : }
1617 :
1618 642 : return conn;
1619 : }
1620 :
1621 : /* qsort comparator for Variable array */
1622 : static int
1623 107958 : compareVariableNames(const void *v1, const void *v2)
1624 : {
1625 215916 : return strcmp(((const Variable *) v1)->name,
1626 107958 : ((const Variable *) v2)->name);
1627 : }
1628 :
1629 : /* Locate a variable by name; returns NULL if unknown */
1630 : static Variable *
1631 15960 : lookupVariable(Variables *variables, char *name)
1632 : {
1633 : Variable key;
1634 :
1635 : /* On some versions of Solaris, bsearch of zero items dumps core */
1636 15960 : if (variables->nvars <= 0)
1637 402 : return NULL;
1638 :
1639 : /* Sort if we have to */
1640 15558 : if (!variables->vars_sorted)
1641 : {
1642 2038 : qsort(variables->vars, variables->nvars, sizeof(Variable),
1643 : compareVariableNames);
1644 2038 : variables->vars_sorted = true;
1645 : }
1646 :
1647 : /* Now we can search */
1648 15558 : key.name = name;
1649 15558 : return (Variable *) bsearch(&key,
1650 15558 : variables->vars,
1651 15558 : variables->nvars,
1652 : sizeof(Variable),
1653 : compareVariableNames);
1654 : }
1655 :
1656 : /* Get the value of a variable, in string form; returns NULL if unknown */
1657 : static char *
1658 4964 : getVariable(Variables *variables, char *name)
1659 : {
1660 : Variable *var;
1661 : char stringform[64];
1662 :
1663 4964 : var = lookupVariable(variables, name);
1664 4964 : if (var == NULL)
1665 8 : return NULL; /* not found */
1666 :
1667 4956 : if (var->svalue)
1668 1744 : return var->svalue; /* we have it in string form */
1669 :
1670 : /* We need to produce a string equivalent of the value */
1671 : Assert(var->value.type != PGBT_NO_VALUE);
1672 3212 : if (var->value.type == PGBT_NULL)
1673 2 : snprintf(stringform, sizeof(stringform), "NULL");
1674 3210 : else if (var->value.type == PGBT_BOOLEAN)
1675 2 : snprintf(stringform, sizeof(stringform),
1676 2 : "%s", var->value.u.bval ? "true" : "false");
1677 3208 : else if (var->value.type == PGBT_INT)
1678 3204 : snprintf(stringform, sizeof(stringform),
1679 : INT64_FORMAT, var->value.u.ival);
1680 4 : else if (var->value.type == PGBT_DOUBLE)
1681 4 : snprintf(stringform, sizeof(stringform),
1682 : "%.*g", DBL_DIG, var->value.u.dval);
1683 : else /* internal error, unexpected type */
1684 : Assert(0);
1685 3212 : var->svalue = pg_strdup(stringform);
1686 3212 : return var->svalue;
1687 : }
1688 :
1689 : /* Try to convert variable to a value; return false on failure */
1690 : static bool
1691 4006 : makeVariableValue(Variable *var)
1692 : {
1693 : size_t slen;
1694 :
1695 4006 : if (var->value.type != PGBT_NO_VALUE)
1696 2988 : return true; /* no work */
1697 :
1698 1018 : slen = strlen(var->svalue);
1699 :
1700 1018 : if (slen == 0)
1701 : /* what should it do on ""? */
1702 0 : return false;
1703 :
1704 1018 : if (pg_strcasecmp(var->svalue, "null") == 0)
1705 : {
1706 2 : setNullValue(&var->value);
1707 : }
1708 :
1709 : /*
1710 : * accept prefixes such as y, ye, n, no... but not for "o". 0/1 are
1711 : * recognized later as an int, which is converted to bool if needed.
1712 : */
1713 2030 : else if (pg_strncasecmp(var->svalue, "true", slen) == 0 ||
1714 2028 : pg_strncasecmp(var->svalue, "yes", slen) == 0 ||
1715 1014 : pg_strcasecmp(var->svalue, "on") == 0)
1716 : {
1717 2 : setBoolValue(&var->value, true);
1718 : }
1719 2028 : else if (pg_strncasecmp(var->svalue, "false", slen) == 0 ||
1720 2028 : pg_strncasecmp(var->svalue, "no", slen) == 0 ||
1721 2028 : pg_strcasecmp(var->svalue, "off") == 0 ||
1722 1014 : pg_strcasecmp(var->svalue, "of") == 0)
1723 : {
1724 2 : setBoolValue(&var->value, false);
1725 : }
1726 1012 : else if (is_an_int(var->svalue))
1727 : {
1728 : /* if it looks like an int, it must be an int without overflow */
1729 : int64 iv;
1730 :
1731 1006 : if (!strtoint64(var->svalue, false, &iv))
1732 0 : return false;
1733 :
1734 1006 : setIntValue(&var->value, iv);
1735 : }
1736 : else /* type should be double */
1737 : {
1738 : double dv;
1739 :
1740 6 : if (!strtodouble(var->svalue, true, &dv))
1741 : {
1742 4 : pg_log_error("malformed variable \"%s\" value: \"%s\"",
1743 : var->name, var->svalue);
1744 4 : return false;
1745 : }
1746 2 : setDoubleValue(&var->value, dv);
1747 : }
1748 1014 : return true;
1749 : }
1750 :
1751 : /*
1752 : * Check whether a variable's name is allowed.
1753 : *
1754 : * We allow any non-ASCII character, as well as ASCII letters, digits, and
1755 : * underscore.
1756 : *
1757 : * Keep this in sync with the definitions of variable name characters in
1758 : * "src/fe_utils/psqlscan.l", "src/bin/psql/psqlscanslash.l" and
1759 : * "src/bin/pgbench/exprscan.l". Also see parseVariable(), below.
1760 : *
1761 : * Note: this static function is copied from "src/bin/psql/variables.c"
1762 : * but changed to disallow variable names starting with a digit.
1763 : */
1764 : static bool
1765 2220 : valid_variable_name(const char *name)
1766 : {
1767 2220 : const unsigned char *ptr = (const unsigned char *) name;
1768 :
1769 : /* Mustn't be zero-length */
1770 2220 : if (*ptr == '\0')
1771 0 : return false;
1772 :
1773 : /* must not start with [0-9] */
1774 2220 : if (IS_HIGHBIT_SET(*ptr) ||
1775 2220 : strchr("ABCDEFGHIJKLMNOPQRSTUVWXYZ" "abcdefghijklmnopqrstuvwxyz"
1776 2220 : "_", *ptr) != NULL)
1777 2216 : ptr++;
1778 : else
1779 4 : return false;
1780 :
1781 : /* remaining characters can include [0-9] */
1782 14512 : while (*ptr)
1783 : {
1784 12298 : if (IS_HIGHBIT_SET(*ptr) ||
1785 12298 : strchr("ABCDEFGHIJKLMNOPQRSTUVWXYZ" "abcdefghijklmnopqrstuvwxyz"
1786 12298 : "_0123456789", *ptr) != NULL)
1787 12296 : ptr++;
1788 : else
1789 2 : return false;
1790 : }
1791 :
1792 2214 : return true;
1793 : }
1794 :
1795 : /*
1796 : * Make sure there is enough space for 'needed' more variable in the variables
1797 : * array.
1798 : */
1799 : static void
1800 2214 : enlargeVariables(Variables *variables, int needed)
1801 : {
1802 : /* total number of variables required now */
1803 2214 : needed += variables->nvars;
1804 :
1805 2214 : if (variables->max_vars < needed)
1806 : {
1807 378 : variables->max_vars = needed + VARIABLES_ALLOC_MARGIN;
1808 378 : variables->vars = (Variable *)
1809 378 : pg_realloc(variables->vars, variables->max_vars * sizeof(Variable));
1810 : }
1811 2214 : }
1812 :
1813 : /*
1814 : * Lookup a variable by name, creating it if need be.
1815 : * Caller is expected to assign a value to the variable.
1816 : * Returns NULL on failure (bad name).
1817 : */
1818 : static Variable *
1819 6290 : lookupCreateVariable(Variables *variables, const char *context, char *name)
1820 : {
1821 : Variable *var;
1822 :
1823 6290 : var = lookupVariable(variables, name);
1824 6290 : if (var == NULL)
1825 : {
1826 : /*
1827 : * Check for the name only when declaring a new variable to avoid
1828 : * overhead.
1829 : */
1830 2220 : if (!valid_variable_name(name))
1831 : {
1832 6 : pg_log_error("%s: invalid variable name: \"%s\"", context, name);
1833 6 : return NULL;
1834 : }
1835 :
1836 : /* Create variable at the end of the array */
1837 2214 : enlargeVariables(variables, 1);
1838 :
1839 2214 : var = &(variables->vars[variables->nvars]);
1840 :
1841 2214 : var->name = pg_strdup(name);
1842 2214 : var->svalue = NULL;
1843 : /* caller is expected to initialize remaining fields */
1844 :
1845 2214 : variables->nvars++;
1846 : /* we don't re-sort the array till we have to */
1847 2214 : variables->vars_sorted = false;
1848 : }
1849 :
1850 6284 : return var;
1851 : }
1852 :
1853 : /* Assign a string value to a variable, creating it if need be */
1854 : /* Returns false on failure (bad name) */
1855 : static bool
1856 1894 : putVariable(Variables *variables, const char *context, char *name,
1857 : const char *value)
1858 : {
1859 : Variable *var;
1860 : char *val;
1861 :
1862 1894 : var = lookupCreateVariable(variables, context, name);
1863 1894 : if (!var)
1864 4 : return false;
1865 :
1866 : /* dup then free, in case value is pointing at this variable */
1867 1890 : val = pg_strdup(value);
1868 :
1869 1890 : free(var->svalue);
1870 1890 : var->svalue = val;
1871 1890 : var->value.type = PGBT_NO_VALUE;
1872 :
1873 1890 : return true;
1874 : }
1875 :
1876 : /* Assign a value to a variable, creating it if need be */
1877 : /* Returns false on failure (bad name) */
1878 : static bool
1879 4396 : putVariableValue(Variables *variables, const char *context, char *name,
1880 : const PgBenchValue *value)
1881 : {
1882 : Variable *var;
1883 :
1884 4396 : var = lookupCreateVariable(variables, context, name);
1885 4396 : if (!var)
1886 2 : return false;
1887 :
1888 4394 : free(var->svalue);
1889 4394 : var->svalue = NULL;
1890 4394 : var->value = *value;
1891 :
1892 4394 : return true;
1893 : }
1894 :
1895 : /* Assign an integer value to a variable, creating it if need be */
1896 : /* Returns false on failure (bad name) */
1897 : static bool
1898 1018 : putVariableInt(Variables *variables, const char *context, char *name,
1899 : int64 value)
1900 : {
1901 : PgBenchValue val;
1902 :
1903 1018 : setIntValue(&val, value);
1904 1018 : return putVariableValue(variables, context, name, &val);
1905 : }
1906 :
1907 : /*
1908 : * Parse a possible variable reference (:varname).
1909 : *
1910 : * "sql" points at a colon. If what follows it looks like a valid
1911 : * variable name, return a malloc'd string containing the variable name,
1912 : * and set *eaten to the number of characters consumed (including the colon).
1913 : * Otherwise, return NULL.
1914 : */
1915 : static char *
1916 4830 : parseVariable(const char *sql, int *eaten)
1917 : {
1918 4830 : int i = 1; /* starting at 1 skips the colon */
1919 : char *name;
1920 :
1921 : /* keep this logic in sync with valid_variable_name() */
1922 4830 : if (IS_HIGHBIT_SET(sql[i]) ||
1923 4830 : strchr("ABCDEFGHIJKLMNOPQRSTUVWXYZ" "abcdefghijklmnopqrstuvwxyz"
1924 4830 : "_", sql[i]) != NULL)
1925 2184 : i++;
1926 : else
1927 2646 : return NULL;
1928 :
1929 10154 : while (IS_HIGHBIT_SET(sql[i]) ||
1930 10154 : strchr("ABCDEFGHIJKLMNOPQRSTUVWXYZ" "abcdefghijklmnopqrstuvwxyz"
1931 10154 : "_0123456789", sql[i]) != NULL)
1932 7970 : i++;
1933 :
1934 2184 : name = pg_malloc(i);
1935 2184 : memcpy(name, &sql[1], i - 1);
1936 2184 : name[i - 1] = '\0';
1937 :
1938 2184 : *eaten = i;
1939 2184 : return name;
1940 : }
1941 :
1942 : static char *
1943 2182 : replaceVariable(char **sql, char *param, int len, char *value)
1944 : {
1945 2182 : int valueln = strlen(value);
1946 :
1947 2182 : if (valueln > len)
1948 : {
1949 1152 : size_t offset = param - *sql;
1950 :
1951 1152 : *sql = pg_realloc(*sql, strlen(*sql) - len + valueln + 1);
1952 1152 : param = *sql + offset;
1953 : }
1954 :
1955 2182 : if (valueln != len)
1956 2104 : memmove(param + valueln, param + len, strlen(param + len) + 1);
1957 2182 : memcpy(param, value, valueln);
1958 :
1959 2182 : return param + valueln;
1960 : }
1961 :
1962 : static char *
1963 16292 : assignVariables(Variables *variables, char *sql)
1964 : {
1965 : char *p,
1966 : *name,
1967 : *val;
1968 :
1969 16292 : p = sql;
1970 20528 : while ((p = strchr(p, ':')) != NULL)
1971 : {
1972 : int eaten;
1973 :
1974 4236 : name = parseVariable(p, &eaten);
1975 4236 : if (name == NULL)
1976 : {
1977 6242 : while (*p == ':')
1978 : {
1979 3628 : p++;
1980 : }
1981 2614 : continue;
1982 : }
1983 :
1984 1622 : val = getVariable(variables, name);
1985 1622 : free(name);
1986 1622 : if (val == NULL)
1987 : {
1988 0 : p++;
1989 0 : continue;
1990 : }
1991 :
1992 1622 : p = replaceVariable(&sql, p, eaten, val);
1993 : }
1994 :
1995 16292 : return sql;
1996 : }
1997 :
1998 : static void
1999 5074 : getQueryParams(Variables *variables, const Command *command,
2000 : const char **params)
2001 : {
2002 : int i;
2003 :
2004 8406 : for (i = 0; i < command->argc - 1; i++)
2005 3332 : params[i] = getVariable(variables, command->argv[i + 1]);
2006 5074 : }
2007 :
2008 : static char *
2009 8 : valueTypeName(PgBenchValue *pval)
2010 : {
2011 8 : if (pval->type == PGBT_NO_VALUE)
2012 0 : return "none";
2013 8 : else if (pval->type == PGBT_NULL)
2014 0 : return "null";
2015 8 : else if (pval->type == PGBT_INT)
2016 0 : return "int";
2017 8 : else if (pval->type == PGBT_DOUBLE)
2018 2 : return "double";
2019 6 : else if (pval->type == PGBT_BOOLEAN)
2020 6 : return "boolean";
2021 : else
2022 : {
2023 : /* internal error, should never get there */
2024 : Assert(false);
2025 0 : return NULL;
2026 : }
2027 : }
2028 :
2029 : /* get a value as a boolean, or tell if there is a problem */
2030 : static bool
2031 216 : coerceToBool(PgBenchValue *pval, bool *bval)
2032 : {
2033 216 : if (pval->type == PGBT_BOOLEAN)
2034 : {
2035 214 : *bval = pval->u.bval;
2036 214 : return true;
2037 : }
2038 : else /* NULL, INT or DOUBLE */
2039 : {
2040 2 : pg_log_error("cannot coerce %s to boolean", valueTypeName(pval));
2041 2 : *bval = false; /* suppress uninitialized-variable warnings */
2042 2 : return false;
2043 : }
2044 : }
2045 :
2046 : /*
2047 : * Return true or false from an expression for conditional purposes.
2048 : * Non zero numerical values are true, zero and NULL are false.
2049 : */
2050 : static bool
2051 1042 : valueTruth(PgBenchValue *pval)
2052 : {
2053 1042 : switch (pval->type)
2054 : {
2055 2 : case PGBT_NULL:
2056 2 : return false;
2057 66 : case PGBT_BOOLEAN:
2058 66 : return pval->u.bval;
2059 972 : case PGBT_INT:
2060 972 : return pval->u.ival != 0;
2061 2 : case PGBT_DOUBLE:
2062 2 : return pval->u.dval != 0.0;
2063 0 : default:
2064 : /* internal error, unexpected type */
2065 : Assert(0);
2066 0 : return false;
2067 : }
2068 : }
2069 :
2070 : /* get a value as an int, tell if there is a problem */
2071 : static bool
2072 13200 : coerceToInt(PgBenchValue *pval, int64 *ival)
2073 : {
2074 13200 : if (pval->type == PGBT_INT)
2075 : {
2076 13192 : *ival = pval->u.ival;
2077 13192 : return true;
2078 : }
2079 8 : else if (pval->type == PGBT_DOUBLE)
2080 : {
2081 4 : double dval = rint(pval->u.dval);
2082 :
2083 4 : if (isnan(dval) || !FLOAT8_FITS_IN_INT64(dval))
2084 : {
2085 2 : pg_log_error("double to int overflow for %f", dval);
2086 2 : return false;
2087 : }
2088 2 : *ival = (int64) dval;
2089 2 : return true;
2090 : }
2091 : else /* BOOLEAN or NULL */
2092 : {
2093 4 : pg_log_error("cannot coerce %s to int", valueTypeName(pval));
2094 4 : return false;
2095 : }
2096 : }
2097 :
2098 : /* get a value as a double, or tell if there is a problem */
2099 : static bool
2100 208 : coerceToDouble(PgBenchValue *pval, double *dval)
2101 : {
2102 208 : if (pval->type == PGBT_DOUBLE)
2103 : {
2104 146 : *dval = pval->u.dval;
2105 146 : return true;
2106 : }
2107 62 : else if (pval->type == PGBT_INT)
2108 : {
2109 60 : *dval = (double) pval->u.ival;
2110 60 : return true;
2111 : }
2112 : else /* BOOLEAN or NULL */
2113 : {
2114 2 : pg_log_error("cannot coerce %s to double", valueTypeName(pval));
2115 2 : return false;
2116 : }
2117 : }
2118 :
2119 : /* assign a null value */
2120 : static void
2121 8 : setNullValue(PgBenchValue *pv)
2122 : {
2123 8 : pv->type = PGBT_NULL;
2124 8 : pv->u.ival = 0;
2125 8 : }
2126 :
2127 : /* assign a boolean value */
2128 : static void
2129 282 : setBoolValue(PgBenchValue *pv, bool bval)
2130 : {
2131 282 : pv->type = PGBT_BOOLEAN;
2132 282 : pv->u.bval = bval;
2133 282 : }
2134 :
2135 : /* assign an integer value */
2136 : static void
2137 8436 : setIntValue(PgBenchValue *pv, int64 ival)
2138 : {
2139 8436 : pv->type = PGBT_INT;
2140 8436 : pv->u.ival = ival;
2141 8436 : }
2142 :
2143 : /* assign a double value */
2144 : static void
2145 78 : setDoubleValue(PgBenchValue *pv, double dval)
2146 : {
2147 78 : pv->type = PGBT_DOUBLE;
2148 78 : pv->u.dval = dval;
2149 78 : }
2150 :
2151 : static bool
2152 7012 : isLazyFunc(PgBenchFunction func)
2153 : {
2154 7012 : return func == PGBENCH_AND || func == PGBENCH_OR || func == PGBENCH_CASE;
2155 : }
2156 :
2157 : /* lazy evaluation of some functions */
2158 : static bool
2159 130 : evalLazyFunc(CState *st,
2160 : PgBenchFunction func, PgBenchExprLink *args, PgBenchValue *retval)
2161 : {
2162 : PgBenchValue a1,
2163 : a2;
2164 : bool ba1,
2165 : ba2;
2166 :
2167 : Assert(isLazyFunc(func) && args != NULL && args->next != NULL);
2168 :
2169 : /* args points to first condition */
2170 130 : if (!evaluateExpr(st, args->expr, &a1))
2171 2 : return false;
2172 :
2173 : /* second condition for AND/OR and corresponding branch for CASE */
2174 128 : args = args->next;
2175 :
2176 128 : switch (func)
2177 : {
2178 88 : case PGBENCH_AND:
2179 88 : if (a1.type == PGBT_NULL)
2180 : {
2181 0 : setNullValue(retval);
2182 0 : return true;
2183 : }
2184 :
2185 88 : if (!coerceToBool(&a1, &ba1))
2186 0 : return false;
2187 :
2188 88 : if (!ba1)
2189 : {
2190 6 : setBoolValue(retval, false);
2191 6 : return true;
2192 : }
2193 :
2194 82 : if (!evaluateExpr(st, args->expr, &a2))
2195 0 : return false;
2196 :
2197 82 : if (a2.type == PGBT_NULL)
2198 : {
2199 0 : setNullValue(retval);
2200 0 : return true;
2201 : }
2202 82 : else if (!coerceToBool(&a2, &ba2))
2203 0 : return false;
2204 : else
2205 : {
2206 82 : setBoolValue(retval, ba2);
2207 82 : return true;
2208 : }
2209 :
2210 : return true;
2211 :
2212 8 : case PGBENCH_OR:
2213 :
2214 8 : if (a1.type == PGBT_NULL)
2215 : {
2216 0 : setNullValue(retval);
2217 0 : return true;
2218 : }
2219 :
2220 8 : if (!coerceToBool(&a1, &ba1))
2221 0 : return false;
2222 :
2223 8 : if (ba1)
2224 : {
2225 2 : setBoolValue(retval, true);
2226 2 : return true;
2227 : }
2228 :
2229 6 : if (!evaluateExpr(st, args->expr, &a2))
2230 0 : return false;
2231 :
2232 6 : if (a2.type == PGBT_NULL)
2233 : {
2234 0 : setNullValue(retval);
2235 0 : return true;
2236 : }
2237 6 : else if (!coerceToBool(&a2, &ba2))
2238 0 : return false;
2239 : else
2240 : {
2241 6 : setBoolValue(retval, ba2);
2242 6 : return true;
2243 : }
2244 :
2245 32 : case PGBENCH_CASE:
2246 : /* when true, execute branch */
2247 32 : if (valueTruth(&a1))
2248 22 : return evaluateExpr(st, args->expr, retval);
2249 :
2250 : /* now args contains next condition or final else expression */
2251 10 : args = args->next;
2252 :
2253 : /* final else case? */
2254 10 : if (args->next == NULL)
2255 6 : return evaluateExpr(st, args->expr, retval);
2256 :
2257 : /* no, another when, proceed */
2258 4 : return evalLazyFunc(st, PGBENCH_CASE, args, retval);
2259 :
2260 0 : default:
2261 : /* internal error, cannot get here */
2262 : Assert(0);
2263 0 : break;
2264 : }
2265 0 : return false;
2266 : }
2267 :
2268 : /* maximum number of function arguments */
2269 : #define MAX_FARGS 16
2270 :
2271 : /*
2272 : * Recursive evaluation of standard functions,
2273 : * which do not require lazy evaluation.
2274 : */
2275 : static bool
2276 6886 : evalStandardFunc(CState *st,
2277 : PgBenchFunction func, PgBenchExprLink *args,
2278 : PgBenchValue *retval)
2279 : {
2280 : /* evaluate all function arguments */
2281 6886 : int nargs = 0;
2282 6886 : PgBenchValue vargs[MAX_FARGS] = {0};
2283 6886 : PgBenchExprLink *l = args;
2284 6886 : bool has_null = false;
2285 :
2286 20584 : for (nargs = 0; nargs < MAX_FARGS && l != NULL; nargs++, l = l->next)
2287 : {
2288 13702 : if (!evaluateExpr(st, l->expr, &vargs[nargs]))
2289 4 : return false;
2290 13698 : has_null |= vargs[nargs].type == PGBT_NULL;
2291 : }
2292 :
2293 6882 : if (l != NULL)
2294 : {
2295 2 : pg_log_error("too many function arguments, maximum is %d", MAX_FARGS);
2296 2 : return false;
2297 : }
2298 :
2299 : /* NULL arguments */
2300 6880 : if (has_null && func != PGBENCH_IS && func != PGBENCH_DEBUG)
2301 : {
2302 6 : setNullValue(retval);
2303 6 : return true;
2304 : }
2305 :
2306 : /* then evaluate function */
2307 6874 : switch (func)
2308 : {
2309 : /* overloaded operators */
2310 3402 : case PGBENCH_ADD:
2311 : case PGBENCH_SUB:
2312 : case PGBENCH_MUL:
2313 : case PGBENCH_DIV:
2314 : case PGBENCH_MOD:
2315 : case PGBENCH_EQ:
2316 : case PGBENCH_NE:
2317 : case PGBENCH_LE:
2318 : case PGBENCH_LT:
2319 : {
2320 3402 : PgBenchValue *lval = &vargs[0],
2321 3402 : *rval = &vargs[1];
2322 :
2323 : Assert(nargs == 2);
2324 :
2325 : /* overloaded type management, double if some double */
2326 3402 : if ((lval->type == PGBT_DOUBLE ||
2327 3402 : rval->type == PGBT_DOUBLE) && func != PGBENCH_MOD)
2328 0 : {
2329 : double ld,
2330 : rd;
2331 :
2332 62 : if (!coerceToDouble(lval, &ld) ||
2333 62 : !coerceToDouble(rval, &rd))
2334 62 : return false;
2335 :
2336 62 : switch (func)
2337 : {
2338 2 : case PGBENCH_ADD:
2339 2 : setDoubleValue(retval, ld + rd);
2340 2 : return true;
2341 :
2342 20 : case PGBENCH_SUB:
2343 20 : setDoubleValue(retval, ld - rd);
2344 20 : return true;
2345 :
2346 16 : case PGBENCH_MUL:
2347 16 : setDoubleValue(retval, ld * rd);
2348 16 : return true;
2349 :
2350 4 : case PGBENCH_DIV:
2351 4 : setDoubleValue(retval, ld / rd);
2352 4 : return true;
2353 :
2354 8 : case PGBENCH_EQ:
2355 8 : setBoolValue(retval, ld == rd);
2356 8 : return true;
2357 :
2358 4 : case PGBENCH_NE:
2359 4 : setBoolValue(retval, ld != rd);
2360 4 : return true;
2361 :
2362 4 : case PGBENCH_LE:
2363 4 : setBoolValue(retval, ld <= rd);
2364 4 : return true;
2365 :
2366 4 : case PGBENCH_LT:
2367 4 : setBoolValue(retval, ld < rd);
2368 4 : return true;
2369 :
2370 0 : default:
2371 : /* cannot get here */
2372 : Assert(0);
2373 : }
2374 : }
2375 : else /* we have integer operands, or % */
2376 : {
2377 : int64 li,
2378 : ri,
2379 : res;
2380 :
2381 3340 : if (!coerceToInt(lval, &li) ||
2382 3338 : !coerceToInt(rval, &ri))
2383 3340 : return false;
2384 :
2385 3338 : switch (func)
2386 : {
2387 88 : case PGBENCH_ADD:
2388 88 : if (pg_add_s64_overflow(li, ri, &res))
2389 : {
2390 2 : pg_log_error("bigint add out of range");
2391 2 : return false;
2392 : }
2393 86 : setIntValue(retval, res);
2394 86 : return true;
2395 :
2396 298 : case PGBENCH_SUB:
2397 298 : if (pg_sub_s64_overflow(li, ri, &res))
2398 : {
2399 2 : pg_log_error("bigint sub out of range");
2400 2 : return false;
2401 : }
2402 296 : setIntValue(retval, res);
2403 296 : return true;
2404 :
2405 2820 : case PGBENCH_MUL:
2406 2820 : if (pg_mul_s64_overflow(li, ri, &res))
2407 : {
2408 2 : pg_log_error("bigint mul out of range");
2409 2 : return false;
2410 : }
2411 2818 : setIntValue(retval, res);
2412 2818 : return true;
2413 :
2414 68 : case PGBENCH_EQ:
2415 68 : setBoolValue(retval, li == ri);
2416 68 : return true;
2417 :
2418 10 : case PGBENCH_NE:
2419 10 : setBoolValue(retval, li != ri);
2420 10 : return true;
2421 :
2422 10 : case PGBENCH_LE:
2423 10 : setBoolValue(retval, li <= ri);
2424 10 : return true;
2425 :
2426 24 : case PGBENCH_LT:
2427 24 : setBoolValue(retval, li < ri);
2428 24 : return true;
2429 :
2430 20 : case PGBENCH_DIV:
2431 : case PGBENCH_MOD:
2432 20 : if (ri == 0)
2433 : {
2434 4 : pg_log_error("division by zero");
2435 4 : return false;
2436 : }
2437 : /* special handling of -1 divisor */
2438 16 : if (ri == -1)
2439 : {
2440 6 : if (func == PGBENCH_DIV)
2441 : {
2442 : /* overflow check (needed for INT64_MIN) */
2443 4 : if (li == PG_INT64_MIN)
2444 : {
2445 2 : pg_log_error("bigint div out of range");
2446 2 : return false;
2447 : }
2448 : else
2449 2 : setIntValue(retval, -li);
2450 : }
2451 : else
2452 2 : setIntValue(retval, 0);
2453 4 : return true;
2454 : }
2455 : /* else divisor is not -1 */
2456 10 : if (func == PGBENCH_DIV)
2457 4 : setIntValue(retval, li / ri);
2458 : else /* func == PGBENCH_MOD */
2459 6 : setIntValue(retval, li % ri);
2460 :
2461 10 : return true;
2462 :
2463 0 : default:
2464 : /* cannot get here */
2465 : Assert(0);
2466 : }
2467 : }
2468 :
2469 : Assert(0);
2470 0 : return false; /* NOTREACHED */
2471 : }
2472 :
2473 : /* integer bitwise operators */
2474 28 : case PGBENCH_BITAND:
2475 : case PGBENCH_BITOR:
2476 : case PGBENCH_BITXOR:
2477 : case PGBENCH_LSHIFT:
2478 : case PGBENCH_RSHIFT:
2479 : {
2480 : int64 li,
2481 : ri;
2482 :
2483 28 : if (!coerceToInt(&vargs[0], &li) || !coerceToInt(&vargs[1], &ri))
2484 0 : return false;
2485 :
2486 28 : if (func == PGBENCH_BITAND)
2487 2 : setIntValue(retval, li & ri);
2488 26 : else if (func == PGBENCH_BITOR)
2489 4 : setIntValue(retval, li | ri);
2490 22 : else if (func == PGBENCH_BITXOR)
2491 6 : setIntValue(retval, li ^ ri);
2492 16 : else if (func == PGBENCH_LSHIFT)
2493 14 : setIntValue(retval, li << ri);
2494 2 : else if (func == PGBENCH_RSHIFT)
2495 2 : setIntValue(retval, li >> ri);
2496 : else /* cannot get here */
2497 : Assert(0);
2498 :
2499 28 : return true;
2500 : }
2501 :
2502 : /* logical operators */
2503 32 : case PGBENCH_NOT:
2504 : {
2505 : bool b;
2506 :
2507 32 : if (!coerceToBool(&vargs[0], &b))
2508 2 : return false;
2509 :
2510 30 : setBoolValue(retval, !b);
2511 30 : return true;
2512 : }
2513 :
2514 : /* no arguments */
2515 2 : case PGBENCH_PI:
2516 2 : setDoubleValue(retval, M_PI);
2517 2 : return true;
2518 :
2519 : /* 1 overloaded argument */
2520 4 : case PGBENCH_ABS:
2521 : {
2522 4 : PgBenchValue *varg = &vargs[0];
2523 :
2524 : Assert(nargs == 1);
2525 :
2526 4 : if (varg->type == PGBT_INT)
2527 : {
2528 2 : int64 i = varg->u.ival;
2529 :
2530 2 : setIntValue(retval, i < 0 ? -i : i);
2531 : }
2532 : else
2533 : {
2534 2 : double d = varg->u.dval;
2535 :
2536 : Assert(varg->type == PGBT_DOUBLE);
2537 2 : setDoubleValue(retval, d < 0.0 ? -d : d);
2538 : }
2539 :
2540 4 : return true;
2541 : }
2542 :
2543 168 : case PGBENCH_DEBUG:
2544 : {
2545 168 : PgBenchValue *varg = &vargs[0];
2546 :
2547 : Assert(nargs == 1);
2548 :
2549 168 : fprintf(stderr, "debug(script=%d,command=%d): ",
2550 168 : st->use_file, st->command + 1);
2551 :
2552 168 : if (varg->type == PGBT_NULL)
2553 4 : fprintf(stderr, "null\n");
2554 164 : else if (varg->type == PGBT_BOOLEAN)
2555 38 : fprintf(stderr, "boolean %s\n", varg->u.bval ? "true" : "false");
2556 126 : else if (varg->type == PGBT_INT)
2557 94 : fprintf(stderr, "int " INT64_FORMAT "\n", varg->u.ival);
2558 32 : else if (varg->type == PGBT_DOUBLE)
2559 32 : fprintf(stderr, "double %.*g\n", DBL_DIG, varg->u.dval);
2560 : else /* internal error, unexpected type */
2561 : Assert(0);
2562 :
2563 168 : *retval = *varg;
2564 :
2565 168 : return true;
2566 : }
2567 :
2568 : /* 1 double argument */
2569 10 : case PGBENCH_DOUBLE:
2570 : case PGBENCH_SQRT:
2571 : case PGBENCH_LN:
2572 : case PGBENCH_EXP:
2573 : {
2574 : double dval;
2575 :
2576 : Assert(nargs == 1);
2577 :
2578 10 : if (!coerceToDouble(&vargs[0], &dval))
2579 2 : return false;
2580 :
2581 8 : if (func == PGBENCH_SQRT)
2582 2 : dval = sqrt(dval);
2583 6 : else if (func == PGBENCH_LN)
2584 2 : dval = log(dval);
2585 4 : else if (func == PGBENCH_EXP)
2586 2 : dval = exp(dval);
2587 : /* else is cast: do nothing */
2588 :
2589 8 : setDoubleValue(retval, dval);
2590 8 : return true;
2591 : }
2592 :
2593 : /* 1 int argument */
2594 4 : case PGBENCH_INT:
2595 : {
2596 : int64 ival;
2597 :
2598 : Assert(nargs == 1);
2599 :
2600 4 : if (!coerceToInt(&vargs[0], &ival))
2601 2 : return false;
2602 :
2603 2 : setIntValue(retval, ival);
2604 2 : return true;
2605 : }
2606 :
2607 : /* variable number of arguments */
2608 8 : case PGBENCH_LEAST:
2609 : case PGBENCH_GREATEST:
2610 : {
2611 : bool havedouble;
2612 : int i;
2613 :
2614 : Assert(nargs >= 1);
2615 :
2616 : /* need double result if any input is double */
2617 8 : havedouble = false;
2618 28 : for (i = 0; i < nargs; i++)
2619 : {
2620 24 : if (vargs[i].type == PGBT_DOUBLE)
2621 : {
2622 4 : havedouble = true;
2623 4 : break;
2624 : }
2625 : }
2626 8 : if (havedouble)
2627 : {
2628 : double extremum;
2629 :
2630 4 : if (!coerceToDouble(&vargs[0], &extremum))
2631 0 : return false;
2632 12 : for (i = 1; i < nargs; i++)
2633 : {
2634 : double dval;
2635 :
2636 8 : if (!coerceToDouble(&vargs[i], &dval))
2637 0 : return false;
2638 8 : if (func == PGBENCH_LEAST)
2639 4 : extremum = Min(extremum, dval);
2640 : else
2641 4 : extremum = Max(extremum, dval);
2642 : }
2643 4 : setDoubleValue(retval, extremum);
2644 : }
2645 : else
2646 : {
2647 : int64 extremum;
2648 :
2649 4 : if (!coerceToInt(&vargs[0], &extremum))
2650 0 : return false;
2651 16 : for (i = 1; i < nargs; i++)
2652 : {
2653 : int64 ival;
2654 :
2655 12 : if (!coerceToInt(&vargs[i], &ival))
2656 0 : return false;
2657 12 : if (func == PGBENCH_LEAST)
2658 6 : extremum = Min(extremum, ival);
2659 : else
2660 6 : extremum = Max(extremum, ival);
2661 : }
2662 4 : setIntValue(retval, extremum);
2663 : }
2664 8 : return true;
2665 : }
2666 :
2667 : /* random functions */
2668 3074 : case PGBENCH_RANDOM:
2669 : case PGBENCH_RANDOM_EXPONENTIAL:
2670 : case PGBENCH_RANDOM_GAUSSIAN:
2671 : case PGBENCH_RANDOM_ZIPFIAN:
2672 : {
2673 : int64 imin,
2674 : imax,
2675 : delta;
2676 :
2677 : Assert(nargs >= 2);
2678 :
2679 3074 : if (!coerceToInt(&vargs[0], &imin) ||
2680 3072 : !coerceToInt(&vargs[1], &imax))
2681 2 : return false;
2682 :
2683 : /* check random range */
2684 3072 : if (unlikely(imin > imax))
2685 : {
2686 2 : pg_log_error("empty range given to random");
2687 2 : return false;
2688 : }
2689 3070 : else if (unlikely(pg_sub_s64_overflow(imax, imin, &delta) ||
2690 : pg_add_s64_overflow(delta, 1, &delta)))
2691 : {
2692 : /* prevent int overflows in random functions */
2693 2 : pg_log_error("random range is too large");
2694 2 : return false;
2695 : }
2696 :
2697 3068 : if (func == PGBENCH_RANDOM)
2698 : {
2699 : Assert(nargs == 2);
2700 3042 : setIntValue(retval, getrand(&st->cs_func_rs, imin, imax));
2701 : }
2702 : else /* gaussian & exponential */
2703 : {
2704 : double param;
2705 :
2706 : Assert(nargs == 3);
2707 :
2708 26 : if (!coerceToDouble(&vargs[2], ¶m))
2709 8 : return false;
2710 :
2711 26 : if (func == PGBENCH_RANDOM_GAUSSIAN)
2712 : {
2713 8 : if (param < MIN_GAUSSIAN_PARAM)
2714 : {
2715 2 : pg_log_error("gaussian parameter must be at least %f (not %f)",
2716 : MIN_GAUSSIAN_PARAM, param);
2717 2 : return false;
2718 : }
2719 :
2720 6 : setIntValue(retval,
2721 : getGaussianRand(&st->cs_func_rs,
2722 : imin, imax, param));
2723 : }
2724 18 : else if (func == PGBENCH_RANDOM_ZIPFIAN)
2725 : {
2726 10 : if (param < MIN_ZIPFIAN_PARAM || param > MAX_ZIPFIAN_PARAM)
2727 : {
2728 4 : pg_log_error("zipfian parameter must be in range [%.3f, %.0f] (not %f)",
2729 : MIN_ZIPFIAN_PARAM, MAX_ZIPFIAN_PARAM, param);
2730 4 : return false;
2731 : }
2732 :
2733 6 : setIntValue(retval,
2734 : getZipfianRand(&st->cs_func_rs, imin, imax, param));
2735 : }
2736 : else /* exponential */
2737 : {
2738 8 : if (param <= 0.0)
2739 : {
2740 2 : pg_log_error("exponential parameter must be greater than zero (not %f)",
2741 : param);
2742 2 : return false;
2743 : }
2744 :
2745 6 : setIntValue(retval,
2746 : getExponentialRand(&st->cs_func_rs,
2747 : imin, imax, param));
2748 : }
2749 : }
2750 :
2751 3060 : return true;
2752 : }
2753 :
2754 18 : case PGBENCH_POW:
2755 : {
2756 18 : PgBenchValue *lval = &vargs[0];
2757 18 : PgBenchValue *rval = &vargs[1];
2758 : double ld,
2759 : rd;
2760 :
2761 : Assert(nargs == 2);
2762 :
2763 18 : if (!coerceToDouble(lval, &ld) ||
2764 18 : !coerceToDouble(rval, &rd))
2765 0 : return false;
2766 :
2767 18 : setDoubleValue(retval, pow(ld, rd));
2768 :
2769 18 : return true;
2770 : }
2771 :
2772 20 : case PGBENCH_IS:
2773 : {
2774 : Assert(nargs == 2);
2775 :
2776 : /*
2777 : * note: this simple implementation is more permissive than
2778 : * SQL
2779 : */
2780 20 : setBoolValue(retval,
2781 30 : vargs[0].type == vargs[1].type &&
2782 10 : vargs[0].u.bval == vargs[1].u.bval);
2783 20 : return true;
2784 : }
2785 :
2786 : /* hashing */
2787 12 : case PGBENCH_HASH_FNV1A:
2788 : case PGBENCH_HASH_MURMUR2:
2789 : {
2790 : int64 val,
2791 : seed;
2792 :
2793 : Assert(nargs == 2);
2794 :
2795 12 : if (!coerceToInt(&vargs[0], &val) ||
2796 12 : !coerceToInt(&vargs[1], &seed))
2797 0 : return false;
2798 :
2799 12 : if (func == PGBENCH_HASH_MURMUR2)
2800 10 : setIntValue(retval, getHashMurmur2(val, seed));
2801 2 : else if (func == PGBENCH_HASH_FNV1A)
2802 2 : setIntValue(retval, getHashFnv1a(val, seed));
2803 : else
2804 : /* cannot get here */
2805 : Assert(0);
2806 :
2807 12 : return true;
2808 : }
2809 :
2810 92 : case PGBENCH_PERMUTE:
2811 : {
2812 : int64 val,
2813 : size,
2814 : seed;
2815 :
2816 : Assert(nargs == 3);
2817 :
2818 92 : if (!coerceToInt(&vargs[0], &val) ||
2819 92 : !coerceToInt(&vargs[1], &size) ||
2820 92 : !coerceToInt(&vargs[2], &seed))
2821 0 : return false;
2822 :
2823 92 : if (size <= 0)
2824 : {
2825 2 : pg_log_error("permute size parameter must be greater than zero");
2826 2 : return false;
2827 : }
2828 :
2829 90 : setIntValue(retval, permute(val, size, seed));
2830 90 : return true;
2831 : }
2832 :
2833 0 : default:
2834 : /* cannot get here */
2835 : Assert(0);
2836 : /* dead code to avoid a compiler warning */
2837 0 : return false;
2838 : }
2839 : }
2840 :
2841 : /* evaluate some function */
2842 : static bool
2843 7012 : evalFunc(CState *st,
2844 : PgBenchFunction func, PgBenchExprLink *args, PgBenchValue *retval)
2845 : {
2846 7012 : if (isLazyFunc(func))
2847 126 : return evalLazyFunc(st, func, args, retval);
2848 : else
2849 6886 : return evalStandardFunc(st, func, args, retval);
2850 : }
2851 :
2852 : /*
2853 : * Recursive evaluation of an expression in a pgbench script
2854 : * using the current state of variables.
2855 : * Returns whether the evaluation was ok,
2856 : * the value itself is returned through the retval pointer.
2857 : */
2858 : static bool
2859 18382 : evaluateExpr(CState *st, PgBenchExpr *expr, PgBenchValue *retval)
2860 : {
2861 18382 : switch (expr->etype)
2862 : {
2863 7360 : case ENODE_CONSTANT:
2864 : {
2865 7360 : *retval = expr->u.constant;
2866 7360 : return true;
2867 : }
2868 :
2869 4010 : case ENODE_VARIABLE:
2870 : {
2871 : Variable *var;
2872 :
2873 4010 : if ((var = lookupVariable(&st->variables, expr->u.variable.varname)) == NULL)
2874 : {
2875 4 : pg_log_error("undefined variable \"%s\"", expr->u.variable.varname);
2876 4 : return false;
2877 : }
2878 :
2879 4006 : if (!makeVariableValue(var))
2880 4 : return false;
2881 :
2882 4002 : *retval = var->value;
2883 4002 : return true;
2884 : }
2885 :
2886 7012 : case ENODE_FUNCTION:
2887 7012 : return evalFunc(st,
2888 : expr->u.function.function,
2889 : expr->u.function.args,
2890 : retval);
2891 :
2892 0 : default:
2893 : /* internal error which should never occur */
2894 0 : pg_fatal("unexpected enode type in evaluation: %d", expr->etype);
2895 : }
2896 : }
2897 :
2898 : /*
2899 : * Convert command name to meta-command enum identifier
2900 : */
2901 : static MetaCommand
2902 1064 : getMetaCommand(const char *cmd)
2903 : {
2904 : MetaCommand mc;
2905 :
2906 1064 : if (cmd == NULL)
2907 0 : mc = META_NONE;
2908 1064 : else if (pg_strcasecmp(cmd, "set") == 0)
2909 726 : mc = META_SET;
2910 338 : else if (pg_strcasecmp(cmd, "setshell") == 0)
2911 8 : mc = META_SETSHELL;
2912 330 : else if (pg_strcasecmp(cmd, "shell") == 0)
2913 10 : mc = META_SHELL;
2914 320 : else if (pg_strcasecmp(cmd, "sleep") == 0)
2915 18 : mc = META_SLEEP;
2916 302 : else if (pg_strcasecmp(cmd, "if") == 0)
2917 48 : mc = META_IF;
2918 254 : else if (pg_strcasecmp(cmd, "elif") == 0)
2919 26 : mc = META_ELIF;
2920 228 : else if (pg_strcasecmp(cmd, "else") == 0)
2921 28 : mc = META_ELSE;
2922 200 : else if (pg_strcasecmp(cmd, "endif") == 0)
2923 42 : mc = META_ENDIF;
2924 158 : else if (pg_strcasecmp(cmd, "gset") == 0)
2925 64 : mc = META_GSET;
2926 94 : else if (pg_strcasecmp(cmd, "aset") == 0)
2927 6 : mc = META_ASET;
2928 88 : else if (pg_strcasecmp(cmd, "startpipeline") == 0)
2929 42 : mc = META_STARTPIPELINE;
2930 46 : else if (pg_strcasecmp(cmd, "syncpipeline") == 0)
2931 10 : mc = META_SYNCPIPELINE;
2932 36 : else if (pg_strcasecmp(cmd, "endpipeline") == 0)
2933 34 : mc = META_ENDPIPELINE;
2934 : else
2935 2 : mc = META_NONE;
2936 1064 : return mc;
2937 : }
2938 :
2939 : /*
2940 : * Run a shell command. The result is assigned to the variable if not NULL.
2941 : * Return true if succeeded, or false on error.
2942 : */
2943 : static bool
2944 12 : runShellCommand(Variables *variables, char *variable, char **argv, int argc)
2945 : {
2946 : char command[SHELL_COMMAND_SIZE];
2947 : int i,
2948 12 : len = 0;
2949 : FILE *fp;
2950 : char res[64];
2951 : char *endptr;
2952 : int retval;
2953 :
2954 : /*----------
2955 : * Join arguments with whitespace separators. Arguments starting with
2956 : * exactly one colon are treated as variables:
2957 : * name - append a string "name"
2958 : * :var - append a variable named 'var'
2959 : * ::name - append a string ":name"
2960 : *----------
2961 : */
2962 34 : for (i = 0; i < argc; i++)
2963 : {
2964 : char *arg;
2965 : int arglen;
2966 :
2967 24 : if (argv[i][0] != ':')
2968 : {
2969 18 : arg = argv[i]; /* a string literal */
2970 : }
2971 6 : else if (argv[i][1] == ':')
2972 : {
2973 2 : arg = argv[i] + 1; /* a string literal starting with colons */
2974 : }
2975 4 : else if ((arg = getVariable(variables, argv[i] + 1)) == NULL)
2976 : {
2977 2 : pg_log_error("%s: undefined variable \"%s\"", argv[0], argv[i]);
2978 2 : return false;
2979 : }
2980 :
2981 22 : arglen = strlen(arg);
2982 22 : if (len + arglen + (i > 0 ? 1 : 0) >= SHELL_COMMAND_SIZE - 1)
2983 : {
2984 0 : pg_log_error("%s: shell command is too long", argv[0]);
2985 0 : return false;
2986 : }
2987 :
2988 22 : if (i > 0)
2989 10 : command[len++] = ' ';
2990 22 : memcpy(command + len, arg, arglen);
2991 22 : len += arglen;
2992 : }
2993 :
2994 10 : command[len] = '\0';
2995 :
2996 10 : fflush(NULL); /* needed before either system() or popen() */
2997 :
2998 : /* Fast path for non-assignment case */
2999 10 : if (variable == NULL)
3000 : {
3001 4 : if (system(command))
3002 : {
3003 2 : if (!timer_exceeded)
3004 2 : pg_log_error("%s: could not launch shell command", argv[0]);
3005 2 : return false;
3006 : }
3007 2 : return true;
3008 : }
3009 :
3010 : /* Execute the command with pipe and read the standard output. */
3011 6 : if ((fp = popen(command, "r")) == NULL)
3012 : {
3013 0 : pg_log_error("%s: could not launch shell command", argv[0]);
3014 0 : return false;
3015 : }
3016 6 : if (fgets(res, sizeof(res), fp) == NULL)
3017 : {
3018 2 : if (!timer_exceeded)
3019 2 : pg_log_error("%s: could not read result of shell command", argv[0]);
3020 2 : (void) pclose(fp);
3021 2 : return false;
3022 : }
3023 4 : if (pclose(fp) < 0)
3024 : {
3025 0 : pg_log_error("%s: could not run shell command: %m", argv[0]);
3026 0 : return false;
3027 : }
3028 :
3029 : /* Check whether the result is an integer and assign it to the variable */
3030 4 : retval = (int) strtol(res, &endptr, 10);
3031 6 : while (*endptr != '\0' && isspace((unsigned char) *endptr))
3032 2 : endptr++;
3033 4 : if (*res == '\0' || *endptr != '\0')
3034 : {
3035 2 : pg_log_error("%s: shell command must return an integer (not \"%s\")", argv[0], res);
3036 2 : return false;
3037 : }
3038 2 : if (!putVariableInt(variables, "setshell", variable, retval))
3039 0 : return false;
3040 :
3041 2 : pg_log_debug("%s: shell parameter name: \"%s\", value: \"%s\"", argv[0], argv[1], res);
3042 :
3043 2 : return true;
3044 : }
3045 :
3046 : /*
3047 : * Report the abortion of the client when processing SQL commands.
3048 : */
3049 : static void
3050 64 : commandFailed(CState *st, const char *cmd, const char *message)
3051 : {
3052 64 : pg_log_error("client %d aborted in command %d (%s) of script %d; %s",
3053 : st->id, st->command, cmd, st->use_file, message);
3054 64 : }
3055 :
3056 : /*
3057 : * Report the error in the command while the script is executing.
3058 : */
3059 : static void
3060 4 : commandError(CState *st, const char *message)
3061 : {
3062 : /*
3063 : * Errors should only be detected during an SQL command or the
3064 : * \endpipeline meta command. Any other case triggers an assertion
3065 : * failure.
3066 : */
3067 : Assert(sql_script[st->use_file].commands[st->command]->type == SQL_COMMAND ||
3068 : sql_script[st->use_file].commands[st->command]->meta == META_ENDPIPELINE);
3069 :
3070 4 : pg_log_info("client %d got an error in command %d (SQL) of script %d; %s",
3071 : st->id, st->command, st->use_file, message);
3072 4 : }
3073 :
3074 : /* return a script number with a weighted choice. */
3075 : static int
3076 15494 : chooseScript(TState *thread)
3077 : {
3078 15494 : int i = 0;
3079 : int64 w;
3080 :
3081 15494 : if (num_scripts == 1)
3082 12794 : return 0;
3083 :
3084 2700 : w = getrand(&thread->ts_choose_rs, 0, total_weight - 1);
3085 : do
3086 : {
3087 6314 : w -= sql_script[i++].weight;
3088 6314 : } while (w >= 0);
3089 :
3090 2700 : return i - 1;
3091 : }
3092 :
3093 : /*
3094 : * Allocate space for CState->prepared: we need one boolean for each command
3095 : * of each script.
3096 : */
3097 : static void
3098 68 : allocCStatePrepared(CState *st)
3099 : {
3100 : Assert(st->prepared == NULL);
3101 :
3102 68 : st->prepared = pg_malloc(sizeof(bool *) * num_scripts);
3103 148 : for (int i = 0; i < num_scripts; i++)
3104 : {
3105 80 : ParsedScript *script = &sql_script[i];
3106 : int numcmds;
3107 :
3108 340 : for (numcmds = 0; script->commands[numcmds] != NULL; numcmds++)
3109 : ;
3110 80 : st->prepared[i] = pg_malloc0(sizeof(bool) * numcmds);
3111 : }
3112 68 : }
3113 :
3114 : /*
3115 : * Prepare the SQL command from st->use_file at command_num.
3116 : */
3117 : static void
3118 4004 : prepareCommand(CState *st, int command_num)
3119 : {
3120 4004 : Command *command = sql_script[st->use_file].commands[command_num];
3121 :
3122 : /* No prepare for non-SQL commands */
3123 4004 : if (command->type != SQL_COMMAND)
3124 0 : return;
3125 :
3126 4004 : if (!st->prepared)
3127 58 : allocCStatePrepared(st);
3128 :
3129 4004 : if (!st->prepared[st->use_file][command_num])
3130 : {
3131 : PGresult *res;
3132 :
3133 218 : pg_log_debug("client %d preparing %s", st->id, command->prepname);
3134 218 : res = PQprepare(st->con, command->prepname,
3135 218 : command->argv[0], command->argc - 1, NULL);
3136 218 : if (PQresultStatus(res) != PGRES_COMMAND_OK)
3137 2 : pg_log_error("%s", PQerrorMessage(st->con));
3138 218 : PQclear(res);
3139 218 : st->prepared[st->use_file][command_num] = true;
3140 : }
3141 : }
3142 :
3143 : /*
3144 : * Prepare all the commands in the script that come after the \startpipeline
3145 : * that's at position st->command, and the first \endpipeline we find.
3146 : *
3147 : * This sets the ->prepared flag for each relevant command as well as the
3148 : * \startpipeline itself, but doesn't move the st->command counter.
3149 : */
3150 : static void
3151 84 : prepareCommandsInPipeline(CState *st)
3152 : {
3153 : int j;
3154 84 : Command **commands = sql_script[st->use_file].commands;
3155 :
3156 : Assert(commands[st->command]->type == META_COMMAND &&
3157 : commands[st->command]->meta == META_STARTPIPELINE);
3158 :
3159 84 : if (!st->prepared)
3160 10 : allocCStatePrepared(st);
3161 :
3162 : /*
3163 : * We set the 'prepared' flag on the \startpipeline itself to flag that we
3164 : * don't need to do this next time without calling prepareCommand(), even
3165 : * though we don't actually prepare this command.
3166 : */
3167 84 : if (st->prepared[st->use_file][st->command])
3168 72 : return;
3169 :
3170 128 : for (j = st->command + 1; commands[j] != NULL; j++)
3171 : {
3172 128 : if (commands[j]->type == META_COMMAND &&
3173 12 : commands[j]->meta == META_ENDPIPELINE)
3174 12 : break;
3175 :
3176 116 : prepareCommand(st, j);
3177 : }
3178 :
3179 12 : st->prepared[st->use_file][st->command] = true;
3180 : }
3181 :
3182 : /* Send a SQL command, using the chosen querymode */
3183 : static bool
3184 21366 : sendCommand(CState *st, Command *command)
3185 : {
3186 : int r;
3187 :
3188 21366 : if (querymode == QUERY_SIMPLE)
3189 : {
3190 : char *sql;
3191 :
3192 16292 : sql = pg_strdup(command->argv[0]);
3193 16292 : sql = assignVariables(&st->variables, sql);
3194 :
3195 16292 : pg_log_debug("client %d sending %s", st->id, sql);
3196 16292 : r = PQsendQuery(st->con, sql);
3197 16292 : free(sql);
3198 : }
3199 5074 : else if (querymode == QUERY_EXTENDED)
3200 : {
3201 1186 : const char *sql = command->argv[0];
3202 : const char *params[MAX_ARGS];
3203 :
3204 1186 : getQueryParams(&st->variables, command, params);
3205 :
3206 1186 : pg_log_debug("client %d sending %s", st->id, sql);
3207 1186 : r = PQsendQueryParams(st->con, sql, command->argc - 1,
3208 : NULL, params, NULL, NULL, 0);
3209 : }
3210 3888 : else if (querymode == QUERY_PREPARED)
3211 : {
3212 : const char *params[MAX_ARGS];
3213 :
3214 3888 : prepareCommand(st, st->command);
3215 3888 : getQueryParams(&st->variables, command, params);
3216 :
3217 3888 : pg_log_debug("client %d sending %s", st->id, command->prepname);
3218 3888 : r = PQsendQueryPrepared(st->con, command->prepname, command->argc - 1,
3219 : params, NULL, NULL, 0);
3220 : }
3221 : else /* unknown sql mode */
3222 0 : r = 0;
3223 :
3224 21366 : if (r == 0)
3225 : {
3226 0 : pg_log_debug("client %d could not send %s", st->id, command->argv[0]);
3227 0 : return false;
3228 : }
3229 : else
3230 21366 : return true;
3231 : }
3232 :
3233 : /*
3234 : * Get the error status from the error code.
3235 : */
3236 : static EStatus
3237 26 : getSQLErrorStatus(const char *sqlState)
3238 : {
3239 26 : if (sqlState != NULL)
3240 : {
3241 26 : if (strcmp(sqlState, ERRCODE_T_R_SERIALIZATION_FAILURE) == 0)
3242 2 : return ESTATUS_SERIALIZATION_ERROR;
3243 24 : else if (strcmp(sqlState, ERRCODE_T_R_DEADLOCK_DETECTED) == 0)
3244 2 : return ESTATUS_DEADLOCK_ERROR;
3245 : }
3246 :
3247 22 : return ESTATUS_OTHER_SQL_ERROR;
3248 : }
3249 :
3250 : /*
3251 : * Returns true if this type of error can be retried.
3252 : */
3253 : static bool
3254 68 : canRetryError(EStatus estatus)
3255 : {
3256 68 : return (estatus == ESTATUS_SERIALIZATION_ERROR ||
3257 : estatus == ESTATUS_DEADLOCK_ERROR);
3258 : }
3259 :
3260 : /*
3261 : * Process query response from the backend.
3262 : *
3263 : * If varprefix is not NULL, it's the variable name prefix where to store
3264 : * the results of the *last* command (META_GSET) or *all* commands
3265 : * (META_ASET).
3266 : *
3267 : * Returns true if everything is A-OK, false if any error occurs.
3268 : */
3269 : static bool
3270 21456 : readCommandResponse(CState *st, MetaCommand meta, char *varprefix)
3271 : {
3272 : PGresult *res;
3273 : PGresult *next_res;
3274 21456 : int qrynum = 0;
3275 :
3276 : /*
3277 : * varprefix should be set only with \gset or \aset, and \endpipeline and
3278 : * SQL commands do not need it.
3279 : */
3280 : Assert((meta == META_NONE && varprefix == NULL) ||
3281 : ((meta == META_ENDPIPELINE) && varprefix == NULL) ||
3282 : ((meta == META_GSET || meta == META_ASET) && varprefix != NULL));
3283 :
3284 21456 : res = PQgetResult(st->con);
3285 :
3286 42886 : while (res != NULL)
3287 : {
3288 : bool is_last;
3289 :
3290 : /* peek at the next result to know whether the current is last */
3291 21468 : next_res = PQgetResult(st->con);
3292 21468 : is_last = (next_res == NULL);
3293 :
3294 21468 : switch (PQresultStatus(res))
3295 : {
3296 16694 : case PGRES_COMMAND_OK: /* non-SELECT commands */
3297 : case PGRES_EMPTY_QUERY: /* may be used for testing no-op overhead */
3298 16694 : if (is_last && meta == META_GSET)
3299 : {
3300 2 : pg_log_error("client %d script %d command %d query %d: expected one row, got %d",
3301 : st->id, st->use_file, st->command, qrynum, 0);
3302 2 : st->estatus = ESTATUS_META_COMMAND_ERROR;
3303 2 : goto error;
3304 : }
3305 16692 : break;
3306 :
3307 4638 : case PGRES_TUPLES_OK:
3308 4638 : if ((is_last && meta == META_GSET) || meta == META_ASET)
3309 : {
3310 1030 : int ntuples = PQntuples(res);
3311 :
3312 1030 : if (meta == META_GSET && ntuples != 1)
3313 : {
3314 : /* under \gset, report the error */
3315 4 : pg_log_error("client %d script %d command %d query %d: expected one row, got %d",
3316 : st->id, st->use_file, st->command, qrynum, PQntuples(res));
3317 4 : st->estatus = ESTATUS_META_COMMAND_ERROR;
3318 4 : goto error;
3319 : }
3320 1026 : else if (meta == META_ASET && ntuples <= 0)
3321 : {
3322 : /* coldly skip empty result under \aset */
3323 2 : break;
3324 : }
3325 :
3326 : /* store results into variables */
3327 2048 : for (int fld = 0; fld < PQnfields(res); fld++)
3328 : {
3329 1028 : char *varname = PQfname(res, fld);
3330 :
3331 : /* allocate varname only if necessary, freed below */
3332 1028 : if (*varprefix != '\0')
3333 2 : varname = psprintf("%s%s", varprefix, varname);
3334 :
3335 : /* store last row result as a string */
3336 1028 : if (!putVariable(&st->variables, meta == META_ASET ? "aset" : "gset", varname,
3337 1028 : PQgetvalue(res, ntuples - 1, fld)))
3338 : {
3339 : /* internal error */
3340 4 : pg_log_error("client %d script %d command %d query %d: error storing into variable %s",
3341 : st->id, st->use_file, st->command, qrynum, varname);
3342 4 : st->estatus = ESTATUS_META_COMMAND_ERROR;
3343 4 : goto error;
3344 : }
3345 :
3346 1024 : if (*varprefix != '\0')
3347 2 : pg_free(varname);
3348 : }
3349 : }
3350 : /* otherwise the result is simply thrown away by PQclear below */
3351 4628 : break;
3352 :
3353 108 : case PGRES_PIPELINE_SYNC:
3354 108 : pg_log_debug("client %d pipeline ending, ongoing syncs: %d",
3355 : st->id, st->num_syncs);
3356 108 : st->num_syncs--;
3357 108 : if (st->num_syncs == 0 && PQexitPipelineMode(st->con) != 1)
3358 0 : pg_log_error("client %d failed to exit pipeline mode: %s", st->id,
3359 : PQresultErrorMessage(res));
3360 108 : break;
3361 :
3362 2 : case PGRES_COPY_IN:
3363 : case PGRES_COPY_OUT:
3364 : case PGRES_COPY_BOTH:
3365 2 : pg_log_error("COPY is not supported in pgbench, aborting");
3366 :
3367 : /*
3368 : * We need to exit the copy state. Otherwise, PQgetResult()
3369 : * will always return an empty PGresult as an effect of
3370 : * getCopyResult(), leading to an infinite loop in the error
3371 : * cleanup done below.
3372 : */
3373 2 : PQendcopy(st->con);
3374 2 : goto error;
3375 :
3376 26 : case PGRES_NONFATAL_ERROR:
3377 : case PGRES_FATAL_ERROR:
3378 26 : st->estatus = getSQLErrorStatus(PQresultErrorField(res,
3379 : PG_DIAG_SQLSTATE));
3380 26 : if (canRetryError(st->estatus))
3381 : {
3382 4 : if (verbose_errors)
3383 4 : commandError(st, PQresultErrorMessage(res));
3384 4 : goto error;
3385 : }
3386 : /* fall through */
3387 :
3388 : default:
3389 : /* anything else is unexpected */
3390 22 : pg_log_error("client %d script %d aborted in command %d query %d: %s",
3391 : st->id, st->use_file, st->command, qrynum,
3392 : PQresultErrorMessage(res));
3393 22 : goto error;
3394 : }
3395 :
3396 21430 : PQclear(res);
3397 21430 : qrynum++;
3398 21430 : res = next_res;
3399 : }
3400 :
3401 21418 : if (qrynum == 0)
3402 : {
3403 0 : pg_log_error("client %d command %d: no results", st->id, st->command);
3404 0 : return false;
3405 : }
3406 :
3407 21418 : return true;
3408 :
3409 38 : error:
3410 38 : PQclear(res);
3411 38 : PQclear(next_res);
3412 : do
3413 : {
3414 46 : res = PQgetResult(st->con);
3415 46 : PQclear(res);
3416 46 : } while (res);
3417 :
3418 38 : return false;
3419 : }
3420 :
3421 : /*
3422 : * Parse the argument to a \sleep command, and return the requested amount
3423 : * of delay, in microseconds. Returns true on success, false on error.
3424 : */
3425 : static bool
3426 12 : evaluateSleep(Variables *variables, int argc, char **argv, int *usecs)
3427 : {
3428 : char *var;
3429 : int usec;
3430 :
3431 12 : if (*argv[1] == ':')
3432 : {
3433 6 : if ((var = getVariable(variables, argv[1] + 1)) == NULL)
3434 : {
3435 2 : pg_log_error("%s: undefined variable \"%s\"", argv[0], argv[1] + 1);
3436 2 : return false;
3437 : }
3438 :
3439 4 : usec = atoi(var);
3440 :
3441 : /* Raise an error if the value of a variable is not a number */
3442 4 : if (usec == 0 && !isdigit((unsigned char) *var))
3443 : {
3444 0 : pg_log_error("%s: invalid sleep time \"%s\" for variable \"%s\"",
3445 : argv[0], var, argv[1] + 1);
3446 0 : return false;
3447 : }
3448 : }
3449 : else
3450 6 : usec = atoi(argv[1]);
3451 :
3452 10 : if (argc > 2)
3453 : {
3454 8 : if (pg_strcasecmp(argv[2], "ms") == 0)
3455 4 : usec *= 1000;
3456 4 : else if (pg_strcasecmp(argv[2], "s") == 0)
3457 2 : usec *= 1000000;
3458 : }
3459 : else
3460 2 : usec *= 1000000;
3461 :
3462 10 : *usecs = usec;
3463 10 : return true;
3464 : }
3465 :
3466 :
3467 : /*
3468 : * Returns true if the error can be retried.
3469 : */
3470 : static bool
3471 4 : doRetry(CState *st, pg_time_usec_t *now)
3472 : {
3473 : Assert(st->estatus != ESTATUS_NO_ERROR);
3474 :
3475 : /* We can only retry serialization or deadlock errors. */
3476 4 : if (!canRetryError(st->estatus))
3477 0 : return false;
3478 :
3479 : /*
3480 : * We must have at least one option to limit the retrying of transactions
3481 : * that got an error.
3482 : */
3483 : Assert(max_tries || latency_limit || duration > 0);
3484 :
3485 : /*
3486 : * We cannot retry the error if we have reached the maximum number of
3487 : * tries.
3488 : */
3489 4 : if (max_tries && st->tries >= max_tries)
3490 0 : return false;
3491 :
3492 : /*
3493 : * We cannot retry the error if we spent too much time on this
3494 : * transaction.
3495 : */
3496 4 : if (latency_limit)
3497 : {
3498 0 : pg_time_now_lazy(now);
3499 0 : if (*now - st->txn_scheduled > latency_limit)
3500 0 : return false;
3501 : }
3502 :
3503 : /*
3504 : * We cannot retry the error if the benchmark duration is over.
3505 : */
3506 4 : if (timer_exceeded)
3507 0 : return false;
3508 :
3509 : /* OK */
3510 4 : return true;
3511 : }
3512 :
3513 : /*
3514 : * Read results and discard it until a sync point.
3515 : */
3516 : static int
3517 0 : discardUntilSync(CState *st)
3518 : {
3519 0 : bool received_sync = false;
3520 :
3521 : /* send a sync */
3522 0 : if (!PQpipelineSync(st->con))
3523 : {
3524 0 : pg_log_error("client %d aborted: failed to send a pipeline sync",
3525 : st->id);
3526 0 : return 0;
3527 : }
3528 :
3529 : /* receive PGRES_PIPELINE_SYNC and null following it */
3530 : for (;;)
3531 0 : {
3532 0 : PGresult *res = PQgetResult(st->con);
3533 :
3534 0 : if (PQresultStatus(res) == PGRES_PIPELINE_SYNC)
3535 0 : received_sync = true;
3536 0 : else if (received_sync)
3537 : {
3538 : /*
3539 : * PGRES_PIPELINE_SYNC must be followed by another
3540 : * PGRES_PIPELINE_SYNC or NULL; otherwise, assert failure.
3541 : */
3542 : Assert(res == NULL);
3543 :
3544 : /*
3545 : * Reset ongoing sync count to 0 since all PGRES_PIPELINE_SYNC
3546 : * results have been discarded.
3547 : */
3548 0 : st->num_syncs = 0;
3549 0 : PQclear(res);
3550 0 : break;
3551 : }
3552 0 : PQclear(res);
3553 : }
3554 :
3555 : /* exit pipeline */
3556 0 : if (PQexitPipelineMode(st->con) != 1)
3557 : {
3558 0 : pg_log_error("client %d aborted: failed to exit pipeline mode for rolling back the failed transaction",
3559 : st->id);
3560 0 : return 0;
3561 : }
3562 0 : return 1;
3563 : }
3564 :
3565 : /*
3566 : * Get the transaction status at the end of a command especially for
3567 : * checking if we are in a (failed) transaction block.
3568 : */
3569 : static TStatus
3570 15390 : getTransactionStatus(PGconn *con)
3571 : {
3572 : PGTransactionStatusType tx_status;
3573 :
3574 15390 : tx_status = PQtransactionStatus(con);
3575 15390 : switch (tx_status)
3576 : {
3577 15386 : case PQTRANS_IDLE:
3578 15386 : return TSTATUS_IDLE;
3579 4 : case PQTRANS_INTRANS:
3580 : case PQTRANS_INERROR:
3581 4 : return TSTATUS_IN_BLOCK;
3582 0 : case PQTRANS_UNKNOWN:
3583 : /* PQTRANS_UNKNOWN is expected given a broken connection */
3584 0 : if (PQstatus(con) == CONNECTION_BAD)
3585 0 : return TSTATUS_CONN_ERROR;
3586 : /* fall through */
3587 : case PQTRANS_ACTIVE:
3588 : default:
3589 :
3590 : /*
3591 : * We cannot find out whether we are in a transaction block or
3592 : * not. Internal error which should never occur.
3593 : */
3594 0 : pg_log_error("unexpected transaction status %d", tx_status);
3595 0 : return TSTATUS_OTHER_ERROR;
3596 : }
3597 :
3598 : /* not reached */
3599 : Assert(false);
3600 : return TSTATUS_OTHER_ERROR;
3601 : }
3602 :
3603 : /*
3604 : * Print verbose messages of an error
3605 : */
3606 : static void
3607 4 : printVerboseErrorMessages(CState *st, pg_time_usec_t *now, bool is_retry)
3608 : {
3609 : static PQExpBuffer buf = NULL;
3610 :
3611 4 : if (buf == NULL)
3612 4 : buf = createPQExpBuffer();
3613 : else
3614 0 : resetPQExpBuffer(buf);
3615 :
3616 4 : printfPQExpBuffer(buf, "client %d ", st->id);
3617 4 : appendPQExpBufferStr(buf, (is_retry ?
3618 : "repeats the transaction after the error" :
3619 : "ends the failed transaction"));
3620 4 : appendPQExpBuffer(buf, " (try %u", st->tries);
3621 :
3622 : /* Print max_tries if it is not unlimited. */
3623 4 : if (max_tries)
3624 4 : appendPQExpBuffer(buf, "/%u", max_tries);
3625 :
3626 : /*
3627 : * If the latency limit is used, print a percentage of the current
3628 : * transaction latency from the latency limit.
3629 : */
3630 4 : if (latency_limit)
3631 : {
3632 0 : pg_time_now_lazy(now);
3633 0 : appendPQExpBuffer(buf, ", %.3f%% of the maximum time of tries was used",
3634 0 : (100.0 * (*now - st->txn_scheduled) / latency_limit));
3635 : }
3636 4 : appendPQExpBufferStr(buf, ")\n");
3637 :
3638 4 : pg_log_info("%s", buf->data);
3639 4 : }
3640 :
3641 : /*
3642 : * Advance the state machine of a connection.
3643 : */
3644 : static void
3645 35930 : advanceConnectionState(TState *thread, CState *st, StatsData *agg)
3646 : {
3647 :
3648 : /*
3649 : * gettimeofday() isn't free, so we get the current timestamp lazily the
3650 : * first time it's needed, and reuse the same value throughout this
3651 : * function after that. This also ensures that e.g. the calculated
3652 : * latency reported in the log file and in the totals are the same. Zero
3653 : * means "not set yet". Reset "now" when we execute shell commands or
3654 : * expressions, which might take a non-negligible amount of time, though.
3655 : */
3656 35930 : pg_time_usec_t now = 0;
3657 :
3658 : /*
3659 : * Loop in the state machine, until we have to wait for a result from the
3660 : * server or have to sleep for throttling or \sleep.
3661 : *
3662 : * Note: In the switch-statement below, 'break' will loop back here,
3663 : * meaning "continue in the state machine". Return is used to return to
3664 : * the caller, giving the thread the opportunity to advance another
3665 : * client.
3666 : */
3667 : for (;;)
3668 121966 : {
3669 : Command *command;
3670 :
3671 157896 : switch (st->state)
3672 : {
3673 : /* Select transaction (script) to run. */
3674 15494 : case CSTATE_CHOOSE_SCRIPT:
3675 15494 : st->use_file = chooseScript(thread);
3676 : Assert(conditional_stack_empty(st->cstack));
3677 :
3678 : /* reset transaction variables to default values */
3679 15494 : st->estatus = ESTATUS_NO_ERROR;
3680 15494 : st->tries = 1;
3681 :
3682 15494 : pg_log_debug("client %d executing script \"%s\"",
3683 : st->id, sql_script[st->use_file].desc);
3684 :
3685 : /*
3686 : * If time is over, we're done; otherwise, get ready to start
3687 : * a new transaction, or to get throttled if that's requested.
3688 : */
3689 30988 : st->state = timer_exceeded ? CSTATE_FINISHED :
3690 15494 : throttle_delay > 0 ? CSTATE_PREPARE_THROTTLE : CSTATE_START_TX;
3691 15494 : break;
3692 :
3693 : /* Start new transaction (script) */
3694 15492 : case CSTATE_START_TX:
3695 15492 : pg_time_now_lazy(&now);
3696 :
3697 : /* establish connection if needed, i.e. under --connect */
3698 15492 : if (st->con == NULL)
3699 : {
3700 220 : pg_time_usec_t start = now;
3701 :
3702 220 : if ((st->con = doConnect()) == NULL)
3703 : {
3704 : /*
3705 : * as the bench is already running, we do not abort
3706 : * the process
3707 : */
3708 0 : pg_log_error("client %d aborted while establishing connection", st->id);
3709 0 : st->state = CSTATE_ABORTED;
3710 0 : break;
3711 : }
3712 :
3713 : /* reset now after connection */
3714 220 : now = pg_time_now();
3715 :
3716 220 : thread->conn_duration += now - start;
3717 :
3718 : /* Reset session-local state */
3719 220 : pg_free(st->prepared);
3720 220 : st->prepared = NULL;
3721 : }
3722 :
3723 : /*
3724 : * It is the first try to run this transaction. Remember the
3725 : * random state: maybe it will get an error and we will need
3726 : * to run it again.
3727 : */
3728 15492 : st->random_state = st->cs_func_rs;
3729 :
3730 : /* record transaction start time */
3731 15492 : st->txn_begin = now;
3732 :
3733 : /*
3734 : * When not throttling, this is also the transaction's
3735 : * scheduled start time.
3736 : */
3737 15492 : if (!throttle_delay)
3738 15090 : st->txn_scheduled = now;
3739 :
3740 : /* Begin with the first command */
3741 15492 : st->state = CSTATE_START_COMMAND;
3742 15492 : st->command = 0;
3743 15492 : break;
3744 :
3745 : /*
3746 : * Handle throttling once per transaction by sleeping.
3747 : */
3748 420 : case CSTATE_PREPARE_THROTTLE:
3749 :
3750 : /*
3751 : * Generate a delay such that the series of delays will
3752 : * approximate a Poisson distribution centered on the
3753 : * throttle_delay time.
3754 : *
3755 : * If transactions are too slow or a given wait is shorter
3756 : * than a transaction, the next transaction will start right
3757 : * away.
3758 : */
3759 : Assert(throttle_delay > 0);
3760 :
3761 420 : thread->throttle_trigger +=
3762 420 : getPoissonRand(&thread->ts_throttle_rs, throttle_delay);
3763 420 : st->txn_scheduled = thread->throttle_trigger;
3764 :
3765 : /*
3766 : * If --latency-limit is used, and this slot is already late
3767 : * so that the transaction will miss the latency limit even if
3768 : * it completed immediately, skip this time slot and loop to
3769 : * reschedule.
3770 : */
3771 420 : if (latency_limit)
3772 : {
3773 420 : pg_time_now_lazy(&now);
3774 :
3775 420 : if (thread->throttle_trigger < now - latency_limit)
3776 : {
3777 18 : processXactStats(thread, st, &now, true, agg);
3778 :
3779 : /*
3780 : * Finish client if -T or -t was exceeded.
3781 : *
3782 : * Stop counting skipped transactions under -T as soon
3783 : * as the timer is exceeded. Because otherwise it can
3784 : * take a very long time to count all of them
3785 : * especially when quite a lot of them happen with
3786 : * unrealistically high rate setting in -R, which
3787 : * would prevent pgbench from ending immediately.
3788 : * Because of this behavior, note that there is no
3789 : * guarantee that all skipped transactions are counted
3790 : * under -T though there is under -t. This is OK in
3791 : * practice because it's very unlikely to happen with
3792 : * realistic setting.
3793 : */
3794 18 : if (timer_exceeded || (nxacts > 0 && st->cnt >= nxacts))
3795 2 : st->state = CSTATE_FINISHED;
3796 :
3797 : /* Go back to top of loop with CSTATE_PREPARE_THROTTLE */
3798 18 : break;
3799 : }
3800 : }
3801 :
3802 : /*
3803 : * stop client if next transaction is beyond pgbench end of
3804 : * execution; otherwise, throttle it.
3805 : */
3806 0 : st->state = end_time > 0 && st->txn_scheduled > end_time ?
3807 402 : CSTATE_FINISHED : CSTATE_THROTTLE;
3808 402 : break;
3809 :
3810 : /*
3811 : * Wait until it's time to start next transaction.
3812 : */
3813 402 : case CSTATE_THROTTLE:
3814 402 : pg_time_now_lazy(&now);
3815 :
3816 402 : if (now < st->txn_scheduled)
3817 0 : return; /* still sleeping, nothing to do here */
3818 :
3819 : /* done sleeping, but don't start transaction if we're done */
3820 402 : st->state = timer_exceeded ? CSTATE_FINISHED : CSTATE_START_TX;
3821 402 : break;
3822 :
3823 : /*
3824 : * Send a command to server (or execute a meta-command)
3825 : */
3826 41552 : case CSTATE_START_COMMAND:
3827 41552 : command = sql_script[st->use_file].commands[st->command];
3828 :
3829 : /*
3830 : * Transition to script end processing if done, but close up
3831 : * shop if a pipeline is open at this point.
3832 : */
3833 41552 : if (command == NULL)
3834 : {
3835 15392 : if (PQpipelineStatus(st->con) == PQ_PIPELINE_OFF)
3836 15386 : st->state = CSTATE_END_TX;
3837 : else
3838 : {
3839 6 : pg_log_error("client %d aborted: end of script reached with pipeline open",
3840 : st->id);
3841 6 : st->state = CSTATE_ABORTED;
3842 : }
3843 :
3844 15392 : break;
3845 : }
3846 :
3847 : /* record begin time of next command, and initiate it */
3848 26160 : if (report_per_command)
3849 : {
3850 802 : pg_time_now_lazy(&now);
3851 802 : st->stmt_begin = now;
3852 : }
3853 :
3854 : /* Execute the command */
3855 26160 : if (command->type == SQL_COMMAND)
3856 : {
3857 : /* disallow \aset and \gset in pipeline mode */
3858 21368 : if (PQpipelineStatus(st->con) != PQ_PIPELINE_OFF)
3859 : {
3860 1048 : if (command->meta == META_GSET)
3861 : {
3862 2 : commandFailed(st, "gset", "\\gset is not allowed in pipeline mode");
3863 2 : st->state = CSTATE_ABORTED;
3864 2 : break;
3865 : }
3866 1046 : else if (command->meta == META_ASET)
3867 : {
3868 0 : commandFailed(st, "aset", "\\aset is not allowed in pipeline mode");
3869 0 : st->state = CSTATE_ABORTED;
3870 0 : break;
3871 : }
3872 : }
3873 :
3874 21366 : if (!sendCommand(st, command))
3875 : {
3876 0 : commandFailed(st, "SQL", "SQL command send failed");
3877 0 : st->state = CSTATE_ABORTED;
3878 : }
3879 : else
3880 : {
3881 : /* Wait for results, unless in pipeline mode */
3882 21366 : if (PQpipelineStatus(st->con) == PQ_PIPELINE_OFF)
3883 20320 : st->state = CSTATE_WAIT_RESULT;
3884 : else
3885 1046 : st->state = CSTATE_END_COMMAND;
3886 : }
3887 : }
3888 4792 : else if (command->type == META_COMMAND)
3889 : {
3890 : /*-----
3891 : * Possible state changes when executing meta commands:
3892 : * - on errors CSTATE_ABORTED
3893 : * - on sleep CSTATE_SLEEP
3894 : * - else CSTATE_END_COMMAND
3895 : */
3896 4792 : st->state = executeMetaCommand(st, &now);
3897 4792 : if (st->state == CSTATE_ABORTED)
3898 62 : st->estatus = ESTATUS_META_COMMAND_ERROR;
3899 : }
3900 :
3901 : /*
3902 : * We're now waiting for an SQL command to complete, or
3903 : * finished processing a metacommand, or need to sleep, or
3904 : * something bad happened.
3905 : */
3906 : Assert(st->state == CSTATE_WAIT_RESULT ||
3907 : st->state == CSTATE_END_COMMAND ||
3908 : st->state == CSTATE_SLEEP ||
3909 : st->state == CSTATE_ABORTED);
3910 26158 : break;
3911 :
3912 : /*
3913 : * non executed conditional branch
3914 : */
3915 5124 : case CSTATE_SKIP_COMMAND:
3916 : Assert(!conditional_active(st->cstack));
3917 : /* quickly skip commands until something to do... */
3918 : while (true)
3919 : {
3920 5124 : command = sql_script[st->use_file].commands[st->command];
3921 :
3922 : /* cannot reach end of script in that state */
3923 : Assert(command != NULL);
3924 :
3925 : /*
3926 : * if this is conditional related, update conditional
3927 : * state
3928 : */
3929 5124 : if (command->type == META_COMMAND &&
3930 982 : (command->meta == META_IF ||
3931 976 : command->meta == META_ELIF ||
3932 960 : command->meta == META_ELSE ||
3933 946 : command->meta == META_ENDIF))
3934 : {
3935 954 : switch (conditional_stack_peek(st->cstack))
3936 : {
3937 924 : case IFSTATE_FALSE:
3938 924 : if (command->meta == META_IF)
3939 : {
3940 : /* nested if in skipped branch - ignore */
3941 4 : conditional_stack_push(st->cstack,
3942 : IFSTATE_IGNORED);
3943 4 : st->command++;
3944 : }
3945 920 : else if (command->meta == META_ELIF)
3946 : {
3947 : /* we must evaluate the condition */
3948 10 : st->state = CSTATE_START_COMMAND;
3949 : }
3950 910 : else if (command->meta == META_ELSE)
3951 : {
3952 : /* we must execute next command */
3953 6 : conditional_stack_poke(st->cstack,
3954 : IFSTATE_ELSE_TRUE);
3955 6 : st->state = CSTATE_START_COMMAND;
3956 6 : st->command++;
3957 : }
3958 904 : else if (command->meta == META_ENDIF)
3959 : {
3960 : Assert(!conditional_stack_empty(st->cstack));
3961 904 : conditional_stack_pop(st->cstack);
3962 904 : if (conditional_active(st->cstack))
3963 904 : st->state = CSTATE_START_COMMAND;
3964 : /* else state remains CSTATE_SKIP_COMMAND */
3965 904 : st->command++;
3966 : }
3967 924 : break;
3968 :
3969 30 : case IFSTATE_IGNORED:
3970 : case IFSTATE_ELSE_FALSE:
3971 30 : if (command->meta == META_IF)
3972 2 : conditional_stack_push(st->cstack,
3973 : IFSTATE_IGNORED);
3974 28 : else if (command->meta == META_ENDIF)
3975 : {
3976 : Assert(!conditional_stack_empty(st->cstack));
3977 14 : conditional_stack_pop(st->cstack);
3978 14 : if (conditional_active(st->cstack))
3979 8 : st->state = CSTATE_START_COMMAND;
3980 : }
3981 : /* could detect "else" & "elif" after "else" */
3982 30 : st->command++;
3983 30 : break;
3984 :
3985 954 : case IFSTATE_NONE:
3986 : case IFSTATE_TRUE:
3987 : case IFSTATE_ELSE_TRUE:
3988 : default:
3989 :
3990 : /*
3991 : * inconsistent if inactive, unreachable dead
3992 : * code
3993 : */
3994 : Assert(false);
3995 : }
3996 : }
3997 : else
3998 : {
3999 : /* skip and consider next */
4000 4170 : st->command++;
4001 : }
4002 :
4003 5124 : if (st->state != CSTATE_SKIP_COMMAND)
4004 : /* out of quick skip command loop */
4005 928 : break;
4006 : }
4007 928 : break;
4008 :
4009 : /*
4010 : * Wait for the current SQL command to complete
4011 : */
4012 41886 : case CSTATE_WAIT_RESULT:
4013 41886 : pg_log_debug("client %d receiving", st->id);
4014 :
4015 : /*
4016 : * Only check for new network data if we processed all data
4017 : * fetched prior. Otherwise we end up doing a syscall for each
4018 : * individual pipelined query, which has a measurable
4019 : * performance impact.
4020 : */
4021 41886 : if (PQisBusy(st->con) && !PQconsumeInput(st->con))
4022 : {
4023 : /* there's something wrong */
4024 0 : commandFailed(st, "SQL", "perhaps the backend died while processing");
4025 0 : st->state = CSTATE_ABORTED;
4026 0 : break;
4027 : }
4028 41886 : if (PQisBusy(st->con))
4029 20430 : return; /* don't have the whole result yet */
4030 :
4031 : /* store or discard the query results */
4032 21456 : if (readCommandResponse(st,
4033 21456 : sql_script[st->use_file].commands[st->command]->meta,
4034 21456 : sql_script[st->use_file].commands[st->command]->varprefix))
4035 : {
4036 : /*
4037 : * outside of pipeline mode: stop reading results.
4038 : * pipeline mode: continue reading results until an
4039 : * end-of-pipeline response.
4040 : */
4041 21418 : if (PQpipelineStatus(st->con) != PQ_PIPELINE_ON)
4042 20388 : st->state = CSTATE_END_COMMAND;
4043 : }
4044 38 : else if (canRetryError(st->estatus))
4045 4 : st->state = CSTATE_ERROR;
4046 : else
4047 34 : st->state = CSTATE_ABORTED;
4048 21456 : break;
4049 :
4050 : /*
4051 : * Wait until sleep is done. This state is entered after a
4052 : * \sleep metacommand. The behavior is similar to
4053 : * CSTATE_THROTTLE, but proceeds to CSTATE_START_COMMAND
4054 : * instead of CSTATE_START_TX.
4055 : */
4056 16 : case CSTATE_SLEEP:
4057 16 : pg_time_now_lazy(&now);
4058 16 : if (now < st->sleep_until)
4059 6 : return; /* still sleeping, nothing to do here */
4060 : /* Else done sleeping. */
4061 10 : st->state = CSTATE_END_COMMAND;
4062 10 : break;
4063 :
4064 : /*
4065 : * End of command: record stats and proceed to next command.
4066 : */
4067 26056 : case CSTATE_END_COMMAND:
4068 :
4069 : /*
4070 : * command completed: accumulate per-command execution times
4071 : * in thread-local data structure, if per-command latencies
4072 : * are requested.
4073 : */
4074 26056 : if (report_per_command)
4075 : {
4076 802 : pg_time_now_lazy(&now);
4077 :
4078 802 : command = sql_script[st->use_file].commands[st->command];
4079 : /* XXX could use a mutex here, but we choose not to */
4080 802 : addToSimpleStats(&command->stats,
4081 802 : PG_TIME_GET_DOUBLE(now - st->stmt_begin));
4082 : }
4083 :
4084 : /* Go ahead with next command, to be executed or skipped */
4085 26056 : st->command++;
4086 26056 : st->state = conditional_active(st->cstack) ?
4087 26056 : CSTATE_START_COMMAND : CSTATE_SKIP_COMMAND;
4088 26056 : break;
4089 :
4090 : /*
4091 : * Clean up after an error.
4092 : */
4093 4 : case CSTATE_ERROR:
4094 : {
4095 : TStatus tstatus;
4096 :
4097 : Assert(st->estatus != ESTATUS_NO_ERROR);
4098 :
4099 : /* Clear the conditional stack */
4100 4 : conditional_stack_reset(st->cstack);
4101 :
4102 : /* Read and discard until a sync point in pipeline mode */
4103 4 : if (PQpipelineStatus(st->con) != PQ_PIPELINE_OFF)
4104 : {
4105 0 : if (!discardUntilSync(st))
4106 : {
4107 0 : st->state = CSTATE_ABORTED;
4108 0 : break;
4109 : }
4110 : }
4111 :
4112 : /*
4113 : * Check if we have a (failed) transaction block or not,
4114 : * and roll it back if any.
4115 : */
4116 4 : tstatus = getTransactionStatus(st->con);
4117 4 : if (tstatus == TSTATUS_IN_BLOCK)
4118 : {
4119 : /* Try to rollback a (failed) transaction block. */
4120 2 : if (!PQsendQuery(st->con, "ROLLBACK"))
4121 : {
4122 0 : pg_log_error("client %d aborted: failed to send sql command for rolling back the failed transaction",
4123 : st->id);
4124 0 : st->state = CSTATE_ABORTED;
4125 : }
4126 : else
4127 2 : st->state = CSTATE_WAIT_ROLLBACK_RESULT;
4128 : }
4129 2 : else if (tstatus == TSTATUS_IDLE)
4130 : {
4131 : /*
4132 : * If time is over, we're done; otherwise, check if we
4133 : * can retry the error.
4134 : */
4135 4 : st->state = timer_exceeded ? CSTATE_FINISHED :
4136 2 : doRetry(st, &now) ? CSTATE_RETRY : CSTATE_FAILURE;
4137 : }
4138 : else
4139 : {
4140 0 : if (tstatus == TSTATUS_CONN_ERROR)
4141 0 : pg_log_error("perhaps the backend died while processing");
4142 :
4143 0 : pg_log_error("client %d aborted while receiving the transaction status", st->id);
4144 0 : st->state = CSTATE_ABORTED;
4145 : }
4146 4 : break;
4147 : }
4148 :
4149 : /*
4150 : * Wait for the rollback command to complete
4151 : */
4152 4 : case CSTATE_WAIT_ROLLBACK_RESULT:
4153 : {
4154 : PGresult *res;
4155 :
4156 4 : pg_log_debug("client %d receiving", st->id);
4157 4 : if (!PQconsumeInput(st->con))
4158 : {
4159 0 : pg_log_error("client %d aborted while rolling back the transaction after an error; perhaps the backend died while processing",
4160 : st->id);
4161 0 : st->state = CSTATE_ABORTED;
4162 0 : break;
4163 : }
4164 4 : if (PQisBusy(st->con))
4165 2 : return; /* don't have the whole result yet */
4166 :
4167 : /*
4168 : * Read and discard the query result;
4169 : */
4170 2 : res = PQgetResult(st->con);
4171 2 : switch (PQresultStatus(res))
4172 : {
4173 2 : case PGRES_COMMAND_OK:
4174 : /* OK */
4175 2 : PQclear(res);
4176 : /* null must be returned */
4177 2 : res = PQgetResult(st->con);
4178 : Assert(res == NULL);
4179 :
4180 : /*
4181 : * If time is over, we're done; otherwise, check
4182 : * if we can retry the error.
4183 : */
4184 4 : st->state = timer_exceeded ? CSTATE_FINISHED :
4185 2 : doRetry(st, &now) ? CSTATE_RETRY : CSTATE_FAILURE;
4186 2 : break;
4187 0 : default:
4188 0 : pg_log_error("client %d aborted while rolling back the transaction after an error; %s",
4189 : st->id, PQerrorMessage(st->con));
4190 0 : PQclear(res);
4191 0 : st->state = CSTATE_ABORTED;
4192 0 : break;
4193 : }
4194 2 : break;
4195 : }
4196 :
4197 : /*
4198 : * Retry the transaction after an error.
4199 : */
4200 4 : case CSTATE_RETRY:
4201 4 : command = sql_script[st->use_file].commands[st->command];
4202 :
4203 : /*
4204 : * Inform that the transaction will be retried after the
4205 : * error.
4206 : */
4207 4 : if (verbose_errors)
4208 4 : printVerboseErrorMessages(st, &now, true);
4209 :
4210 : /* Count tries and retries */
4211 4 : st->tries++;
4212 4 : command->retries++;
4213 :
4214 : /*
4215 : * Reset the random state as they were at the beginning of the
4216 : * transaction.
4217 : */
4218 4 : st->cs_func_rs = st->random_state;
4219 :
4220 : /* Process the first transaction command. */
4221 4 : st->command = 0;
4222 4 : st->estatus = ESTATUS_NO_ERROR;
4223 4 : st->state = CSTATE_START_COMMAND;
4224 4 : break;
4225 :
4226 : /*
4227 : * Record a failed transaction.
4228 : */
4229 0 : case CSTATE_FAILURE:
4230 0 : command = sql_script[st->use_file].commands[st->command];
4231 :
4232 : /* Accumulate the failure. */
4233 0 : command->failures++;
4234 :
4235 : /*
4236 : * Inform that the failed transaction will not be retried.
4237 : */
4238 0 : if (verbose_errors)
4239 0 : printVerboseErrorMessages(st, &now, false);
4240 :
4241 : /* End the failed transaction. */
4242 0 : st->state = CSTATE_END_TX;
4243 0 : break;
4244 :
4245 : /*
4246 : * End of transaction (end of script, really).
4247 : */
4248 15386 : case CSTATE_END_TX:
4249 : {
4250 : TStatus tstatus;
4251 :
4252 : /* transaction finished: calculate latency and do log */
4253 15386 : processXactStats(thread, st, &now, false, agg);
4254 :
4255 : /*
4256 : * missing \endif... cannot happen if CheckConditional was
4257 : * okay
4258 : */
4259 : Assert(conditional_stack_empty(st->cstack));
4260 :
4261 : /*
4262 : * We must complete all the transaction blocks that were
4263 : * started in this script.
4264 : */
4265 15386 : tstatus = getTransactionStatus(st->con);
4266 15386 : if (tstatus == TSTATUS_IN_BLOCK)
4267 : {
4268 2 : pg_log_error("client %d aborted: end of script reached without completing the last transaction",
4269 : st->id);
4270 2 : st->state = CSTATE_ABORTED;
4271 2 : break;
4272 : }
4273 15384 : else if (tstatus != TSTATUS_IDLE)
4274 : {
4275 0 : if (tstatus == TSTATUS_CONN_ERROR)
4276 0 : pg_log_error("perhaps the backend died while processing");
4277 :
4278 0 : pg_log_error("client %d aborted while receiving the transaction status", st->id);
4279 0 : st->state = CSTATE_ABORTED;
4280 0 : break;
4281 : }
4282 :
4283 15384 : if (is_connect)
4284 : {
4285 220 : pg_time_usec_t start = now;
4286 :
4287 220 : pg_time_now_lazy(&start);
4288 220 : finishCon(st);
4289 220 : now = pg_time_now();
4290 220 : thread->conn_duration += now - start;
4291 : }
4292 :
4293 15384 : if ((st->cnt >= nxacts && duration <= 0) || timer_exceeded)
4294 : {
4295 : /* script completed */
4296 144 : st->state = CSTATE_FINISHED;
4297 144 : break;
4298 : }
4299 :
4300 : /* next transaction (script) */
4301 15240 : st->state = CSTATE_CHOOSE_SCRIPT;
4302 :
4303 : /*
4304 : * Ensure that we always return on this point, so as to
4305 : * avoid an infinite loop if the script only contains meta
4306 : * commands.
4307 : */
4308 15240 : return;
4309 : }
4310 :
4311 : /*
4312 : * Final states. Close the connection if it's still open.
4313 : */
4314 252 : case CSTATE_ABORTED:
4315 : case CSTATE_FINISHED:
4316 :
4317 : /*
4318 : * Don't measure the disconnection delays here even if in
4319 : * CSTATE_FINISHED and -C/--connect option is specified.
4320 : * Because in this case all the connections that this thread
4321 : * established are closed at the end of transactions and the
4322 : * disconnection delays should have already been measured at
4323 : * that moment.
4324 : *
4325 : * In CSTATE_ABORTED state, the measurement is no longer
4326 : * necessary because we cannot report complete results anyways
4327 : * in this case.
4328 : */
4329 252 : finishCon(st);
4330 252 : return;
4331 : }
4332 : }
4333 : }
4334 :
4335 : /*
4336 : * Subroutine for advanceConnectionState -- initiate or execute the current
4337 : * meta command, and return the next state to set.
4338 : *
4339 : * *now is updated to the current time, unless the command is expected to
4340 : * take no time to execute.
4341 : */
4342 : static ConnectionStateEnum
4343 4792 : executeMetaCommand(CState *st, pg_time_usec_t *now)
4344 : {
4345 4792 : Command *command = sql_script[st->use_file].commands[st->command];
4346 : int argc;
4347 : char **argv;
4348 :
4349 : Assert(command != NULL && command->type == META_COMMAND);
4350 :
4351 4792 : argc = command->argc;
4352 4792 : argv = command->argv;
4353 :
4354 4792 : if (unlikely(__pg_log_level <= PG_LOG_DEBUG))
4355 : {
4356 : PQExpBufferData buf;
4357 :
4358 1406 : initPQExpBuffer(&buf);
4359 :
4360 1406 : printfPQExpBuffer(&buf, "client %d executing \\%s", st->id, argv[0]);
4361 2812 : for (int i = 1; i < argc; i++)
4362 1406 : appendPQExpBuffer(&buf, " %s", argv[i]);
4363 :
4364 1406 : pg_log_debug("%s", buf.data);
4365 :
4366 1406 : termPQExpBuffer(&buf);
4367 : }
4368 :
4369 4792 : if (command->meta == META_SLEEP)
4370 : {
4371 : int usec;
4372 :
4373 : /*
4374 : * A \sleep doesn't execute anything, we just get the delay from the
4375 : * argument, and enter the CSTATE_SLEEP state. (The per-command
4376 : * latency will be recorded in CSTATE_SLEEP state, not here, after the
4377 : * delay has elapsed.)
4378 : */
4379 12 : if (!evaluateSleep(&st->variables, argc, argv, &usec))
4380 : {
4381 2 : commandFailed(st, "sleep", "execution of meta-command failed");
4382 2 : return CSTATE_ABORTED;
4383 : }
4384 :
4385 10 : pg_time_now_lazy(now);
4386 10 : st->sleep_until = (*now) + usec;
4387 10 : return CSTATE_SLEEP;
4388 : }
4389 4780 : else if (command->meta == META_SET)
4390 : {
4391 3424 : PgBenchExpr *expr = command->expr;
4392 : PgBenchValue result;
4393 :
4394 3424 : if (!evaluateExpr(st, expr, &result))
4395 : {
4396 46 : commandFailed(st, argv[0], "evaluation of meta-command failed");
4397 48 : return CSTATE_ABORTED;
4398 : }
4399 :
4400 3378 : if (!putVariableValue(&st->variables, argv[0], argv[1], &result))
4401 : {
4402 2 : commandFailed(st, "set", "assignment of meta-command failed");
4403 2 : return CSTATE_ABORTED;
4404 : }
4405 : }
4406 1356 : else if (command->meta == META_IF)
4407 : {
4408 : /* backslash commands with an expression to evaluate */
4409 1000 : PgBenchExpr *expr = command->expr;
4410 : PgBenchValue result;
4411 : bool cond;
4412 :
4413 1000 : if (!evaluateExpr(st, expr, &result))
4414 : {
4415 0 : commandFailed(st, argv[0], "evaluation of meta-command failed");
4416 0 : return CSTATE_ABORTED;
4417 : }
4418 :
4419 1000 : cond = valueTruth(&result);
4420 1000 : conditional_stack_push(st->cstack, cond ? IFSTATE_TRUE : IFSTATE_FALSE);
4421 : }
4422 356 : else if (command->meta == META_ELIF)
4423 : {
4424 : /* backslash commands with an expression to evaluate */
4425 14 : PgBenchExpr *expr = command->expr;
4426 : PgBenchValue result;
4427 : bool cond;
4428 :
4429 14 : if (conditional_stack_peek(st->cstack) == IFSTATE_TRUE)
4430 : {
4431 : /* elif after executed block, skip eval and wait for endif. */
4432 4 : conditional_stack_poke(st->cstack, IFSTATE_IGNORED);
4433 4 : return CSTATE_END_COMMAND;
4434 : }
4435 :
4436 10 : if (!evaluateExpr(st, expr, &result))
4437 : {
4438 0 : commandFailed(st, argv[0], "evaluation of meta-command failed");
4439 0 : return CSTATE_ABORTED;
4440 : }
4441 :
4442 10 : cond = valueTruth(&result);
4443 : Assert(conditional_stack_peek(st->cstack) == IFSTATE_FALSE);
4444 10 : conditional_stack_poke(st->cstack, cond ? IFSTATE_TRUE : IFSTATE_FALSE);
4445 : }
4446 342 : else if (command->meta == META_ELSE)
4447 : {
4448 4 : switch (conditional_stack_peek(st->cstack))
4449 : {
4450 4 : case IFSTATE_TRUE:
4451 4 : conditional_stack_poke(st->cstack, IFSTATE_ELSE_FALSE);
4452 4 : break;
4453 4 : case IFSTATE_FALSE: /* inconsistent if active */
4454 : case IFSTATE_IGNORED: /* inconsistent if active */
4455 : case IFSTATE_NONE: /* else without if */
4456 : case IFSTATE_ELSE_TRUE: /* else after else */
4457 : case IFSTATE_ELSE_FALSE: /* else after else */
4458 : default:
4459 : /* dead code if conditional check is ok */
4460 : Assert(false);
4461 : }
4462 : }
4463 338 : else if (command->meta == META_ENDIF)
4464 : {
4465 : Assert(!conditional_stack_empty(st->cstack));
4466 86 : conditional_stack_pop(st->cstack);
4467 : }
4468 252 : else if (command->meta == META_SETSHELL)
4469 : {
4470 6 : if (!runShellCommand(&st->variables, argv[1], argv + 2, argc - 2))
4471 : {
4472 4 : commandFailed(st, "setshell", "execution of meta-command failed");
4473 4 : return CSTATE_ABORTED;
4474 : }
4475 : }
4476 246 : else if (command->meta == META_SHELL)
4477 : {
4478 6 : if (!runShellCommand(&st->variables, NULL, argv + 1, argc - 1))
4479 : {
4480 4 : commandFailed(st, "shell", "execution of meta-command failed");
4481 4 : return CSTATE_ABORTED;
4482 : }
4483 : }
4484 240 : else if (command->meta == META_STARTPIPELINE)
4485 : {
4486 : /*
4487 : * In pipeline mode, we use a workflow based on libpq pipeline
4488 : * functions.
4489 : */
4490 120 : if (querymode == QUERY_SIMPLE)
4491 : {
4492 0 : commandFailed(st, "startpipeline", "cannot use pipeline mode with the simple query protocol");
4493 0 : return CSTATE_ABORTED;
4494 : }
4495 :
4496 : /*
4497 : * If we're in prepared-query mode, we need to prepare all the
4498 : * commands that are inside the pipeline before we actually start the
4499 : * pipeline itself. This solves the problem that running BEGIN
4500 : * ISOLATION LEVEL SERIALIZABLE in a pipeline would fail due to a
4501 : * snapshot having been acquired by the prepare within the pipeline.
4502 : */
4503 120 : if (querymode == QUERY_PREPARED)
4504 84 : prepareCommandsInPipeline(st);
4505 :
4506 120 : if (PQpipelineStatus(st->con) != PQ_PIPELINE_OFF)
4507 : {
4508 2 : commandFailed(st, "startpipeline", "already in pipeline mode");
4509 2 : return CSTATE_ABORTED;
4510 : }
4511 118 : if (PQenterPipelineMode(st->con) == 0)
4512 : {
4513 0 : commandFailed(st, "startpipeline", "failed to enter pipeline mode");
4514 0 : return CSTATE_ABORTED;
4515 : }
4516 : }
4517 120 : else if (command->meta == META_SYNCPIPELINE)
4518 : {
4519 10 : if (PQpipelineStatus(st->con) != PQ_PIPELINE_ON)
4520 : {
4521 0 : commandFailed(st, "syncpipeline", "not in pipeline mode");
4522 0 : return CSTATE_ABORTED;
4523 : }
4524 10 : if (PQsendPipelineSync(st->con) == 0)
4525 : {
4526 0 : commandFailed(st, "syncpipeline", "failed to send a pipeline sync");
4527 0 : return CSTATE_ABORTED;
4528 : }
4529 10 : st->num_syncs++;
4530 : }
4531 110 : else if (command->meta == META_ENDPIPELINE)
4532 : {
4533 110 : if (PQpipelineStatus(st->con) != PQ_PIPELINE_ON)
4534 : {
4535 2 : commandFailed(st, "endpipeline", "not in pipeline mode");
4536 2 : return CSTATE_ABORTED;
4537 : }
4538 108 : if (!PQpipelineSync(st->con))
4539 : {
4540 0 : commandFailed(st, "endpipeline", "failed to send a pipeline sync");
4541 0 : return CSTATE_ABORTED;
4542 : }
4543 108 : st->num_syncs++;
4544 : /* Now wait for the PGRES_PIPELINE_SYNC and exit pipeline mode there */
4545 : /* collect pending results before getting out of pipeline mode */
4546 108 : return CSTATE_WAIT_RESULT;
4547 : }
4548 :
4549 : /*
4550 : * executing the expression or shell command might have taken a
4551 : * non-negligible amount of time, so reset 'now'
4552 : */
4553 4608 : *now = 0;
4554 :
4555 4608 : return CSTATE_END_COMMAND;
4556 : }
4557 :
4558 : /*
4559 : * Return the number of failed transactions.
4560 : */
4561 : static int64
4562 198 : getFailures(const StatsData *stats)
4563 : {
4564 396 : return (stats->serialization_failures +
4565 198 : stats->deadlock_failures);
4566 : }
4567 :
4568 : /*
4569 : * Return a string constant representing the result of a transaction
4570 : * that is not successfully processed.
4571 : */
4572 : static const char *
4573 0 : getResultString(bool skipped, EStatus estatus)
4574 : {
4575 0 : if (skipped)
4576 0 : return "skipped";
4577 0 : else if (failures_detailed)
4578 : {
4579 0 : switch (estatus)
4580 : {
4581 0 : case ESTATUS_SERIALIZATION_ERROR:
4582 0 : return "serialization";
4583 0 : case ESTATUS_DEADLOCK_ERROR:
4584 0 : return "deadlock";
4585 0 : default:
4586 : /* internal error which should never occur */
4587 0 : pg_fatal("unexpected error status: %d", estatus);
4588 : }
4589 : }
4590 : else
4591 0 : return "failed";
4592 : }
4593 :
4594 : /*
4595 : * Print log entry after completing one transaction.
4596 : *
4597 : * We print Unix-epoch timestamps in the log, so that entries can be
4598 : * correlated against other logs.
4599 : *
4600 : * XXX We could obtain the time from the caller and just shift it here, to
4601 : * avoid the cost of an extra call to pg_time_now().
4602 : */
4603 : static void
4604 220 : doLog(TState *thread, CState *st,
4605 : StatsData *agg, bool skipped, double latency, double lag)
4606 : {
4607 220 : FILE *logfile = thread->logfile;
4608 220 : pg_time_usec_t now = pg_time_now() + epoch_shift;
4609 :
4610 : Assert(use_log);
4611 :
4612 : /*
4613 : * Skip the log entry if sampling is enabled and this row doesn't belong
4614 : * to the random sample.
4615 : */
4616 220 : if (sample_rate != 0.0 &&
4617 200 : pg_prng_double(&thread->ts_sample_rs) > sample_rate)
4618 118 : return;
4619 :
4620 : /* should we aggregate the results or not? */
4621 102 : if (agg_interval > 0)
4622 : {
4623 : pg_time_usec_t next;
4624 :
4625 : /*
4626 : * Loop until we reach the interval of the current moment, and print
4627 : * any empty intervals in between (this may happen with very low tps,
4628 : * e.g. --rate=0.1).
4629 : */
4630 :
4631 0 : while ((next = agg->start_time + agg_interval * INT64CONST(1000000)) <= now)
4632 : {
4633 0 : double lag_sum = 0.0;
4634 0 : double lag_sum2 = 0.0;
4635 0 : double lag_min = 0.0;
4636 0 : double lag_max = 0.0;
4637 0 : int64 skipped = 0;
4638 0 : int64 serialization_failures = 0;
4639 0 : int64 deadlock_failures = 0;
4640 0 : int64 retried = 0;
4641 0 : int64 retries = 0;
4642 :
4643 : /* print aggregated report to logfile */
4644 0 : fprintf(logfile, INT64_FORMAT " " INT64_FORMAT " %.0f %.0f %.0f %.0f",
4645 0 : agg->start_time / 1000000, /* seconds since Unix epoch */
4646 : agg->cnt,
4647 : agg->latency.sum,
4648 : agg->latency.sum2,
4649 : agg->latency.min,
4650 : agg->latency.max);
4651 :
4652 0 : if (throttle_delay)
4653 : {
4654 0 : lag_sum = agg->lag.sum;
4655 0 : lag_sum2 = agg->lag.sum2;
4656 0 : lag_min = agg->lag.min;
4657 0 : lag_max = agg->lag.max;
4658 : }
4659 0 : fprintf(logfile, " %.0f %.0f %.0f %.0f",
4660 : lag_sum,
4661 : lag_sum2,
4662 : lag_min,
4663 : lag_max);
4664 :
4665 0 : if (latency_limit)
4666 0 : skipped = agg->skipped;
4667 0 : fprintf(logfile, " " INT64_FORMAT, skipped);
4668 :
4669 0 : if (max_tries != 1)
4670 : {
4671 0 : retried = agg->retried;
4672 0 : retries = agg->retries;
4673 : }
4674 0 : fprintf(logfile, " " INT64_FORMAT " " INT64_FORMAT, retried, retries);
4675 :
4676 0 : if (failures_detailed)
4677 : {
4678 0 : serialization_failures = agg->serialization_failures;
4679 0 : deadlock_failures = agg->deadlock_failures;
4680 : }
4681 0 : fprintf(logfile, " " INT64_FORMAT " " INT64_FORMAT,
4682 : serialization_failures,
4683 : deadlock_failures);
4684 :
4685 0 : fputc('\n', logfile);
4686 :
4687 : /* reset data and move to next interval */
4688 0 : initStats(agg, next);
4689 : }
4690 :
4691 : /* accumulate the current transaction */
4692 0 : accumStats(agg, skipped, latency, lag, st->estatus, st->tries);
4693 : }
4694 : else
4695 : {
4696 : /* no, print raw transactions */
4697 102 : if (!skipped && st->estatus == ESTATUS_NO_ERROR)
4698 102 : fprintf(logfile, "%d " INT64_FORMAT " %.0f %d " INT64_FORMAT " "
4699 : INT64_FORMAT,
4700 : st->id, st->cnt, latency, st->use_file,
4701 : now / 1000000, now % 1000000);
4702 : else
4703 0 : fprintf(logfile, "%d " INT64_FORMAT " %s %d " INT64_FORMAT " "
4704 : INT64_FORMAT,
4705 : st->id, st->cnt, getResultString(skipped, st->estatus),
4706 : st->use_file, now / 1000000, now % 1000000);
4707 :
4708 102 : if (throttle_delay)
4709 0 : fprintf(logfile, " %.0f", lag);
4710 102 : if (max_tries != 1)
4711 0 : fprintf(logfile, " %u", st->tries - 1);
4712 102 : fputc('\n', logfile);
4713 : }
4714 : }
4715 :
4716 : /*
4717 : * Accumulate and report statistics at end of a transaction.
4718 : *
4719 : * (This is also called when a transaction is late and thus skipped.
4720 : * Note that even skipped and failed transactions are counted in the CState
4721 : * "cnt" field.)
4722 : */
4723 : static void
4724 15402 : processXactStats(TState *thread, CState *st, pg_time_usec_t *now,
4725 : bool skipped, StatsData *agg)
4726 : {
4727 15402 : double latency = 0.0,
4728 15402 : lag = 0.0;
4729 15402 : bool detailed = progress || throttle_delay || latency_limit ||
4730 30804 : use_log || per_script_stats;
4731 :
4732 15402 : if (detailed && !skipped && st->estatus == ESTATUS_NO_ERROR)
4733 : {
4734 3322 : pg_time_now_lazy(now);
4735 :
4736 : /* compute latency & lag */
4737 3322 : latency = (*now) - st->txn_scheduled;
4738 3322 : lag = st->txn_begin - st->txn_scheduled;
4739 : }
4740 :
4741 : /* keep detailed thread stats */
4742 15402 : accumStats(&thread->stats, skipped, latency, lag, st->estatus, st->tries);
4743 :
4744 : /* count transactions over the latency limit, if needed */
4745 15402 : if (latency_limit && latency > latency_limit)
4746 2 : thread->latency_late++;
4747 :
4748 : /* client stat is just counting */
4749 15402 : st->cnt++;
4750 :
4751 15402 : if (use_log)
4752 220 : doLog(thread, st, agg, skipped, latency, lag);
4753 :
4754 : /* XXX could use a mutex here, but we choose not to */
4755 15402 : if (per_script_stats)
4756 2700 : accumStats(&sql_script[st->use_file].stats, skipped, latency, lag,
4757 2700 : st->estatus, st->tries);
4758 15402 : }
4759 :
4760 :
4761 : /* discard connections */
4762 : static void
4763 344 : disconnect_all(CState *state, int length)
4764 : {
4765 : int i;
4766 :
4767 844 : for (i = 0; i < length; i++)
4768 500 : finishCon(&state[i]);
4769 344 : }
4770 :
4771 : /*
4772 : * Remove old pgbench tables, if any exist
4773 : */
4774 : static void
4775 6 : initDropTables(PGconn *con)
4776 : {
4777 6 : fprintf(stderr, "dropping old tables...\n");
4778 :
4779 : /*
4780 : * We drop all the tables in one command, so that whether there are
4781 : * foreign key dependencies or not doesn't matter.
4782 : */
4783 6 : executeStatement(con, "drop table if exists "
4784 : "pgbench_accounts, "
4785 : "pgbench_branches, "
4786 : "pgbench_history, "
4787 : "pgbench_tellers");
4788 6 : }
4789 :
4790 : /*
4791 : * Create "pgbench_accounts" partitions if needed.
4792 : *
4793 : * This is the larger table of pgbench default tpc-b like schema
4794 : * with a known size, so we choose to partition it.
4795 : */
4796 : static void
4797 4 : createPartitions(PGconn *con)
4798 : {
4799 : PQExpBufferData query;
4800 :
4801 : /* we must have to create some partitions */
4802 : Assert(partitions > 0);
4803 :
4804 4 : fprintf(stderr, "creating %d partitions...\n", partitions);
4805 :
4806 4 : initPQExpBuffer(&query);
4807 :
4808 14 : for (int p = 1; p <= partitions; p++)
4809 : {
4810 10 : if (partition_method == PART_RANGE)
4811 : {
4812 6 : int64 part_size = (naccounts * (int64) scale + partitions - 1) / partitions;
4813 :
4814 6 : printfPQExpBuffer(&query,
4815 : "create%s table pgbench_accounts_%d\n"
4816 : " partition of pgbench_accounts\n"
4817 : " for values from (",
4818 6 : unlogged_tables ? " unlogged" : "", p);
4819 :
4820 : /*
4821 : * For RANGE, we use open-ended partitions at the beginning and
4822 : * end to allow any valid value for the primary key. Although the
4823 : * actual minimum and maximum values can be derived from the
4824 : * scale, it is more generic and the performance is better.
4825 : */
4826 6 : if (p == 1)
4827 2 : appendPQExpBufferStr(&query, "minvalue");
4828 : else
4829 4 : appendPQExpBuffer(&query, INT64_FORMAT, (p - 1) * part_size + 1);
4830 :
4831 6 : appendPQExpBufferStr(&query, ") to (");
4832 :
4833 6 : if (p < partitions)
4834 4 : appendPQExpBuffer(&query, INT64_FORMAT, p * part_size + 1);
4835 : else
4836 2 : appendPQExpBufferStr(&query, "maxvalue");
4837 :
4838 6 : appendPQExpBufferChar(&query, ')');
4839 : }
4840 4 : else if (partition_method == PART_HASH)
4841 4 : printfPQExpBuffer(&query,
4842 : "create%s table pgbench_accounts_%d\n"
4843 : " partition of pgbench_accounts\n"
4844 : " for values with (modulus %d, remainder %d)",
4845 4 : unlogged_tables ? " unlogged" : "", p,
4846 : partitions, p - 1);
4847 : else /* cannot get there */
4848 : Assert(0);
4849 :
4850 : /*
4851 : * Per ddlinfo in initCreateTables, fillfactor is needed on table
4852 : * pgbench_accounts.
4853 : */
4854 10 : appendPQExpBuffer(&query, " with (fillfactor=%d)", fillfactor);
4855 :
4856 10 : executeStatement(con, query.data);
4857 : }
4858 :
4859 4 : termPQExpBuffer(&query);
4860 4 : }
4861 :
4862 : /*
4863 : * Create pgbench's standard tables
4864 : */
4865 : static void
4866 6 : initCreateTables(PGconn *con)
4867 : {
4868 : /*
4869 : * Note: TPC-B requires at least 100 bytes per row, and the "filler"
4870 : * fields in these table declarations were intended to comply with that.
4871 : * The pgbench_accounts table complies with that because the "filler"
4872 : * column is set to blank-padded empty string. But for all other tables
4873 : * the columns default to NULL and so don't actually take any space. We
4874 : * could fix that by giving them non-null default values. However, that
4875 : * would completely break comparability of pgbench results with prior
4876 : * versions. Since pgbench has never pretended to be fully TPC-B compliant
4877 : * anyway, we stick with the historical behavior.
4878 : */
4879 : struct ddlinfo
4880 : {
4881 : const char *table; /* table name */
4882 : const char *smcols; /* column decls if accountIDs are 32 bits */
4883 : const char *bigcols; /* column decls if accountIDs are 64 bits */
4884 : int declare_fillfactor;
4885 : };
4886 : static const struct ddlinfo DDLs[] = {
4887 : {
4888 : "pgbench_history",
4889 : "tid int,bid int,aid int,delta int,mtime timestamp,filler char(22)",
4890 : "tid int,bid int,aid bigint,delta int,mtime timestamp,filler char(22)",
4891 : 0
4892 : },
4893 : {
4894 : "pgbench_tellers",
4895 : "tid int not null,bid int,tbalance int,filler char(84)",
4896 : "tid int not null,bid int,tbalance int,filler char(84)",
4897 : 1
4898 : },
4899 : {
4900 : "pgbench_accounts",
4901 : "aid int not null,bid int,abalance int,filler char(84)",
4902 : "aid bigint not null,bid int,abalance int,filler char(84)",
4903 : 1
4904 : },
4905 : {
4906 : "pgbench_branches",
4907 : "bid int not null,bbalance int,filler char(88)",
4908 : "bid int not null,bbalance int,filler char(88)",
4909 : 1
4910 : }
4911 : };
4912 : int i;
4913 : PQExpBufferData query;
4914 :
4915 6 : fprintf(stderr, "creating tables...\n");
4916 :
4917 6 : initPQExpBuffer(&query);
4918 :
4919 30 : for (i = 0; i < lengthof(DDLs); i++)
4920 : {
4921 24 : const struct ddlinfo *ddl = &DDLs[i];
4922 :
4923 : /* Construct new create table statement. */
4924 48 : printfPQExpBuffer(&query, "create%s table %s(%s)",
4925 16 : (unlogged_tables && partition_method == PART_NONE) ? " unlogged" : "",
4926 24 : ddl->table,
4927 24 : (scale >= SCALE_32BIT_THRESHOLD) ? ddl->bigcols : ddl->smcols);
4928 :
4929 : /* Partition pgbench_accounts table */
4930 24 : if (partition_method != PART_NONE && strcmp(ddl->table, "pgbench_accounts") == 0)
4931 4 : appendPQExpBuffer(&query,
4932 4 : " partition by %s (aid)", PARTITION_METHOD[partition_method]);
4933 20 : else if (ddl->declare_fillfactor)
4934 : {
4935 : /* fillfactor is only expected on actual tables */
4936 14 : appendPQExpBuffer(&query, " with (fillfactor=%d)", fillfactor);
4937 : }
4938 :
4939 24 : if (tablespace != NULL)
4940 : {
4941 : char *escape_tablespace;
4942 :
4943 8 : escape_tablespace = PQescapeIdentifier(con, tablespace, strlen(tablespace));
4944 8 : appendPQExpBuffer(&query, " tablespace %s", escape_tablespace);
4945 8 : PQfreemem(escape_tablespace);
4946 : }
4947 :
4948 24 : executeStatement(con, query.data);
4949 : }
4950 :
4951 6 : termPQExpBuffer(&query);
4952 :
4953 6 : if (partition_method != PART_NONE)
4954 4 : createPartitions(con);
4955 6 : }
4956 :
4957 : /*
4958 : * Truncate away any old data, in one command in case there are foreign keys
4959 : */
4960 : static void
4961 6 : initTruncateTables(PGconn *con)
4962 : {
4963 6 : executeStatement(con, "truncate table "
4964 : "pgbench_accounts, "
4965 : "pgbench_branches, "
4966 : "pgbench_history, "
4967 : "pgbench_tellers");
4968 6 : }
4969 :
4970 : static void
4971 4 : initBranch(PQExpBufferData *sql, int64 curr)
4972 : {
4973 : /* "filler" column uses NULL */
4974 4 : printfPQExpBuffer(sql,
4975 : INT64_FORMAT "\t0\t\\N\n",
4976 : curr + 1);
4977 4 : }
4978 :
4979 : static void
4980 40 : initTeller(PQExpBufferData *sql, int64 curr)
4981 : {
4982 : /* "filler" column uses NULL */
4983 40 : printfPQExpBuffer(sql,
4984 : INT64_FORMAT "\t" INT64_FORMAT "\t0\t\\N\n",
4985 40 : curr + 1, curr / ntellers + 1);
4986 40 : }
4987 :
4988 : static void
4989 400000 : initAccount(PQExpBufferData *sql, int64 curr)
4990 : {
4991 : /* "filler" column defaults to blank padded empty string */
4992 400000 : printfPQExpBuffer(sql,
4993 : INT64_FORMAT "\t" INT64_FORMAT "\t0\t\n",
4994 400000 : curr + 1, curr / naccounts + 1);
4995 400000 : }
4996 :
4997 : static void
4998 12 : initPopulateTable(PGconn *con, const char *table, int64 base,
4999 : initRowMethod init_row)
5000 : {
5001 : int n;
5002 : int64 k;
5003 12 : int chars = 0;
5004 12 : int prev_chars = 0;
5005 : PGresult *res;
5006 : PQExpBufferData sql;
5007 : char copy_statement[256];
5008 12 : const char *copy_statement_fmt = "copy %s from stdin";
5009 12 : int64 total = base * scale;
5010 :
5011 : /* used to track elapsed time and estimate of the remaining time */
5012 : pg_time_usec_t start;
5013 12 : int log_interval = 1;
5014 :
5015 : /* Stay on the same line if reporting to a terminal */
5016 12 : char eol = isatty(fileno(stderr)) ? '\r' : '\n';
5017 :
5018 12 : initPQExpBuffer(&sql);
5019 :
5020 : /* Use COPY with FREEZE on v14 and later for all ordinary tables */
5021 24 : if ((PQserverVersion(con) >= 140000) &&
5022 12 : get_table_relkind(con, table) == RELKIND_RELATION)
5023 10 : copy_statement_fmt = "copy %s from stdin with (freeze on)";
5024 :
5025 :
5026 12 : n = pg_snprintf(copy_statement, sizeof(copy_statement), copy_statement_fmt, table);
5027 12 : if (n >= sizeof(copy_statement))
5028 0 : pg_fatal("invalid buffer size: must be at least %d characters long", n);
5029 12 : else if (n == -1)
5030 0 : pg_fatal("invalid format string");
5031 :
5032 12 : res = PQexec(con, copy_statement);
5033 :
5034 12 : if (PQresultStatus(res) != PGRES_COPY_IN)
5035 0 : pg_fatal("unexpected copy in result: %s", PQerrorMessage(con));
5036 12 : PQclear(res);
5037 :
5038 12 : start = pg_time_now();
5039 :
5040 400056 : for (k = 0; k < total; k++)
5041 : {
5042 400044 : int64 j = k + 1;
5043 :
5044 400044 : init_row(&sql, k);
5045 400044 : if (PQputline(con, sql.data))
5046 0 : pg_fatal("PQputline failed");
5047 :
5048 400044 : if (CancelRequested)
5049 0 : break;
5050 :
5051 : /*
5052 : * If we want to stick with the original logging, print a message each
5053 : * 100k inserted rows.
5054 : */
5055 400044 : if ((!use_quiet) && (j % 100000 == 0))
5056 2 : {
5057 2 : double elapsed_sec = PG_TIME_GET_DOUBLE(pg_time_now() - start);
5058 2 : double remaining_sec = ((double) total - j) * elapsed_sec / j;
5059 :
5060 2 : chars = fprintf(stderr, INT64_FORMAT " of " INT64_FORMAT " tuples (%d%%) of %s done (elapsed %.2f s, remaining %.2f s)",
5061 : j, total,
5062 2 : (int) ((j * 100) / total),
5063 : table, elapsed_sec, remaining_sec);
5064 :
5065 : /*
5066 : * If the previous progress message is longer than the current
5067 : * one, add spaces to the current line to fully overwrite any
5068 : * remaining characters from the previous message.
5069 : */
5070 2 : if (prev_chars > chars)
5071 0 : fprintf(stderr, "%*c", prev_chars - chars, ' ');
5072 2 : fputc(eol, stderr);
5073 2 : prev_chars = chars;
5074 : }
5075 : /* let's not call the timing for each row, but only each 100 rows */
5076 400042 : else if (use_quiet && (j % 100 == 0))
5077 : {
5078 2000 : double elapsed_sec = PG_TIME_GET_DOUBLE(pg_time_now() - start);
5079 2000 : double remaining_sec = ((double) total - j) * elapsed_sec / j;
5080 :
5081 : /* have we reached the next interval (or end)? */
5082 2000 : if ((j == total) || (elapsed_sec >= log_interval * LOG_STEP_SECONDS))
5083 : {
5084 2 : chars = fprintf(stderr, INT64_FORMAT " of " INT64_FORMAT " tuples (%d%%) of %s done (elapsed %.2f s, remaining %.2f s)",
5085 : j, total,
5086 2 : (int) ((j * 100) / total),
5087 : table, elapsed_sec, remaining_sec);
5088 :
5089 : /*
5090 : * If the previous progress message is longer than the current
5091 : * one, add spaces to the current line to fully overwrite any
5092 : * remaining characters from the previous message.
5093 : */
5094 2 : if (prev_chars > chars)
5095 0 : fprintf(stderr, "%*c", prev_chars - chars, ' ');
5096 2 : fputc(eol, stderr);
5097 2 : prev_chars = chars;
5098 :
5099 : /* skip to the next interval */
5100 2 : log_interval = (int) ceil(elapsed_sec / LOG_STEP_SECONDS);
5101 : }
5102 : }
5103 : }
5104 :
5105 12 : if (chars != 0 && eol != '\n')
5106 0 : fprintf(stderr, "%*c\r", chars, ' '); /* Clear the current line */
5107 :
5108 12 : if (PQputline(con, "\\.\n"))
5109 0 : pg_fatal("very last PQputline failed");
5110 12 : if (PQendcopy(con))
5111 0 : pg_fatal("PQendcopy failed");
5112 :
5113 12 : termPQExpBuffer(&sql);
5114 12 : }
5115 :
5116 : /*
5117 : * Fill the standard tables with some data generated and sent from the client.
5118 : *
5119 : * The filler column is NULL in pgbench_branches and pgbench_tellers, and is
5120 : * a blank-padded string in pgbench_accounts.
5121 : */
5122 : static void
5123 4 : initGenerateDataClientSide(PGconn *con)
5124 : {
5125 4 : fprintf(stderr, "generating data (client-side)...\n");
5126 :
5127 : /*
5128 : * we do all of this in one transaction to enable the backend's
5129 : * data-loading optimizations
5130 : */
5131 4 : executeStatement(con, "begin");
5132 :
5133 : /* truncate away any old data */
5134 4 : initTruncateTables(con);
5135 :
5136 : /*
5137 : * fill branches, tellers, accounts in that order in case foreign keys
5138 : * already exist
5139 : */
5140 4 : initPopulateTable(con, "pgbench_branches", nbranches, initBranch);
5141 4 : initPopulateTable(con, "pgbench_tellers", ntellers, initTeller);
5142 4 : initPopulateTable(con, "pgbench_accounts", naccounts, initAccount);
5143 :
5144 4 : executeStatement(con, "commit");
5145 4 : }
5146 :
5147 : /*
5148 : * Fill the standard tables with some data generated on the server
5149 : *
5150 : * As already the case with the client-side data generation, the filler
5151 : * column defaults to NULL in pgbench_branches and pgbench_tellers,
5152 : * and is a blank-padded string in pgbench_accounts.
5153 : */
5154 : static void
5155 2 : initGenerateDataServerSide(PGconn *con)
5156 : {
5157 : PQExpBufferData sql;
5158 :
5159 2 : fprintf(stderr, "generating data (server-side)...\n");
5160 :
5161 : /*
5162 : * we do all of this in one transaction to enable the backend's
5163 : * data-loading optimizations
5164 : */
5165 2 : executeStatement(con, "begin");
5166 :
5167 : /* truncate away any old data */
5168 2 : initTruncateTables(con);
5169 :
5170 2 : initPQExpBuffer(&sql);
5171 :
5172 2 : printfPQExpBuffer(&sql,
5173 : "insert into pgbench_branches(bid,bbalance) "
5174 : "select bid, 0 "
5175 : "from generate_series(1, %d) as bid", nbranches * scale);
5176 2 : executeStatement(con, sql.data);
5177 :
5178 2 : printfPQExpBuffer(&sql,
5179 : "insert into pgbench_tellers(tid,bid,tbalance) "
5180 : "select tid, (tid - 1) / %d + 1, 0 "
5181 : "from generate_series(1, %d) as tid", ntellers, ntellers * scale);
5182 2 : executeStatement(con, sql.data);
5183 :
5184 2 : printfPQExpBuffer(&sql,
5185 : "insert into pgbench_accounts(aid,bid,abalance,filler) "
5186 : "select aid, (aid - 1) / %d + 1, 0, '' "
5187 : "from generate_series(1, " INT64_FORMAT ") as aid",
5188 : naccounts, (int64) naccounts * scale);
5189 2 : executeStatement(con, sql.data);
5190 :
5191 2 : termPQExpBuffer(&sql);
5192 :
5193 2 : executeStatement(con, "commit");
5194 2 : }
5195 :
5196 : /*
5197 : * Invoke vacuum on the standard tables
5198 : */
5199 : static void
5200 4 : initVacuum(PGconn *con)
5201 : {
5202 4 : fprintf(stderr, "vacuuming...\n");
5203 4 : executeStatement(con, "vacuum analyze pgbench_branches");
5204 4 : executeStatement(con, "vacuum analyze pgbench_tellers");
5205 4 : executeStatement(con, "vacuum analyze pgbench_accounts");
5206 4 : executeStatement(con, "vacuum analyze pgbench_history");
5207 4 : }
5208 :
5209 : /*
5210 : * Create primary keys on the standard tables
5211 : */
5212 : static void
5213 6 : initCreatePKeys(PGconn *con)
5214 : {
5215 : static const char *const DDLINDEXes[] = {
5216 : "alter table pgbench_branches add primary key (bid)",
5217 : "alter table pgbench_tellers add primary key (tid)",
5218 : "alter table pgbench_accounts add primary key (aid)"
5219 : };
5220 : int i;
5221 : PQExpBufferData query;
5222 :
5223 6 : fprintf(stderr, "creating primary keys...\n");
5224 6 : initPQExpBuffer(&query);
5225 :
5226 24 : for (i = 0; i < lengthof(DDLINDEXes); i++)
5227 : {
5228 18 : resetPQExpBuffer(&query);
5229 18 : appendPQExpBufferStr(&query, DDLINDEXes[i]);
5230 :
5231 18 : if (index_tablespace != NULL)
5232 : {
5233 : char *escape_tablespace;
5234 :
5235 6 : escape_tablespace = PQescapeIdentifier(con, index_tablespace,
5236 : strlen(index_tablespace));
5237 6 : appendPQExpBuffer(&query, " using index tablespace %s", escape_tablespace);
5238 6 : PQfreemem(escape_tablespace);
5239 : }
5240 :
5241 18 : executeStatement(con, query.data);
5242 : }
5243 :
5244 6 : termPQExpBuffer(&query);
5245 6 : }
5246 :
5247 : /*
5248 : * Create foreign key constraints between the standard tables
5249 : */
5250 : static void
5251 4 : initCreateFKeys(PGconn *con)
5252 : {
5253 : static const char *const DDLKEYs[] = {
5254 : "alter table pgbench_tellers add constraint pgbench_tellers_bid_fkey foreign key (bid) references pgbench_branches",
5255 : "alter table pgbench_accounts add constraint pgbench_accounts_bid_fkey foreign key (bid) references pgbench_branches",
5256 : "alter table pgbench_history add constraint pgbench_history_bid_fkey foreign key (bid) references pgbench_branches",
5257 : "alter table pgbench_history add constraint pgbench_history_tid_fkey foreign key (tid) references pgbench_tellers",
5258 : "alter table pgbench_history add constraint pgbench_history_aid_fkey foreign key (aid) references pgbench_accounts"
5259 : };
5260 : int i;
5261 :
5262 4 : fprintf(stderr, "creating foreign keys...\n");
5263 24 : for (i = 0; i < lengthof(DDLKEYs); i++)
5264 : {
5265 20 : executeStatement(con, DDLKEYs[i]);
5266 : }
5267 4 : }
5268 :
5269 : /*
5270 : * Validate an initialization-steps string
5271 : *
5272 : * (We could just leave it to runInitSteps() to fail if there are wrong
5273 : * characters, but since initialization can take awhile, it seems friendlier
5274 : * to check during option parsing.)
5275 : */
5276 : static void
5277 8 : checkInitSteps(const char *initialize_steps)
5278 : {
5279 8 : if (initialize_steps[0] == '\0')
5280 0 : pg_fatal("no initialization steps specified");
5281 :
5282 42 : for (const char *step = initialize_steps; *step != '\0'; step++)
5283 : {
5284 36 : if (strchr(ALL_INIT_STEPS " ", *step) == NULL)
5285 : {
5286 2 : pg_log_error("unrecognized initialization step \"%c\"", *step);
5287 2 : pg_log_error_detail("Allowed step characters are: \"" ALL_INIT_STEPS "\".");
5288 2 : exit(1);
5289 : }
5290 : }
5291 6 : }
5292 :
5293 : /*
5294 : * Invoke each initialization step in the given string
5295 : */
5296 : static void
5297 6 : runInitSteps(const char *initialize_steps)
5298 : {
5299 : PQExpBufferData stats;
5300 : PGconn *con;
5301 : const char *step;
5302 6 : double run_time = 0.0;
5303 6 : bool first = true;
5304 :
5305 6 : initPQExpBuffer(&stats);
5306 :
5307 6 : if ((con = doConnect()) == NULL)
5308 0 : pg_fatal("could not create connection for initialization");
5309 :
5310 6 : setup_cancel_handler(NULL);
5311 6 : SetCancelConn(con);
5312 :
5313 44 : for (step = initialize_steps; *step != '\0'; step++)
5314 : {
5315 38 : char *op = NULL;
5316 38 : pg_time_usec_t start = pg_time_now();
5317 :
5318 38 : switch (*step)
5319 : {
5320 6 : case 'd':
5321 6 : op = "drop tables";
5322 6 : initDropTables(con);
5323 6 : break;
5324 6 : case 't':
5325 6 : op = "create tables";
5326 6 : initCreateTables(con);
5327 6 : break;
5328 4 : case 'g':
5329 4 : op = "client-side generate";
5330 4 : initGenerateDataClientSide(con);
5331 4 : break;
5332 2 : case 'G':
5333 2 : op = "server-side generate";
5334 2 : initGenerateDataServerSide(con);
5335 2 : break;
5336 4 : case 'v':
5337 4 : op = "vacuum";
5338 4 : initVacuum(con);
5339 4 : break;
5340 6 : case 'p':
5341 6 : op = "primary keys";
5342 6 : initCreatePKeys(con);
5343 6 : break;
5344 4 : case 'f':
5345 4 : op = "foreign keys";
5346 4 : initCreateFKeys(con);
5347 4 : break;
5348 6 : case ' ':
5349 6 : break; /* ignore */
5350 0 : default:
5351 0 : pg_log_error("unrecognized initialization step \"%c\"", *step);
5352 0 : PQfinish(con);
5353 0 : exit(1);
5354 : }
5355 :
5356 38 : if (op != NULL)
5357 : {
5358 32 : double elapsed_sec = PG_TIME_GET_DOUBLE(pg_time_now() - start);
5359 :
5360 32 : if (!first)
5361 26 : appendPQExpBufferStr(&stats, ", ");
5362 : else
5363 6 : first = false;
5364 :
5365 32 : appendPQExpBuffer(&stats, "%s %.2f s", op, elapsed_sec);
5366 :
5367 32 : run_time += elapsed_sec;
5368 : }
5369 : }
5370 :
5371 6 : fprintf(stderr, "done in %.2f s (%s).\n", run_time, stats.data);
5372 6 : ResetCancelConn();
5373 6 : PQfinish(con);
5374 6 : termPQExpBuffer(&stats);
5375 6 : }
5376 :
5377 : /*
5378 : * Extract pgbench table information into global variables scale,
5379 : * partition_method and partitions.
5380 : */
5381 : static void
5382 14 : GetTableInfo(PGconn *con, bool scale_given)
5383 : {
5384 : PGresult *res;
5385 :
5386 : /*
5387 : * get the scaling factor that should be same as count(*) from
5388 : * pgbench_branches if this is not a custom query
5389 : */
5390 14 : res = PQexec(con, "select count(*) from pgbench_branches");
5391 14 : if (PQresultStatus(res) != PGRES_TUPLES_OK)
5392 : {
5393 2 : char *sqlState = PQresultErrorField(res, PG_DIAG_SQLSTATE);
5394 :
5395 2 : pg_log_error("could not count number of branches: %s", PQerrorMessage(con));
5396 :
5397 2 : if (sqlState && strcmp(sqlState, ERRCODE_UNDEFINED_TABLE) == 0)
5398 2 : pg_log_error_hint("Perhaps you need to do initialization (\"pgbench -i\") in database \"%s\".",
5399 : PQdb(con));
5400 :
5401 2 : exit(1);
5402 : }
5403 12 : scale = atoi(PQgetvalue(res, 0, 0));
5404 12 : if (scale < 0)
5405 0 : pg_fatal("invalid count(*) from pgbench_branches: \"%s\"",
5406 : PQgetvalue(res, 0, 0));
5407 12 : PQclear(res);
5408 :
5409 : /* warn if we override user-given -s switch */
5410 12 : if (scale_given)
5411 2 : pg_log_warning("scale option ignored, using count from pgbench_branches table (%d)",
5412 : scale);
5413 :
5414 : /*
5415 : * Get the partition information for the first "pgbench_accounts" table
5416 : * found in search_path.
5417 : *
5418 : * The result is empty if no "pgbench_accounts" is found.
5419 : *
5420 : * Otherwise, it always returns one row even if the table is not
5421 : * partitioned (in which case the partition strategy is NULL).
5422 : *
5423 : * The number of partitions can be 0 even for partitioned tables, if no
5424 : * partition is attached.
5425 : *
5426 : * We assume no partitioning on any failure, so as to avoid failing on an
5427 : * old version without "pg_partitioned_table".
5428 : */
5429 12 : res = PQexec(con,
5430 : "select o.n, p.partstrat, pg_catalog.count(i.inhparent) "
5431 : "from pg_catalog.pg_class as c "
5432 : "join pg_catalog.pg_namespace as n on (n.oid = c.relnamespace) "
5433 : "cross join lateral (select pg_catalog.array_position(pg_catalog.current_schemas(true), n.nspname)) as o(n) "
5434 : "left join pg_catalog.pg_partitioned_table as p on (p.partrelid = c.oid) "
5435 : "left join pg_catalog.pg_inherits as i on (c.oid = i.inhparent) "
5436 : "where c.relname = 'pgbench_accounts' and o.n is not null "
5437 : "group by 1, 2 "
5438 : "order by 1 asc "
5439 : "limit 1");
5440 :
5441 12 : if (PQresultStatus(res) != PGRES_TUPLES_OK)
5442 : {
5443 : /* probably an older version, coldly assume no partitioning */
5444 0 : partition_method = PART_NONE;
5445 0 : partitions = 0;
5446 : }
5447 12 : else if (PQntuples(res) == 0)
5448 : {
5449 : /*
5450 : * This case is unlikely as pgbench already found "pgbench_branches"
5451 : * above to compute the scale.
5452 : */
5453 0 : pg_log_error("no pgbench_accounts table found in \"search_path\"");
5454 0 : pg_log_error_hint("Perhaps you need to do initialization (\"pgbench -i\") in database \"%s\".", PQdb(con));
5455 0 : exit(1);
5456 : }
5457 : else /* PQntuples(res) == 1 */
5458 : {
5459 : /* normal case, extract partition information */
5460 12 : if (PQgetisnull(res, 0, 1))
5461 0 : partition_method = PART_NONE;
5462 : else
5463 : {
5464 12 : char *ps = PQgetvalue(res, 0, 1);
5465 :
5466 : /* column must be there */
5467 : Assert(ps != NULL);
5468 :
5469 12 : if (strcmp(ps, "r") == 0)
5470 12 : partition_method = PART_RANGE;
5471 0 : else if (strcmp(ps, "h") == 0)
5472 0 : partition_method = PART_HASH;
5473 : else
5474 : {
5475 : /* possibly a newer version with new partition method */
5476 0 : pg_fatal("unexpected partition method: \"%s\"", ps);
5477 : }
5478 : }
5479 :
5480 12 : partitions = atoi(PQgetvalue(res, 0, 2));
5481 : }
5482 :
5483 12 : PQclear(res);
5484 12 : }
5485 :
5486 : /*
5487 : * Replace :param with $n throughout the command's SQL text, which
5488 : * is a modifiable string in cmd->lines.
5489 : */
5490 : static bool
5491 188 : parseQuery(Command *cmd)
5492 : {
5493 : char *sql,
5494 : *p;
5495 :
5496 188 : cmd->argc = 1;
5497 :
5498 188 : p = sql = pg_strdup(cmd->lines.data);
5499 780 : while ((p = strchr(p, ':')) != NULL)
5500 : {
5501 : char var[13];
5502 : char *name;
5503 : int eaten;
5504 :
5505 594 : name = parseVariable(p, &eaten);
5506 594 : if (name == NULL)
5507 : {
5508 96 : while (*p == ':')
5509 : {
5510 64 : p++;
5511 : }
5512 32 : continue;
5513 : }
5514 :
5515 : /*
5516 : * cmd->argv[0] is the SQL statement itself, so the max number of
5517 : * arguments is one less than MAX_ARGS
5518 : */
5519 562 : if (cmd->argc >= MAX_ARGS)
5520 : {
5521 2 : pg_log_error("statement has too many arguments (maximum is %d): %s",
5522 : MAX_ARGS - 1, cmd->lines.data);
5523 2 : pg_free(name);
5524 2 : return false;
5525 : }
5526 :
5527 560 : sprintf(var, "$%d", cmd->argc);
5528 560 : p = replaceVariable(&sql, p, eaten, var);
5529 :
5530 560 : cmd->argv[cmd->argc] = name;
5531 560 : cmd->argc++;
5532 : }
5533 :
5534 : Assert(cmd->argv[0] == NULL);
5535 186 : cmd->argv[0] = sql;
5536 186 : return true;
5537 : }
5538 :
5539 : /*
5540 : * syntax error while parsing a script (in practice, while parsing a
5541 : * backslash command, because we don't detect syntax errors in SQL)
5542 : *
5543 : * source: source of script (filename or builtin-script ID)
5544 : * lineno: line number within script (count from 1)
5545 : * line: whole line of backslash command, if available
5546 : * command: backslash command name, if available
5547 : * msg: the actual error message
5548 : * more: optional extra message
5549 : * column: zero-based column number, or -1 if unknown
5550 : */
5551 : void
5552 66 : syntax_error(const char *source, int lineno,
5553 : const char *line, const char *command,
5554 : const char *msg, const char *more, int column)
5555 : {
5556 : PQExpBufferData buf;
5557 :
5558 66 : initPQExpBuffer(&buf);
5559 :
5560 66 : printfPQExpBuffer(&buf, "%s:%d: %s", source, lineno, msg);
5561 66 : if (more != NULL)
5562 30 : appendPQExpBuffer(&buf, " (%s)", more);
5563 66 : if (column >= 0 && line == NULL)
5564 0 : appendPQExpBuffer(&buf, " at column %d", column + 1);
5565 66 : if (command != NULL)
5566 60 : appendPQExpBuffer(&buf, " in command \"%s\"", command);
5567 :
5568 66 : pg_log_error("%s", buf.data);
5569 :
5570 66 : termPQExpBuffer(&buf);
5571 :
5572 66 : if (line != NULL)
5573 : {
5574 56 : fprintf(stderr, "%s\n", line);
5575 56 : if (column >= 0)
5576 42 : fprintf(stderr, "%*c error found here\n", column + 1, '^');
5577 : }
5578 :
5579 66 : exit(1);
5580 : }
5581 :
5582 : /*
5583 : * Return a pointer to the start of the SQL command, after skipping over
5584 : * whitespace and "--" comments.
5585 : * If the end of the string is reached, return NULL.
5586 : */
5587 : static char *
5588 2344 : skip_sql_comments(char *sql_command)
5589 : {
5590 2344 : char *p = sql_command;
5591 :
5592 : /* Skip any leading whitespace, as well as "--" style comments */
5593 : for (;;)
5594 : {
5595 2344 : if (isspace((unsigned char) *p))
5596 0 : p++;
5597 2344 : else if (strncmp(p, "--", 2) == 0)
5598 : {
5599 0 : p = strchr(p, '\n');
5600 0 : if (p == NULL)
5601 0 : return NULL;
5602 0 : p++;
5603 : }
5604 : else
5605 2344 : break;
5606 : }
5607 :
5608 : /* NULL if there's nothing but whitespace and comments */
5609 2344 : if (*p == '\0')
5610 1496 : return NULL;
5611 :
5612 848 : return p;
5613 : }
5614 :
5615 : /*
5616 : * Parse a SQL command; return a Command struct, or NULL if it's a comment
5617 : *
5618 : * On entry, psqlscan.l has collected the command into "buf", so we don't
5619 : * really need to do much here except check for comments and set up a Command
5620 : * struct.
5621 : */
5622 : static Command *
5623 2344 : create_sql_command(PQExpBuffer buf)
5624 : {
5625 : Command *my_command;
5626 2344 : char *p = skip_sql_comments(buf->data);
5627 :
5628 2344 : if (p == NULL)
5629 1496 : return NULL;
5630 :
5631 : /* Allocate and initialize Command structure */
5632 848 : my_command = (Command *) pg_malloc(sizeof(Command));
5633 848 : initPQExpBuffer(&my_command->lines);
5634 848 : appendPQExpBufferStr(&my_command->lines, p);
5635 848 : my_command->first_line = NULL; /* this is set later */
5636 848 : my_command->type = SQL_COMMAND;
5637 848 : my_command->meta = META_NONE;
5638 848 : my_command->argc = 0;
5639 848 : my_command->retries = 0;
5640 848 : my_command->failures = 0;
5641 848 : memset(my_command->argv, 0, sizeof(my_command->argv));
5642 848 : my_command->varprefix = NULL; /* allocated later, if needed */
5643 848 : my_command->expr = NULL;
5644 848 : initSimpleStats(&my_command->stats);
5645 848 : my_command->prepname = NULL; /* set later, if needed */
5646 :
5647 848 : return my_command;
5648 : }
5649 :
5650 : /* Free a Command structure and associated data */
5651 : static void
5652 62 : free_command(Command *command)
5653 : {
5654 62 : termPQExpBuffer(&command->lines);
5655 62 : pg_free(command->first_line);
5656 128 : for (int i = 0; i < command->argc; i++)
5657 66 : pg_free(command->argv[i]);
5658 62 : pg_free(command->varprefix);
5659 :
5660 : /*
5661 : * It should also free expr recursively, but this is currently not needed
5662 : * as only gset commands (which do not have an expression) are freed.
5663 : */
5664 62 : pg_free(command);
5665 62 : }
5666 :
5667 : /*
5668 : * Once an SQL command is fully parsed, possibly by accumulating several
5669 : * parts, complete other fields of the Command structure.
5670 : */
5671 : static void
5672 586 : postprocess_sql_command(Command *my_command)
5673 : {
5674 : char buffer[128];
5675 : static int prepnum = 0;
5676 :
5677 : Assert(my_command->type == SQL_COMMAND);
5678 :
5679 : /* Save the first line for error display. */
5680 586 : strlcpy(buffer, my_command->lines.data, sizeof(buffer));
5681 586 : buffer[strcspn(buffer, "\n\r")] = '\0';
5682 586 : my_command->first_line = pg_strdup(buffer);
5683 :
5684 : /* Parse query and generate prepared statement name, if necessary */
5685 586 : switch (querymode)
5686 : {
5687 398 : case QUERY_SIMPLE:
5688 398 : my_command->argv[0] = my_command->lines.data;
5689 398 : my_command->argc++;
5690 398 : break;
5691 104 : case QUERY_PREPARED:
5692 104 : my_command->prepname = psprintf("P_%d", prepnum++);
5693 : /* fall through */
5694 188 : case QUERY_EXTENDED:
5695 188 : if (!parseQuery(my_command))
5696 2 : exit(1);
5697 186 : break;
5698 0 : default:
5699 0 : exit(1);
5700 : }
5701 584 : }
5702 :
5703 : /*
5704 : * Parse a backslash command; return a Command struct, or NULL if comment
5705 : *
5706 : * At call, we have scanned only the initial backslash.
5707 : */
5708 : static Command *
5709 1064 : process_backslash_command(PsqlScanState sstate, const char *source,
5710 : int lineno, int start_offset)
5711 : {
5712 : Command *my_command;
5713 : PQExpBufferData word_buf;
5714 : int word_offset;
5715 : int offsets[MAX_ARGS]; /* offsets of argument words */
5716 : int j;
5717 :
5718 1064 : initPQExpBuffer(&word_buf);
5719 :
5720 : /* Collect first word of command */
5721 1064 : if (!expr_lex_one_word(sstate, &word_buf, &word_offset))
5722 : {
5723 0 : termPQExpBuffer(&word_buf);
5724 0 : return NULL;
5725 : }
5726 :
5727 : /* Allocate and initialize Command structure */
5728 1064 : my_command = (Command *) pg_malloc0(sizeof(Command));
5729 1064 : my_command->type = META_COMMAND;
5730 1064 : my_command->argc = 0;
5731 1064 : initSimpleStats(&my_command->stats);
5732 :
5733 : /* Save first word (command name) */
5734 1064 : j = 0;
5735 1064 : offsets[j] = word_offset;
5736 1064 : my_command->argv[j++] = pg_strdup(word_buf.data);
5737 1064 : my_command->argc++;
5738 :
5739 : /* ... and convert it to enum form */
5740 1064 : my_command->meta = getMetaCommand(my_command->argv[0]);
5741 :
5742 1064 : if (my_command->meta == META_SET ||
5743 338 : my_command->meta == META_IF ||
5744 290 : my_command->meta == META_ELIF)
5745 : {
5746 : yyscan_t yyscanner;
5747 :
5748 : /* For \set, collect var name */
5749 800 : if (my_command->meta == META_SET)
5750 : {
5751 726 : if (!expr_lex_one_word(sstate, &word_buf, &word_offset))
5752 2 : syntax_error(source, lineno, my_command->first_line, my_command->argv[0],
5753 : "missing argument", NULL, -1);
5754 :
5755 724 : offsets[j] = word_offset;
5756 724 : my_command->argv[j++] = pg_strdup(word_buf.data);
5757 724 : my_command->argc++;
5758 : }
5759 :
5760 : /* then for all parse the expression */
5761 798 : yyscanner = expr_scanner_init(sstate, source, lineno, start_offset,
5762 798 : my_command->argv[0]);
5763 :
5764 798 : if (expr_yyparse(&my_command->expr, yyscanner) != 0)
5765 : {
5766 : /* dead code: exit done from syntax_error called by yyerror */
5767 0 : exit(1);
5768 : }
5769 :
5770 : /* Save line, trimming any trailing newline */
5771 760 : my_command->first_line =
5772 760 : expr_scanner_get_substring(sstate,
5773 : start_offset,
5774 : true);
5775 :
5776 760 : expr_scanner_finish(yyscanner);
5777 :
5778 760 : termPQExpBuffer(&word_buf);
5779 :
5780 760 : return my_command;
5781 : }
5782 :
5783 : /* For all other commands, collect remaining words. */
5784 846 : while (expr_lex_one_word(sstate, &word_buf, &word_offset))
5785 : {
5786 : /*
5787 : * my_command->argv[0] is the command itself, so the max number of
5788 : * arguments is one less than MAX_ARGS
5789 : */
5790 584 : if (j >= MAX_ARGS)
5791 2 : syntax_error(source, lineno, my_command->first_line, my_command->argv[0],
5792 : "too many arguments", NULL, -1);
5793 :
5794 582 : offsets[j] = word_offset;
5795 582 : my_command->argv[j++] = pg_strdup(word_buf.data);
5796 582 : my_command->argc++;
5797 : }
5798 :
5799 : /* Save line, trimming any trailing newline */
5800 262 : my_command->first_line =
5801 262 : expr_scanner_get_substring(sstate,
5802 : start_offset,
5803 : true);
5804 :
5805 262 : if (my_command->meta == META_SLEEP)
5806 : {
5807 18 : if (my_command->argc < 2)
5808 2 : syntax_error(source, lineno, my_command->first_line, my_command->argv[0],
5809 : "missing argument", NULL, -1);
5810 :
5811 16 : if (my_command->argc > 3)
5812 2 : syntax_error(source, lineno, my_command->first_line, my_command->argv[0],
5813 : "too many arguments", NULL,
5814 2 : offsets[3] - start_offset);
5815 :
5816 : /*
5817 : * Split argument into number and unit to allow "sleep 1ms" etc. We
5818 : * don't have to terminate the number argument with null because it
5819 : * will be parsed with atoi, which ignores trailing non-digit
5820 : * characters.
5821 : */
5822 14 : if (my_command->argv[1][0] != ':')
5823 : {
5824 8 : char *c = my_command->argv[1];
5825 8 : bool have_digit = false;
5826 :
5827 : /* Skip sign */
5828 8 : if (*c == '+' || *c == '-')
5829 0 : c++;
5830 :
5831 : /* Require at least one digit */
5832 8 : if (*c && isdigit((unsigned char) *c))
5833 8 : have_digit = true;
5834 :
5835 : /* Eat all digits */
5836 20 : while (*c && isdigit((unsigned char) *c))
5837 12 : c++;
5838 :
5839 8 : if (*c)
5840 : {
5841 2 : if (my_command->argc == 2 && have_digit)
5842 : {
5843 2 : my_command->argv[2] = c;
5844 2 : offsets[2] = offsets[1] + (c - my_command->argv[1]);
5845 2 : my_command->argc = 3;
5846 : }
5847 : else
5848 : {
5849 : /*
5850 : * Raise an error if argument starts with non-digit
5851 : * character (after sign).
5852 : */
5853 0 : syntax_error(source, lineno, my_command->first_line, my_command->argv[0],
5854 : "invalid sleep time, must be an integer",
5855 0 : my_command->argv[1], offsets[1] - start_offset);
5856 : }
5857 : }
5858 : }
5859 :
5860 14 : if (my_command->argc == 3)
5861 : {
5862 18 : if (pg_strcasecmp(my_command->argv[2], "us") != 0 &&
5863 12 : pg_strcasecmp(my_command->argv[2], "ms") != 0 &&
5864 4 : pg_strcasecmp(my_command->argv[2], "s") != 0)
5865 2 : syntax_error(source, lineno, my_command->first_line, my_command->argv[0],
5866 : "unrecognized time unit, must be us, ms or s",
5867 2 : my_command->argv[2], offsets[2] - start_offset);
5868 : }
5869 : }
5870 244 : else if (my_command->meta == META_SETSHELL)
5871 : {
5872 8 : if (my_command->argc < 3)
5873 2 : syntax_error(source, lineno, my_command->first_line, my_command->argv[0],
5874 : "missing argument", NULL, -1);
5875 : }
5876 236 : else if (my_command->meta == META_SHELL)
5877 : {
5878 8 : if (my_command->argc < 2)
5879 2 : syntax_error(source, lineno, my_command->first_line, my_command->argv[0],
5880 : "missing command", NULL, -1);
5881 : }
5882 228 : else if (my_command->meta == META_ELSE || my_command->meta == META_ENDIF ||
5883 158 : my_command->meta == META_STARTPIPELINE ||
5884 116 : my_command->meta == META_ENDPIPELINE ||
5885 82 : my_command->meta == META_SYNCPIPELINE)
5886 : {
5887 156 : if (my_command->argc != 1)
5888 4 : syntax_error(source, lineno, my_command->first_line, my_command->argv[0],
5889 : "unexpected argument", NULL, -1);
5890 : }
5891 72 : else if (my_command->meta == META_GSET || my_command->meta == META_ASET)
5892 : {
5893 70 : if (my_command->argc > 2)
5894 2 : syntax_error(source, lineno, my_command->first_line, my_command->argv[0],
5895 : "too many arguments", NULL, -1);
5896 : }
5897 : else
5898 : {
5899 : /* my_command->meta == META_NONE */
5900 2 : syntax_error(source, lineno, my_command->first_line, my_command->argv[0],
5901 : "invalid command", NULL, -1);
5902 : }
5903 :
5904 244 : termPQExpBuffer(&word_buf);
5905 :
5906 244 : return my_command;
5907 : }
5908 :
5909 : static void
5910 12 : ConditionError(const char *desc, int cmdn, const char *msg)
5911 : {
5912 12 : pg_fatal("condition error in script \"%s\" command %d: %s",
5913 : desc, cmdn, msg);
5914 : }
5915 :
5916 : /*
5917 : * Partial evaluation of conditionals before recording and running the script.
5918 : */
5919 : static void
5920 498 : CheckConditional(const ParsedScript *ps)
5921 : {
5922 : /* statically check conditional structure */
5923 498 : ConditionalStack cs = conditional_stack_create();
5924 : int i;
5925 :
5926 2252 : for (i = 0; ps->commands[i] != NULL; i++)
5927 : {
5928 1764 : Command *cmd = ps->commands[i];
5929 :
5930 1764 : if (cmd->type == META_COMMAND)
5931 : {
5932 922 : switch (cmd->meta)
5933 : {
5934 40 : case META_IF:
5935 40 : conditional_stack_push(cs, IFSTATE_FALSE);
5936 40 : break;
5937 24 : case META_ELIF:
5938 24 : if (conditional_stack_empty(cs))
5939 2 : ConditionError(ps->desc, i + 1, "\\elif without matching \\if");
5940 22 : if (conditional_stack_peek(cs) == IFSTATE_ELSE_FALSE)
5941 2 : ConditionError(ps->desc, i + 1, "\\elif after \\else");
5942 20 : break;
5943 26 : case META_ELSE:
5944 26 : if (conditional_stack_empty(cs))
5945 2 : ConditionError(ps->desc, i + 1, "\\else without matching \\if");
5946 24 : if (conditional_stack_peek(cs) == IFSTATE_ELSE_FALSE)
5947 2 : ConditionError(ps->desc, i + 1, "\\else after \\else");
5948 22 : conditional_stack_poke(cs, IFSTATE_ELSE_FALSE);
5949 22 : break;
5950 36 : case META_ENDIF:
5951 36 : if (!conditional_stack_pop(cs))
5952 2 : ConditionError(ps->desc, i + 1, "\\endif without matching \\if");
5953 34 : break;
5954 796 : default:
5955 : /* ignore anything else... */
5956 796 : break;
5957 : }
5958 : }
5959 : }
5960 488 : if (!conditional_stack_empty(cs))
5961 2 : ConditionError(ps->desc, i + 1, "\\if without matching \\endif");
5962 486 : conditional_stack_destroy(cs);
5963 486 : }
5964 :
5965 : /*
5966 : * Parse a script (either the contents of a file, or a built-in script)
5967 : * and add it to the list of scripts.
5968 : */
5969 : static void
5970 568 : ParseScript(const char *script, const char *desc, int weight)
5971 : {
5972 : ParsedScript ps;
5973 : PsqlScanState sstate;
5974 : PQExpBufferData line_buf;
5975 : int alloc_num;
5976 : int index;
5977 :
5978 : #define COMMANDS_ALLOC_NUM 128
5979 568 : alloc_num = COMMANDS_ALLOC_NUM;
5980 :
5981 : /* Initialize all fields of ps */
5982 568 : ps.desc = desc;
5983 568 : ps.weight = weight;
5984 568 : ps.commands = (Command **) pg_malloc(sizeof(Command *) * alloc_num);
5985 568 : initStats(&ps.stats, 0);
5986 :
5987 : /* Prepare to parse script */
5988 568 : sstate = psql_scan_create(&pgbench_callbacks);
5989 :
5990 : /*
5991 : * Ideally, we'd scan scripts using the encoding and stdstrings settings
5992 : * we get from a DB connection. However, without major rearrangement of
5993 : * pgbench's argument parsing, we can't have a DB connection at the time
5994 : * we parse scripts. Using SQL_ASCII (encoding 0) should work well enough
5995 : * with any backend-safe encoding, though conceivably we could be fooled
5996 : * if a script file uses a client-only encoding. We also assume that
5997 : * stdstrings should be true, which is a bit riskier.
5998 : */
5999 568 : psql_scan_setup(sstate, script, strlen(script), 0, true);
6000 :
6001 568 : initPQExpBuffer(&line_buf);
6002 :
6003 568 : index = 0;
6004 :
6005 : for (;;)
6006 1776 : {
6007 : PsqlScanResult sr;
6008 : promptStatus_t prompt;
6009 2344 : Command *command = NULL;
6010 :
6011 2344 : resetPQExpBuffer(&line_buf);
6012 :
6013 2344 : sr = psql_scan(sstate, &line_buf, &prompt);
6014 :
6015 : /* If we collected a new SQL command, process that */
6016 2344 : command = create_sql_command(&line_buf);
6017 :
6018 : /* store new command */
6019 2344 : if (command)
6020 848 : ps.commands[index++] = command;
6021 :
6022 : /* If we reached a backslash, process that */
6023 2344 : if (sr == PSCAN_BACKSLASH)
6024 : {
6025 : int lineno;
6026 : int start_offset;
6027 :
6028 : /* Capture location of the backslash */
6029 1064 : psql_scan_get_location(sstate, &lineno, &start_offset);
6030 1064 : start_offset--;
6031 :
6032 1064 : command = process_backslash_command(sstate, desc,
6033 : lineno, start_offset);
6034 :
6035 1004 : if (command)
6036 : {
6037 : /*
6038 : * If this is gset or aset, merge into the preceding command.
6039 : * (We don't use a command slot in this case).
6040 : */
6041 1004 : if (command->meta == META_GSET || command->meta == META_ASET)
6042 62 : {
6043 : Command *cmd;
6044 :
6045 68 : if (index == 0)
6046 2 : syntax_error(desc, lineno, NULL, NULL,
6047 : "\\gset must follow an SQL command",
6048 : NULL, -1);
6049 :
6050 66 : cmd = ps.commands[index - 1];
6051 :
6052 66 : if (cmd->type != SQL_COMMAND ||
6053 64 : cmd->varprefix != NULL)
6054 4 : syntax_error(desc, lineno, NULL, NULL,
6055 : "\\gset must follow an SQL command",
6056 4 : cmd->first_line, -1);
6057 :
6058 : /* get variable prefix */
6059 62 : if (command->argc <= 1 || command->argv[1][0] == '\0')
6060 58 : cmd->varprefix = pg_strdup("");
6061 : else
6062 4 : cmd->varprefix = pg_strdup(command->argv[1]);
6063 :
6064 : /* update the sql command meta */
6065 62 : cmd->meta = command->meta;
6066 :
6067 : /* cleanup unused command */
6068 62 : free_command(command);
6069 :
6070 62 : continue;
6071 : }
6072 :
6073 : /* Attach any other backslash command as a new command */
6074 936 : ps.commands[index++] = command;
6075 : }
6076 : }
6077 :
6078 : /*
6079 : * Since we used a command slot, allocate more if needed. Note we
6080 : * always allocate one more in order to accommodate the NULL
6081 : * terminator below.
6082 : */
6083 2216 : if (index >= alloc_num)
6084 : {
6085 0 : alloc_num += COMMANDS_ALLOC_NUM;
6086 0 : ps.commands = (Command **)
6087 0 : pg_realloc(ps.commands, sizeof(Command *) * alloc_num);
6088 : }
6089 :
6090 : /* Done if we reached EOF */
6091 2216 : if (sr == PSCAN_INCOMPLETE || sr == PSCAN_EOL)
6092 : break;
6093 : }
6094 :
6095 502 : ps.commands[index] = NULL;
6096 :
6097 502 : addScript(&ps);
6098 :
6099 486 : termPQExpBuffer(&line_buf);
6100 486 : psql_scan_finish(sstate);
6101 486 : psql_scan_destroy(sstate);
6102 486 : }
6103 :
6104 : /*
6105 : * Read the entire contents of file fd, and return it in a malloc'd buffer.
6106 : *
6107 : * The buffer will typically be larger than necessary, but we don't care
6108 : * in this program, because we'll free it as soon as we've parsed the script.
6109 : */
6110 : static char *
6111 262 : read_file_contents(FILE *fd)
6112 : {
6113 : char *buf;
6114 262 : size_t buflen = BUFSIZ;
6115 262 : size_t used = 0;
6116 :
6117 262 : buf = (char *) pg_malloc(buflen);
6118 :
6119 : for (;;)
6120 0 : {
6121 : size_t nread;
6122 :
6123 262 : nread = fread(buf + used, 1, BUFSIZ, fd);
6124 262 : used += nread;
6125 : /* If fread() read less than requested, must be EOF or error */
6126 262 : if (nread < BUFSIZ)
6127 262 : break;
6128 : /* Enlarge buf so we can read some more */
6129 0 : buflen += BUFSIZ;
6130 0 : buf = (char *) pg_realloc(buf, buflen);
6131 : }
6132 : /* There is surely room for a terminator */
6133 262 : buf[used] = '\0';
6134 :
6135 262 : return buf;
6136 : }
6137 :
6138 : /*
6139 : * Given a file name, read it and add its script to the list.
6140 : * "-" means to read stdin.
6141 : * NB: filename must be storage that won't disappear.
6142 : */
6143 : static void
6144 264 : process_file(const char *filename, int weight)
6145 : {
6146 : FILE *fd;
6147 : char *buf;
6148 :
6149 : /* Slurp the file contents into "buf" */
6150 264 : if (strcmp(filename, "-") == 0)
6151 0 : fd = stdin;
6152 264 : else if ((fd = fopen(filename, "r")) == NULL)
6153 2 : pg_fatal("could not open file \"%s\": %m", filename);
6154 :
6155 262 : buf = read_file_contents(fd);
6156 :
6157 262 : if (ferror(fd))
6158 0 : pg_fatal("could not read file \"%s\": %m", filename);
6159 :
6160 262 : if (fd != stdin)
6161 262 : fclose(fd);
6162 :
6163 262 : ParseScript(buf, filename, weight);
6164 :
6165 182 : free(buf);
6166 182 : }
6167 :
6168 : /* Parse the given builtin script and add it to the list. */
6169 : static void
6170 306 : process_builtin(const BuiltinScript *bi, int weight)
6171 : {
6172 306 : ParseScript(bi->script, bi->desc, weight);
6173 304 : }
6174 :
6175 : /* show available builtin scripts */
6176 : static void
6177 6 : listAvailableScripts(void)
6178 : {
6179 : int i;
6180 :
6181 6 : fprintf(stderr, "Available builtin scripts:\n");
6182 24 : for (i = 0; i < lengthof(builtin_script); i++)
6183 18 : fprintf(stderr, " %13s: %s\n", builtin_script[i].name, builtin_script[i].desc);
6184 6 : fprintf(stderr, "\n");
6185 6 : }
6186 :
6187 : /* return builtin script "name" if unambiguous, fails if not found */
6188 : static const BuiltinScript *
6189 312 : findBuiltin(const char *name)
6190 : {
6191 : int i,
6192 312 : found = 0,
6193 312 : len = strlen(name);
6194 312 : const BuiltinScript *result = NULL;
6195 :
6196 1248 : for (i = 0; i < lengthof(builtin_script); i++)
6197 : {
6198 936 : if (strncmp(builtin_script[i].name, name, len) == 0)
6199 : {
6200 312 : result = &builtin_script[i];
6201 312 : found++;
6202 : }
6203 : }
6204 :
6205 : /* ok, unambiguous result */
6206 312 : if (found == 1)
6207 308 : return result;
6208 :
6209 : /* error cases */
6210 4 : if (found == 0)
6211 2 : pg_log_error("no builtin script found for name \"%s\"", name);
6212 : else /* found > 1 */
6213 2 : pg_log_error("ambiguous builtin name: %d builtin scripts found for prefix \"%s\"", found, name);
6214 :
6215 4 : listAvailableScripts();
6216 4 : exit(1);
6217 : }
6218 :
6219 : /*
6220 : * Determine the weight specification from a script option (-b, -f), if any,
6221 : * and return it as an integer (1 is returned if there's no weight). The
6222 : * script name is returned in *script as a malloc'd string.
6223 : */
6224 : static int
6225 286 : parseScriptWeight(const char *option, char **script)
6226 : {
6227 : char *sep;
6228 : int weight;
6229 :
6230 286 : if ((sep = strrchr(option, WSEP)))
6231 : {
6232 18 : int namelen = sep - option;
6233 : long wtmp;
6234 : char *badp;
6235 :
6236 : /* generate the script name */
6237 18 : *script = pg_malloc(namelen + 1);
6238 18 : strncpy(*script, option, namelen);
6239 18 : (*script)[namelen] = '\0';
6240 :
6241 : /* process digits of the weight spec */
6242 18 : errno = 0;
6243 18 : wtmp = strtol(sep + 1, &badp, 10);
6244 18 : if (errno != 0 || badp == sep + 1 || *badp != '\0')
6245 2 : pg_fatal("invalid weight specification: %s", sep);
6246 16 : if (wtmp > INT_MAX || wtmp < 0)
6247 2 : pg_fatal("weight specification out of range (0 .. %d): %lld",
6248 : INT_MAX, (long long) wtmp);
6249 14 : weight = wtmp;
6250 : }
6251 : else
6252 : {
6253 268 : *script = pg_strdup(option);
6254 268 : weight = 1;
6255 : }
6256 :
6257 282 : return weight;
6258 : }
6259 :
6260 : /* append a script to the list of scripts to process */
6261 : static void
6262 502 : addScript(const ParsedScript *script)
6263 : {
6264 502 : if (script->commands == NULL || script->commands[0] == NULL)
6265 2 : pg_fatal("empty command list for script \"%s\"", script->desc);
6266 :
6267 500 : if (num_scripts >= MAX_SCRIPTS)
6268 2 : pg_fatal("at most %d SQL scripts are allowed", MAX_SCRIPTS);
6269 :
6270 498 : CheckConditional(script);
6271 :
6272 486 : sql_script[num_scripts] = *script;
6273 486 : num_scripts++;
6274 486 : }
6275 :
6276 : /*
6277 : * Print progress report.
6278 : *
6279 : * On entry, *last and *last_report contain the statistics and time of last
6280 : * progress report. On exit, they are updated with the new stats.
6281 : */
6282 : static void
6283 0 : printProgressReport(TState *threads, int64 test_start, pg_time_usec_t now,
6284 : StatsData *last, int64 *last_report)
6285 : {
6286 : /* generate and show report */
6287 0 : pg_time_usec_t run = now - *last_report;
6288 : int64 cnt,
6289 : failures,
6290 : retried;
6291 : double tps,
6292 : total_run,
6293 : latency,
6294 : sqlat,
6295 : lag,
6296 : stdev;
6297 : char tbuf[315];
6298 : StatsData cur;
6299 :
6300 : /*
6301 : * Add up the statistics of all threads.
6302 : *
6303 : * XXX: No locking. There is no guarantee that we get an atomic snapshot
6304 : * of the transaction count and latencies, so these figures can well be
6305 : * off by a small amount. The progress report's purpose is to give a
6306 : * quick overview of how the test is going, so that shouldn't matter too
6307 : * much. (If a read from a 64-bit integer is not atomic, you might get a
6308 : * "torn" read and completely bogus latencies though!)
6309 : */
6310 0 : initStats(&cur, 0);
6311 0 : for (int i = 0; i < nthreads; i++)
6312 : {
6313 0 : mergeSimpleStats(&cur.latency, &threads[i].stats.latency);
6314 0 : mergeSimpleStats(&cur.lag, &threads[i].stats.lag);
6315 0 : cur.cnt += threads[i].stats.cnt;
6316 0 : cur.skipped += threads[i].stats.skipped;
6317 0 : cur.retries += threads[i].stats.retries;
6318 0 : cur.retried += threads[i].stats.retried;
6319 0 : cur.serialization_failures +=
6320 0 : threads[i].stats.serialization_failures;
6321 0 : cur.deadlock_failures += threads[i].stats.deadlock_failures;
6322 : }
6323 :
6324 : /* we count only actually executed transactions */
6325 0 : cnt = cur.cnt - last->cnt;
6326 0 : total_run = (now - test_start) / 1000000.0;
6327 0 : tps = 1000000.0 * cnt / run;
6328 0 : if (cnt > 0)
6329 : {
6330 0 : latency = 0.001 * (cur.latency.sum - last->latency.sum) / cnt;
6331 0 : sqlat = 1.0 * (cur.latency.sum2 - last->latency.sum2) / cnt;
6332 0 : stdev = 0.001 * sqrt(sqlat - 1000000.0 * latency * latency);
6333 0 : lag = 0.001 * (cur.lag.sum - last->lag.sum) / cnt;
6334 : }
6335 : else
6336 : {
6337 0 : latency = sqlat = stdev = lag = 0;
6338 : }
6339 0 : failures = getFailures(&cur) - getFailures(last);
6340 0 : retried = cur.retried - last->retried;
6341 :
6342 0 : if (progress_timestamp)
6343 : {
6344 0 : snprintf(tbuf, sizeof(tbuf), "%.3f s",
6345 0 : PG_TIME_GET_DOUBLE(now + epoch_shift));
6346 : }
6347 : else
6348 : {
6349 : /* round seconds are expected, but the thread may be late */
6350 0 : snprintf(tbuf, sizeof(tbuf), "%.1f s", total_run);
6351 : }
6352 :
6353 0 : fprintf(stderr,
6354 : "progress: %s, %.1f tps, lat %.3f ms stddev %.3f, " INT64_FORMAT " failed",
6355 : tbuf, tps, latency, stdev, failures);
6356 :
6357 0 : if (throttle_delay)
6358 : {
6359 0 : fprintf(stderr, ", lag %.3f ms", lag);
6360 0 : if (latency_limit)
6361 0 : fprintf(stderr, ", " INT64_FORMAT " skipped",
6362 0 : cur.skipped - last->skipped);
6363 : }
6364 :
6365 : /* it can be non-zero only if max_tries is not equal to one */
6366 0 : if (max_tries != 1)
6367 0 : fprintf(stderr,
6368 : ", " INT64_FORMAT " retried, " INT64_FORMAT " retries",
6369 0 : retried, cur.retries - last->retries);
6370 0 : fprintf(stderr, "\n");
6371 :
6372 0 : *last = cur;
6373 0 : *last_report = now;
6374 0 : }
6375 :
6376 : static void
6377 30 : printSimpleStats(const char *prefix, SimpleStats *ss)
6378 : {
6379 30 : if (ss->count > 0)
6380 : {
6381 30 : double latency = ss->sum / ss->count;
6382 30 : double stddev = sqrt(ss->sum2 / ss->count - latency * latency);
6383 :
6384 30 : printf("%s average = %.3f ms\n", prefix, 0.001 * latency);
6385 30 : printf("%s stddev = %.3f ms\n", prefix, 0.001 * stddev);
6386 : }
6387 30 : }
6388 :
6389 : /* print version banner */
6390 : static void
6391 176 : printVersion(PGconn *con)
6392 : {
6393 176 : int server_ver = PQserverVersion(con);
6394 176 : int client_ver = PG_VERSION_NUM;
6395 :
6396 176 : if (server_ver != client_ver)
6397 : {
6398 : const char *server_version;
6399 : char sverbuf[32];
6400 :
6401 : /* Try to get full text form, might include "devel" etc */
6402 0 : server_version = PQparameterStatus(con, "server_version");
6403 : /* Otherwise fall back on server_ver */
6404 0 : if (!server_version)
6405 : {
6406 0 : formatPGVersionNumber(server_ver, true,
6407 : sverbuf, sizeof(sverbuf));
6408 0 : server_version = sverbuf;
6409 : }
6410 :
6411 0 : printf(_("%s (%s, server %s)\n"),
6412 : "pgbench", PG_VERSION, server_version);
6413 : }
6414 : /* For version match, only print pgbench version */
6415 : else
6416 176 : printf("%s (%s)\n", "pgbench", PG_VERSION);
6417 176 : fflush(stdout);
6418 176 : }
6419 :
6420 : /* print out results */
6421 : static void
6422 172 : printResults(StatsData *total,
6423 : pg_time_usec_t total_duration, /* benchmarking time */
6424 : pg_time_usec_t conn_total_duration, /* is_connect */
6425 : pg_time_usec_t conn_elapsed_duration, /* !is_connect */
6426 : int64 latency_late)
6427 : {
6428 : /* tps is about actually executed transactions during benchmarking */
6429 172 : int64 failures = getFailures(total);
6430 172 : int64 total_cnt = total->cnt + total->skipped + failures;
6431 172 : double bench_duration = PG_TIME_GET_DOUBLE(total_duration);
6432 172 : double tps = total->cnt / bench_duration;
6433 :
6434 : /* Report test parameters. */
6435 172 : printf("transaction type: %s\n",
6436 : num_scripts == 1 ? sql_script[0].desc : "multiple scripts");
6437 172 : printf("scaling factor: %d\n", scale);
6438 : /* only print partitioning information if some partitioning was detected */
6439 172 : if (partition_method != PART_NONE)
6440 12 : printf("partition method: %s\npartitions: %d\n",
6441 : PARTITION_METHOD[partition_method], partitions);
6442 172 : printf("query mode: %s\n", QUERYMODE[querymode]);
6443 172 : printf("number of clients: %d\n", nclients);
6444 172 : printf("number of threads: %d\n", nthreads);
6445 :
6446 172 : if (max_tries)
6447 172 : printf("maximum number of tries: %u\n", max_tries);
6448 :
6449 172 : if (duration <= 0)
6450 : {
6451 172 : printf("number of transactions per client: %d\n", nxacts);
6452 172 : printf("number of transactions actually processed: " INT64_FORMAT "/%d\n",
6453 : total->cnt, nxacts * nclients);
6454 : }
6455 : else
6456 : {
6457 0 : printf("duration: %d s\n", duration);
6458 0 : printf("number of transactions actually processed: " INT64_FORMAT "\n",
6459 : total->cnt);
6460 : }
6461 :
6462 : /*
6463 : * Remaining stats are nonsensical if we failed to execute any xacts due
6464 : * to others than serialization or deadlock errors
6465 : */
6466 172 : if (total_cnt <= 0)
6467 102 : return;
6468 :
6469 70 : printf("number of failed transactions: " INT64_FORMAT " (%.3f%%)\n",
6470 : failures, 100.0 * failures / total_cnt);
6471 :
6472 70 : if (failures_detailed)
6473 : {
6474 0 : printf("number of serialization failures: " INT64_FORMAT " (%.3f%%)\n",
6475 : total->serialization_failures,
6476 : 100.0 * total->serialization_failures / total_cnt);
6477 0 : printf("number of deadlock failures: " INT64_FORMAT " (%.3f%%)\n",
6478 : total->deadlock_failures,
6479 : 100.0 * total->deadlock_failures / total_cnt);
6480 : }
6481 :
6482 : /* it can be non-zero only if max_tries is not equal to one */
6483 70 : if (max_tries != 1)
6484 : {
6485 4 : printf("number of transactions retried: " INT64_FORMAT " (%.3f%%)\n",
6486 : total->retried, 100.0 * total->retried / total_cnt);
6487 4 : printf("total number of retries: " INT64_FORMAT "\n", total->retries);
6488 : }
6489 :
6490 70 : if (throttle_delay && latency_limit)
6491 4 : printf("number of transactions skipped: " INT64_FORMAT " (%.3f%%)\n",
6492 : total->skipped, 100.0 * total->skipped / total_cnt);
6493 :
6494 70 : if (latency_limit)
6495 4 : printf("number of transactions above the %.1f ms latency limit: " INT64_FORMAT "/" INT64_FORMAT " (%.3f%%)\n",
6496 : latency_limit / 1000.0, latency_late, total->cnt,
6497 : (total->cnt > 0) ? 100.0 * latency_late / total->cnt : 0.0);
6498 :
6499 70 : if (throttle_delay || progress || latency_limit)
6500 4 : printSimpleStats("latency", &total->latency);
6501 : else
6502 : {
6503 : /* no measurement, show average latency computed from run time */
6504 66 : printf("latency average = %.3f ms%s\n",
6505 : 0.001 * total_duration * nclients / total_cnt,
6506 : failures > 0 ? " (including failures)" : "");
6507 : }
6508 :
6509 70 : if (throttle_delay)
6510 : {
6511 : /*
6512 : * Report average transaction lag under rate limit throttling. This
6513 : * is the delay between scheduled and actual start times for the
6514 : * transaction. The measured lag may be caused by thread/client load,
6515 : * the database load, or the Poisson throttling process.
6516 : */
6517 4 : printf("rate limit schedule lag: avg %.3f (max %.3f) ms\n",
6518 : 0.001 * total->lag.sum / total->cnt, 0.001 * total->lag.max);
6519 : }
6520 :
6521 : /*
6522 : * Under -C/--connect, each transaction incurs a significant connection
6523 : * cost, it would not make much sense to ignore it in tps, and it would
6524 : * not be tps anyway.
6525 : *
6526 : * Otherwise connections are made just once at the beginning of the run
6527 : * and should not impact performance but for very short run, so they are
6528 : * (right)fully ignored in tps.
6529 : */
6530 70 : if (is_connect)
6531 : {
6532 4 : printf("average connection time = %.3f ms\n", 0.001 * conn_total_duration / (total->cnt + failures));
6533 4 : printf("tps = %f (including reconnection times)\n", tps);
6534 : }
6535 : else
6536 : {
6537 66 : printf("initial connection time = %.3f ms\n", 0.001 * conn_elapsed_duration);
6538 66 : printf("tps = %f (without initial connection time)\n", tps);
6539 : }
6540 :
6541 : /* Report per-script/command statistics */
6542 70 : if (per_script_stats || report_per_command)
6543 : {
6544 : int i;
6545 :
6546 42 : for (i = 0; i < num_scripts; i++)
6547 : {
6548 30 : if (per_script_stats)
6549 : {
6550 26 : StatsData *sstats = &sql_script[i].stats;
6551 26 : int64 script_failures = getFailures(sstats);
6552 26 : int64 script_total_cnt =
6553 26 : sstats->cnt + sstats->skipped + script_failures;
6554 :
6555 26 : printf("SQL script %d: %s\n"
6556 : " - weight: %d (targets %.1f%% of total)\n"
6557 : " - " INT64_FORMAT " transactions (%.1f%% of total)\n",
6558 : i + 1, sql_script[i].desc,
6559 : sql_script[i].weight,
6560 : 100.0 * sql_script[i].weight / total_weight,
6561 : script_total_cnt,
6562 : 100.0 * script_total_cnt / total_cnt);
6563 :
6564 26 : if (script_total_cnt > 0)
6565 : {
6566 26 : printf(" - number of transactions actually processed: " INT64_FORMAT " (tps = %f)\n",
6567 : sstats->cnt, sstats->cnt / bench_duration);
6568 :
6569 26 : printf(" - number of failed transactions: " INT64_FORMAT " (%.3f%%)\n",
6570 : script_failures,
6571 : 100.0 * script_failures / script_total_cnt);
6572 :
6573 26 : if (failures_detailed)
6574 : {
6575 0 : printf(" - number of serialization failures: " INT64_FORMAT " (%.3f%%)\n",
6576 : sstats->serialization_failures,
6577 : (100.0 * sstats->serialization_failures /
6578 : script_total_cnt));
6579 0 : printf(" - number of deadlock failures: " INT64_FORMAT " (%.3f%%)\n",
6580 : sstats->deadlock_failures,
6581 : (100.0 * sstats->deadlock_failures /
6582 : script_total_cnt));
6583 : }
6584 :
6585 : /*
6586 : * it can be non-zero only if max_tries is not equal to
6587 : * one
6588 : */
6589 26 : if (max_tries != 1)
6590 : {
6591 0 : printf(" - number of transactions retried: " INT64_FORMAT " (%.3f%%)\n",
6592 : sstats->retried,
6593 : 100.0 * sstats->retried / script_total_cnt);
6594 0 : printf(" - total number of retries: " INT64_FORMAT "\n",
6595 : sstats->retries);
6596 : }
6597 :
6598 26 : if (throttle_delay && latency_limit)
6599 0 : printf(" - number of transactions skipped: " INT64_FORMAT " (%.3f%%)\n",
6600 : sstats->skipped,
6601 : 100.0 * sstats->skipped / script_total_cnt);
6602 :
6603 : }
6604 26 : printSimpleStats(" - latency", &sstats->latency);
6605 : }
6606 :
6607 : /*
6608 : * Report per-command statistics: latencies, retries after errors,
6609 : * failures (errors without retrying).
6610 : */
6611 30 : if (report_per_command)
6612 : {
6613 : Command **commands;
6614 :
6615 4 : printf("%sstatement latencies in milliseconds%s:\n",
6616 : per_script_stats ? " - " : "",
6617 : (max_tries == 1 ?
6618 : " and failures" :
6619 : ", failures and retries"));
6620 :
6621 4 : for (commands = sql_script[i].commands;
6622 10 : *commands != NULL;
6623 6 : commands++)
6624 : {
6625 6 : SimpleStats *cstats = &(*commands)->stats;
6626 :
6627 6 : if (max_tries == 1)
6628 6 : printf(" %11.3f %10" PRId64 " %s\n",
6629 : (cstats->count > 0) ?
6630 : 1000.0 * cstats->sum / cstats->count : 0.0,
6631 : (*commands)->failures,
6632 : (*commands)->first_line);
6633 : else
6634 0 : printf(" %11.3f %10" PRId64 " %10" PRId64 " %s\n",
6635 : (cstats->count > 0) ?
6636 : 1000.0 * cstats->sum / cstats->count : 0.0,
6637 : (*commands)->failures,
6638 : (*commands)->retries,
6639 : (*commands)->first_line);
6640 : }
6641 : }
6642 : }
6643 : }
6644 : }
6645 :
6646 : /*
6647 : * Set up a random seed according to seed parameter (NULL means default),
6648 : * and initialize base_random_sequence for use in initializing other sequences.
6649 : */
6650 : static bool
6651 362 : set_random_seed(const char *seed)
6652 : {
6653 : uint64 iseed;
6654 :
6655 362 : if (seed == NULL || strcmp(seed, "time") == 0)
6656 : {
6657 : /* rely on current time */
6658 354 : iseed = pg_time_now();
6659 : }
6660 8 : else if (strcmp(seed, "rand") == 0)
6661 : {
6662 : /* use some "strong" random source */
6663 0 : if (!pg_strong_random(&iseed, sizeof(iseed)))
6664 : {
6665 0 : pg_log_error("could not generate random seed");
6666 0 : return false;
6667 : }
6668 : }
6669 : else
6670 : {
6671 : char garbage;
6672 :
6673 8 : if (sscanf(seed, "%" SCNu64 "%c", &iseed, &garbage) != 1)
6674 : {
6675 2 : pg_log_error("unrecognized random seed option \"%s\"", seed);
6676 2 : pg_log_error_detail("Expecting an unsigned integer, \"time\" or \"rand\".");
6677 2 : return false;
6678 : }
6679 : }
6680 :
6681 360 : if (seed != NULL)
6682 6 : pg_log_info("setting random seed to %" PRIu64, iseed);
6683 :
6684 360 : random_seed = iseed;
6685 :
6686 : /* Initialize base_random_sequence using seed */
6687 360 : pg_prng_seed(&base_random_sequence, iseed);
6688 :
6689 360 : return true;
6690 : }
6691 :
6692 : int
6693 358 : main(int argc, char **argv)
6694 : {
6695 : static struct option long_options[] = {
6696 : /* systematic long/short named options */
6697 : {"builtin", required_argument, NULL, 'b'},
6698 : {"client", required_argument, NULL, 'c'},
6699 : {"connect", no_argument, NULL, 'C'},
6700 : {"dbname", required_argument, NULL, 'd'},
6701 : {"define", required_argument, NULL, 'D'},
6702 : {"file", required_argument, NULL, 'f'},
6703 : {"fillfactor", required_argument, NULL, 'F'},
6704 : {"host", required_argument, NULL, 'h'},
6705 : {"initialize", no_argument, NULL, 'i'},
6706 : {"init-steps", required_argument, NULL, 'I'},
6707 : {"jobs", required_argument, NULL, 'j'},
6708 : {"log", no_argument, NULL, 'l'},
6709 : {"latency-limit", required_argument, NULL, 'L'},
6710 : {"no-vacuum", no_argument, NULL, 'n'},
6711 : {"port", required_argument, NULL, 'p'},
6712 : {"progress", required_argument, NULL, 'P'},
6713 : {"protocol", required_argument, NULL, 'M'},
6714 : {"quiet", no_argument, NULL, 'q'},
6715 : {"report-per-command", no_argument, NULL, 'r'},
6716 : {"rate", required_argument, NULL, 'R'},
6717 : {"scale", required_argument, NULL, 's'},
6718 : {"select-only", no_argument, NULL, 'S'},
6719 : {"skip-some-updates", no_argument, NULL, 'N'},
6720 : {"time", required_argument, NULL, 'T'},
6721 : {"transactions", required_argument, NULL, 't'},
6722 : {"username", required_argument, NULL, 'U'},
6723 : {"vacuum-all", no_argument, NULL, 'v'},
6724 : /* long-named only options */
6725 : {"unlogged-tables", no_argument, NULL, 1},
6726 : {"tablespace", required_argument, NULL, 2},
6727 : {"index-tablespace", required_argument, NULL, 3},
6728 : {"sampling-rate", required_argument, NULL, 4},
6729 : {"aggregate-interval", required_argument, NULL, 5},
6730 : {"progress-timestamp", no_argument, NULL, 6},
6731 : {"log-prefix", required_argument, NULL, 7},
6732 : {"foreign-keys", no_argument, NULL, 8},
6733 : {"random-seed", required_argument, NULL, 9},
6734 : {"show-script", required_argument, NULL, 10},
6735 : {"partitions", required_argument, NULL, 11},
6736 : {"partition-method", required_argument, NULL, 12},
6737 : {"failures-detailed", no_argument, NULL, 13},
6738 : {"max-tries", required_argument, NULL, 14},
6739 : {"verbose-errors", no_argument, NULL, 15},
6740 : {"exit-on-abort", no_argument, NULL, 16},
6741 : {"debug", no_argument, NULL, 17},
6742 : {NULL, 0, NULL, 0}
6743 : };
6744 :
6745 : int c;
6746 358 : bool is_init_mode = false; /* initialize mode? */
6747 358 : char *initialize_steps = NULL;
6748 358 : bool foreign_keys = false;
6749 358 : bool is_no_vacuum = false;
6750 358 : bool do_vacuum_accounts = false; /* vacuum accounts table? */
6751 : int optindex;
6752 358 : bool scale_given = false;
6753 :
6754 358 : bool benchmarking_option_set = false;
6755 358 : bool initialization_option_set = false;
6756 358 : bool internal_script_used = false;
6757 :
6758 : CState *state; /* status of clients */
6759 : TState *threads; /* array of thread */
6760 :
6761 : pg_time_usec_t
6762 : start_time, /* start up time */
6763 358 : bench_start = 0, /* first recorded benchmarking time */
6764 : conn_total_duration; /* cumulated connection time in
6765 : * threads */
6766 358 : int64 latency_late = 0;
6767 : StatsData stats;
6768 : int weight;
6769 :
6770 : int i;
6771 : int nclients_dealt;
6772 :
6773 : #ifdef HAVE_GETRLIMIT
6774 : struct rlimit rlim;
6775 : #endif
6776 :
6777 : PGconn *con;
6778 : char *env;
6779 :
6780 358 : int exit_code = 0;
6781 : struct timeval tv;
6782 :
6783 : /*
6784 : * Record difference between Unix time and instr_time time. We'll use
6785 : * this for logging and aggregation.
6786 : */
6787 358 : gettimeofday(&tv, NULL);
6788 358 : epoch_shift = tv.tv_sec * INT64CONST(1000000) + tv.tv_usec - pg_time_now();
6789 :
6790 358 : pg_logging_init(argv[0]);
6791 358 : progname = get_progname(argv[0]);
6792 :
6793 358 : if (argc > 1)
6794 : {
6795 358 : if (strcmp(argv[1], "--help") == 0 || strcmp(argv[1], "-?") == 0)
6796 : {
6797 2 : usage();
6798 2 : exit(0);
6799 : }
6800 356 : if (strcmp(argv[1], "--version") == 0 || strcmp(argv[1], "-V") == 0)
6801 : {
6802 2 : puts("pgbench (PostgreSQL) " PG_VERSION);
6803 2 : exit(0);
6804 : }
6805 : }
6806 :
6807 354 : state = (CState *) pg_malloc0(sizeof(CState));
6808 :
6809 : /* set random seed early, because it may be used while parsing scripts. */
6810 354 : if (!set_random_seed(getenv("PGBENCH_RANDOM_SEED")))
6811 0 : pg_fatal("error while setting random seed from PGBENCH_RANDOM_SEED environment variable");
6812 :
6813 2484 : while ((c = getopt_long(argc, argv, "b:c:Cd:D:f:F:h:iI:j:lL:M:nNp:P:qrR:s:St:T:U:v", long_options, &optindex)) != -1)
6814 : {
6815 : char *script;
6816 :
6817 2268 : switch (c)
6818 : {
6819 24 : case 'b':
6820 24 : if (strcmp(optarg, "list") == 0)
6821 : {
6822 2 : listAvailableScripts();
6823 2 : exit(0);
6824 : }
6825 22 : weight = parseScriptWeight(optarg, &script);
6826 18 : process_builtin(findBuiltin(script), weight);
6827 14 : benchmarking_option_set = true;
6828 14 : internal_script_used = true;
6829 14 : break;
6830 50 : case 'c':
6831 50 : benchmarking_option_set = true;
6832 50 : if (!option_parse_int(optarg, "-c/--clients", 1, INT_MAX,
6833 : &nclients))
6834 : {
6835 2 : exit(1);
6836 : }
6837 : #ifdef HAVE_GETRLIMIT
6838 48 : if (getrlimit(RLIMIT_NOFILE, &rlim) == -1)
6839 0 : pg_fatal("getrlimit failed: %m");
6840 :
6841 48 : if (rlim.rlim_max < nclients + 3)
6842 : {
6843 0 : pg_log_error("need at least %d open files, but system limit is %ld",
6844 : nclients + 3, (long) rlim.rlim_max);
6845 0 : pg_log_error_hint("Reduce number of clients, or use limit/ulimit to increase the system limit.");
6846 0 : exit(1);
6847 : }
6848 :
6849 48 : if (rlim.rlim_cur < nclients + 3)
6850 : {
6851 0 : rlim.rlim_cur = nclients + 3;
6852 0 : if (setrlimit(RLIMIT_NOFILE, &rlim) == -1)
6853 : {
6854 0 : pg_log_error("need at least %d open files, but couldn't raise the limit: %m",
6855 : nclients + 3);
6856 0 : pg_log_error_hint("Reduce number of clients, or use limit/ulimit to increase the system limit.");
6857 0 : exit(1);
6858 : }
6859 : }
6860 : #endif /* HAVE_GETRLIMIT */
6861 48 : break;
6862 4 : case 'C':
6863 4 : benchmarking_option_set = true;
6864 4 : is_connect = true;
6865 4 : break;
6866 0 : case 'd':
6867 0 : dbName = pg_strdup(optarg);
6868 0 : break;
6869 866 : case 'D':
6870 : {
6871 : char *p;
6872 :
6873 866 : benchmarking_option_set = true;
6874 :
6875 866 : if ((p = strchr(optarg, '=')) == NULL || p == optarg || *(p + 1) == '\0')
6876 2 : pg_fatal("invalid variable definition: \"%s\"", optarg);
6877 :
6878 864 : *p++ = '\0';
6879 864 : if (!putVariable(&state[0].variables, "option", optarg, p))
6880 0 : exit(1);
6881 : }
6882 864 : break;
6883 264 : case 'f':
6884 264 : weight = parseScriptWeight(optarg, &script);
6885 264 : process_file(script, weight);
6886 182 : benchmarking_option_set = true;
6887 182 : break;
6888 6 : case 'F':
6889 6 : initialization_option_set = true;
6890 6 : if (!option_parse_int(optarg, "-F/--fillfactor", 10, 100,
6891 : &fillfactor))
6892 2 : exit(1);
6893 4 : break;
6894 2 : case 'h':
6895 2 : pghost = pg_strdup(optarg);
6896 2 : break;
6897 18 : case 'i':
6898 18 : is_init_mode = true;
6899 18 : break;
6900 8 : case 'I':
6901 8 : pg_free(initialize_steps);
6902 8 : initialize_steps = pg_strdup(optarg);
6903 8 : checkInitSteps(initialize_steps);
6904 6 : initialization_option_set = true;
6905 6 : break;
6906 8 : case 'j': /* jobs */
6907 8 : benchmarking_option_set = true;
6908 8 : if (!option_parse_int(optarg, "-j/--jobs", 1, INT_MAX,
6909 : &nthreads))
6910 : {
6911 2 : exit(1);
6912 : }
6913 6 : break;
6914 14 : case 'l':
6915 14 : benchmarking_option_set = true;
6916 14 : use_log = true;
6917 14 : break;
6918 6 : case 'L':
6919 : {
6920 6 : double limit_ms = atof(optarg);
6921 :
6922 6 : if (limit_ms <= 0.0)
6923 2 : pg_fatal("invalid latency limit: \"%s\"", optarg);
6924 4 : benchmarking_option_set = true;
6925 4 : latency_limit = (int64) (limit_ms * 1000);
6926 : }
6927 4 : break;
6928 176 : case 'M':
6929 176 : benchmarking_option_set = true;
6930 482 : for (querymode = 0; querymode < NUM_QUERYMODE; querymode++)
6931 480 : if (strcmp(optarg, QUERYMODE[querymode]) == 0)
6932 174 : break;
6933 176 : if (querymode >= NUM_QUERYMODE)
6934 2 : pg_fatal("invalid query mode (-M): \"%s\"", optarg);
6935 174 : break;
6936 198 : case 'n':
6937 198 : is_no_vacuum = true;
6938 198 : break;
6939 2 : case 'N':
6940 2 : process_builtin(findBuiltin("simple-update"), 1);
6941 2 : benchmarking_option_set = true;
6942 2 : internal_script_used = true;
6943 2 : break;
6944 2 : case 'p':
6945 2 : pgport = pg_strdup(optarg);
6946 2 : break;
6947 4 : case 'P':
6948 4 : benchmarking_option_set = true;
6949 4 : if (!option_parse_int(optarg, "-P/--progress", 1, INT_MAX,
6950 : &progress))
6951 2 : exit(1);
6952 2 : break;
6953 2 : case 'q':
6954 2 : initialization_option_set = true;
6955 2 : use_quiet = true;
6956 2 : break;
6957 4 : case 'r':
6958 4 : benchmarking_option_set = true;
6959 4 : report_per_command = true;
6960 4 : break;
6961 6 : case 'R':
6962 : {
6963 : /* get a double from the beginning of option value */
6964 6 : double throttle_value = atof(optarg);
6965 :
6966 6 : benchmarking_option_set = true;
6967 :
6968 6 : if (throttle_value <= 0.0)
6969 2 : pg_fatal("invalid rate limit: \"%s\"", optarg);
6970 : /* Invert rate limit into per-transaction delay in usec */
6971 4 : throttle_delay = 1000000.0 / throttle_value;
6972 : }
6973 4 : break;
6974 6 : case 's':
6975 6 : scale_given = true;
6976 6 : if (!option_parse_int(optarg, "-s/--scale", 1, INT_MAX,
6977 : &scale))
6978 2 : exit(1);
6979 4 : break;
6980 268 : case 'S':
6981 268 : process_builtin(findBuiltin("select-only"), 1);
6982 266 : benchmarking_option_set = true;
6983 266 : internal_script_used = true;
6984 266 : break;
6985 222 : case 't':
6986 222 : benchmarking_option_set = true;
6987 222 : if (!option_parse_int(optarg, "-t/--transactions", 1, INT_MAX,
6988 : &nxacts))
6989 2 : exit(1);
6990 220 : break;
6991 10 : case 'T':
6992 10 : benchmarking_option_set = true;
6993 10 : if (!option_parse_int(optarg, "-T/--time", 1, INT_MAX,
6994 : &duration))
6995 2 : exit(1);
6996 8 : break;
6997 2 : case 'U':
6998 2 : username = pg_strdup(optarg);
6999 2 : break;
7000 2 : case 'v':
7001 2 : benchmarking_option_set = true;
7002 2 : do_vacuum_accounts = true;
7003 2 : break;
7004 4 : case 1: /* unlogged-tables */
7005 4 : initialization_option_set = true;
7006 4 : unlogged_tables = true;
7007 4 : break;
7008 2 : case 2: /* tablespace */
7009 2 : initialization_option_set = true;
7010 2 : tablespace = pg_strdup(optarg);
7011 2 : break;
7012 2 : case 3: /* index-tablespace */
7013 2 : initialization_option_set = true;
7014 2 : index_tablespace = pg_strdup(optarg);
7015 2 : break;
7016 10 : case 4: /* sampling-rate */
7017 10 : benchmarking_option_set = true;
7018 10 : sample_rate = atof(optarg);
7019 10 : if (sample_rate <= 0.0 || sample_rate > 1.0)
7020 2 : pg_fatal("invalid sampling rate: \"%s\"", optarg);
7021 8 : break;
7022 12 : case 5: /* aggregate-interval */
7023 12 : benchmarking_option_set = true;
7024 12 : if (!option_parse_int(optarg, "--aggregate-interval", 1, INT_MAX,
7025 : &agg_interval))
7026 2 : exit(1);
7027 10 : break;
7028 4 : case 6: /* progress-timestamp */
7029 4 : progress_timestamp = true;
7030 4 : benchmarking_option_set = true;
7031 4 : break;
7032 8 : case 7: /* log-prefix */
7033 8 : benchmarking_option_set = true;
7034 8 : logfile_prefix = pg_strdup(optarg);
7035 8 : break;
7036 4 : case 8: /* foreign-keys */
7037 4 : initialization_option_set = true;
7038 4 : foreign_keys = true;
7039 4 : break;
7040 8 : case 9: /* random-seed */
7041 8 : benchmarking_option_set = true;
7042 8 : if (!set_random_seed(optarg))
7043 2 : pg_fatal("error while setting random seed from --random-seed option");
7044 6 : break;
7045 2 : case 10: /* list */
7046 : {
7047 2 : const BuiltinScript *s = findBuiltin(optarg);
7048 :
7049 2 : fprintf(stderr, "-- %s: %s\n%s\n", s->name, s->desc, s->script);
7050 2 : exit(0);
7051 : }
7052 : break;
7053 6 : case 11: /* partitions */
7054 6 : initialization_option_set = true;
7055 6 : if (!option_parse_int(optarg, "--partitions", 0, INT_MAX,
7056 : &partitions))
7057 2 : exit(1);
7058 4 : break;
7059 6 : case 12: /* partition-method */
7060 6 : initialization_option_set = true;
7061 6 : if (pg_strcasecmp(optarg, "range") == 0)
7062 0 : partition_method = PART_RANGE;
7063 6 : else if (pg_strcasecmp(optarg, "hash") == 0)
7064 4 : partition_method = PART_HASH;
7065 : else
7066 2 : pg_fatal("invalid partition method, expecting \"range\" or \"hash\", got: \"%s\"",
7067 : optarg);
7068 4 : break;
7069 0 : case 13: /* failures-detailed */
7070 0 : benchmarking_option_set = true;
7071 0 : failures_detailed = true;
7072 0 : break;
7073 8 : case 14: /* max-tries */
7074 : {
7075 8 : int32 max_tries_arg = atoi(optarg);
7076 :
7077 8 : if (max_tries_arg < 0)
7078 2 : pg_fatal("invalid number of maximum tries: \"%s\"", optarg);
7079 :
7080 6 : benchmarking_option_set = true;
7081 6 : max_tries = (uint32) max_tries_arg;
7082 : }
7083 6 : break;
7084 4 : case 15: /* verbose-errors */
7085 4 : benchmarking_option_set = true;
7086 4 : verbose_errors = true;
7087 4 : break;
7088 4 : case 16: /* exit-on-abort */
7089 4 : benchmarking_option_set = true;
7090 4 : exit_on_abort = true;
7091 4 : break;
7092 4 : case 17: /* debug */
7093 4 : pg_logging_increase_verbosity();
7094 4 : break;
7095 6 : default:
7096 : /* getopt_long already emitted a complaint */
7097 6 : pg_log_error_hint("Try \"%s --help\" for more information.", progname);
7098 6 : exit(1);
7099 : }
7100 : }
7101 :
7102 : /* set default script if none */
7103 216 : if (num_scripts == 0 && !is_init_mode)
7104 : {
7105 22 : process_builtin(findBuiltin("tpcb-like"), 1);
7106 22 : benchmarking_option_set = true;
7107 22 : internal_script_used = true;
7108 : }
7109 :
7110 : /* complete SQL command initialization and compute total weight */
7111 444 : for (i = 0; i < num_scripts; i++)
7112 : {
7113 230 : Command **commands = sql_script[i].commands;
7114 :
7115 1460 : for (int j = 0; commands[j] != NULL; j++)
7116 1232 : if (commands[j]->type == SQL_COMMAND)
7117 586 : postprocess_sql_command(commands[j]);
7118 :
7119 : /* cannot overflow: weight is 32b, total_weight 64b */
7120 228 : total_weight += sql_script[i].weight;
7121 : }
7122 :
7123 214 : if (total_weight == 0 && !is_init_mode)
7124 2 : pg_fatal("total script weight must not be zero");
7125 :
7126 : /* show per script stats if several scripts are used */
7127 212 : if (num_scripts > 1)
7128 8 : per_script_stats = true;
7129 :
7130 : /*
7131 : * Don't need more threads than there are clients. (This is not merely an
7132 : * optimization; throttle_delay is calculated incorrectly below if some
7133 : * threads have no clients assigned to them.)
7134 : */
7135 212 : if (nthreads > nclients)
7136 2 : nthreads = nclients;
7137 :
7138 : /*
7139 : * Convert throttle_delay to a per-thread delay time. Note that this
7140 : * might be a fractional number of usec, but that's OK, since it's just
7141 : * the center of a Poisson distribution of delays.
7142 : */
7143 212 : throttle_delay *= nthreads;
7144 :
7145 212 : if (dbName == NULL)
7146 : {
7147 212 : if (argc > optind)
7148 2 : dbName = argv[optind++];
7149 : else
7150 : {
7151 210 : if ((env = getenv("PGDATABASE")) != NULL && *env != '\0')
7152 182 : dbName = env;
7153 28 : else if ((env = getenv("PGUSER")) != NULL && *env != '\0')
7154 0 : dbName = env;
7155 : else
7156 28 : dbName = get_user_name_or_exit(progname);
7157 : }
7158 : }
7159 :
7160 212 : if (optind < argc)
7161 : {
7162 0 : pg_log_error("too many command-line arguments (first is \"%s\")",
7163 : argv[optind]);
7164 0 : pg_log_error_hint("Try \"%s --help\" for more information.", progname);
7165 0 : exit(1);
7166 : }
7167 :
7168 212 : if (is_init_mode)
7169 : {
7170 10 : if (benchmarking_option_set)
7171 2 : pg_fatal("some of the specified options cannot be used in initialization (-i) mode");
7172 :
7173 8 : if (partitions == 0 && partition_method != PART_NONE)
7174 2 : pg_fatal("--partition-method requires greater than zero --partitions");
7175 :
7176 : /* set default method */
7177 6 : if (partitions > 0 && partition_method == PART_NONE)
7178 2 : partition_method = PART_RANGE;
7179 :
7180 6 : if (initialize_steps == NULL)
7181 2 : initialize_steps = pg_strdup(DEFAULT_INIT_STEPS);
7182 :
7183 6 : if (is_no_vacuum)
7184 : {
7185 : /* Remove any vacuum step in initialize_steps */
7186 : char *p;
7187 :
7188 8 : while ((p = strchr(initialize_steps, 'v')) != NULL)
7189 6 : *p = ' ';
7190 : }
7191 :
7192 6 : if (foreign_keys)
7193 : {
7194 : /* Add 'f' to end of initialize_steps, if not already there */
7195 4 : if (strchr(initialize_steps, 'f') == NULL)
7196 : {
7197 : initialize_steps = (char *)
7198 4 : pg_realloc(initialize_steps,
7199 4 : strlen(initialize_steps) + 2);
7200 4 : strcat(initialize_steps, "f");
7201 : }
7202 : }
7203 :
7204 6 : runInitSteps(initialize_steps);
7205 6 : exit(0);
7206 : }
7207 : else
7208 : {
7209 202 : if (initialization_option_set)
7210 4 : pg_fatal("some of the specified options cannot be used in benchmarking mode");
7211 : }
7212 :
7213 198 : if (nxacts > 0 && duration > 0)
7214 4 : pg_fatal("specify either a number of transactions (-t) or a duration (-T), not both");
7215 :
7216 : /* Use DEFAULT_NXACTS if neither nxacts nor duration is specified. */
7217 194 : if (nxacts <= 0 && duration <= 0)
7218 16 : nxacts = DEFAULT_NXACTS;
7219 :
7220 : /* --sampling-rate may be used only with -l */
7221 194 : if (sample_rate > 0.0 && !use_log)
7222 2 : pg_fatal("log sampling (--sampling-rate) is allowed only when logging transactions (-l)");
7223 :
7224 : /* --sampling-rate may not be used with --aggregate-interval */
7225 192 : if (sample_rate > 0.0 && agg_interval > 0)
7226 2 : pg_fatal("log sampling (--sampling-rate) and aggregation (--aggregate-interval) cannot be used at the same time");
7227 :
7228 190 : if (agg_interval > 0 && !use_log)
7229 2 : pg_fatal("log aggregation is allowed only when actually logging transactions");
7230 :
7231 188 : if (!use_log && logfile_prefix)
7232 2 : pg_fatal("log file prefix (--log-prefix) is allowed only when logging transactions (-l)");
7233 :
7234 186 : if (duration > 0 && agg_interval > duration)
7235 2 : pg_fatal("number of seconds for aggregation (%d) must not be higher than test duration (%d)", agg_interval, duration);
7236 :
7237 184 : if (duration > 0 && agg_interval > 0 && duration % agg_interval != 0)
7238 2 : pg_fatal("duration (%d) must be a multiple of aggregation interval (%d)", duration, agg_interval);
7239 :
7240 182 : if (progress_timestamp && progress == 0)
7241 2 : pg_fatal("--progress-timestamp is allowed only under --progress");
7242 :
7243 180 : if (!max_tries)
7244 : {
7245 2 : if (!latency_limit && duration <= 0)
7246 2 : pg_fatal("an unlimited number of transaction tries can only be used with --latency-limit or a duration (-T)");
7247 : }
7248 :
7249 : /*
7250 : * save main process id in the global variable because process id will be
7251 : * changed after fork.
7252 : */
7253 178 : main_pid = (int) getpid();
7254 :
7255 178 : if (nclients > 1)
7256 : {
7257 30 : state = (CState *) pg_realloc(state, sizeof(CState) * nclients);
7258 30 : memset(state + 1, 0, sizeof(CState) * (nclients - 1));
7259 :
7260 : /* copy any -D switch values to all clients */
7261 110 : for (i = 1; i < nclients; i++)
7262 : {
7263 : int j;
7264 :
7265 80 : state[i].id = i;
7266 82 : for (j = 0; j < state[0].variables.nvars; j++)
7267 : {
7268 2 : Variable *var = &state[0].variables.vars[j];
7269 :
7270 2 : if (var->value.type != PGBT_NO_VALUE)
7271 : {
7272 0 : if (!putVariableValue(&state[i].variables, "startup",
7273 0 : var->name, &var->value))
7274 0 : exit(1);
7275 : }
7276 : else
7277 : {
7278 2 : if (!putVariable(&state[i].variables, "startup",
7279 2 : var->name, var->svalue))
7280 0 : exit(1);
7281 : }
7282 : }
7283 : }
7284 : }
7285 :
7286 : /* other CState initializations */
7287 436 : for (i = 0; i < nclients; i++)
7288 : {
7289 258 : state[i].cstack = conditional_stack_create();
7290 258 : initRandomState(&state[i].cs_func_rs);
7291 : }
7292 :
7293 : /* opening connection... */
7294 178 : con = doConnect();
7295 178 : if (con == NULL)
7296 2 : pg_fatal("could not create connection for setup");
7297 :
7298 : /* report pgbench and server versions */
7299 176 : printVersion(con);
7300 :
7301 176 : pg_log_debug("pghost: %s pgport: %s nclients: %d %s: %d dbName: %s",
7302 : PQhost(con), PQport(con), nclients,
7303 : duration <= 0 ? "nxacts" : "duration",
7304 : duration <= 0 ? nxacts : duration, PQdb(con));
7305 :
7306 176 : if (internal_script_used)
7307 14 : GetTableInfo(con, scale_given);
7308 :
7309 : /*
7310 : * :scale variables normally get -s or database scale, but don't override
7311 : * an explicit -D switch
7312 : */
7313 174 : if (lookupVariable(&state[0].variables, "scale") == NULL)
7314 : {
7315 428 : for (i = 0; i < nclients; i++)
7316 : {
7317 254 : if (!putVariableInt(&state[i].variables, "startup", "scale", scale))
7318 0 : exit(1);
7319 : }
7320 : }
7321 :
7322 : /*
7323 : * Define a :client_id variable that is unique per connection. But don't
7324 : * override an explicit -D switch.
7325 : */
7326 174 : if (lookupVariable(&state[0].variables, "client_id") == NULL)
7327 : {
7328 428 : for (i = 0; i < nclients; i++)
7329 254 : if (!putVariableInt(&state[i].variables, "startup", "client_id", i))
7330 0 : exit(1);
7331 : }
7332 :
7333 : /* set default seed for hash functions */
7334 174 : if (lookupVariable(&state[0].variables, "default_seed") == NULL)
7335 : {
7336 174 : uint64 seed = pg_prng_uint64(&base_random_sequence);
7337 :
7338 428 : for (i = 0; i < nclients; i++)
7339 254 : if (!putVariableInt(&state[i].variables, "startup", "default_seed",
7340 : (int64) seed))
7341 0 : exit(1);
7342 : }
7343 :
7344 : /* set random seed unless overwritten */
7345 174 : if (lookupVariable(&state[0].variables, "random_seed") == NULL)
7346 : {
7347 428 : for (i = 0; i < nclients; i++)
7348 254 : if (!putVariableInt(&state[i].variables, "startup", "random_seed",
7349 : random_seed))
7350 0 : exit(1);
7351 : }
7352 :
7353 174 : if (!is_no_vacuum)
7354 : {
7355 22 : fprintf(stderr, "starting vacuum...");
7356 22 : tryExecuteStatement(con, "vacuum pgbench_branches");
7357 22 : tryExecuteStatement(con, "vacuum pgbench_tellers");
7358 22 : tryExecuteStatement(con, "truncate pgbench_history");
7359 22 : fprintf(stderr, "end.\n");
7360 :
7361 22 : if (do_vacuum_accounts)
7362 : {
7363 0 : fprintf(stderr, "starting vacuum pgbench_accounts...");
7364 0 : tryExecuteStatement(con, "vacuum analyze pgbench_accounts");
7365 0 : fprintf(stderr, "end.\n");
7366 : }
7367 : }
7368 174 : PQfinish(con);
7369 :
7370 : /* set up thread data structures */
7371 174 : threads = (TState *) pg_malloc(sizeof(TState) * nthreads);
7372 174 : nclients_dealt = 0;
7373 :
7374 350 : for (i = 0; i < nthreads; i++)
7375 : {
7376 176 : TState *thread = &threads[i];
7377 :
7378 176 : thread->tid = i;
7379 176 : thread->state = &state[nclients_dealt];
7380 176 : thread->nstate =
7381 176 : (nclients - nclients_dealt + nthreads - i - 1) / (nthreads - i);
7382 176 : initRandomState(&thread->ts_choose_rs);
7383 176 : initRandomState(&thread->ts_throttle_rs);
7384 176 : initRandomState(&thread->ts_sample_rs);
7385 176 : thread->logfile = NULL; /* filled in later */
7386 176 : thread->latency_late = 0;
7387 176 : initStats(&thread->stats, 0);
7388 :
7389 176 : nclients_dealt += thread->nstate;
7390 : }
7391 :
7392 : /* all clients must be assigned to a thread */
7393 : Assert(nclients_dealt == nclients);
7394 :
7395 : /* get start up time for the whole computation */
7396 174 : start_time = pg_time_now();
7397 :
7398 : /* set alarm if duration is specified. */
7399 174 : if (duration > 0)
7400 0 : setalarm(duration);
7401 :
7402 174 : errno = THREAD_BARRIER_INIT(&barrier, nthreads);
7403 174 : if (errno != 0)
7404 0 : pg_fatal("could not initialize barrier: %m");
7405 :
7406 : /* start all threads but thread 0 which is executed directly later */
7407 176 : for (i = 1; i < nthreads; i++)
7408 : {
7409 2 : TState *thread = &threads[i];
7410 :
7411 2 : thread->create_time = pg_time_now();
7412 2 : errno = THREAD_CREATE(&thread->thread, threadRun, thread);
7413 :
7414 2 : if (errno != 0)
7415 0 : pg_fatal("could not create thread: %m");
7416 : }
7417 :
7418 : /* compute when to stop */
7419 174 : threads[0].create_time = pg_time_now();
7420 174 : if (duration > 0)
7421 0 : end_time = threads[0].create_time + (int64) 1000000 * duration;
7422 :
7423 : /* run thread 0 directly */
7424 174 : (void) threadRun(&threads[0]);
7425 :
7426 : /* wait for other threads and accumulate results */
7427 172 : initStats(&stats, 0);
7428 172 : conn_total_duration = 0;
7429 :
7430 344 : for (i = 0; i < nthreads; i++)
7431 : {
7432 172 : TState *thread = &threads[i];
7433 :
7434 172 : if (i > 0)
7435 0 : THREAD_JOIN(thread->thread);
7436 :
7437 422 : for (int j = 0; j < thread->nstate; j++)
7438 250 : if (thread->state[j].state != CSTATE_FINISHED)
7439 104 : exit_code = 2;
7440 :
7441 : /* aggregate thread level stats */
7442 172 : mergeSimpleStats(&stats.latency, &thread->stats.latency);
7443 172 : mergeSimpleStats(&stats.lag, &thread->stats.lag);
7444 172 : stats.cnt += thread->stats.cnt;
7445 172 : stats.skipped += thread->stats.skipped;
7446 172 : stats.retries += thread->stats.retries;
7447 172 : stats.retried += thread->stats.retried;
7448 172 : stats.serialization_failures += thread->stats.serialization_failures;
7449 172 : stats.deadlock_failures += thread->stats.deadlock_failures;
7450 172 : latency_late += thread->latency_late;
7451 172 : conn_total_duration += thread->conn_duration;
7452 :
7453 : /* first recorded benchmarking start time */
7454 172 : if (bench_start == 0 || thread->bench_start < bench_start)
7455 172 : bench_start = thread->bench_start;
7456 : }
7457 :
7458 : /*
7459 : * All connections should be already closed in threadRun(), so this
7460 : * disconnect_all() will be a no-op, but clean up the connections just to
7461 : * be sure. We don't need to measure the disconnection delays here.
7462 : */
7463 172 : disconnect_all(state, nclients);
7464 :
7465 : /*
7466 : * Beware that performance of short benchmarks with many threads and
7467 : * possibly long transactions can be deceptive because threads do not
7468 : * start and finish at the exact same time. The total duration computed
7469 : * here encompasses all transactions so that tps shown is somehow slightly
7470 : * underestimated.
7471 : */
7472 172 : printResults(&stats, pg_time_now() - bench_start, conn_total_duration,
7473 : bench_start - start_time, latency_late);
7474 :
7475 172 : THREAD_BARRIER_DESTROY(&barrier);
7476 :
7477 172 : if (exit_code != 0)
7478 104 : pg_log_error("Run was aborted; the above results are incomplete.");
7479 :
7480 172 : return exit_code;
7481 : }
7482 :
7483 : static THREAD_FUNC_RETURN_TYPE THREAD_FUNC_CC
7484 176 : threadRun(void *arg)
7485 : {
7486 176 : TState *thread = (TState *) arg;
7487 176 : CState *state = thread->state;
7488 : pg_time_usec_t start;
7489 176 : int nstate = thread->nstate;
7490 176 : int remains = nstate; /* number of remaining clients */
7491 176 : socket_set *sockets = alloc_socket_set(nstate);
7492 : int64 thread_start,
7493 : last_report,
7494 : next_report;
7495 : StatsData last,
7496 : aggs;
7497 :
7498 : /* open log file if requested */
7499 176 : if (use_log)
7500 : {
7501 : char logpath[MAXPGPATH];
7502 4 : char *prefix = logfile_prefix ? logfile_prefix : "pgbench_log";
7503 :
7504 4 : if (thread->tid == 0)
7505 4 : snprintf(logpath, sizeof(logpath), "%s.%d", prefix, main_pid);
7506 : else
7507 0 : snprintf(logpath, sizeof(logpath), "%s.%d.%d", prefix, main_pid, thread->tid);
7508 :
7509 4 : thread->logfile = fopen(logpath, "w");
7510 :
7511 4 : if (thread->logfile == NULL)
7512 0 : pg_fatal("could not open logfile \"%s\": %m", logpath);
7513 : }
7514 :
7515 : /* explicitly initialize the state machines */
7516 430 : for (int i = 0; i < nstate; i++)
7517 254 : state[i].state = CSTATE_CHOOSE_SCRIPT;
7518 :
7519 : /* READY */
7520 176 : THREAD_BARRIER_WAIT(&barrier);
7521 :
7522 176 : thread_start = pg_time_now();
7523 176 : thread->started_time = thread_start;
7524 176 : thread->conn_duration = 0;
7525 176 : last_report = thread_start;
7526 176 : next_report = last_report + (int64) 1000000 * progress;
7527 :
7528 : /* STEADY */
7529 176 : if (!is_connect)
7530 : {
7531 : /* make connections to the database before starting */
7532 412 : for (int i = 0; i < nstate; i++)
7533 : {
7534 240 : if ((state[i].con = doConnect()) == NULL)
7535 : {
7536 : /* coldly abort on initial connection failure */
7537 0 : pg_fatal("could not create connection for client %d",
7538 : state[i].id);
7539 : }
7540 : }
7541 : }
7542 :
7543 : /* GO */
7544 176 : THREAD_BARRIER_WAIT(&barrier);
7545 :
7546 176 : start = pg_time_now();
7547 176 : thread->bench_start = start;
7548 176 : thread->throttle_trigger = start;
7549 :
7550 : /*
7551 : * The log format currently has Unix epoch timestamps with whole numbers
7552 : * of seconds. Round the first aggregate's start time down to the nearest
7553 : * Unix epoch second (the very first aggregate might really have started a
7554 : * fraction of a second later, but later aggregates are measured from the
7555 : * whole number time that is actually logged).
7556 : */
7557 176 : initStats(&aggs, (start + epoch_shift) / 1000000 * 1000000);
7558 176 : last = aggs;
7559 :
7560 : /* loop till all clients have terminated */
7561 30796 : while (remains > 0)
7562 : {
7563 : int nsocks; /* number of sockets to be waited for */
7564 : pg_time_usec_t min_usec;
7565 30624 : pg_time_usec_t now = 0; /* set this only if needed */
7566 :
7567 : /*
7568 : * identify which client sockets should be checked for input, and
7569 : * compute the nearest time (if any) at which we need to wake up.
7570 : */
7571 30624 : clear_socket_set(sockets);
7572 30624 : nsocks = 0;
7573 30624 : min_usec = PG_INT64_MAX;
7574 137598 : for (int i = 0; i < nstate; i++)
7575 : {
7576 120190 : CState *st = &state[i];
7577 :
7578 120190 : if (st->state == CSTATE_SLEEP || st->state == CSTATE_THROTTLE)
7579 6 : {
7580 : /* a nap from the script, or under throttling */
7581 : pg_time_usec_t this_usec;
7582 :
7583 : /* get current time if needed */
7584 6 : pg_time_now_lazy(&now);
7585 :
7586 : /* min_usec should be the minimum delay across all clients */
7587 12 : this_usec = (st->state == CSTATE_SLEEP ?
7588 6 : st->sleep_until : st->txn_scheduled) - now;
7589 6 : if (min_usec > this_usec)
7590 6 : min_usec = this_usec;
7591 : }
7592 120184 : else if (st->state == CSTATE_WAIT_RESULT ||
7593 22968 : st->state == CSTATE_WAIT_ROLLBACK_RESULT)
7594 97218 : {
7595 : /*
7596 : * waiting for result from server - nothing to do unless the
7597 : * socket is readable
7598 : */
7599 97218 : int sock = PQsocket(st->con);
7600 :
7601 97218 : if (sock < 0)
7602 : {
7603 0 : pg_log_error("invalid socket: %s", PQerrorMessage(st->con));
7604 2 : goto done;
7605 : }
7606 :
7607 97218 : add_socket_to_set(sockets, sock, nsocks++);
7608 : }
7609 22966 : else if (st->state != CSTATE_ABORTED &&
7610 22966 : st->state != CSTATE_FINISHED)
7611 : {
7612 : /*
7613 : * This client thread is ready to do something, so we don't
7614 : * want to wait. No need to examine additional clients.
7615 : */
7616 13216 : min_usec = 0;
7617 13216 : break;
7618 : }
7619 : }
7620 :
7621 : /* also wake up to print the next progress report on time */
7622 30624 : if (progress && min_usec > 0 && thread->tid == 0)
7623 : {
7624 0 : pg_time_now_lazy(&now);
7625 :
7626 0 : if (now >= next_report)
7627 0 : min_usec = 0;
7628 0 : else if ((next_report - now) < min_usec)
7629 0 : min_usec = next_report - now;
7630 : }
7631 :
7632 : /*
7633 : * If no clients are ready to execute actions, sleep until we receive
7634 : * data on some client socket or the timeout (if any) elapses.
7635 : */
7636 30624 : if (min_usec > 0)
7637 : {
7638 17408 : int rc = 0;
7639 :
7640 17408 : if (min_usec != PG_INT64_MAX)
7641 : {
7642 6 : if (nsocks > 0)
7643 : {
7644 0 : rc = wait_on_socket_set(sockets, min_usec);
7645 : }
7646 : else /* nothing active, simple sleep */
7647 : {
7648 6 : pg_usleep(min_usec);
7649 : }
7650 : }
7651 : else /* no explicit delay, wait without timeout */
7652 : {
7653 17402 : rc = wait_on_socket_set(sockets, 0);
7654 : }
7655 :
7656 17406 : if (rc < 0)
7657 : {
7658 0 : if (errno == EINTR)
7659 : {
7660 : /* On EINTR, go back to top of loop */
7661 0 : continue;
7662 : }
7663 : /* must be something wrong */
7664 0 : pg_log_error("%s() failed: %m", SOCKET_WAIT_METHOD);
7665 0 : goto done;
7666 : }
7667 : }
7668 : else
7669 : {
7670 : /* min_usec <= 0, i.e. something needs to be executed now */
7671 :
7672 : /* If we didn't wait, don't try to read any data */
7673 13216 : clear_socket_set(sockets);
7674 : }
7675 :
7676 : /* ok, advance the state machine of each connection */
7677 30622 : nsocks = 0;
7678 178546 : for (int i = 0; i < nstate; i++)
7679 : {
7680 147926 : CState *st = &state[i];
7681 :
7682 147926 : if (st->state == CSTATE_WAIT_RESULT ||
7683 28418 : st->state == CSTATE_WAIT_ROLLBACK_RESULT)
7684 20428 : {
7685 : /* don't call advanceConnectionState unless data is available */
7686 119510 : int sock = PQsocket(st->con);
7687 :
7688 119510 : if (sock < 0)
7689 : {
7690 0 : pg_log_error("invalid socket: %s", PQerrorMessage(st->con));
7691 0 : goto done;
7692 : }
7693 :
7694 119510 : if (!socket_has_input(sockets, sock, nsocks++))
7695 99082 : continue;
7696 : }
7697 28416 : else if (st->state == CSTATE_FINISHED ||
7698 15498 : st->state == CSTATE_ABORTED)
7699 : {
7700 : /* this client is done, no need to consider it anymore */
7701 12918 : continue;
7702 : }
7703 :
7704 35926 : advanceConnectionState(thread, st, &aggs);
7705 :
7706 : /*
7707 : * If --exit-on-abort is used, the program is going to exit when
7708 : * any client is aborted.
7709 : */
7710 35926 : if (exit_on_abort && st->state == CSTATE_ABORTED)
7711 2 : goto done;
7712 :
7713 : /*
7714 : * If advanceConnectionState changed client to finished state,
7715 : * that's one fewer client that remains.
7716 : */
7717 35924 : else if (st->state == CSTATE_FINISHED ||
7718 35778 : st->state == CSTATE_ABORTED)
7719 250 : remains--;
7720 : }
7721 :
7722 : /* progress report is made by thread 0 for all threads */
7723 30620 : if (progress && thread->tid == 0)
7724 : {
7725 0 : pg_time_usec_t now2 = pg_time_now();
7726 :
7727 0 : if (now2 >= next_report)
7728 : {
7729 : /*
7730 : * Horrible hack: this relies on the thread pointer we are
7731 : * passed to be equivalent to threads[0], that is the first
7732 : * entry of the threads array. That is why this MUST be done
7733 : * by thread 0 and not any other.
7734 : */
7735 0 : printProgressReport(thread, thread_start, now2,
7736 : &last, &last_report);
7737 :
7738 : /*
7739 : * Ensure that the next report is in the future, in case
7740 : * pgbench/postgres got stuck somewhere.
7741 : */
7742 : do
7743 : {
7744 0 : next_report += (int64) 1000000 * progress;
7745 0 : } while (now2 >= next_report);
7746 : }
7747 : }
7748 : }
7749 :
7750 172 : done:
7751 174 : if (exit_on_abort)
7752 : {
7753 : /*
7754 : * Abort if any client is not finished, meaning some error occurred.
7755 : */
7756 6 : for (int i = 0; i < nstate; i++)
7757 : {
7758 4 : if (state[i].state != CSTATE_FINISHED)
7759 : {
7760 2 : pg_log_error("Run was aborted due to an error in thread %d",
7761 : thread->tid);
7762 2 : exit(2);
7763 : }
7764 : }
7765 : }
7766 :
7767 172 : disconnect_all(state, nstate);
7768 :
7769 172 : if (thread->logfile)
7770 : {
7771 4 : if (agg_interval > 0)
7772 : {
7773 : /* log aggregated but not yet reported transactions */
7774 0 : doLog(thread, state, &aggs, false, 0, 0);
7775 : }
7776 4 : fclose(thread->logfile);
7777 4 : thread->logfile = NULL;
7778 : }
7779 172 : free_socket_set(sockets);
7780 172 : THREAD_FUNC_RETURN;
7781 : }
7782 :
7783 : static void
7784 972 : finishCon(CState *st)
7785 : {
7786 972 : if (st->con != NULL)
7787 : {
7788 458 : PQfinish(st->con);
7789 458 : st->con = NULL;
7790 : }
7791 972 : }
7792 :
7793 : /*
7794 : * Support for duration option: set timer_exceeded after so many seconds.
7795 : */
7796 :
7797 : #ifndef WIN32
7798 :
7799 : static void
7800 0 : handle_sig_alarm(SIGNAL_ARGS)
7801 : {
7802 0 : timer_exceeded = true;
7803 0 : }
7804 :
7805 : static void
7806 0 : setalarm(int seconds)
7807 : {
7808 0 : pqsignal(SIGALRM, handle_sig_alarm);
7809 0 : alarm(seconds);
7810 0 : }
7811 :
7812 : #else /* WIN32 */
7813 :
7814 : static VOID CALLBACK
7815 : win32_timer_callback(PVOID lpParameter, BOOLEAN TimerOrWaitFired)
7816 : {
7817 : timer_exceeded = true;
7818 : }
7819 :
7820 : static void
7821 : setalarm(int seconds)
7822 : {
7823 : HANDLE queue;
7824 : HANDLE timer;
7825 :
7826 : /* This function will be called at most once, so we can cheat a bit. */
7827 : queue = CreateTimerQueue();
7828 : if (seconds > ((DWORD) -1) / 1000 ||
7829 : !CreateTimerQueueTimer(&timer, queue,
7830 : win32_timer_callback, NULL, seconds * 1000, 0,
7831 : WT_EXECUTEINTIMERTHREAD | WT_EXECUTEONLYONCE))
7832 : pg_fatal("failed to set timer");
7833 : }
7834 :
7835 : #endif /* WIN32 */
7836 :
7837 :
7838 : /*
7839 : * These functions provide an abstraction layer that hides the syscall
7840 : * we use to wait for input on a set of sockets.
7841 : *
7842 : * Currently there are two implementations, based on ppoll(2) and select(2).
7843 : * ppoll() is preferred where available due to its typically higher ceiling
7844 : * on the number of usable sockets. We do not use the more-widely-available
7845 : * poll(2) because it only offers millisecond timeout resolution, which could
7846 : * be problematic with high --rate settings.
7847 : *
7848 : * Function APIs:
7849 : *
7850 : * alloc_socket_set: allocate an empty socket set with room for up to
7851 : * "count" sockets.
7852 : *
7853 : * free_socket_set: deallocate a socket set.
7854 : *
7855 : * clear_socket_set: reset a socket set to empty.
7856 : *
7857 : * add_socket_to_set: add socket with indicated FD to slot "idx" in the
7858 : * socket set. Slots must be filled in order, starting with 0.
7859 : *
7860 : * wait_on_socket_set: wait for input on any socket in set, or for timeout
7861 : * to expire. timeout is measured in microseconds; 0 means wait forever.
7862 : * Returns result code of underlying syscall (>=0 if OK, else see errno).
7863 : *
7864 : * socket_has_input: after waiting, call this to see if given socket has
7865 : * input. fd and idx parameters should match some previous call to
7866 : * add_socket_to_set.
7867 : *
7868 : * Note that wait_on_socket_set destructively modifies the state of the
7869 : * socket set. After checking for input, caller must apply clear_socket_set
7870 : * and add_socket_to_set again before waiting again.
7871 : */
7872 :
7873 : #ifdef POLL_USING_PPOLL
7874 :
7875 : static socket_set *
7876 176 : alloc_socket_set(int count)
7877 : {
7878 : socket_set *sa;
7879 :
7880 176 : sa = (socket_set *) pg_malloc0(offsetof(socket_set, pollfds) +
7881 : sizeof(struct pollfd) * count);
7882 176 : sa->maxfds = count;
7883 176 : sa->curfds = 0;
7884 176 : return sa;
7885 : }
7886 :
7887 : static void
7888 172 : free_socket_set(socket_set *sa)
7889 : {
7890 172 : pg_free(sa);
7891 172 : }
7892 :
7893 : static void
7894 43840 : clear_socket_set(socket_set *sa)
7895 : {
7896 43840 : sa->curfds = 0;
7897 43840 : }
7898 :
7899 : static void
7900 97218 : add_socket_to_set(socket_set *sa, int fd, int idx)
7901 : {
7902 : Assert(idx < sa->maxfds && idx == sa->curfds);
7903 97218 : sa->pollfds[idx].fd = fd;
7904 97218 : sa->pollfds[idx].events = POLLIN;
7905 97218 : sa->pollfds[idx].revents = 0;
7906 97218 : sa->curfds++;
7907 97218 : }
7908 :
7909 : static int
7910 17402 : wait_on_socket_set(socket_set *sa, int64 usecs)
7911 : {
7912 17402 : if (usecs > 0)
7913 : {
7914 : struct timespec timeout;
7915 :
7916 0 : timeout.tv_sec = usecs / 1000000;
7917 0 : timeout.tv_nsec = (usecs % 1000000) * 1000;
7918 0 : return ppoll(sa->pollfds, sa->curfds, &timeout, NULL);
7919 : }
7920 : else
7921 : {
7922 17402 : return ppoll(sa->pollfds, sa->curfds, NULL, NULL);
7923 : }
7924 : }
7925 :
7926 : static bool
7927 119510 : socket_has_input(socket_set *sa, int fd, int idx)
7928 : {
7929 : /*
7930 : * In some cases, threadRun will apply clear_socket_set and then try to
7931 : * apply socket_has_input anyway with arguments that it used before that,
7932 : * or might've used before that except that it exited its setup loop
7933 : * early. Hence, if the socket set is empty, silently return false
7934 : * regardless of the parameters. If it's not empty, we can Assert that
7935 : * the parameters match a previous call.
7936 : */
7937 119510 : if (sa->curfds == 0)
7938 44314 : return false;
7939 :
7940 : Assert(idx < sa->curfds && sa->pollfds[idx].fd == fd);
7941 75196 : return (sa->pollfds[idx].revents & POLLIN) != 0;
7942 : }
7943 :
7944 : #endif /* POLL_USING_PPOLL */
7945 :
7946 : #ifdef POLL_USING_SELECT
7947 :
7948 : static socket_set *
7949 : alloc_socket_set(int count)
7950 : {
7951 : return (socket_set *) pg_malloc0(sizeof(socket_set));
7952 : }
7953 :
7954 : static void
7955 : free_socket_set(socket_set *sa)
7956 : {
7957 : pg_free(sa);
7958 : }
7959 :
7960 : static void
7961 : clear_socket_set(socket_set *sa)
7962 : {
7963 : FD_ZERO(&sa->fds);
7964 : sa->maxfd = -1;
7965 : }
7966 :
7967 : static void
7968 : add_socket_to_set(socket_set *sa, int fd, int idx)
7969 : {
7970 : /* See connect_slot() for background on this code. */
7971 : #ifdef WIN32
7972 : if (sa->fds.fd_count + 1 >= FD_SETSIZE)
7973 : {
7974 : pg_log_error("too many concurrent database clients for this platform: %d",
7975 : sa->fds.fd_count + 1);
7976 : exit(1);
7977 : }
7978 : #else
7979 : if (fd < 0 || fd >= FD_SETSIZE)
7980 : {
7981 : pg_log_error("socket file descriptor out of range for select(): %d",
7982 : fd);
7983 : pg_log_error_hint("Try fewer concurrent database clients.");
7984 : exit(1);
7985 : }
7986 : #endif
7987 : FD_SET(fd, &sa->fds);
7988 : if (fd > sa->maxfd)
7989 : sa->maxfd = fd;
7990 : }
7991 :
7992 : static int
7993 : wait_on_socket_set(socket_set *sa, int64 usecs)
7994 : {
7995 : if (usecs > 0)
7996 : {
7997 : struct timeval timeout;
7998 :
7999 : timeout.tv_sec = usecs / 1000000;
8000 : timeout.tv_usec = usecs % 1000000;
8001 : return select(sa->maxfd + 1, &sa->fds, NULL, NULL, &timeout);
8002 : }
8003 : else
8004 : {
8005 : return select(sa->maxfd + 1, &sa->fds, NULL, NULL, NULL);
8006 : }
8007 : }
8008 :
8009 : static bool
8010 : socket_has_input(socket_set *sa, int fd, int idx)
8011 : {
8012 : return (FD_ISSET(fd, &sa->fds) != 0);
8013 : }
8014 :
8015 : #endif /* POLL_USING_SELECT */
|
