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__
19 #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_PREALLOCATED (1 << 0)
35 #define FIFO_SEGMENT_F_WILL_DELETE (1 << 1)
39 svm_fifo_t *fifos; /**< Linked list of active RX fifos */
40 svm_fifo_t **free_fifos; /**< Freelists, by fifo size */
41 u32 n_active_fifos; /**< Number of active fifos */
42 u8 flags; /**< Segment flags */
43 } svm_fifo_segment_header_t;
48 svm_fifo_segment_header_t *h;
49 } svm_fifo_segment_private_t;
55 /** pool of segments */
56 svm_fifo_segment_private_t *segments;
57 /* Where to put the next one */
59 u32 timeout_in_seconds;
60 } svm_fifo_segment_main_t;
62 extern svm_fifo_segment_main_t svm_fifo_segment_main;
66 ssvm_segment_type_t segment_type;
69 u32 *new_segment_indices;
71 } svm_fifo_segment_create_args_t;
73 #define svm_fifo_segment_flags(_seg) _seg->h->flags
75 static inline svm_fifo_segment_private_t *
76 svm_fifo_segment_get_segment (u32 segment_index)
78 svm_fifo_segment_main_t *ssm = &svm_fifo_segment_main;
79 return pool_elt_at_index (ssm->segments, segment_index);
83 svm_fifo_segment_has_fifos (svm_fifo_segment_private_t * fifo_segment)
85 return fifo_segment->h->fifos != 0;
88 static inline svm_fifo_t *
89 svm_fifo_segment_get_fifo_list (svm_fifo_segment_private_t * fifo_segment)
91 return fifo_segment->h->fifos;
94 int svm_fifo_segment_init (svm_fifo_segment_private_t * s);
95 int svm_fifo_segment_create (svm_fifo_segment_create_args_t * a);
96 int svm_fifo_segment_create_process_private (svm_fifo_segment_create_args_t
98 void svm_fifo_segment_preallocate_fifo_pairs (svm_fifo_segment_private_t * s,
102 int svm_fifo_segment_attach (svm_fifo_segment_create_args_t * a);
103 void svm_fifo_segment_delete (svm_fifo_segment_private_t * s);
105 svm_fifo_t *svm_fifo_segment_alloc_fifo (svm_fifo_segment_private_t * s,
106 u32 data_size_in_bytes,
107 svm_fifo_segment_freelist_t index);
108 void svm_fifo_segment_free_fifo (svm_fifo_segment_private_t * s,
110 svm_fifo_segment_freelist_t index);
111 void svm_fifo_segment_main_init (u64 baseva, u32 timeout_in_seconds);
112 u32 svm_fifo_segment_index (svm_fifo_segment_private_t * s);
113 u32 svm_fifo_segment_num_fifos (svm_fifo_segment_private_t * fifo_segment);
114 u32 svm_fifo_segment_num_free_fifos (svm_fifo_segment_private_t *
115 fifo_segment, u32 fifo_size_in_bytes);
116 void svm_fifo_segment_info (svm_fifo_segment_private_t * seg, uword * address,
119 svm_fifo_segment_private_t *svm_fifo_segment_segments_pool (void);
121 format_function_t format_svm_fifo_segment;
122 format_function_t format_svm_fifo_segment_type;
124 #endif /* __included_ssvm_fifo_segment_h__ */
127 * fd.io coding-style-patch-verification: ON
130 * eval: (c-set-style "gnu")