session: Add mq debug cli

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

diff --git a/src/svm/fifo_segment.h b/src/svm/fifo_segment.h
index cc0ff3a..7922274 100644 (file)
--- a/src/svm/fifo_segment.h
+++ b/src/svm/fifo_segment.h
@@ -38,10 +38,13 @@ typedef enum fifo_segment_flags_
 
 typedef struct
 {
-  svm_fifo_t *fifos;           /**< Linked list of active RX fifos */
-  svm_fifo_t **free_fifos;     /**< Freelists, by fifo size  */
-  u32 n_active_fifos;          /**< Number of active fifos */
-  u8 flags;                    /**< Segment flags */
+  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 */
+  u32 n_free_bytes;                    /**< Bytes usable for new allocs */
+  u32 n_fl_chunk_bytes;                        /**< Chunk bytes on freelist */
 } fifo_segment_header_t;
 
 typedef struct
@@ -82,7 +85,7 @@ void fifo_segment_info (fifo_segment_t * seg, char **address, size_t * size);
 /**
  * Allocate fifo in fifo segment
  *
- * @param fs           fifo segment
+ * @param fs           fifo segment for fifo
  * @param data_bytes   size of default fifo chunk in bytes
  * @param ftype                fifo type @ref fifo_segment_ftype_t
  * @return             new fifo or 0 if alloc failed
@@ -94,11 +97,35 @@ svm_fifo_t *fifo_segment_alloc_fifo (fifo_segment_t * fs,
 /**
  * Free fifo allocated in fifo segment
  *
- * @param fs           fifo segment
+ * @param fs           fifo segment for fifo
  * @param f            fifo to be freed
  */
 void fifo_segment_free_fifo (fifo_segment_t * fs, svm_fifo_t * f);
 
+/**
+ * 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 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 chunk_size,
+                                      u32 batch_size);
 /**
  * Pre-allocates fifo pairs in fifo segment
  *
@@ -107,7 +134,7 @@ void fifo_segment_free_fifo (fifo_segment_t * fs, svm_fifo_t * f);
  * is hit, the number of fifo pairs requested is updated by subtracting the
  * number of fifos that have been successfully allocated.
  *
- * @param fs           fifo segment
+ * @param fs           fifo segment for fifo
  * @param rx_fifo_size data size of rx fifos
  * @param tx_fifo_size data size of tx fifos
  * @param n_fifo_pairs number of pairs requested. Prior to returning, this
@@ -117,10 +144,67 @@ 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
+ *
+ * @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
+ */
+int fifo_segment_grow_fifo (fifo_segment_t * fs, svm_fifo_t * f,
+                           u32 chunk_size);
+
+/**
+ * Collect unused chunks for fifo
+ *
+ * @param fs           fifo segment for fifo
+ * @param f            fifo whose chunks are to be collected
+ * @return             0 on success, error otherwise
+ */
+int fifo_segment_collect_fifo_chunks (fifo_segment_t * fs, svm_fifo_t * f);
+
+/**
+ * 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
+ */
+u32 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);
+
+/**
+ * Number of bytes on chunk free lists
+ *
+ * @param fs           fifo segment
+ * @return             free bytes on chunk free lists
+ */
+u32 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);
 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
+ *
+ * @param fs   fifo segment
+ * @param size chunk size of interest or ~0 if all should be counted
+ * @return     number of chunks of given size
+ */
+u32 fifo_segment_num_free_chunks (fifo_segment_t * fs, u32 size);
 
 void fifo_segment_main_init (fifo_segment_main_t * sm, u64 baseva,
                             u32 timeout_in_seconds);