hongyu | 24200d3 | 2015-01-08 15:13:49 -0800 | [diff] [blame] | 1 | /* |
| 2 | * |
David Garcia Quintas | 3598d44 | 2016-03-15 14:53:05 -0700 | [diff] [blame] | 3 | * Copyright 2015-2016, Google Inc. |
hongyu | 24200d3 | 2015-01-08 15:13:49 -0800 | [diff] [blame] | 4 | * All rights reserved. |
| 5 | * |
| 6 | * Redistribution and use in source and binary forms, with or without |
| 7 | * modification, are permitted provided that the following conditions are |
| 8 | * met: |
| 9 | * |
| 10 | * * Redistributions of source code must retain the above copyright |
| 11 | * notice, this list of conditions and the following disclaimer. |
| 12 | * * Redistributions in binary form must reproduce the above |
| 13 | * copyright notice, this list of conditions and the following disclaimer |
| 14 | * in the documentation and/or other materials provided with the |
| 15 | * distribution. |
| 16 | * * Neither the name of Google Inc. nor the names of its |
| 17 | * contributors may be used to endorse or promote products derived from |
| 18 | * this software without specific prior written permission. |
| 19 | * |
| 20 | * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS |
| 21 | * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT |
| 22 | * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR |
| 23 | * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT |
| 24 | * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, |
| 25 | * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT |
| 26 | * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, |
| 27 | * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY |
| 28 | * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT |
| 29 | * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE |
| 30 | * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. |
| 31 | * |
| 32 | */ |
| 33 | |
Craig Tiller | 9a4dddd | 2016-03-25 17:08:13 -0700 | [diff] [blame] | 34 | #ifndef GRPC_CORE_LIB_STATISTICS_CENSUS_TRACING_H |
| 35 | #define GRPC_CORE_LIB_STATISTICS_CENSUS_TRACING_H |
hongyu | 24200d3 | 2015-01-08 15:13:49 -0800 | [diff] [blame] | 36 | |
Hongyu Chen | 1ef06e6 | 2015-02-04 10:36:04 -0800 | [diff] [blame] | 37 | #include <grpc/support/time.h> |
| 38 | #include "src/core/statistics/census_rpc_stats.h" |
| 39 | |
| 40 | /* WARNING: The data structures and APIs provided by this file are for GRPC |
| 41 | library's internal use ONLY. They might be changed in backward-incompatible |
| 42 | ways and are not subject to any deprecation policy. |
| 43 | They are not recommended for external use. |
| 44 | */ |
Hongyu Chen | 2956994 | 2015-01-22 16:57:36 -0800 | [diff] [blame] | 45 | #ifdef __cplusplus |
Craig Tiller | a82950e | 2015-09-22 12:33:20 -0700 | [diff] [blame] | 46 | extern "C" { |
Hongyu Chen | 2956994 | 2015-01-22 16:57:36 -0800 | [diff] [blame] | 47 | #endif |
| 48 | |
Hongyu Chen | 1ef06e6 | 2015-02-04 10:36:04 -0800 | [diff] [blame] | 49 | /* Struct for a trace annotation. */ |
Craig Tiller | a82950e | 2015-09-22 12:33:20 -0700 | [diff] [blame] | 50 | typedef struct census_trace_annotation { |
| 51 | gpr_timespec ts; /* timestamp of the annotation */ |
| 52 | char txt[CENSUS_MAX_ANNOTATION_LENGTH + 1]; /* actual txt annotation */ |
| 53 | struct census_trace_annotation *next; |
| 54 | } census_trace_annotation; |
Hongyu Chen | 1ef06e6 | 2015-02-04 10:36:04 -0800 | [diff] [blame] | 55 | |
Craig Tiller | a82950e | 2015-09-22 12:33:20 -0700 | [diff] [blame] | 56 | typedef struct census_trace_obj { |
| 57 | census_op_id id; |
| 58 | gpr_timespec ts; |
| 59 | census_rpc_stats rpc_stats; |
| 60 | char *method; |
| 61 | census_trace_annotation *annotations; |
| 62 | } census_trace_obj; |
Hongyu Chen | 1ef06e6 | 2015-02-04 10:36:04 -0800 | [diff] [blame] | 63 | |
| 64 | /* Deletes trace object. */ |
Craig Tiller | a82950e | 2015-09-22 12:33:20 -0700 | [diff] [blame] | 65 | void census_trace_obj_destroy(census_trace_obj *obj); |
hongyu | 24200d3 | 2015-01-08 15:13:49 -0800 | [diff] [blame] | 66 | |
| 67 | /* Initializes trace store. This function is thread safe. */ |
Craig Tiller | a82950e | 2015-09-22 12:33:20 -0700 | [diff] [blame] | 68 | void census_tracing_init(void); |
hongyu | 24200d3 | 2015-01-08 15:13:49 -0800 | [diff] [blame] | 69 | |
| 70 | /* Shutsdown trace store. This function is thread safe. */ |
Craig Tiller | a82950e | 2015-09-22 12:33:20 -0700 | [diff] [blame] | 71 | void census_tracing_shutdown(void); |
hongyu | 24200d3 | 2015-01-08 15:13:49 -0800 | [diff] [blame] | 72 | |
| 73 | /* Gets trace obj corresponding to the input op_id. Returns NULL if trace store |
| 74 | is not initialized or trace obj is not found. Requires trace store being |
| 75 | locked before calling this function. */ |
Craig Tiller | a82950e | 2015-09-22 12:33:20 -0700 | [diff] [blame] | 76 | census_trace_obj *census_get_trace_obj_locked(census_op_id op_id); |
hongyu | 24200d3 | 2015-01-08 15:13:49 -0800 | [diff] [blame] | 77 | |
| 78 | /* The following two functions acquire and release the trace store global lock. |
| 79 | They are for census internal use only. */ |
Craig Tiller | a82950e | 2015-09-22 12:33:20 -0700 | [diff] [blame] | 80 | void census_internal_lock_trace_store(void); |
| 81 | void census_internal_unlock_trace_store(void); |
hongyu | 24200d3 | 2015-01-08 15:13:49 -0800 | [diff] [blame] | 82 | |
Alistair Veitch | 46c3be0 | 2015-02-05 11:41:01 -0800 | [diff] [blame] | 83 | /* Gets method name associated with the input trace object. */ |
Craig Tiller | a82950e | 2015-09-22 12:33:20 -0700 | [diff] [blame] | 84 | const char *census_get_trace_method_name(const census_trace_obj *trace); |
hongyu | 24200d3 | 2015-01-08 15:13:49 -0800 | [diff] [blame] | 85 | |
Hongyu Chen | 1ef06e6 | 2015-02-04 10:36:04 -0800 | [diff] [blame] | 86 | /* Returns an array of pointers to trace objects of currently active operations |
Alistair Veitch | 46c3be0 | 2015-02-05 11:41:01 -0800 | [diff] [blame] | 87 | and fills in number of active operations. Returns NULL if there are no active |
Hongyu Chen | 1ef06e6 | 2015-02-04 10:36:04 -0800 | [diff] [blame] | 88 | operations. |
| 89 | Caller owns the returned objects. */ |
Craig Tiller | a82950e | 2015-09-22 12:33:20 -0700 | [diff] [blame] | 90 | census_trace_obj **census_get_active_ops(int *num_active_ops); |
Hongyu Chen | 1ef06e6 | 2015-02-04 10:36:04 -0800 | [diff] [blame] | 91 | |
Hongyu Chen | 2956994 | 2015-01-22 16:57:36 -0800 | [diff] [blame] | 92 | #ifdef __cplusplus |
| 93 | } |
| 94 | #endif |
| 95 | |
Craig Tiller | 9a4dddd | 2016-03-25 17:08:13 -0700 | [diff] [blame] | 96 | #endif /* GRPC_CORE_LIB_STATISTICS_CENSUS_TRACING_H */ |