/* * Copyright (c) 2015 Cisco and/or its affiliates. * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. * You may obtain a copy of the License at: * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, software * distributed under the License is distributed on an "AS IS" BASIS, * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. * See the License for the specific language governing permissions and * limitations under the License. */ /* Copyright (c) 2001, 2002, 2003 Eliot Dresselhaus Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. */ #ifndef included_format_h #define included_format_h #include #include /* for CLIB_UNIX, etc. */ #include #include /* for ASSERT */ #include typedef u8 *(format_function_t) (u8 * s, va_list * args); u8 *va_format (u8 * s, const char *format, va_list * args); u8 *format (u8 * s, const char *format, ...); #ifdef CLIB_UNIX #include #else /* ! CLIB_UNIX */ /* We're not Unix and have not stdio.h */ #define FILE void #define stdin ((FILE *) 0) #define stdout ((FILE *) 1) #define stderr ((FILE *) 2) #endif word va_fformat (FILE * f, char *fmt, va_list * va); word fformat (FILE * f, char *fmt, ...); word fdformat (int fd, char *fmt, ...); always_inline u32 format_get_indent (u8 * s) { u32 indent = 0; u8 *nl; if (!s) return indent; nl = vec_end (s) - 1; while (nl >= s) { if (*nl-- == '\n') break; indent++; } return indent; } #define _(f) u8 * f (u8 * s, va_list * va) /* Standard user-defined formats. */ _(format_vec32); _(format_vec_uword); _(format_ascii_bytes); _(format_hex_bytes); _(format_hex_bytes_no_wrap); _(format_white_space); _(format_f64); _(format_time_interval); #ifdef CLIB_UNIX /* Unix specific formats. */ _(format_address_family); _(format_unix_arphrd); _(format_unix_interface_flags); _(format_network_address); _(format_network_protocol); _(format_network_port); _(format_sockaddr); _(format_ip4_tos_byte); _(format_ip4_packet); _(format_icmp4_type_and_code); _(format_ethernet_packet); _(format_hostname); _(format_timeval); _(format_time_float); _(format_signal); _(format_ucontext_pc); _(format_page_map); #endif #undef _ /* Unformat. */ typedef struct _unformat_input_t { /* Input buffer (vector). */ u8 *buffer; /* Current index in input buffer. */ uword index; /* Vector of buffer marks. Used to delineate pieces of the buffer for error reporting and for parse recovery. */ uword *buffer_marks; /* User's function to fill the buffer when its empty (and argument). */ uword (*fill_buffer) (struct _unformat_input_t * i); /* Return values for fill buffer function which indicate whether not input has been exhausted. */ #define UNFORMAT_END_OF_INPUT (~0) #define UNFORMAT_MORE_INPUT 0 /* User controlled argument to fill buffer function. */ void *fill_buffer_arg; } unformat_input_t; always_inline void unformat_init (unformat_input_t * i, uword (*fill_buffer) (unformat_input_t *), void *fill_buffer_arg) { clib_memset (i, 0, sizeof (i[0])); i->fill_buffer = fill_buffer; i->fill_buffer_arg = fill_buffer_arg; } always_inline void unformat_free (unformat_input_t * i) { vec_free (i->buffer); vec_free (i->buffer_marks); clib_memset (i, 0, sizeof (i[0])); } always_inline uword unformat_check_input (unformat_input_t * i) { /* Low level fill input function. */ extern uword _unformat_fill_input (unformat_input_t * i); if (i->index >= vec_len (i->buffer) && i->index != UNFORMAT_END_OF_INPUT) _unformat_fill_input (i); return i->index; } /* Return true if input is exhausted */ always_inline uword unformat_is_eof (unformat_input_t * input) { return unformat_check_input (input) == UNFORMAT_END_OF_INPUT; } /* Return next element in input vector, possibly calling fill input to get more. */ always_inline uword unformat_get_input (unformat_input_t * input) { uword i = unformat_check_input (input); if (i < vec_len (input->buffer)) { input->index = i + 1; i = input->buffer[i]; } return i; } /* Back up input pointer by one. */ always_inline void unformat_put_input (unformat_input_t * input) { input->index -= 1; } /* Peek current input character without advancing. */ always_inline uword unformat_peek_input (unformat_input_t * input) { uword c = unformat_get_input (input); if (c != UNFORMAT_END_O