host stack: update stale copyright

[vpp.git] / src / svm / svm_fifo_segment.h

diff --git a/src/svm/svm_fifo_segment.h b/src/svm/svm_fifo_segment.h
index a7a3f46..d4d4809 100644 (file)
--- a/src/svm/svm_fifo_segment.h
+++ b/src/svm/svm_fifo_segment.h
@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2016 Cisco and/or its affiliates.
+ * Copyright (c) 2016-2019 Cisco and/or its affiliates.
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
  * You may obtain a copy of the License at:
@@ -15,8 +15,8 @@
 #ifndef __included_ssvm_fifo_segment_h__
 #define __included_ssvm_fifo_segment_h__
 
-#include <svm/svm_fifo.h>
 #include <svm/ssvm.h>
+#include <svm/svm_fifo.h>
 #include <vppinfra/lock.h>
 
 typedef enum
@@ -27,11 +27,19 @@ typedef enum
   FIFO_SEGMENT_N_FREELISTS
 } svm_fifo_segment_freelist_t;
 
+#define FIFO_SEGMENT_MIN_FIFO_SIZE 4096
+#define FIFO_SEGMENT_MAX_FIFO_SIZE (2 << 30)   /* 2GB max fifo size */
+#define FIFO_SEGMENT_ALLOC_CHUNK_SIZE 32       /* Allocation quantum */
+
+#define FIFO_SEGMENT_F_IS_PREALLOCATED (1 << 0)
+#define FIFO_SEGMENT_F_WILL_DELETE     (1 << 1)
+
 typedef struct
 {
   svm_fifo_t *fifos;           /**< Linked list of active RX fifos */
-  u8 *segment_name;            /**< Segment name */
-  svm_fifo_t *free_fifos[FIFO_SEGMENT_N_FREELISTS];    /**< Free lists */
+  svm_fifo_t **free_fifos;     /**< Freelists, by fifo size  */
+  u32 n_active_fifos;          /**< Number of active fifos */
+  u8 flags;                    /**< Segment flags */
 } svm_fifo_segment_header_t;
 
 typedef struct
@@ -51,25 +59,21 @@ typedef struct
   u32 timeout_in_seconds;
 } svm_fifo_segment_main_t;
 
-extern svm_fifo_segment_main_t svm_fifo_segment_main;
-
 typedef struct
 {
+  ssvm_segment_type_t segment_type;
   char *segment_name;
   u32 segment_size;
   u32 *new_segment_indices;
-  u32 rx_fifo_size;
-  u32 tx_fifo_size;
-  u32 preallocated_fifo_pairs;
-  u32 private_segment_count;
-  u32 private_segment_size;
+  int memfd_fd;
 } svm_fifo_segment_create_args_t;
 
+#define svm_fifo_segment_flags(_seg) _seg->h->flags
+
 static inline svm_fifo_segment_private_t *
-svm_fifo_get_segment (u32 segment_index)
+svm_fifo_segment_get_segment (svm_fifo_segment_main_t * sm, u32 segment_index)
 {
-  svm_fifo_segment_main_t *ssm = &svm_fifo_segment_main;
-  return vec_elt_at_index (ssm->segments, segment_index);
+  return pool_elt_at_index (sm->segments, segment_index);
 }
 
 static inline u8
@@ -84,21 +88,20 @@ svm_fifo_segment_get_fifo_list (svm_fifo_segment_private_t * fifo_segment)
   return fifo_segment->h->fifos;
 }
 
-#define foreach_ssvm_fifo_segment_api_error             \
-_(OUT_OF_SPACE, "Out of space in segment", -200)
-
-typedef enum
-{
-#define _(n,s,c) SSVM_FIFO_SEGMENT_API_ERROR_##n = c,
-  foreach_ssvm_fifo_segment_api_error
-#undef _
-} ssvm_fifo_segment_api_error_enum_t;
-
-int svm_fifo_segment_create (svm_fifo_segment_create_args_t * a);
-int svm_fifo_segment_create_process_private (svm_fifo_segment_create_args_t
-                                            * a);
-int svm_fifo_segment_attach (svm_fifo_segment_create_args_t * a);
-void svm_fifo_segment_delete (svm_fifo_segment_private_t * s);
+int svm_fifo_segment_init (svm_fifo_segment_private_t * s);
+int svm_fifo_segment_create (svm_fifo_segment_main_t * sm,
+                            svm_fifo_segment_create_args_t * a);
+int svm_fifo_segment_create_process_private (svm_fifo_segment_main_t * sm,
+                                            svm_fifo_segment_create_args_t
+                                            *);
+void svm_fifo_segment_preallocate_fifo_pairs (svm_fifo_segment_private_t * s,
+                                             u32 rx_fifo_size,
+                                             u32 tx_fifo_size,
+                                             u32 * n_fifo_pairs);
+int svm_fifo_segment_attach (svm_fifo_segment_main_t * sm,
+                            svm_fifo_segment_create_args_t * a);
+void svm_fifo_segment_delete (svm_fifo_segment_main_t * sm,
+                             svm_fifo_segment_private_t * s);
 
 svm_fifo_t *svm_fifo_segment_alloc_fifo (svm_fifo_segment_private_t * s,
                                         u32 data_size_in_bytes,
@@ -106,8 +109,21 @@ svm_fifo_t *svm_fifo_segment_alloc_fifo (svm_fifo_segment_private_t * s,
 void svm_fifo_segment_free_fifo (svm_fifo_segment_private_t * s,
                                 svm_fifo_t * f,
                                 svm_fifo_segment_freelist_t index);
-void svm_fifo_segment_init (u64 baseva, u32 timeout_in_seconds);
-u32 svm_fifo_segment_index (svm_fifo_segment_private_t * s);
+void svm_fifo_segment_main_init (svm_fifo_segment_main_t * sm, u64 baseva,
+                                u32 timeout_in_seconds);
+u32 svm_fifo_segment_index (svm_fifo_segment_main_t * sm,
+                           svm_fifo_segment_private_t * s);
+u32 svm_fifo_segment_num_fifos (svm_fifo_segment_private_t * fifo_segment);
+u32 svm_fifo_segment_num_free_fifos (svm_fifo_segment_private_t *
+                                    fifo_segment, u32 fifo_size_in_bytes);
+void svm_fifo_segment_info (svm_fifo_segment_private_t * seg, char **address,
+                           size_t * size);
+
+svm_fifo_segment_private_t
+  * svm_fifo_segment_segments_pool (svm_fifo_segment_main_t * sm);
+
+format_function_t format_svm_fifo_segment;
+format_function_t format_svm_fifo_segment_type;
 
 #endif /* __included_ssvm_fifo_segment_h__ */