vppinfra/vppinfra/format.h

   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   Copyright (c) 2001, 2002, 2003 Eliot Dresselhaus
  17
  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:
  25
  26   The above copyright notice and this permission notice shall be
  27   included in all copies or substantial portions of the Software.
  28
  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.
  36 */
  37
  38 #ifndef included_format_h
  39 #define included_format_h
  40
  41 #include <stdarg.h>
  42
  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>
  47
  48 typedef u8 *(format_function_t) (u8 * s, va_list * args);
  49
  50 u8 *va_format (u8 * s, const char *format, va_list * args);
  51 u8 *format (u8 * s, const char *format, ...);
  52
  53 #ifdef CLIB_UNIX
  54
  55 #include <stdio.h>
  56
  57 #else /* ! CLIB_UNIX */
  58
  59 /* We're not Unix and have not stdio.h */
  60 #define FILE void
  61 #define stdin ((FILE *) 0)
  62 #define stdout ((FILE *) 1)
  63 #define stderr ((FILE *) 2)
  64
  65 #endif
  66
  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, ...);
  70
  71 always_inline uword
  72 format_get_indent (u8 * s)
  73 {
  74   uword indent = 0;
  75   u8 *nl;
  76
  77   if (!s)
  78     return indent;
  79
  80   nl = vec_end (s) - 1;
  81   while (nl >= s)
  82     {
  83       if (*nl-- == '\n')
  84         break;
  85       indent++;
  86     }
  87   return indent;
  88 }
  89
  90 #define _(f) u8 * f (u8 * s, va_list * va)
  91
  92 /* Standard user-defined formats. */
  93 _(format_vec32);
  94 _(format_vec_uword);
  95 _(format_ascii_bytes);
  96 _(format_hex_bytes);
  97 _(format_white_space);
  98 _(format_f64);
  99 _(format_time_interval);
 100
 101 #ifdef CLIB_UNIX
 102 /* Unix specific formats. */
 103 _(format_address_family);
 104 _(format_unix_arphrd);
 105 _(format_unix_interface_flags);
 106 _(format_network_address);
 107 _(format_network_protocol);
 108 _(format_network_port);
 109 _(format_sockaddr);
 110 _(format_ip4_tos_byte);
 111 _(format_ip4_packet);
 112 _(format_icmp4_type_and_code);
 113 _(format_ethernet_packet);
 114 _(format_hostname);
 115 _(format_timeval);
 116 _(format_time_float);
 117 _(format_signal);
 118 _(format_ucontext_pc);
 119 #endif
 120
 121 #undef _
 122
 123 /* Unformat. */
 124
 125 typedef struct _unformat_input_t
 126 {
 127   /* Input buffer (vector). */
 128   u8 *buffer;
 129
 130   /* Current index in input buffer. */
 131   uword index;
 132
 133   /* Vector of buffer marks.  Used to delineate pieces of the buffer
 134      for error reporting and for parse recovery. */
 135   uword *buffer_marks;
 136
 137   /* User's function to fill the buffer when its empty
 138      (and argument). */
 139     uword (*fill_buffer) (struct _unformat_input_t * i);
 140
 141   /* Return values for fill buffer function which indicate whether not
 142      input has been exhausted. */
 143 #define UNFORMAT_END_OF_INPUT (~0)
 144 #define UNFORMAT_MORE_INPUT   0
 145
 146   /* User controlled argument to fill buffer function. */
 147   void *fill_buffer_arg;
 148 } unformat_input_t;
 149
 150 always_inline void
 151 unformat_init (unformat_input_t * i,
 152                uword (*fill_buffer) (unformat_input_t *),
 153                void *fill_buffer_arg)
 154 {
 155   memset (i, 0, sizeof (i[0]));
 156   i->fill_buffer = fill_buffer;
 157   i->fill_buffer_arg = fill_buffer_arg;
 158 }
 159
 160 always_inline void
 161 unformat_free (unformat_input_t * i)
 162 {
 163   vec_free (i->buffer);
 164   vec_free (i->buffer_marks);
 165   memset (i, 0, sizeof (i[0]));
 166 }
 167
 168 always_inline uword
 169 unformat_check_input (unformat_input_t * i)
 170 {
 171   /* Low level fill input function. */
 172   extern uword _unformat_fill_input (unformat_input_t * i);
 173
 174   if (i->index >= vec_len (i->buffer) && i->index != UNFORMAT_END_OF_INPUT)
 175     _unformat_fill_input (i);
 176
 177   return i->index;
 178 }
 179
 180 /* Return true if input is exhausted */
 181 always_inline uword
 182 unformat_is_eof (unformat_input_t * input)
 183 {
 184   return unformat_check_input (input) == UNFORMAT_END_OF_INPUT;
 185 }
 186
 187 /* Return next element in input vector,
 188    possibly calling fill input to get more. */
 189 always_inline uword
 190 unformat_get_input (unformat_input_t * input)
 191 {
 192   uword i = unformat_check_input (input);
 193   if (i < vec_len (input->buffer))
 194     {
 195       input->index = i + 1;
 196       i = input->buffer[i];
 197     }
 198   return i;
 199 }
 200
 201 /* Back up input pointer by one. */
 202 always_inline void
 203 unformat_put_input (unformat_input_t * input)
 204 {
 205   input->index -= 1;
 206 }
 207
 208 /* Peek current input character without advancing. */
 209 always_inline uword
 210 unformat_peek_input (unformat_input_t * input)
 211 {
 212   uword c = unformat_get_input (input);
 213   if (c != UNFORMAT_END_OF_INPUT)
 214     unformat_put_input (input);
 215   return c;
 216 }
 217
 218 /* Skip current input line. */
 219 always_inline void
 220 unformat_skip_line (unformat_input_t * i)
 221 {
 222   uword c;
 223
 224   while ((c = unformat_get_input (i)) != UNFORMAT_END_OF_INPUT && c != '\n')
 225     ;
 226 }
 227
 228 uword unformat_skip_white_space (unformat_input_t * input);
 229
 230 /* Unformat function. */
 231 typedef uword (unformat_function_t) (unformat_input_t * input,
 232                                      va_list * args);
 233
 234 /* External functions. */
 235
 236 /* General unformatting function with programmable input stream. */
 237 uword unformat (unformat_input_t * i, char *fmt, ...);
 238
 239 /* Call user defined parse function.
 240    unformat_user (i, f, ...) is equivalent to unformat (i, "%U", f, ...) */
 241 uword unformat_user (unformat_input_t * input, unformat_function_t * func,
 242                      ...);
 243
 244 /* Alternate version which allows for extensions. */
 245 uword va_unformat (unformat_input_t * i, char *fmt, va_list * args);
 246
 247 /* Setup for unformat of Unix style command line. */
 248 void unformat_init_command_line (unformat_input_t * input, char *argv[]);
 249
 250 /* Setup for unformat of given string. */
 251 void unformat_init_string (unformat_input_t * input,
 252                            char *string, int string_len);
 253
 254 always_inline void
 255 unformat_init_cstring (unformat_input_t * input, char *string)
 256 {
 257   unformat_init_string (input, string, strlen (string));
 258 }
 259
 260 /* Setup for unformat of given vector string; vector will be freed by unformat_string. */
 261 void unformat_init_vector (unformat_input_t * input, u8 * vector_string);
 262
 263 /* Format function for unformat input usable when an unformat error
 264    has occurred. */
 265 u8 *format_unformat_error (u8 * s, va_list * va);
 266
 267 #define unformat_parse_error(input)                                             \
 268   clib_error_return (0, "parse error `%U'", format_unformat_error, input)
 269
 270 /* Print all input: not just error context. */
 271 u8 *format_unformat_input (u8 * s, va_list * va);
 272
 273 /* Unformat (parse) function which reads a %s string and converts it
 274    to and unformat_input_t. */
 275 unformat_function_t unformat_input;
 276
 277 /* Parse a line ending with \n and return it. */
 278 unformat_function_t unformat_line;
 279
 280 /* Parse a line ending with \n and return it as an unformat_input_t. */
 281 unformat_function_t unformat_line_input;
 282
 283 /* Parse a token containing given set of characters. */
 284 unformat_function_t unformat_token;
 285
 286 /* Parses a hexstring into a vector of bytes. */
 287 unformat_function_t unformat_hex_string;
 288
 289 /* Returns non-zero match if input is exhausted.
 290    Useful to ensure that the entire input matches with no trailing junk. */
 291 unformat_function_t unformat_eof;
 292
 293 /* Parse memory size e.g. 100, 100k, 100m, 100g. */
 294 unformat_function_t unformat_memory_size;
 295
 296 /* Unparse memory size e.g. 100, 100k, 100m, 100g. */
 297 u8 *format_memory_size (u8 * s, va_list * va);
 298
 299 /* Format c identifier: e.g. a_name -> "a name". */
 300 u8 *format_c_identifier (u8 * s, va_list * va);
 301
 302 /* Format hexdump with both hex and printable chars - compatible with text2pcap */
 303 u8 *format_hexdump (u8 * s, va_list * va);
 304
 305 /* Unix specific formats. */
 306 #ifdef CLIB_UNIX
 307 /* Setup input from Unix file. */
 308 void unformat_init_unix_file (unformat_input_t * input, int file_descriptor);
 309
 310 /* Take input from Unix environment variable; returns
 311    1 if variable exists zero otherwise. */
 312 uword unformat_init_unix_env (unformat_input_t * input, char *var);
 313 #endif /* CLIB_UNIX */
 314
 315 /* Test code. */
 316 int test_format_main (unformat_input_t * input);
 317 int test_unformat_main (unformat_input_t * input);
 318
 319 /* This is not the right place for this, but putting it in vec.h
 320 created circular dependency problems. */
 321 int test_vec_main (unformat_input_t * input);
 322
 323 #endif /* included_format_h */
 324
 325 /*
 326  * fd.io coding-style-patch-verification: ON
 327  *
 328  * Local Variables:
 329  * eval: (c-set-style "gnu")
 330  * End:
 331  */