/* This file is part of TALER (C) 2014-2020 Taler Systems SA TALER is free software; you can redistribute it and/or modify it under the terms of the GNU Affero General Public License as published by the Free Software Foundation; either version 3, or (at your option) any later version. TALER is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with TALER; see the file COPYING. If not, see */ /** * @file benchmark/taler-exchange-benchmark.c * @brief HTTP serving layer intended to perform crypto-work and * communication with the exchange * @author Marcello Stanisci * @author Christian Grothoff */ #include "platform.h" #include #include #include #include "taler_util.h" #include "taler_signatures.h" #include "taler_exchange_service.h" #include "taler_json_lib.h" #include "taler_bank_service.h" #include "taler_fakebank_lib.h" #include "taler_testing_lib.h" #include "taler_error_codes.h" /* Error codes. */ enum BenchmarkError { MISSING_BANK_URL, FAILED_TO_LAUNCH_BANK, BAD_CLI_ARG, BAD_CONFIG_FILE, NO_CONFIG_FILE_GIVEN }; /** * The whole benchmark is a repetition of a "unit". Each * unit is a array containing a withdraw+deposit operation, * and _possibly_ a refresh of the deposited coin. */ #define UNITY_SIZE 6 #define FIRST_INSTRUCTION -1 /** * What mode should the benchmark run in? */ enum BenchmarkMode { /** * Run as client (with fakebank), also starts a remote exchange. */ MODE_CLIENT = 1, /** * Run the the exchange. */ MODE_EXCHANGE = 2, /** * Run both, for a local benchmark. */ MODE_BOTH = 3, }; /** * Hold information regarding which bank has the exchange account. */ static struct TALER_BANK_AuthenticationData exchange_bank_account; /** * Configuration of our exchange. */ static struct TALER_TESTING_ExchangeConfiguration ec; /** * Hold information about a user at the bank. */ static char *user_payto_uri; /** * Time snapshot taken right before executing the CMDs. */ static struct GNUNET_TIME_Absolute start_time; /** * Benchmark duration time taken right after the CMD interpreter * returns. */ static struct GNUNET_TIME_Relative duration; /** * Array of all the commands the benchmark is running. */ static struct TALER_TESTING_Command *all_commands; /** * Exit code. */ static int result; /** * How many coins we want to create per client and reserve. */ static unsigned int howmany_coins = 1; /** * How many reserves we want to create per client. */ static unsigned int howmany_reserves = 1; /** * Probability (in percent) of refreshing per spent coin. */ static unsigned int refresh_rate = 10; /** * How many clients we want to create. */ static unsigned int howmany_clients = 1; /** * Log level used during the run. */ static char *loglev; /** * Log file. */ static char *logfile; /** * Benchmarking mode (run as client, exchange, both) as string. */ static char *mode_str; /** * Benchmarking mode (run as client, exchange, both). */ static enum BenchmarkMode mode; /** * Configuration. */ static struct GNUNET_CONFIGURATION_Handle *cfg; /** * Currency used. */ static char *currency; /** * Remote host that runs the exchange. */ static char *remote_host; /** * Remote benchmarking directory. */ static char *remote_dir; /** * Array of command labels. */ static char **labels; /** * Length of #labels. */ static unsigned int label_len; /** * Offset in #labels. */ static unsigned int label_off; /** * Don't kill exchange/fakebank/wirewatch until * requested by the user explicitly. */ static int linger; /** * Add label to the #labels table and return it. * * @param label string to add to the table * @return same string, now stored in the table */ const char * add_label (char *label) { if (label_off == label_len) GNUNET_array_grow (labels, label_len, label_len * 2 + 4); labels[label_off++] = label; return label; } static struct TALER_TESTING_Command cmd_transfer_to_exchange (const char *label, const char *amount) { return TALER_TESTING_cmd_admin_add_incoming_retry (TALER_TESTING_cmd_admin_add_incoming (label, amount, &exchange_bank_account, user_payto_uri)); } /** * Decide which exchange account is going to be * used to address a wire transfer to. Used at * withdrawal time. * * @param cls closure * @param section section name. */ static void pick_exchange_account_cb (void *cls, const char *section) { if (0 == strncasecmp ("exchange-account-", section, strlen ("exchange-account-"))) { const char **s = cls; *s = section; } } /** * Throw a weighted coin with @a probability. * * @return #GNUNET_OK with @a probability, * #GNUNET_NO with 1 - @a probability */ static unsigned int eval_probability (float probability) { uint64_t random; float random_01; random = GNUNET_CRYPTO_random_u64 (GNUNET_CRYPTO_QUALITY_WEAK, UINT64_MAX); random_01 = (double) random / UINT64_MAX; return (random_01 <= probability) ? GNUNET_OK : GNUNET_NO; } /** * Actual commands construction and execution. * * @param cls unused * @param is interpreter to run commands with */ static void run (void *cls, struct TALER_TESTING_Interpreter *is) { struct TALER_Amount total_reserve_amount; struct TALER_Amount withdraw_fee; char *withdraw_fee_str; char *amount_5; char *amount_4; char *amount_1; (void) cls; all_commands = GNUNET_new_array (howmany_reserves * (1 /* Withdraw block */ + howmany_coins) /* All units */ + 1 /* End CMD */, struct TALER_TESTING_Command); GNUNET_asprintf (&amount_5, "%s:5", currency); GNUNET_asprintf (&amount_4, "%s:4", currency); GNUNET_asprintf (&amount_1, "%s:1", currency); GNUNET_assert (GNUNET_OK == TALER_amount_get_zero (currency, &total_reserve_amount)); total_reserve_amount.value = 5 * howmany_coins; GNUNET_asprintf (&withdraw_fee_str, "%s:0.1", currency); GNUNET_assert (GNUNET_OK == TALER_string_to_amount (withdraw_fee_str, &withdraw_fee)); for (unsigned int i = 0; i < howmany_coins; i++) GNUNET_assert (GNUNET_OK == TALER_amount_add (&total_reserve_amount, &total_reserve_amount, &withdraw_fee)); for (unsigned int j = 0; j < howmany_reserves; j++) { char *create_reserve_label; GNUNET_asprintf (&create_reserve_label, "create-reserve-%u", j); { struct TALER_TESTING_Command make_reserve[] = { cmd_transfer_to_exchange (add_label (create_reserve_label), TALER_amount2s (&total_reserve_amount)), TALER_TESTING_cmd_end () }; char *batch_label; GNUNET_asprintf (&batch_label, "batch-start-%u", j); all_commands[j * (howmany_coins + 1)] = TALER_TESTING_cmd_batch (add_label (batch_label), make_reserve); } for (unsigned int i = 0; i < howmany_coins; i++) { char *withdraw_label; char *order_enc; struct TALER_TESTING_Command unit[UNITY_SIZE]; char *unit_label; GNUNET_asprintf (&withdraw_label, "withdraw-%u-%u", i, j); GNUNET_asprintf (&order_enc, "{\"nonce\": %llu}", i + (howmany_coins * j)); unit[0] = TALER_TESTING_cmd_withdraw_with_retry (TALER_TESTING_cmd_withdraw_amount (add_label (withdraw_label), create_reserve_label, amount_5, MHD_HTTP_OK)); unit[1] = TALER_TESTING_cmd_deposit_with_retry (TALER_TESTING_cmd_deposit ("deposit", add_label (withdraw_label), 0, /* Index of the one withdrawn coin in the traits. */ user_payto_uri, add_label (order_enc), GNUNET_TIME_UNIT_ZERO, amount_1, MHD_HTTP_OK)); if (eval_probability (refresh_rate / 100.0)) { char *melt_label; char *reveal_label; GNUNET_asprintf (&melt_label, "refresh-melt-%u-%u", i, j); GNUNET_asprintf (&reveal_label, "refresh-reveal-%u-%u", i, j); unit[2] = TALER_TESTING_cmd_melt_with_retry (TALER_TESTING_cmd_melt (add_label (melt_label), withdraw_label, MHD_HTTP_OK, NULL)); unit[3] = TALER_TESTING_cmd_refresh_reveal_with_retry (TALER_TESTING_cmd_refresh_reveal (add_label (reveal_label), melt_label, MHD_HTTP_OK)); unit[4] = TALER_TESTING_cmd_refresh_link_with_retry (TALER_TESTING_cmd_refresh_link ("refresh-link", reveal_label, MHD_HTTP_OK)); unit[5] = TALER_TESTING_cmd_end (); } else unit[2] = TALER_TESTING_cmd_end (); GNUNET_asprintf (&unit_label, "unit-%u-%u", i, j); all_commands[j * (howmany_coins + 1) + (1 + i)] = TALER_TESTING_cmd_batch (add_label (unit_label), unit); } } all_commands[howmany_reserves * (1 + howmany_coins)] = TALER_TESTING_cmd_end (); TALER_TESTING_run2 (is, all_commands, GNUNET_TIME_UNIT_FOREVER_REL); /* no timeout */ GNUNET_free (amount_1); GNUNET_free (amount_4); GNUNET_free (amount_5); GNUNET_free (withdraw_fee_str); result = 1; } /** * Stop the fakebank. * * @param cls fakebank handle */ static void stop_fakebank (void *cls) { struct TALER_FAKEBANK_Handle *fakebank = cls; TALER_FAKEBANK_stop (fakebank); } /** * Start the fakebank. * * @param cls NULL */ static void launch_fakebank (void *cls) { struct TALER_FAKEBANK_Handle *fakebank; (void) cls; fakebank = TALER_TESTING_run_fakebank (exchange_bank_account.wire_gateway_url, currency); if (NULL == fakebank) { GNUNET_break (0); return; } GNUNET_SCHEDULER_add_shutdown (&stop_fakebank, fakebank); } /** * Run the benchmark in parallel in many (client) processes * and summarize result. * * @param main_cb main function to run per process * @param main_cb_cls closure for @a main_cb * @param config_file configuration file to use * @return #GNUNET_OK on success */ static int parallel_benchmark (TALER_TESTING_Main main_cb, void *main_cb_cls, const char *config_file) { int result = GNUNET_OK; pid_t cpids[howmany_clients]; pid_t fakebank = -1; int wstatus; struct GNUNET_OS_Process *auditord = NULL; struct GNUNET_OS_Process *exchanged = NULL; struct GNUNET_OS_Process *wirewatch = NULL; struct GNUNET_OS_Process *exchange_slave = NULL; struct GNUNET_DISK_PipeHandle *exchange_slave_pipe; if ( (MODE_CLIENT == mode) || (MODE_BOTH == mode) ) { /* start fakebank */ fakebank = fork (); if (0 == fakebank) { GNUNET_log_setup ("benchmark-fakebank", NULL == loglev ? "INFO" : loglev, logfile); GNUNET_SCHEDULER_run (&launch_fakebank, NULL); exit (0); } if (-1 == fakebank) { GNUNET_log_strerror (GNUNET_ERROR_TYPE_ERROR, "fork"); return GNUNET_SYSERR; } } if ( (MODE_EXCHANGE == mode) || (MODE_BOTH == mode) ) { /* start exchange */ exchanged = GNUNET_OS_start_process (GNUNET_NO, GNUNET_OS_INHERIT_STD_ALL, NULL, NULL, NULL, "taler-exchange-httpd", "taler-exchange-httpd", "-c", config_file, "-C", NULL); if ( (NULL == exchanged) && (MODE_BOTH == mode) ) { GNUNET_assert (-1 != fakebank); kill (fakebank, SIGTERM); waitpid (fakebank, &wstatus, 0); return 77; } /* start auditor */ auditord = GNUNET_OS_start_process (GNUNET_NO, GNUNET_OS_INHERIT_STD_ALL, NULL, NULL, NULL, "taler-auditor-httpd", "taler-auditor-httpd", "-c", config_file, NULL); if (NULL == auditord) { GNUNET_OS_process_kill (exchanged, SIGTERM); if (MODE_BOTH == mode) { GNUNET_assert (-1 != fakebank); kill (fakebank, SIGTERM); waitpid (fakebank, &wstatus, 0); } GNUNET_OS_process_destroy (exchanged); return 77; } /* start exchange wirewatch */ wirewatch = GNUNET_OS_start_process (GNUNET_NO, GNUNET_OS_INHERIT_STD_ALL, NULL, NULL, NULL, "taler-exchange-wirewatch", "taler-exchange-wirewatch", "-c", config_file, NULL); if (NULL == wirewatch) { GNUNET_OS_process_kill (auditord, SIGTERM); GNUNET_OS_process_kill (exchanged, SIGTERM); if (MODE_BOTH == mode) { GNUNET_assert (-1 != fakebank); kill (fakebank, SIGTERM); waitpid (fakebank, &wstatus, 0); } GNUNET_OS_process_destroy (exchanged); return 77; } } if (MODE_CLIENT == mode) { char *remote_cmd; GNUNET_asprintf (&remote_cmd, ("cd '%s'; " "taler-exchange-benchmark --mode=exchange -c '%s'"), remote_dir, config_file); GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "remote command: %s\n", remote_cmd); GNUNET_assert (NULL != (exchange_slave_pipe = GNUNET_DISK_pipe (GNUNET_YES, GNUNET_YES, 0, 0))); exchange_slave = GNUNET_OS_start_process (GNUNET_NO, GNUNET_OS_INHERIT_STD_OUT_AND_ERR, exchange_slave_pipe, NULL, NULL, "ssh", "ssh", /* Don't ask for pw/passphrase, rather fail */ "-oBatchMode=yes", remote_host, remote_cmd, NULL); GNUNET_free (remote_cmd); } /* We always wait for the exchange, no matter if it's running locally or remotely */ if (0 != TALER_TESTING_wait_exchange_ready (ec.exchange_url)) { GNUNET_log (GNUNET_ERROR_TYPE_ERROR, "Failed to detect running exchange at `%s'\n", ec.exchange_url); GNUNET_OS_process_kill (exchanged, SIGTERM); if ( (MODE_BOTH == mode) || (MODE_CLIENT == mode)) { GNUNET_assert (-1 != fakebank); kill (fakebank, SIGTERM); waitpid (fakebank, &wstatus, 0); } GNUNET_OS_process_wait (exchanged); GNUNET_OS_process_destroy (exchanged); if (NULL != wirewatch) { GNUNET_OS_process_kill (wirewatch, SIGTERM); GNUNET_OS_process_wait (wirewatch); GNUNET_OS_process_destroy (wirewatch); } if (NULL != auditord) { GNUNET_OS_process_kill (auditord, SIGTERM); GNUNET_OS_process_wait (auditord); GNUNET_OS_process_destroy (auditord); } return 77; } if ( (MODE_CLIENT == mode) || (MODE_BOTH == mode) ) { sleep (1); /* make sure fakebank process is ready before continuing */ start_time = GNUNET_TIME_absolute_get (); result = GNUNET_OK; for (unsigned int i = 0; i= (result = GNUNET_GETOPT_run ("taler-exchange-benchmark", options, argc, argv))) { GNUNET_free_non_null (cfg_filename); return BAD_CLI_ARG; } GNUNET_log_setup ("taler-exchange-benchmark", NULL == loglev ? "INFO" : loglev, logfile); if (NULL == mode_str) mode = MODE_BOTH; else if (0 == strcmp (mode_str, "exchange")) mode = MODE_EXCHANGE; else if (0 == strcmp (mode_str, "client")) mode = MODE_CLIENT; else if (0 == strcmp (mode_str, "both")) mode = MODE_BOTH; else { TALER_LOG_ERROR ("Unknown mode given: '%s'\n", mode_str); GNUNET_free_non_null (cfg_filename); return BAD_CONFIG_FILE; } if (NULL == cfg_filename) cfg_filename = GNUNET_strdup ( GNUNET_OS_project_data_get ()->user_config_file); cfg = GNUNET_CONFIGURATION_create (); if (GNUNET_OK != GNUNET_CONFIGURATION_load (cfg, cfg_filename)) { TALER_LOG_ERROR ("Could not parse configuration\n"); GNUNET_free (cfg_filename); return BAD_CONFIG_FILE; } if (GNUNET_OK != TALER_config_get_currency (cfg, ¤cy)) { GNUNET_CONFIGURATION_destroy (cfg); GNUNET_free (cfg_filename); return BAD_CONFIG_FILE; } if (howmany_clients > 10240) { TALER_LOG_ERROR ("-p option value given is too large\n"); return BAD_CLI_ARG; } if (0 == howmany_clients) { TALER_LOG_ERROR ("-p option value must not be zero\n"); GNUNET_free (cfg_filename); return BAD_CLI_ARG; } if (GNUNET_OK != GNUNET_CONFIGURATION_get_value_string (cfg, "benchmark", "USER_PAYTO_URI", &user_payto_uri)) { GNUNET_log_config_missing (GNUNET_ERROR_TYPE_ERROR, "benchmark", "USER_PAYTO_URI"); GNUNET_free (cfg_filename); return BAD_CONFIG_FILE; } { const char *bank_details_section; GNUNET_CONFIGURATION_iterate_sections (cfg, &pick_exchange_account_cb, &bank_details_section); if (NULL == bank_details_section) { GNUNET_log (GNUNET_ERROR_TYPE_ERROR, "Missing specification of bank account in configuration\n"); GNUNET_free (cfg_filename); return BAD_CONFIG_FILE; } if (GNUNET_OK != TALER_BANK_auth_parse_cfg (cfg, bank_details_section, &exchange_bank_account)) { GNUNET_log (GNUNET_ERROR_TYPE_ERROR, "Configuration fails to provide exchange bank details in section `%s'\n", bank_details_section); GNUNET_free (cfg_filename); return BAD_CONFIG_FILE; } } if ( (MODE_EXCHANGE == mode) || (MODE_BOTH == mode) ) { struct GNUNET_OS_Process *compute_wire_response; compute_wire_response = GNUNET_OS_start_process (GNUNET_NO, GNUNET_OS_INHERIT_STD_ALL, NULL, NULL, NULL, "taler-exchange-wire", "taler-exchange-wire", "-c", cfg_filename, NULL); if (NULL == compute_wire_response) { GNUNET_log (GNUNET_ERROR_TYPE_ERROR, "Failed to run `taler-exchange-wire`, is your PATH correct?\n"); GNUNET_free (cfg_filename); return BAD_CONFIG_FILE; } GNUNET_OS_process_wait (compute_wire_response); GNUNET_OS_process_destroy (compute_wire_response); GNUNET_assert (GNUNET_OK == TALER_TESTING_prepare_exchange (cfg_filename, &ec)); } else { if (GNUNET_OK != GNUNET_CONFIGURATION_get_value_string (cfg, "exchange", "BASE_URL", &ec.exchange_url)) { GNUNET_log_config_missing (GNUNET_ERROR_TYPE_ERROR, "exchange", "base_url"); GNUNET_CONFIGURATION_destroy (cfg); GNUNET_free (cfg_filename); return BAD_CONFIG_FILE; } if (GNUNET_OK != GNUNET_CONFIGURATION_get_value_string (cfg, "benchmark-remote-exchange", "host", &remote_host)) { GNUNET_log_config_missing (GNUNET_ERROR_TYPE_ERROR, "benchmark-remote-exchange", "host"); GNUNET_CONFIGURATION_destroy (cfg); GNUNET_free (cfg_filename); return BAD_CONFIG_FILE; } if (GNUNET_OK != GNUNET_CONFIGURATION_get_value_string (cfg, "benchmark-remote-exchange", "dir", &remote_dir)) { GNUNET_log_config_missing (GNUNET_ERROR_TYPE_ERROR, "benchmark-remote-exchange", "dir"); GNUNET_CONFIGURATION_destroy (cfg); GNUNET_free (cfg_filename); return BAD_CONFIG_FILE; } } result = parallel_benchmark (&run, NULL, cfg_filename); GNUNET_CONFIGURATION_destroy (cfg); GNUNET_free (cfg_filename); /* If we're the exchange worker, we're done now. No need to print results */ if (MODE_EXCHANGE == mode) { return (GNUNET_OK == result) ? 0 : result; } duration = GNUNET_TIME_absolute_get_duration (start_time); if (GNUNET_OK == result) { struct rusage usage; GNUNET_assert (0 == getrusage (RUSAGE_CHILDREN, &usage)); fprintf (stdout, "Executed (Withdraw=%u, Deposit=%u, Refresh~=%5.2f) * Reserve=%u * Parallel=%u, operations in %s\n", howmany_coins, howmany_coins, (float) howmany_coins * (refresh_rate / 100.0), howmany_reserves, howmany_clients, GNUNET_STRINGS_relative_time_to_string (duration, GNUNET_NO)); fprintf (stdout, "(approximately %s/coin)\n", GNUNET_STRINGS_relative_time_to_string (GNUNET_TIME_relative_divide (duration, (unsigned long long) howmany_coins * howmany_reserves * howmany_clients), GNUNET_YES)); fprintf (stdout, "RAW: %04u %04u %04u %16llu\n", howmany_coins, howmany_reserves, howmany_clients, (unsigned long long) duration.rel_value_us); fprintf (stdout, "cpu time: sys %llu user %llu\n", \ (unsigned long long) (usage.ru_stime.tv_sec * 1000 * 1000 + usage.ru_stime.tv_usec), (unsigned long long) (usage.ru_utime.tv_sec * 1000 * 1000 + usage.ru_utime.tv_usec)); } for (unsigned int i = 0; i