stats: Move misplaced comment block
[vpp.git] / src / vpp-api / client / stat_client.h
index 89f6fe5..9d2e50c 100644 (file)
 #ifndef included_stat_client_h
 #define included_stat_client_h
 
+#define STAT_VERSION_MAJOR     1
+#define STAT_VERSION_MINOR     2
+
 #include <stdint.h>
 #include <unistd.h>
 #include <vlib/counter_types.h>
-
-typedef enum
-{
-  STAT_DIR_TYPE_ILLEGAL = 0,
-  STAT_DIR_TYPE_SCALAR_INDEX,
-  STAT_DIR_TYPE_COUNTER_VECTOR_SIMPLE,
-  STAT_DIR_TYPE_COUNTER_VECTOR_COMBINED,
-  STAT_DIR_TYPE_ERROR_INDEX,
-} stat_directory_type_t;
+#include <time.h>
+#include <stdbool.h>
+#include <vpp/stats/stat_segment_shared.h>
 
 /* Default socket to exchange segment fd */
+/* TODO: Get from runtime directory */
 #define STAT_SEGMENT_SOCKET_FILE "/run/vpp/stats.sock"
-
-typedef struct stat_client_main_t stat_client_main_t;
+#define STAT_SEGMENT_SOCKET_FILENAME "stats.sock"
 
 typedef struct
 {
@@ -42,12 +39,24 @@ typedef struct
   union
   {
     double scalar_value;
-    uint64_t error_value;
+    counter_t *error_vector;
     counter_t **simple_counter_vec;
     vlib_counter_t **combined_counter_vec;
+    uint8_t **name_vector;
   };
 } stat_segment_data_t;
 
+typedef struct
+{
+  uint64_t current_epoch;
+  stat_segment_shared_header_t *shared_header;
+  stat_segment_directory_entry_t *directory_vector;
+  ssize_t memory_size;
+  uint64_t timeout;
+} stat_client_main_t;
+
+extern stat_client_main_t stat_client_main;
+
 stat_client_main_t *stat_client_get (void);
 void stat_client_free (stat_client_main_t * sm);
 int stat_segment_connect_r (const char *socket_name, stat_client_main_t * sm);
@@ -71,7 +80,80 @@ void stat_segment_data_free (stat_segment_data_t * res);
 double stat_segment_heartbeat_r (stat_client_main_t * sm);
 double stat_segment_heartbeat (void);
 
+char *stat_segment_index_to_name_r (uint32_t index, stat_client_main_t * sm);
 char *stat_segment_index_to_name (uint32_t index);
+uint64_t stat_segment_version (void);
+uint64_t stat_segment_version_r (stat_client_main_t * sm);
+
+typedef struct
+{
+  uint64_t epoch;
+} stat_segment_access_t;
+
+static inline uint64_t
+_time_now_nsec (void)
+{
+  struct timespec ts;
+  clock_gettime (CLOCK_REALTIME, &ts);
+  return 1e9 * ts.tv_sec + ts.tv_nsec;
+}
+
+static inline void *
+stat_segment_adjust (stat_client_main_t * sm, void *data)
+{
+  return (void *) ((char *) sm->shared_header +
+                  ((char *) data - (char *) sm->shared_header->base));
+}
+
+/*
+ * Returns 0 on success, -1 on failure (timeout)
+ */
+static inline int
+stat_segment_access_start (stat_segment_access_t * sa,
+                          stat_client_main_t * sm)
+{
+  stat_segment_shared_header_t *shared_header = sm->shared_header;
+  uint64_t max_time;
+
+  sa->epoch = shared_header->epoch;
+  if (sm->timeout)
+    {
+      max_time = _time_now_nsec () + sm->timeout;
+      while (shared_header->in_progress != 0 && _time_now_nsec () < max_time)
+       ;
+    }
+  else
+    {
+      while (shared_header->in_progress != 0)
+       ;
+    }
+  sm->directory_vector =
+    (stat_segment_directory_entry_t *) stat_segment_adjust (sm,
+                                                           (void *)
+                                                           sm->shared_header->directory_vector);
+  if (sm->timeout)
+    return _time_now_nsec () < max_time ? 0 : -1;
+  return 0;
+}
+
+/*
+ * set maximum number of nano seconds to wait for in_progress state
+ */
+static inline void
+stat_segment_set_timeout_nsec (stat_client_main_t * sm, uint64_t timeout)
+{
+  sm->timeout = timeout;
+}
+
+static inline bool
+stat_segment_access_end (stat_segment_access_t * sa, stat_client_main_t * sm)
+{
+  stat_segment_shared_header_t *shared_header = sm->shared_header;
+
+  if (shared_header->epoch != sa->epoch || shared_header->in_progress)
+    return false;
+  return true;
+}
 
 #endif /* included_stat_client_h */