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