session: update fifo slice on session migration
[vpp.git] / src / svm / fifo_segment.h
index bb4f408..ee5c24d 100644 (file)
@@ -16,6 +16,7 @@
 #define __included_fifo_segment_h__
 
 #include <svm/ssvm.h>
+#include <svm/fifo_types.h>
 #include <svm/svm_fifo.h>
 
 typedef enum
@@ -26,35 +27,53 @@ typedef enum
   FIFO_SEGMENT_N_FTYPES
 } fifo_segment_ftype_t;
 
-#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_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_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_flags_t;
 
-typedef struct
+#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 */
-  u32 n_active_fifos;                  /**< Number of active fifos */
-  u8 flags;                            /**< Segment flags */
-} fifo_segment_header_t;
+#define _(sym,str)  MEMORY_PRESSURE_##sym,
+  foreach_segment_mem_status
+#undef _
+    MEMORY_N_PRESSURE,
+} fifo_segment_mem_status_t;
+
+#if 0
+typedef enum fifo_segment_mem_status_
+{
+  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 */
+  u8 n_slices;                 /**< number of fifo segment slices */
 } fifo_segment_t;
 
 typedef struct
 {
   fifo_segment_t *segments;    /**< pool of fifo segments */
-  u64 next_baseva;             /**< Where to put the next one */
+  uword next_baseva;           /**< Where to put the next one */
   u32 timeout_in_seconds;      /**< Time to wait during attach */
 } fifo_segment_main_t;
 
@@ -88,9 +107,10 @@ void fifo_segment_info (fifo_segment_t * seg, char **address, size_t * size);
  * @param ftype                fifo type @ref fifo_segment_ftype_t
  * @return             new fifo or 0 if alloc failed
  */
-svm_fifo_t *fifo_segment_alloc_fifo (fifo_segment_t * fs,
-                                    u32 data_bytes,
-                                    fifo_segment_ftype_t ftype);
+svm_fifo_t *fifo_segment_alloc_fifo_w_slice (fifo_segment_t * fs,
+                                            u32 slice_index,
+                                            u32 data_bytes,
+                                            fifo_segment_ftype_t ftype);
 
 /**
  * Free fifo allocated in fifo segment
@@ -100,6 +120,35 @@ svm_fifo_t *fifo_segment_alloc_fifo (fifo_segment_t * fs,
  */
 void fifo_segment_free_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);
+
+/**
+ * Try to preallocate fifo headers
+ *
+ * Tries to preallocate fifo headers and adds them to freelist.
+ *
+ * @param fs           fifo segment
+ * @param batch_size   number of chunks to be allocated
+ * @return             0 on success, negative number otherwise
+ */
+int fifo_segment_prealloc_fifo_hdrs (fifo_segment_t * fs, u32 slice_index,
+                                    u32 batch_size);
+
+/**
+ * Try to preallocate fifo chunks on segment
+ *
+ * Tries to preallocate chunks of requested size on segment and adds them
+ * to chunk freelist.
+ *
+ * @param fs           fifo segment
+ * @param chunk_size   size of chunks to be allocated in bytes
+ * @param batch_size   number of chunks to be allocated
+ * @return             0 on success, negative number otherwise
+ */
+int fifo_segment_prealloc_fifo_chunks (fifo_segment_t * fs, u32 slice_index,
+                                      u32 chunk_size, u32 batch_size);
 /**
  * Pre-allocates fifo pairs in fifo segment
  *
@@ -118,29 +167,100 @@ 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 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
+ *
+ * Returns fifo segment's internal estimate of the number of free bytes.
+ * To force a synchronization between the segment and the underlying
+ * memory allocator, call @ref fifo_segment_update_free_bytes
+ *
+ * @param fs           fifo segment
+ * @return             free bytes estimate
+ */
+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
+ *
+ * Returns fifo segment's number of cached bytes.
+ *
+ * @param fs            fifo segment
+ * @return              cached bytes
+ */
+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
+ *
+ * @param fs           fifo segment
+ * @return             free bytes on chunk free lists
+ */
+uword fifo_segment_fl_chunk_bytes (fifo_segment_t * fs);
 u8 fifo_segment_has_fifos (fifo_segment_t * fs);
-svm_fifo_t *fifo_segment_get_fifo_list (fifo_segment_t * fs);
+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, u32 fifo_size_in_bytes);
+u32 fifo_segment_num_free_fifos (fifo_segment_t * fs);
 /**
  * Find number of free chunks of given size
  *
@@ -150,6 +270,11 @@ u32 fifo_segment_num_free_fifos (fifo_segment_t * fs, u32 fifo_size_in_bytes);
  */
 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);