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
  27 typedef enum
  28 {
  29   STAT_DIR_TYPE_ILLEGAL = 0,
  30   STAT_DIR_TYPE_SCALAR_INDEX,
  31   STAT_DIR_TYPE_COUNTER_VECTOR_SIMPLE,
  32   STAT_DIR_TYPE_COUNTER_VECTOR_COMBINED,
  33   STAT_DIR_TYPE_ERROR_INDEX,
  34   STAT_DIR_TYPE_NAME_VECTOR,
  35 } stat_directory_type_t;
  36
  37 /* Default socket to exchange segment fd */
  38 /* TODO: Get from runtime directory */
  39 #define STAT_SEGMENT_SOCKET_FILE "/run/vpp/stats.sock"
  40 #define STAT_SEGMENT_SOCKET_FILENAME "stats.sock"
  41
  42 typedef struct stat_client_main_t stat_client_main_t;
  43
  44 typedef struct
  45 {
  46   char *name;
  47   stat_directory_type_t type;
  48   union
  49   {
  50     double scalar_value;
  51     counter_t *error_vector;
  52     counter_t **simple_counter_vec;
  53     vlib_counter_t **combined_counter_vec;
  54     uint8_t **name_vector;
  55   };
  56 } stat_segment_data_t;
  57
  58 stat_client_main_t *stat_client_get (void);
  59 void stat_client_free (stat_client_main_t * sm);
  60 int stat_segment_connect_r (const char *socket_name, stat_client_main_t * sm);
  61 int stat_segment_connect (const char *socket_name);
  62 void stat_segment_disconnect_r (stat_client_main_t * sm);
  63 void stat_segment_disconnect (void);
  64 uint8_t **stat_segment_string_vector (uint8_t ** string_vector,
  65                                       const char *string);
  66 int stat_segment_vec_len (void *vec);
  67 void stat_segment_vec_free (void *vec);
  68 uint32_t *stat_segment_ls_r (uint8_t ** patterns, stat_client_main_t * sm);
  69 uint32_t *stat_segment_ls (uint8_t ** pattern);
  70 stat_segment_data_t *stat_segment_dump_r (uint32_t * stats,
  71                                           stat_client_main_t * sm);
  72 stat_segment_data_t *stat_segment_dump (uint32_t * counter_vec);
  73 stat_segment_data_t *stat_segment_dump_entry_r (uint32_t index,
  74                                                 stat_client_main_t * sm);
  75 stat_segment_data_t *stat_segment_dump_entry (uint32_t index);
  76
  77 void stat_segment_data_free (stat_segment_data_t * res);
  78 double stat_segment_heartbeat_r (stat_client_main_t * sm);
  79 double stat_segment_heartbeat (void);
  80
  81 char *stat_segment_index_to_name_r (uint32_t index, stat_client_main_t * sm);
  82 char *stat_segment_index_to_name (uint32_t index);
  83 uint64_t stat_segment_version (void);
  84 uint64_t stat_segment_version_r (stat_client_main_t * sm);
  85
  86 #endif /* included_stat_client_h */
  87
  88 /*
  89  * fd.io coding-style-patch-verification: ON
  90  *
  91  * Local Variables:
  92  * eval: (c-set-style "gnu")
  93  * End:
  94  */