session: improve fifo segment allocation
[vpp.git] / src / svm / fifo_segment.h
index 00914e6..440f1bb 100644 (file)
 
 #include <svm/ssvm.h>
 #include <svm/fifo_types.h>
+#include <svm/message_queue.h>
 #include <svm/svm_fifo.h>
 
+#define FIFO_SEGMENT_ALLOC_OVERHEAD (2 * clib_mem_get_page_size ())
+
 typedef enum
 {
   FIFO_SEGMENT_FTYPE_NONE = -1,
@@ -29,7 +32,7 @@ typedef enum
 
 #define FIFO_SEGMENT_MIN_LOG2_FIFO_SIZE 12     /**< 4kB min fifo size */
 #define FIFO_SEGMENT_MIN_FIFO_SIZE 4096                /**< 4kB min fifo size */
-#define FIFO_SEGMENT_MAX_FIFO_SIZE (2 << 30)   /**< 2GB max fifo size */
+#define FIFO_SEGMENT_MAX_FIFO_SIZE (2ULL << 30)        /**< 2GB max fifo size */
 #define FIFO_SEGMENT_ALLOC_BATCH_SIZE 32       /* Allocation quantum */
 
 typedef enum fifo_segment_flags_
@@ -37,6 +40,7 @@ typedef enum fifo_segment_flags_
   FIFO_SEGMENT_F_IS_PREALLOCATED = 1 << 0,
   FIFO_SEGMENT_F_WILL_DELETE = 1 << 1,
   FIFO_SEGMENT_F_MEM_LIMIT = 1 << 2,
+  FIFO_SEGMENT_F_CUSTOM_USE = 1 << 3,
 } fifo_segment_flags_t;
 
 #define foreach_segment_mem_status     \
@@ -67,7 +71,13 @@ typedef struct
 {
   ssvm_private_t ssvm;         /**< ssvm segment data */
   fifo_segment_header_t *h;    /**< fifo segment data */
+  fifo_slice_private_t *slices; /**< private slice information */
+  svm_msg_q_t *mqs;            /**< private vec of attached mqs */
+  uword max_byte_index;                /**< max byte index for segment */
   u8 n_slices;                 /**< number of fifo segment slices */
+  u8 flags;                    /**< private fifo segment flags */
+  u8 high_watermark;           /**< memory pressure watermark high */
+  u8 low_watermark;            /**< memory pressure watermark low */
 } fifo_segment_t;
 
 typedef struct
@@ -86,7 +96,7 @@ typedef struct
   u32 *new_segment_indices;            /**< return vec of new seg indices */
 } fifo_segment_create_args_t;
 
-#define fifo_segment_flags(_fs) _fs->h->flags
+#define fifo_segment_flags(_fs) _fs->flags
 
 int fifo_segment_init (fifo_segment_t * fs);
 int fifo_segment_create (fifo_segment_main_t * sm,
@@ -94,11 +104,26 @@ int fifo_segment_create (fifo_segment_main_t * sm,
 int fifo_segment_attach (fifo_segment_main_t * sm,
                         fifo_segment_create_args_t * a);
 void fifo_segment_delete (fifo_segment_main_t * sm, fifo_segment_t * fs);
+void fifo_segment_cleanup (fifo_segment_t *fs);
 fifo_segment_t *fifo_segment_get_segment (fifo_segment_main_t * sm,
                                          u32 fs_index);
+fifo_segment_t *fifo_segment_get_segment_if_valid (fifo_segment_main_t *sm,
+                                                  u32 segment_index);
 u32 fifo_segment_index (fifo_segment_main_t * sm, fifo_segment_t * fs);
 void fifo_segment_info (fifo_segment_t * seg, char **address, size_t * size);
 
+always_inline void *
+fifo_segment_ptr (fifo_segment_t *fs, uword offset)
+{
+  return (void *) ((u8 *) fs->h + offset);
+}
+
+always_inline uword
+fifo_segment_offset (fifo_segment_t *fs, void *p)
+{
+  return (uword) ((u8 *) p - (u8 *) fs->h);
+}
+
 /**
  * Allocate fifo in fifo segment
  *
@@ -111,6 +136,9 @@ svm_fifo_t *fifo_segment_alloc_fifo_w_slice (fifo_segment_t * fs,
                                             u32 slice_index,
                                             u32 data_bytes,
                                             fifo_segment_ftype_t ftype);
+svm_fifo_t *fifo_segment_alloc_fifo_w_offset (fifo_segment_t *fs,
+                                             uword offset);
+svm_fifo_t *fifo_segment_duplicate_fifo (fifo_segment_t *fs, svm_fifo_t *f);
 
 /**
  * Free fifo allocated in fifo segment
@@ -120,6 +148,59 @@ svm_fifo_t *fifo_segment_alloc_fifo_w_slice (fifo_segment_t * fs,
  */
 void fifo_segment_free_fifo (fifo_segment_t * fs, svm_fifo_t * f);
 
+/**
+ * Free fifo allocated by external applications
+ *
+ * @params fs          fifo segment for fifo
+ * @param f            fifo to be freed
+ */
+void fifo_segment_free_client_fifo (fifo_segment_t *fs, svm_fifo_t *f);
+
+void fifo_segment_detach_fifo (fifo_segment_t *fs, svm_fifo_t **f);
+void fifo_segment_attach_fifo (fifo_segment_t *fs, svm_fifo_t **f,
+                              u32 slice_index);
+uword fifo_segment_fifo_offset (svm_fifo_t *f);
+
+/**
+ * Allocate message queue on segment
+ *
+ * @param fs           fifo segment for mq
+ * @param mq_index     index in private mqs vector to use to attach
+ * @param cfg          configuration for mq
+ * @return             attached message queue
+ */
+svm_msg_q_t *fifo_segment_msg_q_alloc (fifo_segment_t *fs, u32 mq_index,
+                                      svm_msg_q_cfg_t *cfg);
+
+/**
+ *  Attach message queue at fifo segment offset
+ *
+ *  @param fs          fifo segment for mq
+ *  @param offset      offset for shared mq on the segment
+ *  @param mq_index    index in private mqs vector to use to attach
+ *  @return            attached message queue
+ */
+svm_msg_q_t *fifo_segment_msg_q_attach (fifo_segment_t *fs, uword offset,
+                                       u32 mq_index);
+
+/**
+ *  Discover mqs on mq only segment
+ *
+ *  @param fs          fifo segment for mq
+ *  @param fds         array of fds is mqs use eventfds
+ *  @param n_fds       number of fds
+ */
+void fifo_segment_msg_qs_discover (fifo_segment_t *fs, int *fds, u32 n_fds);
+
+/**
+ * Message queue offset on segment
+ *
+ * @param fs           fifo segment for mq
+ * @param mq_index     index of mq in private mqs vector
+ * @return             offset of the shared mq the private mq is attached to
+ */
+uword fifo_segment_msg_q_offset (fifo_segment_t *fs, u32 mq_index);
+
 /**
  * Try to preallocate fifo headers
  *
@@ -186,21 +267,14 @@ svm_fifo_chunk_t *fsh_alloc_chunk (fifo_segment_header_t * fsh,
 void fsh_collect_chunks (fifo_segment_header_t * fsh, u32 slice_index,
                         svm_fifo_chunk_t * c);
 
-/**
- * Fifo segment has reached mem limit
- *
- * @param fsh           fifo segment header
- * @return              1 (if reached) or 0 (otherwise)
- */
-u8 fsh_has_reached_mem_limit (fifo_segment_header_t * fsh);
-
 /**
  * Fifo segment reset mem limit flag
  *
  * @param fs            fifo segment
+ * @param size         size requested
+ * @return             pointer to memory allocated or 0
  */
-void fsh_reset_mem_limit (fifo_segment_header_t * fsh);
-
+void *fifo_segment_alloc (fifo_segment_t *fs, uword size);
 /**
  * Fifo segment allocated size
  *
@@ -223,16 +297,6 @@ uword fifo_segment_size (fifo_segment_t * fs);
  */
 uword fifo_segment_free_bytes (fifo_segment_t * fs);
 
-/**
- * Update fifo segment free bytes estimate
- *
- * Forces fifo segment free bytes estimate synchronization with underlying
- * memory allocator.
- *
- * @param fs           fifo segment
- */
-void fifo_segment_update_free_bytes (fifo_segment_t * fs);
-
 /**
  * Fifo segment number of cached bytes
  *
@@ -243,6 +307,8 @@ void fifo_segment_update_free_bytes (fifo_segment_t * fs);
  */
 uword fifo_segment_cached_bytes (fifo_segment_t * fs);
 
+uword fifo_segment_available_bytes (fifo_segment_t * fs);
+
 /**
  * Number of bytes on chunk free lists
  *
@@ -255,6 +321,14 @@ svm_fifo_t *fifo_segment_get_slice_fifo_list (fifo_segment_t * fs,
                                              u32 slice_index);
 u32 fifo_segment_num_fifos (fifo_segment_t * fs);
 u32 fifo_segment_num_free_fifos (fifo_segment_t * fs);
+
+svm_fifo_chunk_t *fifo_segment_alloc_chunk_w_slice (fifo_segment_t *fs,
+                                                   u32 slice_index,
+                                                   u32 chunk_size);
+void fifo_segment_collect_chunk (fifo_segment_t *fs, u32 slice_index,
+                                svm_fifo_chunk_t *c);
+uword fifo_segment_chunk_offset (fifo_segment_t *fs, svm_fifo_chunk_t *c);
+
 /**
  * Find number of free chunks of given size
  *
@@ -265,8 +339,6 @@ u32 fifo_segment_num_free_fifos (fifo_segment_t * fs);
 u32 fifo_segment_num_free_chunks (fifo_segment_t * fs, u32 size);
 
 u8 fifo_segment_get_mem_usage (fifo_segment_t * fs);
-fifo_segment_mem_status_t fifo_segment_determine_status
-  (fifo_segment_header_t * fsh, u8 usage);
 fifo_segment_mem_status_t fifo_segment_get_mem_status (fifo_segment_t * fs);
 
 void fifo_segment_main_init (fifo_segment_main_t * sm, u64 baseva,