FD.io VPP  v19.04.4-rc0-5-ge88582fac
Vector Packet Processing
edit.h
Go to the documentation of this file.
1 /*
2  * Copyright (c) 2015 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 /*
16  * pg_edit.h: packet generator edits
17  *
18  * Copyright (c) 2008 Eliot Dresselhaus
19  *
20  * Permission is hereby granted, free of charge, to any person obtaining
21  * a copy of this software and associated documentation files (the
22  * "Software"), to deal in the Software without restriction, including
23  * without limitation the rights to use, copy, modify, merge, publish,
24  * distribute, sublicense, and/or sell copies of the Software, and to
25  * permit persons to whom the Software is furnished to do so, subject to
26  * the following conditions:
27  *
28  * The above copyright notice and this permission notice shall be
29  * included in all copies or substantial portions of the Software.
30  *
31  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
32  * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
33  * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
34  * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
35  * LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
36  * OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
37  * WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
38  */
39 
40 #ifndef included_packet_generator_pg_edit_h
41 #define included_packet_generator_pg_edit_h
42 
43 #include <vppinfra/format.h>
44 #include <vppinfra/vec.h>
45 
46 typedef enum
47 {
48  /* Invalid type used to poison edits. */
50 
51  /* Value is fixed: does not change for all packets in sequence. */
53 
54  /* Value v increments between low and high values v_low <= v <= v_high. */
56 
57  /* Random value between low and high values v_low <= v <= v_high. */
59 
60  /* Unspecified value; will be specified by some edit function. */
63 
64 typedef struct
65 {
67 
68  /* Bit offset within packet where value is to be written.
69  Bits are written in network byte order: high bits first.
70  This is the bit offset of the least significant bit: i.e. the
71  highest numbered byte * 8 plus bit offset within that byte.
72  Negative offsets encode special edits. */
74 
75  /* Special offset indicating this edit is for packet length. */
76 #define PG_EDIT_PACKET_LENGTH (-1)
77 
78  /* Number of bits in edit. */
80 
81  /* Low and high values for this edit. Network byte order. */
82  u8 *values[2];
83 #define PG_EDIT_LO 0
84 #define PG_EDIT_HI 1
85 
86  /* Last value used for increment edit type. */
88 } pg_edit_t;
89 
90 always_inline void
92 {
93  int i;
94  for (i = 0; i < ARRAY_LEN (e->values); i++)
95  vec_free (e->values[i]);
96 }
97 
98 #define pg_edit_init_bitfield(e,type,field,field_offset,field_n_bits) \
99 do { \
100  u32 _bo; \
101  \
102  ASSERT ((field_offset) < STRUCT_BITS_OF (type, field)); \
103  \
104  /* Start byte offset. */ \
105  _bo = STRUCT_OFFSET_OF (type, field); \
106  \
107  /* Adjust for big endian byte order. */ \
108  _bo += ((STRUCT_BITS_OF (type, field) \
109  - (field_offset) - 1) / BITS (u8)); \
110  \
111  (e)->lsb_bit_offset = _bo * BITS (u8) + ((field_offset) % BITS (u8)); \
112  (e)->n_bits = (field_n_bits); \
113 } while (0)
114 
115 /* Initialize edit for byte aligned fields. */
116 #define pg_edit_init(e,type,field) \
117  pg_edit_init_bitfield(e,type,field,0,STRUCT_BITS_OF(type,field))
118 
119 static inline uword
121 {
122  int i0, i1, n_bytes, n_bits_left;
123 
124  i0 = e->lsb_bit_offset;
125  i1 = i0 % BITS (u8);
126 
127  n_bytes = 0;
128  n_bits_left = e->n_bits;
129 
130  if (n_bits_left > 0 && i1 != 0)
131  {
132  n_bytes++;
133  n_bits_left -= i1;
134  if (n_bits_left < 0)
135  n_bits_left = 0;
136  }
137 
138  n_bytes += (n_bits_left / BITS (u8));
139  n_bytes += (n_bits_left % BITS (u8)) != 0;
140 
141  return n_bytes;
142 }
143 
144 static inline void
146 {
147  vec_validate (e->values[i], e->lsb_bit_offset / BITS (u8));
148 }
149 
150 extern void pg_edit_set_value (pg_edit_t * e, int hi_or_lo, u64 value);
151 
152 static inline void
154 {
155  e->type = PG_EDIT_FIXED;
156  pg_edit_set_value (e, PG_EDIT_LO, value);
157 }
158 
159 static inline void
161 {
162  int i;
163  dst->type = src->type;
164  src->type = PG_EDIT_INVALID_TYPE;
165  for (i = 0; i < ARRAY_LEN (dst->values); i++)
166  {
167  dst->values[i] = src->values[i];
168  src->values[i] = 0;
169  }
170 }
171 
172 static inline u64
173 pg_edit_get_value (pg_edit_t * e, int hi_or_lo)
174 {
175  u64 r = 0;
176  int i, n;
177  u8 *v = e->values[hi_or_lo];
178 
179  n = round_pow2 (e->n_bits, BITS (u8)) / BITS (u8);
180 
181  ASSERT (n <= vec_len (v));
182  ASSERT (n <= sizeof (r));
183 
184  for (i = 0; i < n; i++)
185  r = (r << BITS (v[i])) + v[i];
186 
187  return r;
188 }
189 
190 static inline uword
192 {
193  return (e->type == PG_EDIT_FIXED
194  && value == pg_edit_get_value (e, PG_EDIT_LO));
195 }
196 
197 uword unformat_pg_edit (unformat_input_t * input, va_list * args);
198 uword unformat_pg_payload (unformat_input_t * input, va_list * args);
199 uword unformat_pg_number (unformat_input_t * input, va_list * args);
200 uword unformat_pg_interface (unformat_input_t * input, va_list * args);
201 
202 #endif /* included_packet_generator_pg_edit_h */
203 
204 /*
205  * fd.io coding-style-patch-verification: ON
206  *
207  * Local Variables:
208  * eval: (c-set-style "gnu")
209  * End:
210  */
#define vec_validate(V, I)
Make sure vector is long enough for given index (no header, unspecified alignment) ...
Definition: vec.h:439
Definition: edit.h:64
#define PG_EDIT_LO
Definition: edit.h:83
static void pg_edit_set_fixed(pg_edit_t *e, u64 value)
Definition: edit.h:153
unsigned long u64
Definition: types.h:89
pg_edit_type_t
Definition: edit.h:46
static void pg_edit_alloc_value(pg_edit_t *e, int i)
Definition: edit.h:145
int i
u64 last_increment_value
Definition: edit.h:87
vl_api_ip4_address_t dst
Definition: ipsec_gre.api:39
static void pg_edit_copy_type_and_values(pg_edit_t *dst, pg_edit_t *src)
Definition: edit.h:160
unsigned char u8
Definition: types.h:56
#define always_inline
Definition: clib.h:98
pg_edit_type_t type
Definition: edit.h:66
i32 lsb_bit_offset
Definition: edit.h:73
unsigned int u32
Definition: types.h:88
u8 * values[2]
Definition: edit.h:82
uword unformat_pg_number(unformat_input_t *input, va_list *args)
Definition: edit.c:85
struct _unformat_input_t unformat_input_t
static u64 pg_edit_get_value(pg_edit_t *e, int hi_or_lo)
Definition: edit.h:173
vl_api_ip4_address_t src
Definition: ipsec_gre.api:38
u32 n_bits
Definition: edit.h:79
static uword pg_edit_is_fixed_with_value(pg_edit_t *e, u64 value)
Definition: edit.h:191
#define vec_free(V)
Free vector&#39;s memory (no header).
Definition: vec.h:341
uword unformat_pg_edit(unformat_input_t *input, va_list *args)
Definition: edit.c:106
void pg_edit_set_value(pg_edit_t *e, int hi_or_lo, u64 value)
Definition: edit.c:77
#define ARRAY_LEN(x)
Definition: clib.h:62
static uword round_pow2(uword x, uword pow2)
Definition: clib.h:241
signed int i32
Definition: types.h:77
#define ASSERT(truth)
uword unformat_pg_payload(unformat_input_t *input, va_list *args)
Definition: edit.c:127
uword unformat_pg_interface(unformat_input_t *input, va_list *args)
static uword pg_edit_n_alloc_bytes(pg_edit_t *e)
Definition: edit.h:120
#define vec_len(v)
Number of elements in vector (rvalue-only, NULL tolerant)
u64 uword
Definition: types.h:112
static void pg_edit_free(pg_edit_t *e)
Definition: edit.h:91
#define BITS(x)
Definition: clib.h:61
CLIB vectors are ubiquitous dynamically resized arrays with by user defined "headers".