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