2 * Copyright (c) 2017 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 SRC_VNET_SESSION_SEGMENT_MANAGER_H_
16 #define SRC_VNET_SESSION_SEGMENT_MANAGER_H_
18 #include <vnet/vnet.h>
19 #include <svm/svm_fifo_segment.h>
21 #include <vlibmemory/unix_shared_memory_queue.h>
22 #include <vlibmemory/api.h>
23 #include <vppinfra/lock.h>
25 typedef struct _segment_manager_properties
27 /** Session fifo sizes. */
31 /** Preallocated pool sizes */
32 u32 preallocated_fifo_pairs;
34 /** Configured additional segment size */
37 /** Flag that indicates if additional segments should be created */
40 /** Use private memory segment instead of shared memory */
41 u8 use_private_segment;
43 /** Use one or more private mheaps, instead of the global heap */
44 u32 private_segment_count;
45 } segment_manager_properties_t;
47 typedef struct _segment_manager
49 clib_spinlock_t lockp;
51 /** segments mapped by this manager */
54 /** Owner app index */
58 * Pointer to manager properties. Could be shared among all of
59 * an app's segment managers s
64 * First segment should not be deleted unless segment manger is deleted.
65 * This also indicates that the segment manager is the first to have been
66 * allocated for the app.
68 u8 first_is_protected;
71 #define SEGMENT_MANAGER_INVALID_APP_INDEX ((u32) ~0)
73 /** Pool of segment managers */
74 extern segment_manager_t *segment_managers;
76 always_inline segment_manager_t *
77 segment_manager_get (u32 index)
79 return pool_elt_at_index (segment_managers, index);
82 always_inline segment_manager_t *
83 segment_manager_get_if_valid (u32 index)
85 if (pool_is_free_index (segment_managers, index))
87 return pool_elt_at_index (segment_managers, index);
91 segment_manager_index (segment_manager_t * sm)
93 return sm - segment_managers;
96 segment_manager_t *segment_manager_new ();
98 segment_manager_init (segment_manager_t * sm, u32 props_index, u32 seg_size);
100 void segment_manager_get_segment_info (u32 index, u8 ** name, u32 * size);
102 session_manager_add_first_segment (segment_manager_t * sm, u32 segment_size);
103 int session_manager_add_segment (segment_manager_t * sm);
104 void segment_manager_del_sessions (segment_manager_t * sm);
105 void segment_manager_del (segment_manager_t * sm);
106 void segment_manager_init_del (segment_manager_t * sm);
107 u8 segment_manager_has_fifos (segment_manager_t * sm);
109 segment_manager_alloc_session_fifos (segment_manager_t * sm,
110 svm_fifo_t ** server_rx_fifo,
111 svm_fifo_t ** server_tx_fifo,
112 u32 * fifo_segment_index);
114 segment_manager_dealloc_fifos (u32 svm_segment_index, svm_fifo_t * rx_fifo,
115 svm_fifo_t * tx_fifo);
116 unix_shared_memory_queue_t *segment_manager_alloc_queue (segment_manager_t *
118 void segment_manager_dealloc_queue (segment_manager_t * sm,
119 unix_shared_memory_queue_t * q);
120 void segment_manager_app_detach (segment_manager_t * sm);
122 segment_manager_properties_t *segment_manager_properties_alloc (void);
123 void segment_manager_properties_free (segment_manager_properties_t * p);
124 segment_manager_properties_t *segment_manager_properties_get (u32 smp_index);
125 u32 segment_manager_properties_index (segment_manager_properties_t * p);
127 #endif /* SRC_VNET_SESSION_SEGMENT_MANAGER_H_ */
129 * fd.io coding-style-patch-verification: ON
132 * eval: (c-set-style "gnu")