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 #include <stdint.h>
  21 #include <vpp/stats/stat_segment.h>
  22 #include <vlib/counter_types.h>
  23
  24 typedef struct
  25 {
  26   uint64_t current_epoch;
  27   stat_segment_shared_header_t *shared_header;
  28   stat_segment_directory_entry_t *directory_vector;
  29   ssize_t memory_size;
  30 } stat_client_main_t;
  31
  32 typedef struct
  33 {
  34   char *name;
  35   stat_directory_type_t type;
  36   union
  37   {
  38     double scalar_value;
  39     uint64_t error_value;
  40     counter_t **simple_counter_vec;
  41     vlib_counter_t **combined_counter_vec;
  42   };
  43 } stat_segment_data_t;
  44
  45 stat_client_main_t *stat_client_get (void);
  46 void stat_client_free (stat_client_main_t * sm);
  47 int stat_segment_connect_r (char *socket_name, stat_client_main_t * sm);
  48 int stat_segment_connect (char *socket_name);
  49 void stat_segment_disconnect_r (stat_client_main_t * sm);
  50 void stat_segment_disconnect (void);
  51 uint8_t **stat_segment_string_vector (uint8_t ** string_vector, char *string);
  52 int stat_segment_vec_len (void *vec);
  53 void stat_segment_vec_free (void *vec);
  54 uint32_t *stat_segment_ls_r (uint8_t ** patterns, stat_client_main_t * sm);
  55 uint32_t *stat_segment_ls (uint8_t ** pattern);
  56 stat_segment_data_t *stat_segment_dump_r (uint32_t * stats,
  57                                           stat_client_main_t * sm);
  58 stat_segment_data_t *stat_segment_dump (uint32_t * counter_vec);
  59 stat_segment_data_t *stat_segment_dump_entry_r (uint32_t index,
  60                                                 stat_client_main_t * sm);
  61 stat_segment_data_t *stat_segment_dump_entry (uint32_t index);
  62
  63 void stat_segment_data_free (stat_segment_data_t * res);
  64 double stat_segment_heartbeat_r (stat_client_main_t * sm);
  65 double stat_segment_heartbeat (void);
  66
  67 char *stat_segment_index_to_name (uint32_t index);
  68
  69 #endif /* included_stat_client_h */
  70
  71 /*
  72  * fd.io coding-style-patch-verification: ON
  73  *
  74  * Local Variables:
  75  * eval: (c-set-style "gnu")
  76  * End:
  77  */