FD.io VPP  v21.06-1-gbb7418cf9
Vector Packet Processing
format_funcs.h
Go to the documentation of this file.
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 /* Formats thread name */
51 u8 *format_vlib_thread_name (u8 * s, va_list * args);
52 
53 /* Formats thread name and thread index */
54 u8 *format_vlib_thread_name_and_index (u8 * s, va_list * args);
55 
56 /* Enable/on => 1; disable/off => 0. */
57 uword unformat_vlib_enable_disable (unformat_input_t * input, va_list * args);
58 
59 /* rx/tx => VLIB_RX/VLIB_TX. */
60 uword unformat_vlib_rx_tx (unformat_input_t * input, va_list * args);
61 
62 /* Parse a-zA-Z0-9_ token and hash to value. */
63 uword unformat_vlib_number_by_name (unformat_input_t * input, va_list * args);
64 
65 /* Parse an int either %d or 0x%x. */
66 uword unformat_vlib_number (unformat_input_t * input, va_list * args);
67 
68 /* Parse a filename to dump debug info */
69 uword unformat_vlib_tmpfile (unformat_input_t * input, va_list * args);
70 
71 /* Flag to format_vlib_*_header functions to tell them not to recurse
72  into the next layer's header. For example, tells format_vlib_ethernet_header
73  not to format ip header. */
74 #define FORMAT_VLIB_HEADER_NO_RECURSION (~0)
75 
76 #endif /* included_vlib_format_h */
77 
78 /*
79  * fd.io coding-style-patch-verification: ON
80  *
81  * Local Variables:
82  * eval: (c-set-style "gnu")
83  * End:
84  */
uword unformat_vlib_number_by_name(unformat_input_t *input, va_list *args)
Definition: format.c:157
uword unformat_vlib_enable_disable(unformat_input_t *input, va_list *args)
Definition: format.c:116
unsigned char u8
Definition: types.h:56
struct _unformat_input_t unformat_input_t
u8 * format_vlib_thread_name_and_index(u8 *s, va_list *args)
Definition: format.c:227
u8 * format_vlib_buffer_data(u8 *s, va_list *args)
Definition: format.c:90
u8 * format_vlib_read_write(u8 *s, va_list *args)
Definition: format.c:66
uword unformat_vlib_tmpfile(unformat_input_t *input, va_list *args)
Definition: format.c:192
uword unformat_vlib_number(unformat_input_t *input, va_list *args)
Definition: format.c:148
uword unformat_vlib_rx_tx(unformat_input_t *input, va_list *args)
Definition: format.c:134
u64 uword
Definition: types.h:112
u8 * format_vlib_rx_tx(u8 *s, va_list *args)
Definition: format.c:43
u8 * format_vlib_thread_name(u8 *s, va_list *args)
Definition: format.c:214