All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
target/Linux-x86_64/include/citrusleaf/cf_hist.h
Go to the documentation of this file.
1 /******************************************************************************
2  * Copyright 2008-2013 by Aerospike.
3  *
4  * Permission is hereby granted, free of charge, to any person obtaining a copy
5  * of this software and associated documentation files (the "Software"), to
6  * deal in the Software without restriction, including without limitation the
7  * rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
8  * sell copies of the Software, and to permit persons to whom the Software is
9  * furnished to do so, subject to the following conditions:
10  *
11  * The above copyright notice and this permission notice shall be included in
12  * all copies or substantial portions of the Software.
13  *
14  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
15  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
16  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
17  * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
18  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
19  * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
20  * IN THE SOFTWARE.
21  *****************************************************************************/
22 #pragma once
23 
24 #include <stdint.h>
25 
26 #include <citrusleaf/cf_atomic.h>
27 
28 /* SYNOPSIS
29  * For timing things, you want to know this histogram of what took how much time.
30  * So have an interface where you create a histogram object, can dump a histogram object,
31  * and can "start" / "stop" a given timer and add it to the histogram - multithread safe,
32  * of course.
33  */
34 
35 #define CF_N_HIST_COUNTS 64
36 
37 //
38 // The counts are powers of two. count[0]
39 // count[0] is 1024 * 1024 a second
40 // count[13] is about a millisecond (1/1024 second)
41 // count[25] is a second
42 
43 
44 typedef struct cf_histogram_counts_s {
45  uint64_t count[CF_N_HIST_COUNTS];
47 
48 typedef struct cf_histogram_s {
49  char name[64];
50  cf_atomic_int n_counts;
51  cf_atomic_int count[CF_N_HIST_COUNTS];
52 } cf_histogram;
53 
54 extern cf_histogram * cf_histogram_create(char *name);
55 extern void cf_histogram_dump( cf_histogram *h ); // for debugging
57 extern void cf_histogram_insert_data_point(cf_histogram *h, uint64_t start);