2 * Copyright (c) 2016 Cisco and/or its affiliates.
3 * Licensed under the Apache License, Version 2.0 (the "License");
4 * you may not use this file except in compliance with the License.
5 * You may obtain a copy of the License at:
7 * http://www.apache.org/licenses/LICENSE-2.0
9 * Unless required by applicable law or agreed to in writing, software
10 * distributed under the License is distributed on an "AS IS" BASIS,
11 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12 * See the License for the specific language governing permissions and
13 * limitations under the License.
15 #ifndef __included_ssvm_fifo_segment_h__
16 #define __included_ssvm_fifo_segment_h__
18 #include <svm/svm_fifo.h>
20 #include <vppinfra/lock.h>
24 FIFO_SEGMENT_FREELIST_NONE = -1,
25 FIFO_SEGMENT_RX_FREELIST = 0,
26 FIFO_SEGMENT_TX_FREELIST,
27 FIFO_SEGMENT_N_FREELISTS
28 } svm_fifo_segment_freelist_t;
30 #define FIFO_SEGMENT_MIN_FIFO_SIZE 4096
31 #define FIFO_SEGMENT_MAX_FIFO_SIZE (8<<20) /* 8mb max fifo size */
32 #define FIFO_SEGMENT_ALLOC_CHUNK_SIZE 32 /* Allocation quantum */
34 #define FIFO_SEGMENT_F_IS_PRIVATE 1 << 0 /* Private segment */
35 #define FIFO_SEGMENT_F_IS_MAIN_HEAP 1 << 1 /* Segment is main heap */
36 #define FIFO_SEGMENT_F_IS_PREALLOCATED 1 << 2 /* Segment is preallocated */
40 svm_fifo_t *fifos; /**< Linked list of active RX fifos */
41 u8 *segment_name; /**< Segment name */
42 svm_fifo_t **free_fifos; /**< Freelists, by fifo size */
43 u32 n_active_fifos; /**< Number of active fifos */
44 u8 flags; /**< Segment flags */
45 } svm_fifo_segment_header_t;
50 svm_fifo_segment_header_t *h;
51 } svm_fifo_segment_private_t;
57 /** pool of segments */
58 svm_fifo_segment_private_t *segments;
59 /* Where to put the next one */
61 u32 timeout_in_seconds;
62 } svm_fifo_segment_main_t;
64 extern svm_fifo_segment_main_t svm_fifo_segment_main;
70 u32 *new_segment_indices;
73 u32 preallocated_fifo_pairs;
74 u32 private_segment_count;
75 } svm_fifo_segment_create_args_t;
77 static inline svm_fifo_segment_private_t *
78 svm_fifo_segment_get_segment (u32 segment_index)
80 svm_fifo_segment_main_t *ssm = &svm_fifo_segment_main;
81 return vec_elt_at_index (ssm->segments, segment_index);
85 svm_fifo_segment_has_fifos (svm_fifo_segment_private_t * fifo_segment)
87 return fifo_segment->h->fifos != 0;
90 static inline svm_fifo_t *
91 svm_fifo_segment_get_fifo_list (svm_fifo_segment_private_t * fifo_segment)
93 return fifo_segment->h->fifos;
96 #define foreach_ssvm_fifo_segment_api_error \
97 _(OUT_OF_SPACE, "Out of space in segment", -200)
101 #define _(n,s,c) SSVM_FIFO_SEGMENT_API_ERROR_##n = c,
102 foreach_ssvm_fifo_segment_api_error
104 } ssvm_fifo_segment_api_error_enum_t;
106 int svm_fifo_segment_create (svm_fifo_segment_create_args_t * a);
107 int svm_fifo_segment_create_process_private (svm_fifo_segment_create_args_t
109 int svm_fifo_segment_attach (svm_fifo_segment_create_args_t * a);
110 void svm_fifo_segment_delete (svm_fifo_segment_private_t * s);
112 svm_fifo_t *svm_fifo_segment_alloc_fifo (svm_fifo_segment_private_t * s,
113 u32 data_size_in_bytes,
114 svm_fifo_segment_freelist_t index);
115 void svm_fifo_segment_free_fifo (svm_fifo_segment_private_t * s,
117 svm_fifo_segment_freelist_t index);
118 void svm_fifo_segment_init (u64 baseva, u32 timeout_in_seconds);
119 u32 svm_fifo_segment_index (svm_fifo_segment_private_t * s);
120 u32 svm_fifo_segment_num_fifos (svm_fifo_segment_private_t * fifo_segment);
121 u32 svm_fifo_segment_num_free_fifos (svm_fifo_segment_private_t *
122 fifo_segment, u32 fifo_size_in_bytes);
124 svm_fifo_segment_private_t *svm_fifo_segment_segments_pool (void);
125 format_function_t format_svm_fifo_segment;
127 #endif /* __included_ssvm_fifo_segment_h__ */
130 * fd.io coding-style-patch-verification: ON
133 * eval: (c-set-style "gnu")