parse: enable options to be marked dont-free
[fio.git] / profiles / act.c
1 #include "../fio.h"
2 #include "../profile.h"
3 #include "../parse.h"
4 #include "../optgroup.h"
5
6 /*
7  * 1x loads
8  */
9 #define R_LOAD          2000
10 #define W_LOAD          1000
11
12 #define SAMPLE_SEC      3600            /* 1h checks */
13
14 struct act_pass_criteria {
15         unsigned int max_usec;
16         unsigned int max_perm;
17 };
18 #define ACT_MAX_CRIT    3
19
20 static struct act_pass_criteria act_pass[ACT_MAX_CRIT] = {
21         {
22                 .max_usec =     1000,
23                 .max_perm =     50,
24         },
25         {
26                 .max_usec =     8000,
27                 .max_perm =     10,
28         },
29         {
30                 .max_usec =     64000,
31                 .max_perm =     1,
32         },
33 };
34
35 struct act_slice {
36         uint64_t lat_buckets[ACT_MAX_CRIT];
37         uint64_t total_ios;
38 };
39
40 struct act_run_data {
41         struct fio_mutex *mutex;
42         unsigned int pending;
43
44         struct act_slice *slices;
45         unsigned int nr_slices;
46 };
47 static struct act_run_data *act_run_data;
48
49 struct act_prof_data {
50         struct timespec sample_tv;
51         struct act_slice *slices;
52         unsigned int cur_slice;
53         unsigned int nr_slices;
54 };
55
56 #define ACT_MAX_OPTS    128
57 static const char *act_opts[ACT_MAX_OPTS] = {
58         "direct=1",
59         "ioengine=sync",
60         "random_generator=lfsr",
61         "group_reporting=1",
62         "thread",
63         NULL,
64 };
65 static unsigned int opt_idx = 5;
66 static unsigned int org_idx;
67
68 static int act_add_opt(const char *format, ...) __attribute__ ((__format__ (__printf__, 1, 2)));
69
70 struct act_options {
71         unsigned int pad;
72         char *device_names;
73         unsigned int load;
74         unsigned int prep;
75         unsigned int threads_per_queue;
76         unsigned int num_read_blocks;
77         unsigned int write_size;
78         unsigned long long test_duration;
79 };
80
81 static struct act_options act_options;
82
83 static struct fio_option options[] = {
84         {
85                 .name   = "device-names",
86                 .lname  = "device-names",
87                 .type   = FIO_OPT_STR_STORE,
88                 .off1   = offsetof(struct act_options, device_names),
89                 .help   = "Devices to use",
90                 .category = FIO_OPT_C_PROFILE,
91                 .group  = FIO_OPT_G_ACT,
92                 .no_free = true,
93         },
94         {
95                 .name   = "load",
96                 .lname  = "Load multiplier",
97                 .type   = FIO_OPT_INT,
98                 .off1   = offsetof(struct act_options, load),
99                 .help   = "ACT load multipler (default 1x)",
100                 .def    = "1",
101                 .category = FIO_OPT_C_PROFILE,
102                 .group  = FIO_OPT_G_ACT,
103         },
104         {
105                 .name   = "test-duration",
106                 .lname  = "Test duration",
107                 .type   = FIO_OPT_STR_VAL_TIME,
108                 .off1   = offsetof(struct act_options, test_duration),
109                 .help   = "How long the entire test takes to run",
110                 .def    = "24h",
111                 .category = FIO_OPT_C_PROFILE,
112                 .group  = FIO_OPT_G_ACT,
113         },
114         {
115                 .name   = "threads-per-queue",
116                 .lname  = "Number of read IO threads per device",
117                 .type   = FIO_OPT_INT,
118                 .off1   = offsetof(struct act_options, threads_per_queue),
119                 .help   = "Number of read IO threads per device",
120                 .def    = "8",
121                 .category = FIO_OPT_C_PROFILE,
122                 .group  = FIO_OPT_G_ACT,
123         },
124         {
125                 .name   = "read-req-num-512-blocks",
126                 .lname  = "Number of 512B blocks to read",
127                 .type   = FIO_OPT_INT,
128                 .off1   = offsetof(struct act_options, num_read_blocks),
129                 .help   = "Number of 512B blocks to read at the time",
130                 .def    = "3",
131                 .category = FIO_OPT_C_PROFILE,
132                 .group  = FIO_OPT_G_ACT,
133         },
134         {
135                 .name   = "large-block-op-kbytes",
136                 .lname  = "Size of large block ops in KiB (writes)",
137                 .type   = FIO_OPT_INT,
138                 .off1   = offsetof(struct act_options, write_size),
139                 .help   = "Size of large block ops in KiB (writes)",
140                 .def    = "131072",
141                 .category = FIO_OPT_C_PROFILE,
142                 .group  = FIO_OPT_G_ACT,
143         },
144         {
145                 .name   = "prep",
146                 .lname  = "Run ACT prep phase",
147                 .type   = FIO_OPT_STR_SET,
148                 .off1   = offsetof(struct act_options, prep),
149                 .help   = "Set to run ACT prep phase",
150                 .category = FIO_OPT_C_PROFILE,
151                 .group  = FIO_OPT_G_ACT,
152         },
153         {
154                 .name   = NULL,
155         },
156 };
157
158 static int act_add_opt(const char *str, ...)
159 {
160         char buffer[512];
161         va_list args;
162         size_t len;
163
164         if (opt_idx == ACT_MAX_OPTS) {
165                 log_err("act: ACT_MAX_OPTS is too small\n");
166                 return 1;
167         }
168
169         va_start(args, str);
170         len = vsnprintf(buffer, sizeof(buffer), str, args);
171         va_end(args);
172
173         if (len)
174                 act_opts[opt_idx++] = strdup(buffer);
175
176         return 0;
177 }
178
179 static int act_add_rw(const char *dev, int reads)
180 {
181         struct act_options *ao = &act_options;
182
183         if (act_add_opt("name=act-%s-%s", reads ? "read" : "write", dev))
184                 return 1;
185         if (act_add_opt("filename=%s", dev))
186                 return 1;
187         if (act_add_opt("rw=%s", reads ? "randread" : "randwrite"))
188                 return 1;
189         if (reads) {
190                 int rload = ao->load * R_LOAD / ao->threads_per_queue;
191
192                 if (act_add_opt("numjobs=%u", ao->threads_per_queue))
193                         return 1;
194                 if (act_add_opt("rate_iops=%u", rload))
195                         return 1;
196                 if (act_add_opt("bs=%u", ao->num_read_blocks * 512))
197                         return 1;
198         } else {
199                 const int rsize = ao->write_size / (ao->num_read_blocks * 512);
200                 int wload = (ao->load * W_LOAD + rsize - 1) / rsize;
201
202                 if (act_add_opt("rate_iops=%u", wload))
203                         return 1;
204                 if (act_add_opt("bs=%u", ao->write_size))
205                         return 1;
206         }
207
208         return 0;
209 }
210
211 static int act_add_dev_prep(const char *dev)
212 {
213         /* Add sequential zero phase */
214         if (act_add_opt("name=act-prep-zeroes-%s", dev))
215                 return 1;
216         if (act_add_opt("filename=%s", dev))
217                 return 1;
218         if (act_add_opt("bs=1048576"))
219                 return 1;
220         if (act_add_opt("zero_buffers"))
221                 return 1;
222         if (act_add_opt("rw=write"))
223                 return 1;
224
225         /* Randomly overwrite device */
226         if (act_add_opt("name=act-prep-salt-%s", dev))
227                 return 1;
228         if (act_add_opt("stonewall"))
229                 return 1;
230         if (act_add_opt("filename=%s", dev))
231                 return 1;
232         if (act_add_opt("bs=4096"))
233                 return 1;
234         if (act_add_opt("ioengine=libaio"))
235                 return 1;
236         if (act_add_opt("iodepth=64"))
237                 return 1;
238         if (act_add_opt("rw=randwrite"))
239                 return 1;
240
241         return 0;
242 }
243
244 static int act_add_dev(const char *dev)
245 {
246         if (act_options.prep)
247                 return act_add_dev_prep(dev);
248
249         if (act_add_opt("runtime=%llus", act_options.test_duration))
250                 return 1;
251         if (act_add_opt("time_based=1"))
252                 return 1;
253
254         if (act_add_rw(dev, 1))
255                 return 1;
256         if (act_add_rw(dev, 0))
257                 return 1;
258
259         return 0;
260 }
261
262 /*
263  * Fill our private options into the command line
264  */
265 static int act_prep_cmdline(void)
266 {
267         if (!act_options.device_names) {
268                 log_err("act: you need to set IO target(s) with the "
269                         "device-names option.\n");
270                 return 1;
271         }
272
273         org_idx = opt_idx;
274
275         do {
276                 char *dev;
277
278                 dev = strsep(&act_options.device_names, ",");
279                 if (!dev)
280                         break;
281
282                 if (act_add_dev(dev)) {
283                         log_err("act: failed adding device to the mix\n");
284                         break;
285                 }
286         } while (1);
287
288         return 0;
289 }
290
291 static int act_io_u_lat(struct thread_data *td, uint64_t usec)
292 {
293         struct act_prof_data *apd = td->prof_data;
294         struct act_slice *slice;
295         int i, ret = 0;
296         double perm;
297
298         if (act_options.prep)
299                 return 0;
300
301         /*
302          * Really should not happen, but lets not let jitter at the end
303          * ruin our day.
304          */
305         if (apd->cur_slice >= apd->nr_slices)
306                 return 0;
307
308         slice = &apd->slices[apd->cur_slice];
309         slice->total_ios++;
310
311         for (i = ACT_MAX_CRIT - 1; i >= 0; i--) {
312                 if (usec > act_pass[i].max_usec) {
313                         slice->lat_buckets[i]++;
314                         break;
315                 }
316         }
317
318         if (time_since_now(&apd->sample_tv) < SAMPLE_SEC)
319                 return 0;
320
321         /* SAMPLE_SEC has passed, check criteria for pass */
322         for (i = 0; i < ACT_MAX_CRIT; i++) {
323                 perm = (1000.0 * slice->lat_buckets[i]) / slice->total_ios;
324                 if (perm < act_pass[i].max_perm)
325                         continue;
326
327                 log_err("act: %f%% exceeds pass criteria of %f%%\n", perm / 10.0, (double) act_pass[i].max_perm / 10.0);
328                 ret = 1;
329                 break;
330         }
331
332         fio_gettime(&apd->sample_tv, NULL);
333         apd->cur_slice++;
334         return ret;
335 }
336
337 static void get_act_ref(void)
338 {
339         fio_mutex_down(act_run_data->mutex);
340         act_run_data->pending++;
341         fio_mutex_up(act_run_data->mutex);
342 }
343
344 static int show_slice(struct act_slice *slice, unsigned int slice_num)
345 {
346         unsigned int i, failed = 0;
347
348         log_info("   %2u", slice_num);
349
350         for (i = 0; i < ACT_MAX_CRIT; i++) {
351                 double perc = 0.0;
352
353                 if (slice->total_ios)
354                         perc = 100.0 * (double) slice->lat_buckets[i] / (double) slice->total_ios;
355                 if ((perc * 10.0) >= act_pass[i].max_perm)
356                         failed++;
357                 log_info("\t%2.2f", perc);
358         }
359         for (i = 0; i < ACT_MAX_CRIT; i++) {
360                 double perc = 0.0;
361
362                 if (slice->total_ios)
363                         perc = 100.0 * (double) slice->lat_buckets[i] / (double) slice->total_ios;
364                 log_info("\t%2.2f", perc);
365         }
366         log_info("\n");
367
368         return failed;
369 }
370
371 static void act_show_all_stats(void)
372 {
373         unsigned int i, fails = 0;
374
375         log_info("        trans                   device\n");
376         log_info("        %%>(ms)                  %%>(ms)\n");
377         log_info(" slice");
378
379         for (i = 0; i < ACT_MAX_CRIT; i++)
380                 log_info("\t %2u", act_pass[i].max_usec / 1000);
381         for (i = 0; i < ACT_MAX_CRIT; i++)
382                 log_info("\t %2u", act_pass[i].max_usec / 1000);
383
384         log_info("\n");
385         log_info(" -----  -----   -----  ------   -----   -----  ------\n");
386
387         for (i = 0; i < act_run_data->nr_slices; i++)
388                 fails += show_slice(&act_run_data->slices[i], i + 1);
389
390         log_info("\nact: test complete, device(s): %s\n", fails ? "FAILED" : "PASSED");
391 }
392
393 static void put_act_ref(struct thread_data *td)
394 {
395         struct act_prof_data *apd = td->prof_data;
396         unsigned int i, slice;
397
398         fio_mutex_down(act_run_data->mutex);
399
400         if (!act_run_data->slices) {
401                 act_run_data->slices = calloc(apd->nr_slices, sizeof(struct act_slice));
402                 act_run_data->nr_slices = apd->nr_slices;
403         }
404
405         for (slice = 0; slice < apd->nr_slices; slice++) {
406                 struct act_slice *dst = &act_run_data->slices[slice];
407                 struct act_slice *src = &apd->slices[slice];
408
409                 dst->total_ios += src->total_ios;
410
411                 for (i = 0; i < ACT_MAX_CRIT; i++)
412                         dst->lat_buckets[i] += src->lat_buckets[i];
413         }
414
415         if (!--act_run_data->pending)
416                 act_show_all_stats();
417
418         fio_mutex_up(act_run_data->mutex);
419 }
420
421 static int act_td_init(struct thread_data *td)
422 {
423         struct act_prof_data *apd;
424         unsigned int nr_slices;
425
426         get_act_ref();
427
428         apd = calloc(1, sizeof(*apd));
429         nr_slices = (act_options.test_duration + SAMPLE_SEC - 1) / SAMPLE_SEC;
430         apd->slices = calloc(nr_slices, sizeof(struct act_slice));
431         apd->nr_slices = nr_slices;
432         fio_gettime(&apd->sample_tv, NULL);
433         td->prof_data = apd;
434         return 0;
435 }
436
437 static void act_td_exit(struct thread_data *td)
438 {
439         struct act_prof_data *apd = td->prof_data;
440
441         put_act_ref(td);
442         free(apd->slices);
443         free(apd);
444         td->prof_data = NULL;
445 }
446
447 static struct prof_io_ops act_io_ops = {
448         .td_init        = act_td_init,
449         .td_exit        = act_td_exit,
450         .io_u_lat       = act_io_u_lat,
451 };
452
453 static struct profile_ops act_profile = {
454         .name           = "act",
455         .desc           = "ACT Aerospike like benchmark",
456         .options        = options,
457         .opt_data       = &act_options,
458         .prep_cmd       = act_prep_cmdline,
459         .cmdline        = act_opts,
460         .io_ops         = &act_io_ops,
461 };
462
463 static void fio_init act_register(void)
464 {
465         act_run_data = calloc(1, sizeof(*act_run_data));
466         act_run_data->mutex = fio_mutex_init(FIO_MUTEX_UNLOCKED);
467
468         if (register_profile(&act_profile))
469                 log_err("fio: failed to register profile 'act'\n");
470 }
471
472 static void fio_exit act_unregister(void)
473 {
474         while (org_idx && org_idx < opt_idx)
475                 free((void *) act_opts[++org_idx]);
476
477         unregister_profile(&act_profile);
478         fio_mutex_remove(act_run_data->mutex);
479         free(act_run_data->slices);
480         free(act_run_data);
481         act_run_data = NULL;
482 }