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 Copyright (c) 2001, 2002, 2003 Eliot Dresselhaus
18 Permission is hereby granted, free of charge, to any person obtaining
19 a copy of this software and associated documentation files (the
20 "Software"), to deal in the Software without restriction, including
21 without limitation the rights to use, copy, modify, merge, publish,
22 distribute, sublicense, and/or sell copies of the Software, and to
23 permit persons to whom the Software is furnished to do so, subject to
24 the following conditions:
26 The above copyright notice and this permission notice shall be
27 included in all copies or substantial portions of the Software.
29 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
30 EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
31 MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
32 NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
33 LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
34 OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
35 WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
38 #ifndef included_format_h
39 #define included_format_h
43 #include <vppinfra/clib.h> /* for CLIB_UNIX, etc. */
44 #include <vppinfra/vec.h>
45 #include <vppinfra/error.h> /* for ASSERT */
46 #include <vppinfra/string.h>
48 typedef u8 *(format_function_t) (u8 * s, va_list * args);
50 u8 *va_format (u8 * s, const char *format, va_list * args);
51 u8 *format (u8 * s, const char *format, ...);
57 #else /* ! CLIB_UNIX */
59 /* We're not Unix and have not stdio.h */
61 #define stdin ((FILE *) 0)
62 #define stdout ((FILE *) 1)
63 #define stderr ((FILE *) 2)
67 word va_fformat (FILE * f, char *fmt, va_list * va);
68 word fformat (FILE * f, char *fmt, ...);
69 word fdformat (int fd, char *fmt, ...);
72 format_get_indent (u8 * s)
90 #define _(f) u8 * f (u8 * s, va_list * va)
92 /* Standard user-defined formats. */
95 _(format_ascii_bytes);
97 _(format_hex_bytes_no_wrap);
98 _(format_white_space);
100 _(format_time_interval);
103 /* Unix specific formats. */
104 _(format_address_family);
105 _(format_unix_arphrd);
106 _(format_unix_interface_flags);
107 _(format_network_address);
108 _(format_network_protocol);
109 _(format_network_port);
111 _(format_ip4_tos_byte);
112 _(format_ip4_packet);
113 _(format_icmp4_type_and_code);
114 _(format_ethernet_packet);
117 _(format_time_float);
119 _(format_ucontext_pc);
127 typedef struct _unformat_input_t
129 /* Input buffer (vector). */
132 /* Current index in input buffer. */
135 /* Vector of buffer marks. Used to delineate pieces of the buffer
136 for error reporting and for parse recovery. */
139 /* User's function to fill the buffer when its empty
141 uword (*fill_buffer) (struct _unformat_input_t * i);
143 /* Return values for fill buffer function which indicate whether not
144 input has been exhausted. */
145 #define UNFORMAT_END_OF_INPUT (~0)
146 #define UNFORMAT_MORE_INPUT 0
148 /* User controlled argument to fill buffer function. */
149 void *fill_buffer_arg;
153 unformat_init (unformat_input_t * i,
154 uword (*fill_buffer) (unformat_input_t *),
155 void *fill_buffer_arg)
157 clib_memset (i, 0, sizeof (i[0]));
158 i->fill_buffer = fill_buffer;
159 i->fill_buffer_arg = fill_buffer_arg;
163 unformat_free (unformat_input_t * i)
165 vec_free (i->buffer);
166 vec_free (i->buffer_marks);
167 clib_memset (i, 0, sizeof (i[0]));
171 unformat_check_input (unformat_input_t * i)
173 /* Low level fill input function. */
174 extern uword _unformat_fill_input (unformat_input_t * i);
176 if (i->index >= vec_len (i->buffer) && i->index != UNFORMAT_END_OF_INPUT)
177 _unformat_fill_input (i);
182 /* Return true if input is exhausted */
184 unformat_is_eof (unformat_input_t * input)
186 return unformat_check_input (input) == UNFORMAT_END_OF_INPUT;
189 /* Return next element in input vector,
190 possibly calling fill input to get more. */
192 unformat_get_input (unformat_input_t * input)
194 uword i = unformat_check_input (input);
195 if (i < vec_len (input->buffer))
197 input->index = i + 1;
198 i = input->buffer[i];
203 /* Back up input pointer by one. */
205 unformat_put_input (unformat_input_t * input)
210 /* Peek current input character without advancing. */
212 unformat_peek_input (unformat_input_t * input)
214 uword c = unformat_get_input (input);
215 if (c != UNFORMAT_END_OF_INPUT)
216 unformat_put_input (input);
220 /* Skip current input line. */
222 unformat_skip_line (unformat_input_t * i)
226 while ((c = unformat_get_input (i)) != UNFORMAT_END_OF_INPUT && c != '\n')
230 uword unformat_skip_white_space (unformat_input_t * input);
232 /* Unformat function. */
233 typedef uword (unformat_function_t) (unformat_input_t * input,
236 /* External functions. */
238 /* General unformatting function with programmable input stream. */
239 uword unformat (unformat_input_t * i, const char *fmt, ...);
241 /* Call user defined parse function.
242 unformat_user (i, f, ...) is equivalent to unformat (i, "%U", f, ...) */
243 uword unformat_user (unformat_input_t * input, unformat_function_t * func,
246 /* Alternate version which allows for extensions. */
247 uword va_unformat (unformat_input_t * i, const char *fmt, va_list * args);
249 /* Setup for unformat of Unix style command line. */
250 void unformat_init_command_line (unformat_input_t * input, char *argv[]);
252 /* Setup for unformat of given string. */
253 void unformat_init_string (unformat_input_t * input,
254 char *string, int string_len);
257 unformat_init_cstring (unformat_input_t * input, char *string)
259 unformat_init_string (input, string, strlen (string));
262 /* Setup for unformat of given vector string; vector will be freed by unformat_string. */
263 void unformat_init_vector (unformat_input_t * input, u8 * vector_string);
265 /* Format function for unformat input usable when an unformat error
267 u8 *format_unformat_error (u8 * s, va_list * va);
269 #define unformat_parse_error(input) \
270 clib_error_return (0, "parse error `%U'", format_unformat_error, input)
272 /* Print all input: not just error context. */
273 u8 *format_unformat_input (u8 * s, va_list * va);
275 /* Unformat (parse) function which reads a %s string and converts it
276 to and unformat_input_t. */
277 unformat_function_t unformat_input;
279 /* Parse a line ending with \n and return it. */
280 unformat_function_t unformat_line;
282 /* Parse a line ending with \n and return it as an unformat_input_t. */
283 unformat_function_t unformat_line_input;
285 /* Parse a token containing given set of characters. */
286 unformat_function_t unformat_token;
288 /* Parses a hexstring into a vector of bytes. */
289 unformat_function_t unformat_hex_string;
291 /* Returns non-zero match if input is exhausted.
292 Useful to ensure that the entire input matches with no trailing junk. */
293 unformat_function_t unformat_eof;
295 /* Parse memory size e.g. 100, 100k, 100m, 100g. */
296 unformat_function_t unformat_memory_size;
298 /* Unparse memory size e.g. 100, 100k, 100m, 100g. */
299 u8 *format_memory_size (u8 * s, va_list * va);
301 /* Format c identifier: e.g. a_name -> "a name". */
302 u8 *format_c_identifier (u8 * s, va_list * va);
304 /* Format hexdump with both hex and printable chars - compatible with text2pcap */
305 u8 *format_hexdump (u8 * s, va_list * va);
307 /* Unix specific formats. */
309 /* Setup input from Unix file. */
310 void unformat_init_clib_file (unformat_input_t * input, int file_descriptor);
312 /* Take input from Unix environment variable; returns
313 1 if variable exists zero otherwise. */
314 uword unformat_init_unix_env (unformat_input_t * input, char *var);
316 /* Unformat unix group id (gid) specified as integer or string */
317 unformat_function_t unformat_unix_gid;
318 #endif /* CLIB_UNIX */
320 uword unformat_data_size (unformat_input_t * input, va_list * args);
323 int test_format_main (unformat_input_t * input);
324 int test_unformat_main (unformat_input_t * input);
326 /* This is not the right place for this, but putting it in vec.h
327 created circular dependency problems. */
328 int test_vec_main (unformat_input_t * input);
330 #endif /* included_format_h */
333 * fd.io coding-style-patch-verification: ON
336 * eval: (c-set-style "gnu")