config_cmdline.c 9.43 KB
Newer Older
1 2 3 4 5
/*
 * Licensed to the OpenAirInterface (OAI) Software Alliance under one or more
 * contributor license agreements.  See the NOTICE file distributed with
 * this work for additional information regarding copyright ownership.
 * The OpenAirInterface Software Alliance licenses this file to You under
6
 * the OAI Public License, Version 1.1  (the "License"); you may not use this file
7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22
 * except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      http://www.openairinterface.org/?page_id=698
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 *-------------------------------------------------------------------------------
 * For more information about the OpenAirInterface (OAI) Software Alliance:
 *      contact@openairinterface.org
 */

/*! \file common/config/cmdline/config_libconfig.c
Raphael Defosseux's avatar
Raphael Defosseux committed
23
 * \brief configuration module, command line parsing implementation
24 25 26 27 28 29 30 31
 * \author Francois TABURET
 * \date 2017
 * \version 0.1
 * \company NOKIA BellLabs France
 * \email: francois.taburet@nokia-bell-labs.com
 * \note
 * \warning
 */
32
#define _GNU_SOURCE
33 34 35
#include <string.h>
#include <stdlib.h>
#include <stdio.h>
36
#include <ctype.h>
37
#include <errno.h>
38
#include <platform_types.h>
39
#include "config_userapi.h"
40
#include "../utils/LOG/log.h"
41

Raphael Defosseux's avatar
Raphael Defosseux committed
42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67
int parse_stringlist(paramdef_t *cfgoptions, char *val) {
  char *atoken;
  char *tokctx;
  char *tmpval=strdup(val);
  int   numelt=0;
  cfgoptions->numelt=0;
  atoken=strtok_r(tmpval, ",",&tokctx);

  while(atoken != NULL) {
    numelt++ ;
    atoken=strtok_r(NULL, ",",&tokctx);
  }

  free(tmpval);
  config_check_valptr(cfgoptions,(char **)&(cfgoptions->strlistptr), sizeof(char *) * numelt);
  cfgoptions->numelt=numelt;
  atoken=strtok_r(val, ",",&tokctx);

  for( int i=0; i<cfgoptions->numelt && atoken != NULL ; i++) {
    config_check_valptr(cfgoptions,&(cfgoptions->strlistptr[i]),strlen(atoken)+1);
    sprintf(cfgoptions->strlistptr[i],"%s",atoken);
    printf_params("[LIBCONFIG] %s[%i]: %s\n", cfgoptions->optname,i,cfgoptions->strlistptr[i]);
    atoken=strtok_r(NULL, ",",&tokctx);
  }

  return (cfgoptions->numelt > 0);
68
}
Raphael Defosseux's avatar
Raphael Defosseux committed
69 70 71 72 73 74 75 76

int processoption(paramdef_t *cfgoptions, char *value) {
  char *tmpval = value;
  int optisset=0;
  char defbool[2]="1";

  if ( value == NULL) {
    if( (cfgoptions->paramflags &PARAMFLAG_BOOL) == 0 ) { /* not a boolean, argument required */
77
      CONFIG_PRINTF_ERROR("[CONFIG] command line, option %s requires an argument\n",cfgoptions->optname);
Raphael Defosseux's avatar
Raphael Defosseux committed
78 79 80 81 82 83
    } else {        /* boolean value option without argument, set value to true*/
      tmpval = defbool;
    }
  }

  switch(cfgoptions->type) {
84 85
      char *charptr;

Raphael Defosseux's avatar
Raphael Defosseux committed
86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108
    case TYPE_STRING:
      if (cfgoptions->numelt == 0 ) {
        config_check_valptr(cfgoptions, cfgoptions->strptr, strlen(tmpval)+1);
        sprintf(*(cfgoptions->strptr), "%s",tmpval);
      } else {
        sprintf( (char *)(cfgoptions->strptr), "%s",tmpval);
      }

      printf_cmdl("[CONFIG] %s set to  %s from command line\n", cfgoptions->optname, tmpval);
      optisset=1;
      break;

    case TYPE_STRINGLIST:
      optisset=parse_stringlist(cfgoptions,tmpval);
      break;

    case TYPE_UINT32:
    case TYPE_INT32:
    case TYPE_UINT16:
    case TYPE_INT16:
    case TYPE_UINT8:
    case TYPE_INT8:
      config_check_valptr(cfgoptions, (char **)&(cfgoptions->iptr),sizeof(int32_t));
109 110 111 112 113 114
      config_assign_int(cfgoptions,cfgoptions->optname,(int32_t)strtol(tmpval,&charptr,0));

      if( *charptr != 0) {
        CONFIG_PRINTF_ERROR("[CONFIG] command line, option %s requires an integer argument\n",cfgoptions->optname);
      }

Raphael Defosseux's avatar
Raphael Defosseux committed
115 116 117 118 119 120
      optisset=1;
      break;

    case TYPE_UINT64:
    case TYPE_INT64:
      config_check_valptr(cfgoptions, (char **)&(cfgoptions->i64ptr),sizeof(uint64_t));
121 122 123 124 125 126
      *(cfgoptions->i64ptr)=strtoll(tmpval,&charptr,0);

      if( *charptr != 0) {
        CONFIG_PRINTF_ERROR("[CONFIG] command line, option %s requires an integer argument\n",cfgoptions->optname);
      }

Raphael Defosseux's avatar
Raphael Defosseux committed
127 128 129 130 131 132 133 134 135 136
      printf_cmdl("[CONFIG] %s set to  %lli from command line\n", cfgoptions->optname, (long long)*(cfgoptions->i64ptr));
      optisset=1;
      break;

    case TYPE_UINTARRAY:
    case TYPE_INTARRAY:
      break;

    case TYPE_DOUBLE:
      config_check_valptr(cfgoptions, (char **)&(cfgoptions->dblptr),sizeof(double));
137 138 139 140 141 142
      *(cfgoptions->dblptr) = strtof(tmpval,&charptr);

      if( *charptr != 0) {
        CONFIG_PRINTF_ERROR("[CONFIG] command line, option %s requires a double argument\n",cfgoptions->optname);
      }

Raphael Defosseux's avatar
Raphael Defosseux committed
143 144 145 146 147 148 149 150
      printf_cmdl("[CONFIG] %s set to  %lf from command line\n", cfgoptions->optname, *(cfgoptions->dblptr));
      optisset=1;
      break;

    case TYPE_IPV4ADDR:
      break;

    default:
151
      CONFIG_PRINTF_ERROR("[CONFIG] command line, %s type %i  not supported\n",cfgoptions->optname, cfgoptions->type);
Raphael Defosseux's avatar
Raphael Defosseux committed
152 153 154 155 156 157 158 159
      break;
  } /* switch on param type */

  if (optisset == 1) {
    cfgoptions->paramflags = cfgoptions->paramflags |  PARAMFLAG_PARAMSET;
  }

  return optisset;
160 161
}

162 163 164 165
/*--------------------------------------------------------------------*/
/*  check unknown options in the command line
*/
int config_check_unknown_cmdlineopt(char *prefix) {
Raphael Defosseux's avatar
Raphael Defosseux committed
166
  int unknowndetected=0;
167
  char testprefix[CONFIG_MAXOPTLENGTH];
Raphael Defosseux's avatar
Raphael Defosseux committed
168 169
  int finalcheck = 0;

170
  memset(testprefix,0,sizeof(testprefix));
Raphael Defosseux's avatar
Raphael Defosseux committed
171 172 173 174
  if (prefix != NULL) {
    if (strcmp(prefix,CONFIG_CHECKALLSECTIONS) == 0)
      finalcheck = 1;
    else if (strlen(prefix) > 0) {
175
      sprintf(testprefix,"--%.*s.",CONFIG_MAXOPTLENGTH-1,prefix);
176
    }
Raphael Defosseux's avatar
Raphael Defosseux committed
177 178 179 180 181 182 183
  }

  for (int i=1; i<config_get_if()->argc ; i++) {
    if ( !finalcheck && strstr(config_get_if()->argv[i],testprefix) == NULL ) continue;

    if ( !finalcheck && testprefix[0]==0 && index(config_get_if()->argv[i],'.') != NULL) continue;

184 185
    if ( !finalcheck && isdigit(config_get_if()->argv[i][0])) continue;

Raphael Defosseux's avatar
Raphael Defosseux committed
186 187 188 189 190 191 192 193
    if ( !finalcheck && config_get_if()->argv[i][0] == '-' && isdigit(config_get_if()->argv[i][1])) continue;

    if ( (config_get_if()->argv_info[i] & CONFIG_CMDLINEOPT_PROCESSED) == 0 ) {
      fprintf(stderr,"[CONFIG] unknown option: %s\n",
              config_get_if()->argv[i] );
      unknowndetected++;
    }
  }
194

195 196 197 198 199
  if (unknowndetected > 0) {
    CONFIG_PRINTF_ERROR("[CONFIG] %i unknown option(s) in command line starting with %s (section %s)\n",
                        unknowndetected,testprefix,((prefix==NULL)?"":prefix));
  }

Raphael Defosseux's avatar
Raphael Defosseux committed
200
  return unknowndetected;
201
}  /* config_check_unknown_cmdlineopt */
202

Raphael Defosseux's avatar
Raphael Defosseux committed
203
int config_process_cmdline(paramdef_t *cfgoptions,int numoptions, char *prefix) {
Cedric Roux's avatar
Cedric Roux committed
204 205 206
  int c = config_get_if()->argc;
  int i,j;
  char *pp;
207
  char cfgpath[CONFIG_MAXOPTLENGTH];
208 209
  j = 0;
  i = 0;
Raphael Defosseux's avatar
Raphael Defosseux committed
210 211 212 213 214 215 216 217 218 219 220 221

  while (c > 0 ) {
    char *oneargv = strdup(config_get_if()->argv[i]);          /* we use strtok_r which modifies its string paramater, and we don't want argv to be modified */

    /* first check help options, either --help, -h or --help_<section> */
    if (strncmp(oneargv, "-h",2) == 0 || strncmp(oneargv, "--help",6) == 0 ) {
      char *tokctx;
      pp=strtok_r(oneargv, "_",&tokctx);
      config_get_if()->argv_info[i] |= CONFIG_CMDLINEOPT_PROCESSED;

      if (pp == NULL || strcasecmp(pp,config_get_if()->argv[i] ) == 0 ) {
        if( prefix == NULL) {
222
          config_printhelp(cfgoptions,numoptions,"(root section)");
Raphael Defosseux's avatar
Raphael Defosseux committed
223 224 225 226 227 228 229 230

          if ( ! ( CONFIG_ISFLAGSET(CONFIG_NOEXITONHELP)))
            exit_fun("[CONFIG] Exiting after displaying help\n");
        }
      } else {
        pp=strtok_r(NULL, " ",&tokctx);

        if ( prefix != NULL && pp != NULL && strncasecmp(prefix,pp,strlen(pp)) == 0 ) {
231
          config_printhelp(cfgoptions,numoptions,prefix);
Raphael Defosseux's avatar
Raphael Defosseux committed
232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278

          if ( ! (CONFIG_ISFLAGSET(CONFIG_NOEXITONHELP))) {
            fprintf(stderr,"[CONFIG] %s %i section %s:", __FILE__, __LINE__, prefix);
            exit_fun(" Exiting after displaying help\n");
          }
        }
      }
    }

    /* now, check for non help options */
    if (oneargv[0] == '-') {
      for(int n=0; n<numoptions; n++) {
        if ( ( cfgoptions[n].paramflags & PARAMFLAG_DISABLECMDLINE) != 0) {
          continue;
        }

        if (prefix != NULL) {
          sprintf(cfgpath,"%s.%s",prefix,cfgoptions[n].optname);
        } else {
          sprintf(cfgpath,"%s",cfgoptions[n].optname);
        }

        if ( ((strlen(oneargv) == 2) && (strcmp(oneargv + 1,cfgpath) == 0))  || /* short option, one "-" */
             ((strlen(oneargv) > 2) && (strcmp(oneargv + 2,cfgpath ) == 0 )) ) {
          char *valptr=NULL;
          int ret;
          config_get_if()->argv_info[i] |= CONFIG_CMDLINEOPT_PROCESSED;

          if (c > 0) {
            pp = config_get_if()->argv[i+1];

            if (pp != NULL ) {
              ret = strlen(pp);

              if (ret > 0 ) {
                if (pp[0] != '-')
                  valptr=pp;
                else if ( ret > 1 && pp[0] == '-' && isdigit(pp[1]) )
                  valptr=pp;
              }
            }
          }

          j += processoption(&(cfgoptions[n]), valptr);

          if (  valptr != NULL ) {
            i++;
279
            config_get_if()->argv_info[i] |= CONFIG_CMDLINEOPT_PROCESSED;
Raphael Defosseux's avatar
Raphael Defosseux committed
280 281 282 283
            c--;
          }

          break;
284
        }
Raphael Defosseux's avatar
Raphael Defosseux committed
285 286 287 288 289 290 291
      } /* for n... */
    } /* if (oneargv[0] == '-') */

    free(oneargv);
    i++;
    c--;
  }   /* fin du while */
292

293
  printf_cmdl("[CONFIG] %s %i options set from command line\n",((prefix == NULL) ? "(root)":prefix),j);
294
  return j;
295
}  /* parse_cmdline*/