FD.io VPP  v16.06
Vector Packet Processing
format.c
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.c: generic network 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 #include <vlib/vlib.h>
41 
42 u8 * format_vlib_rx_tx (u8 * s, va_list * args)
43 {
44  vlib_rx_or_tx_t r = va_arg (*args, vlib_rx_or_tx_t);
45  char * t;
46 
47  switch (r)
48  {
49  case VLIB_RX: t = "rx"; break;
50  case VLIB_TX: t = "tx"; break;
51  default: t = "INVALID"; break;
52  }
53 
54  vec_add (s, t, strlen (t));
55  return s;
56 }
57 
58 u8 * format_vlib_read_write (u8 * s, va_list * args)
59 {
60  vlib_rx_or_tx_t r = va_arg (*args, vlib_rx_or_tx_t);
61  char * t;
62 
63  switch (r)
64  {
65  case VLIB_READ: t = "read"; break;
66  case VLIB_WRITE: t = "write"; break;
67  default: t = "INVALID"; break;
68  }
69 
70  vec_add (s, t, strlen (t));
71  return s;
72 }
73 
74 /* Formats buffer data as printable ascii or as hex. */
75 u8 * format_vlib_buffer_data (u8 * s, va_list * args)
76 {
77  u8 * data = va_arg (*args, u8 *);
78  u32 n_data_bytes = va_arg (*args, u32);
79  u32 i, is_printable;
80 
81  is_printable = 1;
82  for (i = 0; i < n_data_bytes && is_printable; i++)
83  {
84  u8 c = data[i];
85  if (c < 0x20)
86  is_printable = 0;
87  else if (c >= 0x7f)
88  is_printable = 0;
89  }
90 
91  if (is_printable)
92  vec_add (s, data, n_data_bytes);
93  else
94  s = format (s, "%U", format_hex_bytes, data, n_data_bytes);
95 
96  return s;
97 }
98 
99 /* Enable/on => 1; disable/off => 0. */
101 {
102  int * result = va_arg (*args, int *);
103  int enable;
104 
105  if (unformat (input, "enable") || unformat (input, "on"))
106  enable = 1;
107  else if (unformat (input, "disable") || unformat (input, "off"))
108  enable = 0;
109  else
110  return 0;
111 
112  *result = enable;
113  return 1;
114 }
115 
116 /* rx/tx => VLIB_RX/VLIB_TX. */
117 uword unformat_vlib_rx_tx (unformat_input_t * input, va_list * args)
118 {
119  int * result = va_arg (*args, int *);
120  if (unformat (input, "rx"))
121  *result = VLIB_RX;
122  else if (unformat (input, "tx"))
123  *result = VLIB_TX;
124  else
125  return 0;
126  return 1;
127 }
128 
129 /* Parse an int either %d or 0x%x. */
130 uword unformat_vlib_number (unformat_input_t * input, va_list * args)
131 {
132  int * result = va_arg (*args, int *);
133 
134  return (unformat (input, "0x%x", result)
135  || unformat (input, "%d", result));
136 }
137 
138 /* Parse a-zA-Z0-9_ token and hash to value. */
140 {
141  uword * hash = va_arg (*args, uword *);
142  int * result = va_arg (*args, int *);
143  uword * p;
144  u8 * token;
145  int i;
146 
147  if (! unformat_user (input, unformat_token, "a-zA-Z0-9_", &token))
148  return 0;
149 
150  /* Null terminate. */
151  if (vec_len (token) > 0 &&
152  token[vec_len (token) - 1] != 0)
153  vec_add1 (token, 0);
154 
155  /* Check for exact match. */
156  p = hash_get_mem (hash, token);
157  if (p)
158  goto done;
159 
160  /* Convert to upper case & try match. */
161  for (i = 0; i < vec_len (token); i++)
162  if (token[i] >= 'a' && token[i] <= 'z')
163  token[i] = 'A' + token[i] - 'a';
164  p = hash_get_mem (hash, token);
165 
166  done:
167  vec_free (token);
168  if (p)
169  *result = p[0];
170  return p != 0;
171 }
uword unformat_vlib_number(unformat_input_t *input, va_list *args)
Definition: format.c:130
sll srl srl sll sra u16x4 i
Definition: vector_sse2.h:267
uword unformat(unformat_input_t *i, char *fmt,...)
Definition: unformat.c:942
unformat_function_t unformat_token
Definition: format.h:282
#define vec_add1(V, E)
Add 1 element to end of vector (unspecified alignment).
Definition: vec.h:480
u8 * format_vlib_buffer_data(u8 *s, va_list *args)
Definition: format.c:75
#define vec_add(V, E, N)
Add N elements to end of vector V (no header, unspecified alignment)
Definition: vec.h:557
vlib_rx_or_tx_t
Definition: defs.h:44
u8 * format_hex_bytes(u8 *s, va_list *va)
Definition: std-formats.c:79
uword unformat_user(unformat_input_t *input, unformat_function_t *func,...)
Definition: unformat.c:953
uword unformat_vlib_rx_tx(unformat_input_t *input, va_list *args)
Definition: format.c:117
u8 * format_vlib_read_write(u8 *s, va_list *args)
Definition: format.c:58
#define vec_free(V)
Free vector&#39;s memory (no header).
Definition: vec.h:298
uword unformat_vlib_number_by_name(unformat_input_t *input, va_list *args)
Definition: format.c:139
uword unformat_vlib_enable_disable(unformat_input_t *input, va_list *args)
Definition: format.c:100
unsigned int u32
Definition: types.h:88
u8 * format(u8 *s, char *fmt,...)
Definition: format.c:405
u64 uword
Definition: types.h:112
Definition: defs.h:54
Definition: defs.h:46
#define vec_len(v)
Number of elements in vector (rvalue-only, NULL tolerant)
unsigned char u8
Definition: types.h:56
#define hash_get_mem(h, key)
Definition: hash.h:251
u8 * format_vlib_rx_tx(u8 *s, va_list *args)
Definition: format.c:42
struct _unformat_input_t unformat_input_t
Definition: defs.h:45