tools/perf/bench/futex-lock-pi.c

   1 /*
   2  * Copyright (C) 2015 Davidlohr Bueso.
   3  */
   4
   5 /* For the CLR_() macros */
   6 #include <string.h>
   7 #include <pthread.h>
   8
   9 #include <signal.h>
  10 #include "../util/stat.h"
  11 #include <subcmd/parse-options.h>
  12 #include <linux/compiler.h>
  13 #include <linux/kernel.h>
  14 #include <errno.h>
  15 #include "bench.h"
  16 #include "futex.h"
  17
  18 #include <err.h>
  19 #include <stdlib.h>
  20 #include <sys/time.h>
  21
  22 struct worker {
  23         int tid;
  24         u_int32_t *futex;
  25         pthread_t thread;
  26         unsigned long ops;
  27 };
  28
  29 static u_int32_t global_futex = 0;
  30 static struct worker *worker;
  31 static unsigned int nsecs = 10;
  32 static bool silent = false, multi = false;
  33 static bool done = false, fshared = false;
  34 static unsigned int ncpus, nthreads = 0;
  35 static int futex_flag = 0;
  36 struct timeval start, end, runtime;
  37 static pthread_mutex_t thread_lock;
  38 static unsigned int threads_starting;
  39 static struct stats throughput_stats;
  40 static pthread_cond_t thread_parent, thread_worker;
  41
  42 static const struct option options[] = {
  43         OPT_UINTEGER('t', "threads",  &nthreads, "Specify amount of threads"),
  44         OPT_UINTEGER('r', "runtime", &nsecs,     "Specify runtime (in seconds)"),
  45         OPT_BOOLEAN( 'M', "multi",   &multi,     "Use multiple futexes"),
  46         OPT_BOOLEAN( 's', "silent",  &silent,    "Silent mode: do not display data/details"),
  47         OPT_BOOLEAN( 'S', "shared",  &fshared,   "Use shared futexes instead of private ones"),
  48         OPT_END()
  49 };
  50
  51 static const char * const bench_futex_lock_pi_usage[] = {
  52         "perf bench futex lock-pi <options>",
  53         NULL
  54 };
  55
  56 static void print_summary(void)
  57 {
  58         unsigned long avg = avg_stats(&throughput_stats);
  59         double stddev = stddev_stats(&throughput_stats);
  60
  61         printf("%sAveraged %ld operations/sec (+- %.2f%%), total secs = %d\n",
  62                !silent ? "\n" : "", avg, rel_stddev_stats(stddev, avg),
  63                (int) runtime.tv_sec);
  64 }
  65
  66 static void toggle_done(int sig __maybe_unused,
  67                         siginfo_t *info __maybe_unused,
  68                         void *uc __maybe_unused)
  69 {
  70         /* inform all threads that we're done for the day */
  71         done = true;
  72         gettimeofday(&end, NULL);
  73         timersub(&end, &start, &runtime);
  74 }
  75
  76 static void *workerfn(void *arg)
  77 {
  78         struct worker *w = (struct worker *) arg;
  79         unsigned long ops = w->ops;
  80
  81         pthread_mutex_lock(&thread_lock);
  82         threads_starting--;
  83         if (!threads_starting)
  84                 pthread_cond_signal(&thread_parent);
  85         pthread_cond_wait(&thread_worker, &thread_lock);
  86         pthread_mutex_unlock(&thread_lock);
  87
  88         do {
  89                 int ret;
  90         again:
  91                 ret = futex_lock_pi(w->futex, NULL, futex_flag);
  92
  93                 if (ret) { /* handle lock acquisition */
  94                         if (!silent)
  95                                 warn("thread %d: Could not lock pi-lock for %p (%d)",
  96                                      w->tid, w->futex, ret);
  97                         if (done)
  98                                 break;
  99
 100                         goto again;
 101                 }
 102
 103                 usleep(1);
 104                 ret = futex_unlock_pi(w->futex, futex_flag);
 105                 if (ret && !silent)
 106                         warn("thread %d: Could not unlock pi-lock for %p (%d)",
 107                              w->tid, w->futex, ret);
 108                 ops++; /* account for thread's share of work */
 109         }  while (!done);
 110
 111         w->ops = ops;
 112         return NULL;
 113 }
 114
 115 static void create_threads(struct worker *w, pthread_attr_t thread_attr)
 116 {
 117         cpu_set_t cpu;
 118         unsigned int i;
 119
 120         threads_starting = nthreads;
 121
 122         for (i = 0; i < nthreads; i++) {
 123                 worker[i].tid = i;
 124
 125                 if (multi) {
 126                         worker[i].futex = calloc(1, sizeof(u_int32_t));
 127                         if (!worker[i].futex)
 128                                 err(EXIT_FAILURE, "calloc");
 129                 } else
 130                         worker[i].futex = &global_futex;
 131
 132                 CPU_ZERO(&cpu);
 133                 CPU_SET(i % ncpus, &cpu);
 134
 135                 if (pthread_attr_setaffinity_np(&thread_attr, sizeof(cpu_set_t), &cpu))
 136                         err(EXIT_FAILURE, "pthread_attr_setaffinity_np");
 137
 138                 if (pthread_create(&w[i].thread, &thread_attr, workerfn, &worker[i]))
 139                         err(EXIT_FAILURE, "pthread_create");
 140         }
 141 }
 142
 143 int bench_futex_lock_pi(int argc, const char **argv,
 144                         const char *prefix __maybe_unused)
 145 {
 146         int ret = 0;
 147         unsigned int i;
 148         struct sigaction act;
 149         pthread_attr_t thread_attr;
 150
 151         argc = parse_options(argc, argv, options, bench_futex_lock_pi_usage, 0);
 152         if (argc)
 153                 goto err;
 154
 155         ncpus = sysconf(_SC_NPROCESSORS_ONLN);
 156
 157         sigfillset(&act.sa_mask);
 158         act.sa_sigaction = toggle_done;
 159         sigaction(SIGINT, &act, NULL);
 160
 161         if (!nthreads)
 162                 nthreads = ncpus;
 163
 164         worker = calloc(nthreads, sizeof(*worker));
 165         if (!worker)
 166                 err(EXIT_FAILURE, "calloc");
 167
 168         if (!fshared)
 169                 futex_flag = FUTEX_PRIVATE_FLAG;
 170
 171         printf("Run summary [PID %d]: %d threads doing pi lock/unlock pairing for %d secs.\n\n",
 172                getpid(), nthreads, nsecs);
 173
 174         init_stats(&throughput_stats);
 175         pthread_mutex_init(&thread_lock, NULL);
 176         pthread_cond_init(&thread_parent, NULL);
 177         pthread_cond_init(&thread_worker, NULL);
 178
 179         threads_starting = nthreads;
 180         pthread_attr_init(&thread_attr);
 181         gettimeofday(&start, NULL);
 182
 183         create_threads(worker, thread_attr);
 184         pthread_attr_destroy(&thread_attr);
 185
 186         pthread_mutex_lock(&thread_lock);
 187         while (threads_starting)
 188                 pthread_cond_wait(&thread_parent, &thread_lock);
 189         pthread_cond_broadcast(&thread_worker);
 190         pthread_mutex_unlock(&thread_lock);
 191
 192         sleep(nsecs);
 193         toggle_done(0, NULL, NULL);
 194
 195         for (i = 0; i < nthreads; i++) {
 196                 ret = pthread_join(worker[i].thread, NULL);
 197                 if (ret)
 198                         err(EXIT_FAILURE, "pthread_join");
 199         }
 200
 201         /* cleanup & report results */
 202         pthread_cond_destroy(&thread_parent);
 203         pthread_cond_destroy(&thread_worker);
 204         pthread_mutex_destroy(&thread_lock);
 205
 206         for (i = 0; i < nthreads; i++) {
 207                 unsigned long t = worker[i].ops/runtime.tv_sec;
 208
 209                 update_stats(&throughput_stats, t);
 210                 if (!silent)
 211                         printf("[thread %3d] futex: %p [ %ld ops/sec ]\n",
 212                                worker[i].tid, worker[i].futex, t);
 213
 214                 if (multi)
 215                         free(worker[i].futex);
 216         }
 217
 218         print_summary();
 219
 220         free(worker);
 221         return ret;
 222 err:
 223         usage_with_options(bench_futex_lock_pi_usage, options);
 224         exit(EXIT_FAILURE);
 225 }