session: optimize ct fifo segment allocations
[vpp.git] / src / svm / fifo_segment.h
index d363c60..f76798f 100644 (file)
@@ -16,6 +16,8 @@
 #define __included_fifo_segment_h__
 
 #include <svm/ssvm.h>
+#include <svm/fifo_types.h>
+#include <svm/message_queue.h>
 #include <svm/svm_fifo.h>
 
 typedef enum
@@ -28,39 +30,49 @@ 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_
 {
   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;
 
-typedef struct fifo_segment_slice_
+#define foreach_segment_mem_status     \
+_(NO_PRESSURE, "No pressure")          \
+_(LOW_PRESSURE, "Low pressure")                \
+_(HIGH_PRESSURE, "High pressure")      \
+_(NO_MEMORY, "No memory")
+
+typedef enum
 {
-  svm_fifo_t *fifos;                   /**< Linked list of active RX fifos */
-  svm_fifo_t *free_fifos;              /**< Freelists by fifo size  */
-  svm_fifo_chunk_t **free_chunks;      /**< Freelists by chunk size */
-  uword n_fl_chunk_bytes;              /**< Chunk bytes on freelist */
-} fifo_segment_slice_t;
+#define _(sym,str)  MEMORY_PRESSURE_##sym,
+  foreach_segment_mem_status
+#undef _
+    MEMORY_N_PRESSURE,
+} fifo_segment_mem_status_t;
 
-typedef struct
+#if 0
+typedef enum fifo_segment_mem_status_
 {
-  fifo_segment_slice_t *slices;                /** Fixed array of slices */
-  ssvm_shared_header_t *ssvm_sh;       /**< Pointer to fs ssvm shared hdr */
-  uword n_free_bytes;                  /**< Segment free bytes */
-  u32 n_active_fifos;                  /**< Number of active fifos */
-  u32 max_log2_chunk_size;             /**< Max log2(chunk size) for fs */
-  u8 flags;                            /**< Segment flags */
-  u8 n_slices;                         /**< Number of slices */
-} fifo_segment_header_t;
+  MEMORY_PRESSURE_NO_PRESSURE,
+  MEMORY_PRESSURE_LOW_PRESSURE,
+  MEMORY_PRESSURE_HIGH_PRESSURE,
+  MEMORY_PRESSURE_NO_MEMORY,
+} fifo_segment_mem_status_t;
+#endif
 
 typedef struct
 {
   ssvm_private_t ssvm;         /**< ssvm segment data */
   fifo_segment_header_t *h;    /**< fifo segment data */
+  uword max_byte_index;
   u8 n_slices;                 /**< number of fifo segment slices */
+  fifo_slice_private_t *slices; /**< private slice information */
+  svm_msg_q_t *mqs;            /**< private vec of attached mqs */
 } fifo_segment_t;
 
 typedef struct
@@ -87,11 +99,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
  *
@@ -104,6 +131,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
@@ -113,6 +143,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
  *
@@ -156,25 +239,61 @@ void fifo_segment_preallocate_fifo_pairs (fifo_segment_t * fs,
                                          u32 rx_fifo_size,
                                          u32 tx_fifo_size,
                                          u32 * n_fifo_pairs);
+
 /**
- * Grow fifo size by adding an additional chunk of memory
+ * Allocate chunks in fifo segment
  *
- * @param fs           fifo segment for fifo
- * @param f            fifo to be grown
- * @param chunk_size   number of bytes to be added to fifo
- * @return             0 on success or a negative number otherwise
+ * @param fsh          fifo segment header
+ * @param slice_index  slice where chunks should be alocated
+ * @param chunk_size   chunk size needed
+ * @return             chunk (or chunks) that cover at least chunk_size bytes
+ *                     on success, 0 on failure.
  */
-int fifo_segment_grow_fifo (fifo_segment_t * fs, svm_fifo_t * f,
-                           u32 chunk_size);
+svm_fifo_chunk_t *fsh_alloc_chunk (fifo_segment_header_t * fsh,
+                                  u32 slice_index, u32 chunk_size);
 
 /**
- * Collect unused chunks for fifo
+ * Return chunks to fifo segment
  *
- * @param fs           fifo segment for fifo
- * @param f            fifo whose chunks are to be collected
- * @return             0 on success, error otherwise
+ * @param fsh          fifo segment header
+ * @param slice_index  slice where chunks should be returned
+ * @param c            pointer to first chunk in 0 terminated linked list
+ */
+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
  */
-int fifo_segment_collect_fifo_chunks (fifo_segment_t * fs, svm_fifo_t * f);
+void fsh_reset_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 *fifo_segment_alloc (fifo_segment_t *fs, uword size);
+/**
+ * Fifo segment allocated size
+ *
+ * Returns fifo segment's allocated size
+ *
+ * @param fs            fifo segment
+ * @return              allocated size in bytes
+ */
+uword fifo_segment_size (fifo_segment_t * fs);
 
 /**
  * Fifo segment estimate of number of free bytes
@@ -189,14 +308,16 @@ int fifo_segment_collect_fifo_chunks (fifo_segment_t * fs, svm_fifo_t * f);
 uword fifo_segment_free_bytes (fifo_segment_t * fs);
 
 /**
- * Update fifo segment free bytes estimate
+ * Fifo segment number of cached bytes
  *
- * Forces fifo segment free bytes estimate synchronization with underlying
- * memory allocator.
+ * Returns fifo segment's number of cached bytes.
  *
- * @param fs           fifo segment
+ * @param fs            fifo segment
+ * @return              cached bytes
  */
-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
@@ -210,6 +331,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
  *
@@ -219,6 +348,11 @@ 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,
                             u32 timeout_in_seconds);