xref: /dpdk/examples/cmdline/parse_obj_list.c (revision 1c1d4d7a923d4804f1926fc5264f9ecdd8977b04)
1 /*-
2  *   BSD LICENSE
3  *
4  *   Copyright(c) 2010-2013 Intel Corporation. All rights reserved.
5  *   All rights reserved.
6  *
7  *   Redistribution and use in source and binary forms, with or without
8  *   modification, are permitted provided that the following conditions
9  *   are met:
10  *
11  *     * Redistributions of source code must retain the above copyright
12  *       notice, this list of conditions and the following disclaimer.
13  *     * Redistributions in binary form must reproduce the above copyright
14  *       notice, this list of conditions and the following disclaimer in
15  *       the documentation and/or other materials provided with the
16  *       distribution.
17  *     * Neither the name of Intel Corporation nor the names of its
18  *       contributors may be used to endorse or promote products derived
19  *       from this software without specific prior written permission.
20  *
21  *   THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
22  *   "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
23  *   LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
24  *   A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
25  *   OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
26  *   SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
27  *   LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
28  *   DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
29  *   THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
30  *   (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
31  *   OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
32  */
33 
34 /*
35  * Copyright (c) 2009, Olivier MATZ <zer0@droids-corp.org>
36  * All rights reserved.
37  * Redistribution and use in source and binary forms, with or without
38  * modification, are permitted provided that the following conditions are met:
39  *
40  *     * Redistributions of source code must retain the above copyright
41  *       notice, this list of conditions and the following disclaimer.
42  *     * Redistributions in binary form must reproduce the above copyright
43  *       notice, this list of conditions and the following disclaimer in the
44  *       documentation and/or other materials provided with the distribution.
45  *     * Neither the name of the University of California, Berkeley nor the
46  *       names of its contributors may be used to endorse or promote products
47  *       derived from this software without specific prior written permission.
48  *
49  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND ANY
50  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
51  * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
52  * DISCLAIMED. IN NO EVENT SHALL THE REGENTS AND CONTRIBUTORS BE LIABLE FOR ANY
53  * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
54  * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
55  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
56  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
57  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
58  * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
59  */
60 
61 #include <stdio.h>
62 #include <inttypes.h>
63 #include <stdarg.h>
64 #include <errno.h>
65 #include <ctype.h>
66 #include <string.h>
67 #include <netinet/in.h>
68 
69 #include <cmdline_parse.h>
70 #include <cmdline_parse_ipaddr.h>
71 
72 #include <rte_string_fns.h>
73 
74 #include "parse_obj_list.h"
75 
76 /* This file is an example of extension of libcmdline. It provides an
77  * example of objects stored in a list. */
78 
79 struct cmdline_token_ops token_obj_list_ops = {
80 	.parse = parse_obj_list,
81 	.complete_get_nb = complete_get_nb_obj_list,
82 	.complete_get_elt = complete_get_elt_obj_list,
83 	.get_help = get_help_obj_list,
84 };
85 
86 int
87 parse_obj_list(cmdline_parse_token_hdr_t *tk, const char *buf, void *res)
88 {
89 	struct token_obj_list *tk2 = (struct token_obj_list *)tk;
90 	struct token_obj_list_data *tkd = &tk2->obj_list_data;
91 	struct object *o;
92 	unsigned int token_len = 0;
93 
94 	if (*buf == 0)
95 		return -1;
96 
97 	while(!cmdline_isendoftoken(buf[token_len]))
98 		token_len++;
99 
100 	SLIST_FOREACH(o, tkd->list, next) {
101 		if (token_len != strnlen(o->name, OBJ_NAME_LEN_MAX))
102 			continue;
103 		if (strncmp(buf, o->name, token_len))
104 			continue;
105 		break;
106 	}
107 	if (!o) /* not found */
108 		return -1;
109 
110 	/* store the address of object in structure */
111 	if (res)
112 		*(struct object **)res = o;
113 
114 	return token_len;
115 }
116 
117 int complete_get_nb_obj_list(cmdline_parse_token_hdr_t *tk)
118 {
119 	struct token_obj_list *tk2 = (struct token_obj_list *)tk;
120 	struct token_obj_list_data *tkd = &tk2->obj_list_data;
121 	struct object *o;
122 	int ret = 0;
123 
124 	SLIST_FOREACH(o, tkd->list, next) {
125 		ret ++;
126 	}
127 	return ret;
128 }
129 
130 int complete_get_elt_obj_list(cmdline_parse_token_hdr_t *tk,
131 			      int idx, char *dstbuf, unsigned int size)
132 {
133 	struct token_obj_list *tk2 = (struct token_obj_list *)tk;
134 	struct token_obj_list_data *tkd = &tk2->obj_list_data;
135 	struct object *o;
136 	int i = 0;
137 	unsigned len;
138 
139 	SLIST_FOREACH(o, tkd->list, next) {
140 		if (i++ == idx)
141 			break;
142 	}
143 	if (!o)
144 		return -1;
145 
146 	len = strnlen(o->name, OBJ_NAME_LEN_MAX);
147 	if ((len + 1) > size)
148 		return -1;
149 
150 	if (dstbuf)
151 		rte_snprintf(dstbuf, size, "%s", o->name);
152 
153 	return 0;
154 }
155 
156 
157 int get_help_obj_list(__attribute__((unused)) cmdline_parse_token_hdr_t *tk,
158 		      char *dstbuf, unsigned int size)
159 {
160 	rte_snprintf(dstbuf, size, "Obj-List");
161 	return 0;
162 }
163