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 <vlib/vlib.h>
  21 #include <vpp/stats/stats.h>
  22
  23 typedef struct
  24 {
  25   char *name;
  26   stat_directory_type_t type;
  27   union
  28   {
  29     f64 scalar_value;
  30     u64 error_value;
  31     u64 *vector_pointer;
  32     counter_t **simple_counter_vec;
  33     vlib_counter_t **combined_counter_vec;
  34   };
  35 } stat_segment_data_t;
  36
  37 typedef struct
  38 {
  39   char *name;
  40   stat_segment_directory_entry_t *ep;
  41 } stat_segment_cached_pointer_t;
  42
  43 int stat_segment_connect (char *socket_name);
  44 void stat_segment_disconnect (void);
  45
  46 u8 **stat_segment_ls (u8 ** pattern);
  47 stat_segment_data_t *stat_segment_dump (u8 ** counter_vec);
  48
  49 stat_segment_cached_pointer_t *stat_segment_register (u8 ** counter_vec);
  50 stat_segment_data_t *stat_segment_collect (stat_segment_cached_pointer_t *);    /* Collects registered counters */
  51
  52 void stat_segment_data_free (stat_segment_data_t * res);
  53
  54 f64 stat_segment_heartbeat (void);
  55
  56 #endif /* included_stat_client_h */
  57
  58 /*
  59  * fd.io coding-style-patch-verification: ON
  60  *
  61  * Local Variables:
  62  * eval: (c-set-style "gnu")
  63  * End:
  64  */