examples/cmdline/parse_obj_list.c

   1 /*-
   2  *   BSD LICENSE
   3  *
   4  *   Copyright(c) 2010-2014 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         unsigned ressize)
  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         if (res && ressize < sizeof(struct object *))
  99                 return -1;
 100
 101         while(!cmdline_isendoftoken(buf[token_len]))
 102                 token_len++;
 103
 104         SLIST_FOREACH(o, tkd->list, next) {
 105                 if (token_len != strnlen(o->name, OBJ_NAME_LEN_MAX))
 106                         continue;
 107                 if (strncmp(buf, o->name, token_len))
 108                         continue;
 109                 break;
 110         }
 111         if (!o) /* not found */
 112                 return -1;
 113
 114         /* store the address of object in structure */
 115         if (res)
 116                 *(struct object **)res = o;
 117
 118         return token_len;
 119 }
 120
 121 int complete_get_nb_obj_list(cmdline_parse_token_hdr_t *tk)
 122 {
 123         struct token_obj_list *tk2 = (struct token_obj_list *)tk;
 124         struct token_obj_list_data *tkd = &tk2->obj_list_data;
 125         struct object *o;
 126         int ret = 0;
 127
 128         SLIST_FOREACH(o, tkd->list, next) {
 129                 ret ++;
 130         }
 131         return ret;
 132 }
 133
 134 int complete_get_elt_obj_list(cmdline_parse_token_hdr_t *tk,
 135                               int idx, char *dstbuf, unsigned int size)
 136 {
 137         struct token_obj_list *tk2 = (struct token_obj_list *)tk;
 138         struct token_obj_list_data *tkd = &tk2->obj_list_data;
 139         struct object *o;
 140         int i = 0;
 141         unsigned len;
 142
 143         SLIST_FOREACH(o, tkd->list, next) {
 144                 if (i++ == idx)
 145                         break;
 146         }
 147         if (!o)
 148                 return -1;
 149
 150         len = strnlen(o->name, OBJ_NAME_LEN_MAX);
 151         if ((len + 1) > size)
 152                 return -1;
 153
 154         if (dstbuf)
 155                 snprintf(dstbuf, size, "%s", o->name);
 156
 157         return 0;
 158 }
 159
 160
 161 int get_help_obj_list(__attribute__((unused)) cmdline_parse_token_hdr_t *tk,
 162                       char *dstbuf, unsigned int size)
 163 {
 164         snprintf(dstbuf, size, "Obj-List");
 165         return 0;
 166 }