vlib/vlib/format_funcs.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  * format_funcs.h: VLIB formatting/unformating
  17  *
  18  * Copyright (c) 2008 Eliot Dresselhaus
  19  *
  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:
  27  *
  28  * The above copyright notice and this permission notice shall be
  29  * included in all copies or substantial portions of the Software.
  30  *
  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.
  38  */
  39
  40 #ifndef included_vlib_format_h
  41 #define included_vlib_format_h
  42
  43 /* Format vlib_rx_or_tx_t/vlib_read_or_write_t enum as string. */
  44 u8 *format_vlib_rx_tx (u8 * s, va_list * args);
  45 u8 *format_vlib_read_write (u8 * s, va_list * args);
  46
  47 /* Formats buffer data as printable ascii or as hex. */
  48 u8 *format_vlib_buffer_data (u8 * s, va_list * args);
  49
  50 /* Enable/on => 1; disable/off => 0. */
  51 uword unformat_vlib_enable_disable (unformat_input_t * input, va_list * args);
  52
  53 /* rx/tx => VLIB_RX/VLIB_TX. */
  54 uword unformat_vlib_rx_tx (unformat_input_t * input, va_list * args);
  55
  56 /* Parse a-zA-Z0-9_ token and hash to value. */
  57 uword unformat_vlib_number_by_name (unformat_input_t * input, va_list * args);
  58
  59 /* Parse an int either %d or 0x%x. */
  60 uword unformat_vlib_number (unformat_input_t * input, va_list * args);
  61
  62 /* Flag to format_vlib_*_header functions to tell them not to recurse
  63    into the next layer's header.  For example, tells format_vlib_ethernet_header
  64    not to format ip header. */
  65 #define FORMAT_VLIB_HEADER_NO_RECURSION (~0)
  66
  67 #endif /* included_vlib_format_h */
  68
  69 /*
  70  * fd.io coding-style-patch-verification: ON
  71  *
  72  * Local Variables:
  73  * eval: (c-set-style "gnu")
  74  * End:
  75  */