FD.io VPP  v21.10.1-2-g0a485f517
Vector Packet Processing
elog.h
Go to the documentation of this file.
1 /*
2  * Copyright (c) 2015 Cisco and/or its affiliates.
3  * Licensed under the Apache License, Version 2.0 (the "License");
4  * you may not use this file except in compliance with the License.
5  * You may obtain a copy of the License at:
6  *
7  * http://www.apache.org/licenses/LICENSE-2.0
8  *
9  * Unless required by applicable law or agreed to in writing, software
10  * distributed under the License is distributed on an "AS IS" BASIS,
11  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12  * See the License for the specific language governing permissions and
13  * limitations under the License.
14  */
15 /*
16  Copyright (c) 2005,2009 Eliot Dresselhaus
17 
18  Permission is hereby granted, free of charge, to any person obtaining
19  a copy of this software and associated documentation files (the
20  "Software"), to deal in the Software without restriction, including
21  without limitation the rights to use, copy, modify, merge, publish,
22  distribute, sublicense, and/or sell copies of the Software, and to
23  permit persons to whom the Software is furnished to do so, subject to
24  the following conditions:
25 
26  The above copyright notice and this permission notice shall be
27  included in all copies or substantial portions of the Software.
28 
29  THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
30  EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
31  MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
32  NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
33  LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
34  OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
35  WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
36 */
37 
38 /* High speed event logger */
39 
40 /** \file
41  The fine-grained event logger allows lightweight, thread-safe
42  event logging at minimum cost. In typical operation, logging
43  a single event costs around 80ns on x86_64. It's appropriate
44  for at-least per-frame event-logging in vector packet processing.
45 
46  See https://wiki.fd.io/view/VPP/elog for more information.
47 */
48 
49 #ifndef included_clib_elog_h
50 #define included_clib_elog_h
51 
52 #include <vppinfra/cache.h>
53 #include <vppinfra/error.h> /* for ASSERT */
54 #include <vppinfra/serialize.h>
55 #include <vppinfra/time.h> /* for clib_cpu_time_now */
56 #include <vppinfra/hash.h>
57 #include <vppinfra/mhash.h>
58 
59 typedef struct
60 {
61  union
62  {
63  /** Absolute time stamp in CPU clock cycles. */
65 
66  /** Absolute time as floating point number in seconds. */
68  };
69 
70  /** Event type index. */
72 
73  /** Track for this event. Tracks allow events to be sorted and
74  displayed by track. Think of 2 dimensional display with time and
75  track being the x and y axes. */
77 
78  /** 20-bytes of data follows, pads to 32 bytes. */
79  u8 data[20];
80 } elog_event_t;
81 
82 typedef struct
83 {
84  /** Type index plus one assigned to this type.
85  This is used to mark type as seen. */
87 
88  /** String table as a vector constructed when type is registered. */
90 
91  /** Format string. (example: "my-event (%d,%d)"). */
92  char *format;
93 
94  /** Specifies how arguments to format are parsed from event data.
95  String of characters '0' '1' or '2' '3' to specify log2 size of data
96  (e.g. for u8, u16, u32 or u64),
97  's' means a null-terminated C string
98  't' means argument is an index into enum string table for this type.
99  'e' is a float,
100  'f' is a double. */
101  char *format_args;
102 
103  /** Function name generating event. */
104  char *function;
105 
106  /** Number of elements in string enum table. */
108 
109  /** String table for enum/number to string formatting. */
110  char *enum_strings[];
112 
113 typedef struct
114 {
115  /** Track name vector. */
116  char *name;
117 
118  /** Set to one when track has been added to
119  main structure. */
121 } elog_track_t;
122 
123 typedef struct
124 {
125  /** CPU cycle counter. */
127 
128  /** OS timer in nano secs since epoch 3/30/2017, see elog_time_now() */
131 
132 typedef struct
133 {
134  /** Total number of events in buffer. */
136 
137  /** When count reaches limit logging is disabled. This is
138  used for event triggers. */
140 
141  /** Dummy event to use when logger is disabled. */
143 
144  /** Power of 2 number of elements in ring. */
146 
147  /** Vector of events (circular buffer). Power of 2 size.
148  Used when events are being collected. */
150 
151  /** Vector of event types. */
153 
154  /** Hash table mapping type format to type index. */
156 
157  /** Events may refer to strings in string table. */
161 
162  /** Vector of tracks. */
164 
165  /** Default track. */
167 
168  /** Place holder for CPU clock frequency. */
170 
171  /** Timestamps */
173 
174  /** SMP lock, non-zero means locking required */
176 
177  /** Use serialize_time and init_time to give estimate for
178  cpu clock frequency. */
180 
181  /** Vector of events converted to generic form after collection. */
183 } elog_main_t;
184 
185 /** @brief Return number of events in the event-log buffer
186  @param em elog_main_t *
187  @return number of events in the buffer
188 */
189 
192 {
193  return clib_min (em->n_total_events, em->event_ring_size);
194 }
195 
196 /** @brief Return number of events which can fit in the event buffer
197  @param em elog_main_t *
198  @return number of events which can fit in the buffer
199 */
202 {
203  return em->event_ring_size;
204 }
205 
206 /** @brief Reset the event buffer
207  @param em elog_main_t *
208 */
209 always_inline void
211 {
212  em->n_total_events = 0;
214 }
215 
216 /** @brief Enable or disable event logging
217  @param em elog_main_t *
218 */
219 always_inline void
220 elog_enable_disable (elog_main_t * em, int is_enabled)
221 {
222  em->n_total_events = 0;
223  em->n_total_events_disable_limit = is_enabled ? ~0 : 0;
224 }
225 
226 /** @brief disable logging after specified number of ievents have been logged.
227 
228  This is used as a "debug trigger" when a certain event has occurred.
229  Events will be logged both before and after the "event" but the
230  event will not be lost as long as N < RING_SIZE.
231 
232  @param em elog_main_t *
233  @param n uword number of events before disabling event logging
234 */
235 always_inline void
237 {
239 }
240 
241 /* @brief mid-buffer logic-analyzer trigger
242 
243  Currently, only midpoint triggering is supported, but it's pretty obvious
244  how to generalize the scheme.
245  @param em elog_main_t *
246 */
247 always_inline void
249 {
251  em->n_total_events + vec_len (em->event_ring) / 2;
252 }
253 
254 /** @brief register an event type
255  @param em elog_main_t *
256  @param t elog_event_type_t * event to register
257  @return type index
258  @warning Typically not called directly
259 */
260 
262 
263 /** @brief register an event track
264  @param em elog_main_t *
265  @param t elog_track_t * track to register
266  @return track index
267  @note this function is often called directly
268 */
270 
271 /** @brief event logging enabled predicate
272  @param em elog_main_t *
273  @return 1 if enabled, 0 if not enabled
274 */
277 {
279 }
280 
281 /** @brief Allocate an event to be filled in by the caller
282 
283  Not normally called directly; this function underlies the
284  ELOG_DATA and ELOG_TRACK_DATA macros
285 
286  @param em elog_main_t *
287  @param type elog_event_type_t * type
288  @param track elog_track_t * track
289  @param cpu_time u64 current cpu tick value
290  @returns event to be filled in
291 */
292 always_inline void *
295  elog_track_t * track, u64 cpu_time)
296 {
297  elog_event_t *e;
298  uword ei;
299  word type_index, track_index;
300 
301  /* Return the user placeholder memory to scribble data into. */
302  if (PREDICT_FALSE (!elog_is_enabled (em)))
303  return em->placeholder_event.data;
304 
305  type_index = (word) type->type_index_plus_one - 1;
306  track_index = (word) track->track_index_plus_one - 1;
307  if (PREDICT_FALSE ((type_index | track_index) < 0))
308  {
309  if (type_index < 0)
310  type_index = elog_event_type_register (em, type);
311  if (track_index < 0)
312  track_index = elog_track_register (em, track);
313  }
314 
315  ASSERT (track_index < vec_len (em->tracks));
316  ASSERT (is_pow2 (vec_len (em->event_ring)));
317 
318  if (em->lock)
319  ei = clib_atomic_fetch_add (&em->n_total_events, 1);
320  else
321  ei = em->n_total_events++;
322 
323  ei &= em->event_ring_size - 1;
324  e = vec_elt_at_index (em->event_ring, ei);
325 
326  e->time_cycles = cpu_time;
327  e->event_type = type_index;
328  e->track = track_index;
329 
330  /* Return user data for caller to fill in. */
331  return e->data;
332 }
333 
334 /* External version of inline. */
335 void *elog_event_data (elog_main_t * em,
337  elog_track_t * track, u64 cpu_time);
338 
339 /** @brief Allocate an event to be filled in by the caller, non-inline
340 
341  Not normally called directly; this function underlies the
342  ELOG_DATA and ELOG_TRACK_DATA macros
343 
344  @param em elog_main_t *
345  @param type elog_event_type_t * type
346  @param track elog_track_t * track
347  @param cpu_time u64 current cpu tick value
348  @returns event to be filled in
349 */
350 always_inline void *
353  elog_track_t * track, u64 cpu_time)
354 {
355  /* Return the user placeholder memory to scribble data into. */
356  if (PREDICT_FALSE (!elog_is_enabled (em)))
357  return em->placeholder_event.data;
358  return elog_event_data (em, type, track, cpu_time);
359 }
360 
361 /** @brief Log a single-datum event
362  @param em elog_main_t *
363  @param type elog_event_type_t * type
364  @param data u32 single datum to capture
365 */
366 always_inline void
368 {
370  type,
371  &em->default_track,
372  clib_cpu_time_now ());
373  d[0] = data;
374 }
375 
376 /** @brief Log a single-datum event, inline version
377  @param em elog_main_t *
378  @param type elog_event_type_t * type
379  @param data u32 single datum to capture
380 */
381 always_inline void
383 {
384  u32 *d = elog_event_data_inline (em,
385  type,
386  &em->default_track,
387  clib_cpu_time_now ());
388  d[0] = data;
389 }
390 
391 /** @brief Log a single-datum event to a specific track, non-inline version
392  @param em elog_main_t *
393  @param type elog_event_type_t * type
394  @param type elog_event_track_t * track
395  @param data u32 single datum to capture
396 */
397 always_inline void
399  u32 data)
400 {
402  type,
403  track,
404  clib_cpu_time_now ());
405  d[0] = data;
406 }
407 
408 /** @brief Log a single-datum event to a specific track
409  @param em elog_main_t *
410  @param type elog_event_type_t * type
411  @param type elog_event_track_t * track
412  @param data u32 single datum to capture
413 */
414 always_inline void
416  elog_track_t * track, u32 data)
417 {
418  u32 *d = elog_event_data_inline (em,
419  type,
420  track,
421  clib_cpu_time_now ());
422  d[0] = data;
423 }
424 
425 always_inline void *
427 {
428  return elog_event_data_not_inline (em, type, track, clib_cpu_time_now ());
429 }
430 
431 always_inline void *
433  elog_track_t * track)
434 {
435  return elog_event_data_inline (em, type, track, clib_cpu_time_now ());
436 }
437 
438 /* Macro shorthands for generating/declaring events. */
439 #define __ELOG_TYPE_VAR(f) f
440 #define __ELOG_TRACK_VAR(f) f
441 
442 #define ELOG_TYPE_DECLARE(f) static elog_event_type_t __ELOG_TYPE_VAR(f)
443 
444 #define ELOG_TYPE_INIT_FORMAT_AND_FUNCTION(fmt,func) \
445  { .format = fmt, .function = func, }
446 
447 #define ELOG_TYPE_INIT(fmt) \
448  ELOG_TYPE_INIT_FORMAT_AND_FUNCTION(fmt,(char *) __FUNCTION__)
449 
450 #define ELOG_TYPE_DECLARE_HELPER(f,fmt,func) \
451  static elog_event_type_t __ELOG_TYPE_VAR(f) = \
452  ELOG_TYPE_INIT_FORMAT_AND_FUNCTION (fmt, func)
453 
454 #define ELOG_TYPE_DECLARE_FORMAT_AND_FUNCTION(f,fmt) \
455  ELOG_TYPE_DECLARE_HELPER (f, fmt, (char *) __FUNCTION__)
456 
457 #define ELOG_TYPE_DECLARE_FORMAT(f,fmt) \
458  ELOG_TYPE_DECLARE_HELPER (f, fmt, 0)
459 
460 /* Shorthands with and without __FUNCTION__.
461  D for decimal; X for hex. F for __FUNCTION__. */
462 #define ELOG_TYPE(f,fmt) ELOG_TYPE_DECLARE_FORMAT_AND_FUNCTION(f,fmt)
463 #define ELOG_TYPE_D(f) ELOG_TYPE_DECLARE_FORMAT (f, #f " %d")
464 #define ELOG_TYPE_X(f) ELOG_TYPE_DECLARE_FORMAT (f, #f " 0x%x")
465 #define ELOG_TYPE_DF(f) ELOG_TYPE_DECLARE_FORMAT_AND_FUNCTION (f, #f " %d")
466 #define ELOG_TYPE_XF(f) ELOG_TYPE_DECLARE_FORMAT_AND_FUNCTION (f, #f " 0x%x")
467 #define ELOG_TYPE_FD(f) ELOG_TYPE_DECLARE_FORMAT_AND_FUNCTION (f, #f " %d")
468 #define ELOG_TYPE_FX(f) ELOG_TYPE_DECLARE_FORMAT_AND_FUNCTION (f, #f " 0x%x")
469 
470 #define ELOG_TRACK_DECLARE(f) static elog_track_t __ELOG_TRACK_VAR(f)
471 #define ELOG_TRACK(f) ELOG_TRACK_DECLARE(f) = { .name = #f, }
472 
473 /* Log 32 bits of data. */
474 #define ELOG(em,f,data) elog ((em), &__ELOG_TYPE_VAR(f), data)
475 #define ELOG_INLINE(em,f,data) elog_inline ((em), &__ELOG_TYPE_VAR(f), data)
476 
477 /* Return data pointer to fill in. */
478 #define ELOG_TRACK_DATA(em,f,track) \
479  elog_data ((em), &__ELOG_TYPE_VAR(f), &__ELOG_TRACK_VAR(track))
480 #define ELOG_TRACK_DATA_INLINE(em,f,track) \
481  elog_data_inline ((em), &__ELOG_TYPE_VAR(f), &__ELOG_TRACK_VAR(track))
482 
483 /* Shorthand with default track. */
484 #define ELOG_DATA(em,f) elog_data ((em), &__ELOG_TYPE_VAR (f), &(em)->default_track)
485 #define ELOG_DATA_INLINE(em,f) elog_data_inline ((em), &__ELOG_TYPE_VAR (f), &(em)->default_track)
486 
487 /** @brief add a string to the event-log string table
488 
489  Often combined with hashing and the T4 elog format specifier to
490  display complex strings in offline tooling
491 
492  @param em elog_main_t *
493  @param format char *
494  @param VARARGS
495  @return u32 index to add to event log
496 */
497 u32 elog_string (elog_main_t * em, char *format, ...);
498 
499 void elog_time_now (elog_time_stamp_t * et);
500 
501 /** @brief convert event ring events to events, and return them as a vector.
502  @param em elog_main_t *
503  @return event vector with timestamps in f64 seconds
504  @note sets em->events to resulting vector.
505 */
507 
508 /** @brief convert event ring events to events, and return them as a vector.
509  @param em elog_main_t *
510  @return event vector with timestamps in f64 seconds
511  @note no side effects
512 */
514 
515 /* Merge two logs, add supplied track tags. */
516 void elog_merge (elog_main_t * dst, u8 * dst_tag,
517  elog_main_t * src, u8 * src_tag, f64 align_tweak);
518 
519 /* 2 arguments elog_main_t and elog_event_t to format event or track name. */
520 u8 *format_elog_event (u8 * s, va_list * va);
521 u8 *format_elog_track_name (u8 * s, va_list * va);
522 u8 *format_elog_track (u8 * s, va_list * args);
523 
524 void serialize_elog_main (serialize_main_t * m, va_list * va);
525 void unserialize_elog_main (serialize_main_t * m, va_list * va);
526 
527 void elog_init (elog_main_t * em, u32 n_events);
528 void elog_alloc (elog_main_t * em, u32 n_events);
529 void elog_resize (elog_main_t * em, u32 n_events);
530 
531 #ifdef CLIB_UNIX
533 elog_write_file (elog_main_t * em, char *clib_file, int flush_ring)
534 {
537 
539  if (error)
540  return error;
541  error = serialize (&m, serialize_elog_main, em, flush_ring);
542  if (!error)
543  serialize_close (&m);
544  return error;
545 }
546 
548  int flush_ring);
549 
552 {
555 
557  if (error)
558  return error;
560  if (!error)
561  unserialize_close (&m);
562  return error;
563 }
564 
566 char *format_one_elog_event (void *em_arg, void *ep_arg);
567 
568 #endif /* CLIB_UNIX */
569 
570 #endif /* included_clib_elog_h */
571 
572 /*
573  * fd.io coding-style-patch-verification: ON
574  *
575  * Local Variables:
576  * eval: (c-set-style "gnu")
577  * End:
578  */
elog_reset_buffer
static void elog_reset_buffer(elog_main_t *em)
Reset the event buffer.
Definition: elog.h:210
elog_event_t::time
f64 time
Absolute time as floating point number in seconds.
Definition: elog.h:67
mhash.h
elog_event_type_t::format
char * format
Format string.
Definition: elog.h:92
elog_main_t::tracks
elog_track_t * tracks
Vector of tracks.
Definition: elog.h:163
elog_event_t::data
u8 data[20]
20-bytes of data follows, pads to 32 bytes.
Definition: elog.h:79
elog_main_t::string_table_tmp
u8 * string_table_tmp
Definition: elog.h:160
elog_track_t::name
char * name
Track name vector.
Definition: elog.h:116
elog_track_inline
static void elog_track_inline(elog_main_t *em, elog_event_type_t *type, elog_track_t *track, u32 data)
Log a single-datum event to a specific track.
Definition: elog.h:415
unserialize
__clib_export clib_error_t * unserialize(serialize_main_t *m,...)
Definition: serialize.c:684
elog_event_data_inline
static void * elog_event_data_inline(elog_main_t *em, elog_event_type_t *type, elog_track_t *track, u64 cpu_time)
Allocate an event to be filled in by the caller.
Definition: elog.h:293
elog
static void elog(elog_main_t *em, elog_event_type_t *type, u32 data)
Log a single-datum event.
Definition: elog.h:367
elog_main_t::n_total_events_disable_limit
u32 n_total_events_disable_limit
When count reaches limit logging is disabled.
Definition: elog.h:139
elog_event_type_t::n_enum_strings
u32 n_enum_strings
Number of elements in string enum table.
Definition: elog.h:107
elog_data
static void * elog_data(elog_main_t *em, elog_event_type_t *type, elog_track_t *track)
Definition: elog.h:426
elog_main_t::nsec_per_cpu_clock
f64 nsec_per_cpu_clock
Use serialize_time and init_time to give estimate for cpu clock frequency.
Definition: elog.h:179
elog_main_t::event_types
elog_event_type_t * event_types
Vector of event types.
Definition: elog.h:152
elog_event_type_t::enum_strings_vector
char ** enum_strings_vector
String table as a vector constructed when type is registered.
Definition: elog.h:89
elog_read_file
static clib_error_t * elog_read_file(elog_main_t *em, char *clib_file)
Definition: elog.h:551
u16
unsigned short u16
Definition: types.h:57
elog_event_t
Definition: elog.h:59
format_elog_event
u8 * format_elog_event(u8 *s, va_list *va)
Definition: elog.c:296
elog_peek_events
elog_event_t * elog_peek_events(elog_main_t *em)
convert event ring events to events, and return them as a vector.
Definition: elog.c:557
format_elog_track
u8 * format_elog_track(u8 *s, va_list *args)
Definition: elog.c:408
elog_track_t::track_index_plus_one
u32 track_index_plus_one
Set to one when track has been added to main structure.
Definition: elog.h:120
elog_event_data
void * elog_event_data(elog_main_t *em, elog_event_type_t *type, elog_track_t *track, u64 cpu_time)
Definition: elog.c:65
serialize_main_t
Definition: serialize.h:144
elog_get_events
elog_event_t * elog_get_events(elog_main_t *em)
convert event ring events to events, and return them as a vector.
Definition: elog.c:626
error
Definition: cJSON.c:88
elog_main_t::event_ring
elog_event_t * event_ring
Vector of events (circular buffer).
Definition: elog.h:149
elog_buffer_capacity
static uword elog_buffer_capacity(elog_main_t *em)
Return number of events which can fit in the event buffer.
Definition: elog.h:201
hash.h
elog_track_register
word elog_track_register(elog_main_t *em, elog_track_t *t)
register an event track
Definition: elog.c:198
elog_write_file_not_inline
clib_error_t * elog_write_file_not_inline(elog_main_t *em, char *clib_file, int flush_ring)
Definition: elog.c:1184
elog_track
static void elog_track(elog_main_t *em, elog_event_type_t *type, elog_track_t *track, u32 data)
Log a single-datum event to a specific track, non-inline version.
Definition: elog.h:398
serialize_open_clib_file
__clib_export clib_error_t * serialize_open_clib_file(serialize_main_t *m, char *file)
Definition: serialize.c:1236
vec_len
#define vec_len(v)
Number of elements in vector (rvalue-only, NULL tolerant)
Definition: vec_bootstrap.h:142
error.h
serialize
__clib_export clib_error_t * serialize(serialize_main_t *m,...)
Definition: serialize.c:672
elog_main_t::n_total_events
u32 n_total_events
Total number of events in buffer.
Definition: elog.h:135
elog_event_type_t::format_args
char * format_args
Specifies how arguments to format are parsed from event data.
Definition: elog.h:101
elog_time_stamp_t::cpu
u64 cpu
CPU cycle counter.
Definition: elog.h:126
elog_main_t::serialize_time
elog_time_stamp_t serialize_time
Definition: elog.h:172
unserialize_open_clib_file
__clib_export clib_error_t * unserialize_open_clib_file(serialize_main_t *m, char *file)
Definition: serialize.c:1242
vec_elt_at_index
#define vec_elt_at_index(v, i)
Get vector value at index i checking that i is in bounds.
Definition: vec_bootstrap.h:203
clib_file
Definition: file.h:51
format_one_elog_event
char * format_one_elog_event(void *em_arg, void *ep_arg)
Definition: elog.c:431
PREDICT_FALSE
#define PREDICT_FALSE(x)
Definition: clib.h:124
elog_main_t::string_table
char * string_table
Events may refer to strings in string table.
Definition: elog.h:158
uword
u64 uword
Definition: types.h:112
elog_main_t::default_track
elog_track_t default_track
Default track.
Definition: elog.h:166
elog_main_t::event_ring_size
uword event_ring_size
Power of 2 number of elements in ring.
Definition: elog.h:145
time.h
f64
double f64
Definition: types.h:142
unserialize_elog_main
void unserialize_elog_main(serialize_main_t *m, va_list *va)
Definition: elog.c:1147
src
vl_api_address_t src
Definition: gre.api:54
serialize_close
__clib_export void serialize_close(serialize_main_t *m)
Definition: serialize.c:870
clib_min
#define clib_min(x, y)
Definition: clib.h:342
format_elog_track_name
u8 * format_elog_track_name(u8 *s, va_list *va)
Definition: elog.c:399
elog_time_stamp_t::os_nsec
u64 os_nsec
OS timer in nano secs since epoch 3/30/2017, see elog_time_now()
Definition: elog.h:129
clib_atomic_fetch_add
#define clib_atomic_fetch_add(a, b)
Definition: atomics.h:23
data
u8 data[128]
Definition: ipsec_types.api:95
elog_event_t::track
u16 track
Track for this event.
Definition: elog.h:76
elog_alloc
void elog_alloc(elog_main_t *em, u32 n_events)
Definition: elog.c:501
elog_is_enabled
static uword elog_is_enabled(elog_main_t *em)
event logging enabled predicate
Definition: elog.h:276
always_inline
#define always_inline
Definition: rdma_mlx5dv.h:23
elog_data_inline
static void * elog_data_inline(elog_main_t *em, elog_event_type_t *type, elog_track_t *track)
Definition: elog.h:432
clib_time_t
Definition: time.h:44
elog_resize
void elog_resize(elog_main_t *em, u32 n_events)
Definition: elog.c:507
elog_event_type_register
word elog_event_type_register(elog_main_t *em, elog_event_type_t *t)
register an event type
Definition: elog.c:104
elog_track_t
Definition: elog.h:113
u64
unsigned long u64
Definition: types.h:89
format
description fragment has unexpected format
Definition: map.api:433
ASSERT
#define ASSERT(truth)
Definition: error_bootstrap.h:69
cache.h
elog_init
void elog_init(elog_main_t *em, u32 n_events)
Definition: elog.c:513
u32
unsigned int u32
Definition: types.h:88
elog_inline
static void elog_inline(elog_main_t *em, elog_event_type_t *type, u32 data)
Log a single-datum event, inline version.
Definition: elog.h:382
elog_write_file
static clib_error_t * elog_write_file(elog_main_t *em, char *clib_file, int flush_ring)
Definition: elog.h:533
elog_disable_after_events
static void elog_disable_after_events(elog_main_t *em, uword n)
disable logging after specified number of ievents have been logged.
Definition: elog.h:236
dst
vl_api_ip4_address_t dst
Definition: pnat.api:41
elog_time_now
void elog_time_now(elog_time_stamp_t *et)
Definition: elog.c:440
elog_disable_trigger
static void elog_disable_trigger(elog_main_t *em)
Definition: elog.h:248
elog_merge
void elog_merge(elog_main_t *dst, u8 *dst_tag, elog_main_t *src, u8 *src_tag, f64 align_tweak)
Definition: elog.c:699
elog_main_t::string_table_hash
uword * string_table_hash
Definition: elog.h:159
elog_read_file_not_inline
clib_error_t * elog_read_file_not_inline(elog_main_t *em, char *clib_file)
Definition: elog.c:1199
u8
unsigned char u8
Definition: types.h:56
clib_error_t
Definition: clib_error.h:21
serialize.h
unserialize_close
__clib_export void unserialize_close(serialize_main_t *m)
Definition: serialize.c:877
elog_main_t
Definition: elog.h:132
elog_main_t::placeholder_event
elog_event_t placeholder_event
Dummy event to use when logger is disabled.
Definition: elog.h:142
word
i64 word
Definition: types.h:111
elog_event_type_t::type_index_plus_one
u32 type_index_plus_one
Type index plus one assigned to this type.
Definition: elog.h:86
elog_string
u32 elog_string(elog_main_t *em, char *format,...)
add a string to the event-log string table
Definition: elog.c:582
elog_event_t::event_type
u16 event_type
Event type index.
Definition: elog.h:71
serialize_elog_main
void serialize_elog_main(serialize_main_t *m, va_list *va)
Definition: elog.c:1113
elog_event_type_t
Definition: elog.h:82
elog_main_t::event_type_by_format
uword * event_type_by_format
Hash table mapping type format to type index.
Definition: elog.h:155
clib_cpu_time_now
static u64 clib_cpu_time_now(void)
Definition: time.h:81
is_pow2
static uword is_pow2(uword x)
Definition: clib.h:267
elog_main_t::lock
uword * lock
SMP lock, non-zero means locking required.
Definition: elog.h:175
elog_enable_disable
static void elog_enable_disable(elog_main_t *em, int is_enabled)
Enable or disable event logging.
Definition: elog.h:220
elog_time_stamp_t
Definition: elog.h:123
elog_main_t::events
elog_event_t * events
Vector of events converted to generic form after collection.
Definition: elog.h:182
type
vl_api_fib_path_type_t type
Definition: fib_types.api:123
elog_n_events_in_buffer
static uword elog_n_events_in_buffer(elog_main_t *em)
Return number of events in the event-log buffer.
Definition: elog.h:191
elog_event_t::time_cycles
u64 time_cycles
Absolute time stamp in CPU clock cycles.
Definition: elog.h:64
elog_event_data_not_inline
static void * elog_event_data_not_inline(elog_main_t *em, elog_event_type_t *type, elog_track_t *track, u64 cpu_time)
Allocate an event to be filled in by the caller, non-inline.
Definition: elog.h:351
elog_main_t::cpu_timer
clib_time_t cpu_timer
Place holder for CPU clock frequency.
Definition: elog.h:169