src/vpp-api/client/stat_client.h

   1 /*
   2  * stat_client.h - Library for access to VPP statistics segment
   3  *
   4  * Copyright (c) 2018 Cisco and/or its affiliates.
   5  * Licensed under the Apache License, Version 2.0 (the "License");
   6  * you may not use this file except in compliance with the License.
   7  * You may obtain a copy of the License at:
   8  *
   9  *     http://www.apache.org/licenses/LICENSE-2.0
  10  *
  11  * Unless required by applicable law or agreed to in writing, software
  12  * distributed under the License is distributed on an "AS IS" BASIS,
  13  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  14  * See the License for the specific language governing permissions and
  15  * limitations under the License.
  16  */
  17 #ifndef included_stat_client_h
  18 #define included_stat_client_h
  19
  20 #define STAT_VERSION_MAJOR     1
  21 #define STAT_VERSION_MINOR     2
  22
  23 #include <stdint.h>
  24 #include <unistd.h>
  25 #include <vlib/counter_types.h>
  26 #include <stdbool.h>
  27 #include <vpp/stats/stat_segment_shared.h>
  28
  29 /* Default socket to exchange segment fd */
  30 #define STAT_SEGMENT_SOCKET_FILE "/run/vpp/stats.sock"
  31
  32 typedef struct
  33 {
  34   char *name;
  35   stat_directory_type_t type;
  36   union
  37   {
  38     double scalar_value;
  39     counter_t *error_vector;
  40     counter_t **simple_counter_vec;
  41     vlib_counter_t **combined_counter_vec;
  42     uint8_t **name_vector;
  43   };
  44 } stat_segment_data_t;
  45
  46 typedef struct
  47 {
  48   uint64_t current_epoch;
  49   stat_segment_shared_header_t *shared_header;
  50   stat_segment_directory_entry_t *directory_vector;
  51   ssize_t memory_size;
  52 } stat_client_main_t;
  53
  54 extern stat_client_main_t stat_client_main;
  55
  56 stat_client_main_t *stat_client_get (void);
  57 void stat_client_free (stat_client_main_t * sm);
  58 int stat_segment_connect_r (const char *socket_name, stat_client_main_t * sm);
  59 int stat_segment_connect (const char *socket_name);
  60 void stat_segment_disconnect_r (stat_client_main_t * sm);
  61 void stat_segment_disconnect (void);
  62 uint8_t **stat_segment_string_vector (uint8_t ** string_vector,
  63                                       const char *string);
  64 int stat_segment_vec_len (void *vec);
  65 void stat_segment_vec_free (void *vec);
  66 uint32_t *stat_segment_ls_r (uint8_t ** patterns, stat_client_main_t * sm);
  67 uint32_t *stat_segment_ls (uint8_t ** pattern);
  68 stat_segment_data_t *stat_segment_dump_r (uint32_t * stats,
  69                                           stat_client_main_t * sm);
  70 stat_segment_data_t *stat_segment_dump (uint32_t * counter_vec);
  71 stat_segment_data_t *stat_segment_dump_entry_r (uint32_t index,
  72                                                 stat_client_main_t * sm);
  73 stat_segment_data_t *stat_segment_dump_entry (uint32_t index);
  74
  75 void stat_segment_data_free (stat_segment_data_t * res);
  76 double stat_segment_heartbeat_r (stat_client_main_t * sm);
  77 double stat_segment_heartbeat (void);
  78
  79 char *stat_segment_index_to_name_r (uint32_t index, stat_client_main_t * sm);
  80 char *stat_segment_index_to_name (uint32_t index);
  81 uint64_t stat_segment_version (void);
  82 uint64_t stat_segment_version_r (stat_client_main_t * sm);
  83
  84 typedef struct
  85 {
  86   uint64_t epoch;
  87 } stat_segment_access_t;
  88
  89 static inline void
  90 stat_segment_access_start (stat_segment_access_t * sa,
  91                            stat_client_main_t * sm)
  92 {
  93   stat_segment_shared_header_t *shared_header = sm->shared_header;
  94   sa->epoch = shared_header->epoch;
  95   while (shared_header->in_progress != 0)
  96     ;
  97   sm->directory_vector = (stat_segment_directory_entry_t *)
  98     stat_segment_pointer (sm->shared_header,
  99                           sm->shared_header->directory_offset);
 100 }
 101
 102 static inline bool
 103 stat_segment_access_end (stat_segment_access_t * sa, stat_client_main_t * sm)
 104 {
 105   stat_segment_shared_header_t *shared_header = sm->shared_header;
 106
 107   if (shared_header->epoch != sa->epoch || shared_header->in_progress)
 108     return false;
 109   return true;
 110 }
 111
 112
 113 #endif /* included_stat_client_h */
 114
 115 /*
 116  * fd.io coding-style-patch-verification: ON
 117  *
 118  * Local Variables:
 119  * eval: (c-set-style "gnu")
 120  * End:
 121  */