[GITLAB] - UPGRADE TO v12 on Wednesday the 18th of December at 11.30AM

config_load_configmodule.c 10.4 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 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44
 * 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/config_load_configmodule.c
 * \brief configuration module, load the shared library implementing the configuration module 
 * \author Francois TABURET
 * \date 2017
 * \version 0.1
 * \company NOKIA BellLabs France
 * \email: francois.taburet@nokia-bell-labs.com
 * \note
 * \warning
 */
#define _GNU_SOURCE
#include <string.h>
#include <stdlib.h>
#include <stdio.h>
#include <unistd.h>
#include <errno.h>
#include <dlfcn.h>

#define CONFIG_LOADCONFIG_MAIN
#include "config_load_configmodule.h"
#include "config_userapi.h"
#define CONFIG_SHAREDLIBFORMAT "libparams_%s.so"

45
int load_config_sharedlib(configmodule_interface_t *cfgptr)
46 47 48 49 50 51 52
{
void *lib_handle;
char fname[128];
char libname[FILENAME_MAX]; 
int st;

   st=0;  
53
   sprintf(libname,CONFIG_SHAREDLIBFORMAT,cfgptr->cfgmode);
54 55 56 57 58 59

   lib_handle = dlopen(libname,RTLD_NOW | RTLD_GLOBAL | RTLD_NODELETE);
   if (!lib_handle) {
      fprintf(stderr,"[CONFIG] %s %d Error calling dlopen(%s): %s\n",__FILE__, __LINE__, libname,dlerror());
      st = -1;
   } else { 
60
      sprintf (fname,"config_%s_init",cfgptr->cfgmode);
61 62 63 64
      cfgptr->init = dlsym(lib_handle,fname);

      if (cfgptr->init == NULL ) {
         printf("[CONFIG] %s %d no function %s for config mode %s\n",
65
               __FILE__, __LINE__,fname, cfgptr->cfgmode);
66
      } else {
67
         st=cfgptr->init(cfgptr->cfgP,cfgptr->num_cfgP); 
68 69 70 71
         printf("[CONFIG] function %s returned %i\n",
               fname, st);	 
      }

72
      sprintf (fname,"config_%s_get",cfgptr->cfgmode);
73 74 75
      cfgptr->get = dlsym(lib_handle,fname);
      if (cfgptr->get == NULL ) { 
         printf("[CONFIG] %s %d no function %s for config mode %s\n",
76
               __FILE__, __LINE__,fname, cfgptr->cfgmode);
77 78 79
	 st = -1;
      }
      
80
      sprintf (fname,"config_%s_getlist",cfgptr->cfgmode);
81 82 83
      cfgptr->getlist = dlsym(lib_handle,fname);
      if (cfgptr->getlist == NULL ) { 
         printf("[CONFIG] %s %d no function %s for config mode %s\n",
84
               __FILE__, __LINE__,fname, cfgptr->cfgmode);
85 86 87
	 st = -1;
      }

88
      sprintf (fname,"config_%s_end",cfgptr->cfgmode);
89 90 91
      cfgptr->end = dlsym(lib_handle,fname);
      if (cfgptr->getlist == NULL ) { 
         printf("[CONFIG] %s %d no function %s for config mode %s\n",
92
               __FILE__, __LINE__,fname, cfgptr->cfgmode);
93 94 95 96 97 98 99
      }      
   } 
   
   return st;	       
}
/*-----------------------------------------------------------------------------------*/
/* from here: interface implementtion of the configuration module */
100 101 102
int nooptfunc(void) {
   return 0;
};
103

104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170
int config_cmdlineonly_getlist(paramlist_def_t *ParamList, 
                                   paramdef_t *params, int numparams, char *prefix)
{
     ParamList->numelt = 0;
     return 0;
}


int config_cmdlineonly_get(paramdef_t *cfgoptions,int numoptions, char *prefix )
{
  int defval;
  int fatalerror=0;
  int numdefvals=0;
  

  for(int i=0;i<numoptions;i++) {
     defval=0;
     switch(cfgoptions[i].type) {
       case TYPE_STRING:
            defval=config_setdefault_string(&(cfgoptions[i]), prefix);
       break;
       case TYPE_STRINGLIST:
            defval=config_setdefault_stringlist(&(cfgoptions[i]), prefix);
       break;
       	case TYPE_UINT8:
       	case TYPE_INT8:	
       	case TYPE_UINT16:
       	case TYPE_INT16:
       	case TYPE_UINT32:
       	case TYPE_INT32:
       	case TYPE_MASK:	
             defval=config_setdefault_int(&(cfgoptions[i]), prefix);
        break;
       	case TYPE_UINT64:
       	case TYPE_INT64:
             defval=config_setdefault_int64(&(cfgoptions[i]), prefix);
        break;        
       	case TYPE_UINTARRAY:
       	case TYPE_INTARRAY:
             defval=config_setdefault_intlist(&(cfgoptions[i]), prefix);
        break;
       	case TYPE_DOUBLE:
             defval=config_setdefault_double(&(cfgoptions[i]), prefix);  
        break;  
       	case TYPE_IPV4ADDR:
             defval=config_setdefault_ipv4addr(&(cfgoptions[i]), prefix); 
              
        break;
        default:
            fprintf(stderr,"[CONFIG] %s.%s type %i  not supported\n",prefix, cfgoptions[i].optname,cfgoptions[i].type);
            fatalerror=1;
        break;
      } /* switch on param type */
    if (defval == 1) {
    	numdefvals++;
        cfgoptions[i].paramflags = cfgoptions[i].paramflags |  PARAMFLAG_PARAMSETDEF;
    }
  } /* for loop on options */
  printf("[CONFIG] %s: %i/%i parameters successfully set \n",
         ((prefix == NULL)?"(root)":prefix), 
         numdefvals,numoptions );
  if (fatalerror == 1) {
      fprintf(stderr,"[CONFIG] fatal errors found when assigning %s parameters \n",
             prefix);
  }
  return numdefvals;
}
171 172 173 174 175 176 177

configmodule_interface_t *load_configmodule(int argc, char **argv)
{
char *cfgparam=NULL;
char *modeparams=NULL;
char *cfgmode=NULL;
char *strtokctx=NULL;
178
char *atoken;
179
uint32_t tmpflags=0;
180
int i;
181 182
 
/* first parse the command line to look for the -O option */
183 184 185 186
  for (i = 0;i<argc;i++) {
       if (strlen(argv[i]) < 2) continue;
       if ( argv[i][1] == 'O' && i < (argc -1)) {
          cfgparam = argv[i+1]; 
187
       } 
188 189 190 191 192
       if ( strstr(argv[i], "help_config") != NULL  ) {
          config_printhelp(Config_Params,CONFIG_PARAMLENGTH(Config_Params));
          exit(0);
       }
       if ( (strcmp(argv[i]+1, "h") == 0) || (strstr(argv[i]+1, "help_") != NULL ) ) {
193 194
          tmpflags = CONFIG_HELP; 
       }            
195
   }
196

197 198 199 200 201 202 203
/* look for the OAI_CONFIGMODULE environement variable */
  if ( cfgparam == NULL ) {
     cfgparam = getenv("OAI_CONFIGMODULE");
     }

/* default */
  if (cfgparam == NULL) {
204 205 206 207 208 209 210 211
         tmpflags = tmpflags | CONFIG_NOOOPT;
     if (strstr(argv[0],"uesoftmodem") == NULL) {
         cfgparam = CONFIG_LIBCONFIGFILE ":" DEFAULT_CFGFILENAME;
      } else {
         cfgparam = CONFIG_CMDLINEONLY ":dbgl0" ;         
      }
   }
   
212 213 214 215
/* parse the config parameters to set the config source */
   i = sscanf(cfgparam,"%m[^':']:%ms",&cfgmode,&modeparams);
   if (i< 0) {
       fprintf(stderr,"[CONFIG] %s, %d, sscanf error parsing config source  %s: %s\n", __FILE__, __LINE__,cfgparam, strerror(errno));
216
       exit(-1);
217 218
   }
   else if ( i == 1 ) {
219
  /* -O argument doesn't contain ":" separator, assume -O <conf file> option, default cfgmode to libconfig
220
     with one parameter, the path to the configuration file */
221
       modeparams=cfgmode;
222
       cfgmode=strdup(CONFIG_LIBCONFIGFILE);
223 224 225
   }

   cfgptr = malloc(sizeof(configmodule_interface_t));
226
   memset(cfgptr,0,sizeof(configmodule_interface_t));
227 228

   cfgptr->rtflags = cfgptr->rtflags | tmpflags;
229 230 231 232 233 234 235 236
   cfgptr->argc   = argc;
   cfgptr->argv   = argv; 
   cfgptr->cfgmode=strdup(cfgmode);
   cfgptr->num_cfgP=0;
   atoken=strtok_r(modeparams,":",&strtokctx);     
   while ( cfgptr->num_cfgP< CONFIG_MAX_OOPT_PARAMS && atoken != NULL) {
       /* look for debug level in the config parameters, it is commom to all config mode 
          and will be removed frome the parameter array passed to the shared module */
237
       char *aptr;
238
       aptr=strcasestr(atoken,"dbgl");
239
       if (aptr != NULL) {
240 241 242 243 244
           cfgptr->rtflags = cfgptr->rtflags | strtol(aptr+4,NULL,0);

       } else {
           cfgptr->cfgP[cfgptr->num_cfgP] = strdup(atoken);
           cfgptr->num_cfgP++;
245
       }
246
       atoken = strtok_r(NULL,":",&strtokctx);
247 248 249 250
   }

   
   printf("[CONFIG] get parameters from %s ",cfgmode);
251 252
   for (i=0;i<cfgptr->num_cfgP; i++) {
        printf("%s ",cfgptr->cfgP[i]); 
253
   }
254
   printf(", debug flags: 0x%08x\n",cfgptr->rtflags);
255

256 257 258 259 260 261 262 263 264 265
   if (strstr(cfgparam,CONFIG_CMDLINEONLY) == NULL) {
      i=load_config_sharedlib(cfgptr);
      if (i ==  0) {
         printf("[CONFIG] config module %s loaded\n",cfgmode);
         Config_Params[CONFIGPARAM_DEBUGFLAGS_IDX].uptr=&(cfgptr->rtflags);
         config_get(Config_Params,CONFIG_PARAMLENGTH(Config_Params), CONFIG_SECTIONNAME );
      } else {
         fprintf(stderr,"[CONFIG] %s %d config module \"%s\" couldn't be loaded\n", __FILE__, __LINE__,cfgmode);
         cfgptr->rtflags = cfgptr->rtflags | CONFIG_HELP | CONFIG_ABORT;
      } 
266
   } else {
267 268 269 270
      cfgptr->init = (configmodule_initfunc_t)nooptfunc;
      cfgptr->get = config_cmdlineonly_get;
      cfgptr->getlist = config_cmdlineonly_getlist;
      cfgptr->end = (configmodule_endfunc_t)nooptfunc;
271 272
   }

273
  
274 275 276

   if (modeparams != NULL) free(modeparams);
   if (cfgmode != NULL) free(cfgmode);
277 278
   if (CONFIG_ISFLAGSET(CONFIG_ABORT)) {
       config_printhelp(Config_Params,CONFIG_PARAMLENGTH(Config_Params));
279
//       exit(-1);   
280
   }
281 282 283
   return cfgptr;
}

284 285 286 287

/* free memory allocated when reading parameters */
/* config module could be initialized again after this call */
void end_configmodule(void)
288 289
{ 
  if (cfgptr != NULL) {
290 291 292 293
      if (cfgptr->end != NULL) {
         printf ("[CONFIG] calling config module end function...\n"); 
         cfgptr->end();
      }
294

295
      printf ("[CONFIG] free %u config value pointers\n",cfgptr->numptrs);  
296 297 298
      for(int i=0; i<cfgptr->numptrs ; i++) {
          if (cfgptr->ptrs[i] != NULL) {
             free(cfgptr->ptrs[i]);
299
             cfgptr->ptrs[i]=NULL;
300 301
          }
      }
302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317
      cfgptr->numptrs=0;
  }
}

/* free all memory used by config module */
/* should be called only at program exit */
void free_configmodule(void)
{ 
  if (cfgptr != NULL) {
      end_configmodule();
      if( cfgptr->cfgmode != NULL) free(cfgptr->cfgmode);
      printf ("[CONFIG] free %u config parameter pointers\n",cfgptr->num_cfgP);  
      for (int i=0; i<cfgptr->num_cfgP; i++) {
          if ( cfgptr->cfgP[i] != NULL) free(cfgptr->cfgP[i]);
          }

318

319 320 321 322 323 324 325 326
  free(cfgptr);
  cfgptr=NULL;
  }
}