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:
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.
16 * pg_edit.h: packet generator edits
18 * Copyright (c) 2008 Eliot Dresselhaus
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:
28 * The above copyright notice and this permission notice shall be
29 * included in all copies or substantial portions of the Software.
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.
40 #ifndef included_packet_generator_pg_edit_h
41 #define included_packet_generator_pg_edit_h
43 #include <vppinfra/format.h>
44 #include <vppinfra/vec.h>
47 /* Invalid type used to poison edits. */
50 /* Value is fixed: does not change for all packets in sequence. */
53 /* Value v increments between low and high values v_low <= v <= v_high. */
56 /* Random value between low and high values v_low <= v <= v_high. */
59 /* Unspecified value; will be specified by some edit function. */
66 /* Bit offset within packet where value is to be written.
67 Bits are written in network byte order: high bits first.
68 This is the bit offset of the least significant bit: i.e. the
69 highest numbered byte * 8 plus bit offset within that byte.
70 Negative offsets encode special edits. */
73 /* Special offset indicating this edit is for packet length. */
74 #define PG_EDIT_PACKET_LENGTH (-1)
76 /* Number of bits in edit. */
79 /* Low and high values for this edit. Network byte order. */
84 /* Last value used for increment edit type. */
85 u64 last_increment_value;
89 pg_edit_free (pg_edit_t * e)
92 for (i = 0; i < ARRAY_LEN (e->values); i++)
93 vec_free (e->values[i]);
96 #define pg_edit_init_bitfield(e,type,field,field_offset,field_n_bits) \
100 ASSERT ((field_offset) < STRUCT_BITS_OF (type, field)); \
102 /* Start byte offset. */ \
103 _bo = STRUCT_OFFSET_OF (type, field); \
105 /* Adjust for big endian byte order. */ \
106 _bo += ((STRUCT_BITS_OF (type, field) \
107 - (field_offset) - 1) / BITS (u8)); \
109 (e)->lsb_bit_offset = _bo * BITS (u8) + ((field_offset) % BITS (u8)); \
110 (e)->n_bits = (field_n_bits); \
113 /* Initialize edit for byte aligned fields. */
114 #define pg_edit_init(e,type,field) \
115 pg_edit_init_bitfield(e,type,field,0,STRUCT_BITS_OF(type,field))
118 pg_edit_n_alloc_bytes (pg_edit_t * e)
120 int i0, i1, n_bytes, n_bits_left;
122 i0 = e->lsb_bit_offset;
126 n_bits_left = e->n_bits;
128 if (n_bits_left > 0 && i1 != 0)
136 n_bytes += (n_bits_left / BITS (u8));
137 n_bytes += (n_bits_left % BITS (u8)) != 0;
143 pg_edit_alloc_value (pg_edit_t * e, int i)
144 { vec_validate (e->values[i], e->lsb_bit_offset / BITS (u8)); }
146 extern void pg_edit_set_value (pg_edit_t * e, int hi_or_lo, u64 value);
149 pg_edit_set_fixed (pg_edit_t * e, u64 value)
151 e->type = PG_EDIT_FIXED;
152 pg_edit_set_value (e, PG_EDIT_LO, value);
156 pg_edit_copy_type_and_values (pg_edit_t * dst, pg_edit_t * src)
159 dst->type = src->type;
160 src->type = PG_EDIT_INVALID_TYPE;
161 for (i = 0; i < ARRAY_LEN (dst->values); i++)
163 dst->values[i] = src->values[i];
169 pg_edit_get_value (pg_edit_t * e, int hi_or_lo)
173 u8 * v = e->values[hi_or_lo];
175 n = round_pow2 (e->n_bits, BITS (u8)) / BITS (u8);
177 ASSERT (n <= vec_len (v));
178 ASSERT (n <= sizeof (r));
180 for (i = 0; i < n; i++)
181 r = (r << BITS (v[i])) + v[i];
187 pg_edit_is_fixed_with_value (pg_edit_t * e, u64 value)
189 return (e->type == PG_EDIT_FIXED
190 && value == pg_edit_get_value (e, PG_EDIT_LO));
193 uword unformat_pg_edit (unformat_input_t * input, va_list * args);
194 uword unformat_pg_payload (unformat_input_t * input, va_list * args);
195 uword unformat_pg_number (unformat_input_t * input, va_list * args);
196 uword unformat_pg_interface (unformat_input_t * input, va_list * args);
198 #endif /* included_packet_generator_pg_edit_h */