Dave Barach | 68b0fb0 | 2017-02-28 15:15:56 -0500 | [diff] [blame] | 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 | |
Florin Coras | 6792ec0 | 2017-03-13 03:49:51 -0700 | [diff] [blame] | 18 | #include <svm/svm_fifo.h> |
| 19 | #include <svm/ssvm.h> |
Florin Coras | a546481 | 2017-04-19 13:00:05 -0700 | [diff] [blame] | 20 | #include <vppinfra/lock.h> |
Dave Barach | 68b0fb0 | 2017-02-28 15:15:56 -0500 | [diff] [blame] | 21 | |
Dave Barach | 10d8cc6 | 2017-05-30 09:30:07 -0400 | [diff] [blame] | 22 | typedef enum |
| 23 | { |
| 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; |
| 29 | |
Florin Coras | c87c91d | 2017-08-16 19:55:49 -0700 | [diff] [blame] | 30 | #define FIFO_SEGMENT_MIN_FIFO_SIZE 4096 |
Dave Barach | 818eb54 | 2017-08-02 13:56:13 -0400 | [diff] [blame] | 31 | #define FIFO_SEGMENT_MAX_FIFO_SIZE (8<<20) /* 8mb max fifo size */ |
Florin Coras | c87c91d | 2017-08-16 19:55:49 -0700 | [diff] [blame] | 32 | #define FIFO_SEGMENT_ALLOC_CHUNK_SIZE 32 /* Allocation quantum */ |
| 33 | |
| 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 */ |
Florin Coras | 9d06304 | 2017-09-14 03:08:00 -0400 | [diff] [blame] | 36 | #define FIFO_SEGMENT_F_IS_PREALLOCATED 1 << 2 /* Segment is preallocated */ |
Dave Barach | 818eb54 | 2017-08-02 13:56:13 -0400 | [diff] [blame] | 37 | |
Dave Barach | 68b0fb0 | 2017-02-28 15:15:56 -0500 | [diff] [blame] | 38 | typedef struct |
| 39 | { |
Dave Barach | 10d8cc6 | 2017-05-30 09:30:07 -0400 | [diff] [blame] | 40 | svm_fifo_t *fifos; /**< Linked list of active RX fifos */ |
| 41 | u8 *segment_name; /**< Segment name */ |
Dave Barach | 818eb54 | 2017-08-02 13:56:13 -0400 | [diff] [blame] | 42 | svm_fifo_t **free_fifos; /**< Freelists, by fifo size */ |
Florin Coras | c87c91d | 2017-08-16 19:55:49 -0700 | [diff] [blame] | 43 | u32 n_active_fifos; /**< Number of active fifos */ |
| 44 | u8 flags; /**< Segment flags */ |
Dave Barach | 68b0fb0 | 2017-02-28 15:15:56 -0500 | [diff] [blame] | 45 | } svm_fifo_segment_header_t; |
| 46 | |
| 47 | typedef struct |
| 48 | { |
| 49 | ssvm_private_t ssvm; |
| 50 | svm_fifo_segment_header_t *h; |
| 51 | } svm_fifo_segment_private_t; |
| 52 | |
| 53 | typedef struct |
| 54 | { |
Florin Coras | a546481 | 2017-04-19 13:00:05 -0700 | [diff] [blame] | 55 | volatile u32 lock; |
| 56 | |
Dave Barach | 68b0fb0 | 2017-02-28 15:15:56 -0500 | [diff] [blame] | 57 | /** pool of segments */ |
| 58 | svm_fifo_segment_private_t *segments; |
| 59 | /* Where to put the next one */ |
| 60 | u64 next_baseva; |
| 61 | u32 timeout_in_seconds; |
| 62 | } svm_fifo_segment_main_t; |
| 63 | |
| 64 | extern svm_fifo_segment_main_t svm_fifo_segment_main; |
| 65 | |
| 66 | typedef struct |
| 67 | { |
| 68 | char *segment_name; |
| 69 | u32 segment_size; |
Dave Barach | 2c25a62 | 2017-06-26 11:35:07 -0400 | [diff] [blame] | 70 | u32 *new_segment_indices; |
Dave Barach | 10d8cc6 | 2017-05-30 09:30:07 -0400 | [diff] [blame] | 71 | u32 rx_fifo_size; |
| 72 | u32 tx_fifo_size; |
| 73 | u32 preallocated_fifo_pairs; |
Dave Barach | 2c25a62 | 2017-06-26 11:35:07 -0400 | [diff] [blame] | 74 | u32 private_segment_count; |
Dave Barach | 68b0fb0 | 2017-02-28 15:15:56 -0500 | [diff] [blame] | 75 | } svm_fifo_segment_create_args_t; |
| 76 | |
| 77 | static inline svm_fifo_segment_private_t * |
Florin Coras | c87c91d | 2017-08-16 19:55:49 -0700 | [diff] [blame] | 78 | svm_fifo_segment_get_segment (u32 segment_index) |
Dave Barach | 68b0fb0 | 2017-02-28 15:15:56 -0500 | [diff] [blame] | 79 | { |
| 80 | svm_fifo_segment_main_t *ssm = &svm_fifo_segment_main; |
| 81 | return vec_elt_at_index (ssm->segments, segment_index); |
| 82 | } |
| 83 | |
Florin Coras | 6cf30ad | 2017-04-04 23:08:23 -0700 | [diff] [blame] | 84 | static inline u8 |
| 85 | svm_fifo_segment_has_fifos (svm_fifo_segment_private_t * fifo_segment) |
| 86 | { |
Dave Barach | 10d8cc6 | 2017-05-30 09:30:07 -0400 | [diff] [blame] | 87 | return fifo_segment->h->fifos != 0; |
Florin Coras | 6cf30ad | 2017-04-04 23:08:23 -0700 | [diff] [blame] | 88 | } |
| 89 | |
Dave Barach | 10d8cc6 | 2017-05-30 09:30:07 -0400 | [diff] [blame] | 90 | static inline svm_fifo_t * |
| 91 | svm_fifo_segment_get_fifo_list (svm_fifo_segment_private_t * fifo_segment) |
Florin Coras | 6cf30ad | 2017-04-04 23:08:23 -0700 | [diff] [blame] | 92 | { |
Dave Barach | 10d8cc6 | 2017-05-30 09:30:07 -0400 | [diff] [blame] | 93 | return fifo_segment->h->fifos; |
Florin Coras | 6cf30ad | 2017-04-04 23:08:23 -0700 | [diff] [blame] | 94 | } |
| 95 | |
Dave Barach | 68b0fb0 | 2017-02-28 15:15:56 -0500 | [diff] [blame] | 96 | #define foreach_ssvm_fifo_segment_api_error \ |
| 97 | _(OUT_OF_SPACE, "Out of space in segment", -200) |
| 98 | |
| 99 | typedef enum |
| 100 | { |
| 101 | #define _(n,s,c) SSVM_FIFO_SEGMENT_API_ERROR_##n = c, |
| 102 | foreach_ssvm_fifo_segment_api_error |
| 103 | #undef _ |
| 104 | } ssvm_fifo_segment_api_error_enum_t; |
| 105 | |
| 106 | int svm_fifo_segment_create (svm_fifo_segment_create_args_t * a); |
Florin Coras | a546481 | 2017-04-19 13:00:05 -0700 | [diff] [blame] | 107 | int svm_fifo_segment_create_process_private (svm_fifo_segment_create_args_t |
| 108 | * a); |
Dave Barach | 68b0fb0 | 2017-02-28 15:15:56 -0500 | [diff] [blame] | 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); |
| 111 | |
| 112 | svm_fifo_t *svm_fifo_segment_alloc_fifo (svm_fifo_segment_private_t * s, |
Dave Barach | 10d8cc6 | 2017-05-30 09:30:07 -0400 | [diff] [blame] | 113 | u32 data_size_in_bytes, |
| 114 | svm_fifo_segment_freelist_t index); |
Dave Barach | 68b0fb0 | 2017-02-28 15:15:56 -0500 | [diff] [blame] | 115 | void svm_fifo_segment_free_fifo (svm_fifo_segment_private_t * s, |
Dave Barach | 10d8cc6 | 2017-05-30 09:30:07 -0400 | [diff] [blame] | 116 | svm_fifo_t * f, |
| 117 | svm_fifo_segment_freelist_t index); |
Dave Barach | 68b0fb0 | 2017-02-28 15:15:56 -0500 | [diff] [blame] | 118 | void svm_fifo_segment_init (u64 baseva, u32 timeout_in_seconds); |
Dave Barach | 68b0fb0 | 2017-02-28 15:15:56 -0500 | [diff] [blame] | 119 | u32 svm_fifo_segment_index (svm_fifo_segment_private_t * s); |
Florin Coras | c87c91d | 2017-08-16 19:55:49 -0700 | [diff] [blame] | 120 | u32 svm_fifo_segment_num_fifos (svm_fifo_segment_private_t * fifo_segment); |
Dave Barach | 91f3e74 | 2017-09-01 19:12:11 -0400 | [diff] [blame] | 121 | u32 svm_fifo_segment_num_free_fifos (svm_fifo_segment_private_t * |
| 122 | fifo_segment, u32 fifo_size_in_bytes); |
| 123 | |
Florin Coras | c87c91d | 2017-08-16 19:55:49 -0700 | [diff] [blame] | 124 | svm_fifo_segment_private_t *svm_fifo_segment_segments_pool (void); |
Dave Barach | 91f3e74 | 2017-09-01 19:12:11 -0400 | [diff] [blame] | 125 | format_function_t format_svm_fifo_segment; |
Dave Barach | 68b0fb0 | 2017-02-28 15:15:56 -0500 | [diff] [blame] | 126 | |
| 127 | #endif /* __included_ssvm_fifo_segment_h__ */ |
| 128 | |
| 129 | /* |
| 130 | * fd.io coding-style-patch-verification: ON |
| 131 | * |
| 132 | * Local Variables: |
| 133 | * eval: (c-set-style "gnu") |
| 134 | * End: |
| 135 | */ |