FD.io VPP  v17.04-9-g99c0734
Vector Packet Processing
svm_fifo_segment.h
Go to the documentation of this file.
1 /*
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:
6  *
7  * http://www.apache.org/licenses/LICENSE-2.0
8  *
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.
14  */
15 #ifndef __included_ssvm_fifo_segment_h__
16 #define __included_ssvm_fifo_segment_h__
17 
18 #include "svm_fifo.h"
19 #include "ssvm.h"
20 
21 typedef struct
22 {
23  volatile svm_fifo_t **fifos;
26 
27 typedef struct
28 {
32 
33 typedef struct
34 {
35  /** pool of segments */
37  /* Where to put the next one */
41 
43 
44 typedef struct
45 {
46  char *segment_name;
50 
51 static inline svm_fifo_segment_private_t *
52 svm_fifo_get_segment (u32 segment_index)
53 {
55  return vec_elt_at_index (ssm->segments, segment_index);
56 }
57 
58 #define foreach_ssvm_fifo_segment_api_error \
59 _(OUT_OF_SPACE, "Out of space in segment", -200)
60 
61 typedef enum
62 {
63 #define _(n,s,c) SSVM_FIFO_SEGMENT_API_ERROR_##n = c,
65 #undef _
67 
71 
73  u32 data_size_in_bytes);
75  svm_fifo_t * f);
76 
77 void svm_fifo_segment_init (u64 baseva, u32 timeout_in_seconds);
78 
80 
81 #endif /* __included_ssvm_fifo_segment_h__ */
82 
83 /*
84  * fd.io coding-style-patch-verification: ON
85  *
86  * Local Variables:
87  * eval: (c-set-style "gnu")
88  * End:
89  */
ssvm_fifo_segment_api_error_enum_t
a
Definition: bitmap.h:516
svm_fifo_t * svm_fifo_segment_alloc_fifo(svm_fifo_segment_private_t *s, u32 data_size_in_bytes)
u32 svm_fifo_segment_index(svm_fifo_segment_private_t *s)
#define vec_elt_at_index(v, i)
Get vector value at index i checking that i is in bounds.
unsigned long u64
Definition: types.h:89
void svm_fifo_segment_free_fifo(svm_fifo_segment_private_t *s, svm_fifo_t *f)
void svm_fifo_segment_delete(svm_fifo_segment_private_t *s)
svm_fifo_segment_main_t svm_fifo_segment_main
svm_fifo_segment_header_t * h
#define foreach_ssvm_fifo_segment_api_error
int svm_fifo_segment_create(svm_fifo_segment_create_args_t *a)
(master) create an svm fifo segment
static svm_fifo_segment_private_t * svm_fifo_get_segment(u32 segment_index)
unsigned int u32
Definition: types.h:88
void svm_fifo_segment_init(u64 baseva, u32 timeout_in_seconds)
int svm_fifo_segment_attach(svm_fifo_segment_create_args_t *a)
(slave) attach to an svm fifo segment
svm_fifo_segment_private_t * segments
pool of segments
unsigned char u8
Definition: types.h:56
volatile svm_fifo_t ** fifos