src/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 u32
  72 format_get_indent (u8 * s)
  73 {
  74   u32 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) __clib_export 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_hex_bytes_no_wrap);
  98 _(format_white_space);
  99 _(format_f64);
 100 _(format_time_interval);
 101
 102 #ifdef CLIB_UNIX
 103 /* Unix specific formats. */
 104 _(format_address_family);
 105 _(format_network_address);
 106 _(format_network_protocol);
 107 _(format_network_port);
 108 _(format_sockaddr);
 109 _(format_timeval);
 110 _(format_time_float);
 111 _(format_signal);
 112 _(format_ucontext_pc);
 113 #endif
 114
 115 #undef _
 116
 117 /* Unformat. */
 118
 119 typedef struct _unformat_input_t
 120 {
 121   /* Input buffer (vector). */
 122   u8 *buffer;
 123
 124   /* Current index in input buffer. */
 125   uword index;
 126
 127   /* Vector of buffer marks.  Used to delineate pieces of the buffer
 128      for error reporting and for parse recovery. */
 129   uword *buffer_marks;
 130
 131   /* User's function to fill the buffer when its empty
 132      (and argument). */
 133     uword (*fill_buffer) (struct _unformat_input_t * i);
 134
 135   /* Return values for fill buffer function which indicate whether not
 136      input has been exhausted. */
 137 #define UNFORMAT_END_OF_INPUT (~0)
 138 #define UNFORMAT_MORE_INPUT   0
 139
 140   /* User controlled argument to fill buffer function. */
 141   void *fill_buffer_arg;
 142 } unformat_input_t;
 143
 144 always_inline void
 145 unformat_init (unformat_input_t * i,
 146                uword (*fill_buffer) (unformat_input_t *),
 147                void *fill_buffer_arg)
 148 {
 149   clib_memset (i, 0, sizeof (i[0]));
 150   i->fill_buffer = fill_buffer;
 151   i->fill_buffer_arg = fill_buffer_arg;
 152 }
 153
 154 always_inline void
 155 unformat_free (unformat_input_t * i)
 156 {
 157   vec_free (i->buffer);
 158   vec_free (i->buffer_marks);
 159   clib_memset (i, 0, sizeof (i[0]));
 160 }
 161
 162 always_inline uword
 163 unformat_check_input (unformat_input_t * i)
 164 {
 165   /* Low level fill input function. */
 166   extern uword _unformat_fill_input (unformat_input_t * i);
 167
 168   if (i->index >= vec_len (i->buffer) && i->index != UNFORMAT_END_OF_INPUT)
 169     _unformat_fill_input (i);
 170
 171   return i->index;
 172 }
 173
 174 /* Return true if input is exhausted */
 175 always_inline uword
 176 unformat_is_eof (unformat_input_t * input)
 177 {
 178   return unformat_check_input (input) == UNFORMAT_END_OF_INPUT;
 179 }
 180
 181 /* Return next element in input vector,
 182    possibly calling fill input to get more. */
 183 always_inline uword
 184 unformat_get_input (unformat_input_t * input)
 185 {
 186   uword i = unformat_check_input (input);
 187   if (i < vec_len (input->buffer))
 188     {
 189       input->index = i + 1;
 190       i = input->buffer[i];
 191     }
 192   return i;
 193 }
 194
 195 /* Back up input pointer by one. */
 196 always_inline void
 197 unformat_put_input (unformat_input_t * input)
 198 {
 199   input->index -= 1;
 200 }
 201
 202 /* Peek current input character without advancing. */
 203 always_inline uword
 204 unformat_peek_input (unformat_input_t * input)
 205 {
 206   uword c = unformat_get_input (input);
 207   if (c != UNFORMAT_END_OF_INPUT)
 208     unformat_put_input (input);
 209   return c;
 210 }
 211
 212 /* Skip current input line. */
 213 always_inline void
 214 unformat_skip_line (unformat_input_t * i)
 215 {
 216   uword c;
 217
 218   while ((c = unformat_get_input (i)) != UNFORMAT_END_OF_INPUT && c != '\n')
 219     ;
 220 }
 221
 222 uword unformat_skip_white_space (unformat_input_t * input);
 223
 224 /* Unformat function. */
 225 typedef uword (unformat_function_t) (unformat_input_t * input,
 226                                      va_list * args);
 227
 228 /* External functions. */
 229
 230 /* General unformatting function with programmable input stream. */
 231 uword unformat (unformat_input_t * i, const char *fmt, ...);
 232
 233 /* Call user defined parse function.
 234    unformat_user (i, f, ...) is equivalent to unformat (i, "%U", f, ...) */
 235 uword unformat_user (unformat_input_t * input, unformat_function_t * func,
 236                      ...);
 237
 238 /* Alternate version which allows for extensions. */
 239 uword va_unformat (unformat_input_t * i, const char *fmt, va_list * args);
 240
 241 /* Setup for unformat of Unix style command line. */
 242 void unformat_init_command_line (unformat_input_t * input, char *argv[]);
 243
 244 /* Setup for unformat of given string. */
 245 void unformat_init_string (unformat_input_t *input, const char *string,
 246                            int string_len);
 247
 248 always_inline void
 249 unformat_init_cstring (unformat_input_t * input, char *string)
 250 {
 251   unformat_init_string (input, string, strlen (string));
 252 }
 253
 254 /* Setup for unformat of given vector string; vector will be freed by unformat_string. */
 255 void unformat_init_vector (unformat_input_t * input, u8 * vector_string);
 256
 257 /* Format function for unformat input usable when an unformat error
 258    has occurred. */
 259 u8 *format_unformat_error (u8 * s, va_list * va);
 260
 261 #define unformat_parse_error(input)                                             \
 262   clib_error_return (0, "parse error `%U'", format_unformat_error, input)
 263
 264 /* Print all input: not just error context. */
 265 u8 *format_unformat_input (u8 * s, va_list * va);
 266
 267 /* Unformat (parse) function which reads a %s string and converts it
 268    to and unformat_input_t. */
 269 unformat_function_t unformat_input;
 270
 271 /* Parse a line ending with \n and return it. */
 272 unformat_function_t unformat_line;
 273
 274 /* Parse a line ending with \n and return it as an unformat_input_t. */
 275 unformat_function_t unformat_line_input;
 276
 277 /* Parse a token containing given set of characters. */
 278 unformat_function_t unformat_token;
 279
 280 /* Parses a hexstring into a vector of bytes. */
 281 unformat_function_t unformat_hex_string;
 282
 283 /* Returns non-zero match if input is exhausted.
 284    Useful to ensure that the entire input matches with no trailing junk. */
 285 unformat_function_t unformat_eof;
 286
 287 /* Parse memory size e.g. 100, 100k, 100m, 100g. */
 288 unformat_function_t unformat_memory_size;
 289
 290 /* Format base 10 e.g. 100, 100K, 100M, 100G */
 291 u8 *format_base10 (u8 *s, va_list *va);
 292
 293 /* Unparse memory size e.g. 100, 100k, 100m, 100g. */
 294 u8 *format_memory_size (u8 * s, va_list * va);
 295
 296 /* Parse memory page size e.g. 4K, 2M */
 297 unformat_function_t unformat_log2_page_size;
 298
 299 /* Unparse memory page size e.g. 4K, 2M */
 300 u8 *format_log2_page_size (u8 * s, va_list * va);
 301
 302 /* Format c identifier: e.g. a_name -> "a name". */
 303 u8 *format_c_identifier (u8 * s, va_list * va);
 304
 305 /* Format hexdump with both hex and printable chars - compatible with text2pcap */
 306 u8 *format_hexdump (u8 * s, va_list * va);
 307
 308 /* Unix specific formats. */
 309 #ifdef CLIB_UNIX
 310 /* Setup input from Unix file. */
 311 void unformat_init_clib_file (unformat_input_t * input, int file_descriptor);
 312
 313 /* Take input from Unix environment variable; returns
 314    1 if variable exists zero otherwise. */
 315 uword unformat_init_unix_env (unformat_input_t * input, char *var);
 316
 317 /* Unformat unix group id (gid) specified as integer or string */
 318 unformat_function_t unformat_unix_gid;
 319 #endif /* CLIB_UNIX */
 320
 321 uword unformat_data_size (unformat_input_t * input, va_list * args);
 322
 323 /* Test code. */
 324 int test_format_main (unformat_input_t * input);
 325 int test_unformat_main (unformat_input_t * input);
 326
 327 /* This is not the right place for this, but putting it in vec.h
 328 created circular dependency problems. */
 329 int test_vec_main (unformat_input_t * input);
 330
 331 #endif /* included_format_h */
 332
 333 /*
 334  * fd.io coding-style-patch-verification: ON
 335  *
 336  * Local Variables:
 337  * eval: (c-set-style "gnu")
 338  * End:
 339  */