common/tr_config_internal.c

   1 /*
   2  * Copyright (c) 2012-2018, JANET(UK)
   3  * All rights reserved.
   4  *
   5  * Redistribution and use in source and binary forms, with or without
   6  * modification, are permitted provided that the following conditions
   7  * are met:
   8  *
   9  * 1. Redistributions of source code must retain the above copyright
  10  *    notice, this list of conditions and the following disclaimer.
  11  *
  12  * 2. Redistributions in binary form must reproduce the above copyright
  13  *    notice, this list of conditions and the following disclaimer in the
  14  *    documentation and/or other materials provided with the distribution.
  15  *
  16  * 3. Neither the name of JANET(UK) nor the names of its contributors
  17  *    may be used to endorse or promote products derived from this software
  18  *    without specific prior written permission.
  19  *
  20  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  21  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  22  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
  23  * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
  24  * COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT,
  25  * INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
  26  * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
  27  * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  28  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
  29  * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
  30  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
  31  * OF THE POSSIBILITY OF SUCH DAMAGE.
  32  *
  33  */
  34
  35 #include <talloc.h>
  36 #include <jansson.h>
  37 #include <tr_debug.h>
  38 #include <tr_config.h>
  39 #include <tr_cfgwatch.h>
  40
  41 /**
  42  * Parse a boolean
  43  *
  44  * If the key does not exist in the src object, returns success but does fill in *dest.
  45  *
  46  * @param src JSON object to pull a value from
  47  * @param key key to pull
  48  * @param dest (output) pointer to an allocated integer
  49  * @return TR_CFG_SUCCESS or an error code
  50  */
  51 static TR_CFG_RC tr_cfg_parse_boolean(json_t *src, const char *key, int *dest)
  52 {
  53   json_t *jtmp;
  54
  55   /* Validate parameters */
  56   if ((src == NULL) || (key == NULL) || (dest == NULL))
  57     return TR_CFG_BAD_PARAMS;
  58
  59   /* See if we have a value for this key; do nothing if not */
  60   jtmp = json_object_get(src, key);
  61   if (jtmp) {
  62     if (json_is_boolean(jtmp)) {
  63       *dest = json_boolean_value(jtmp);
  64     } else {
  65       tr_debug("tr_cfg_parse_unsigned: Parsing error, %s is not a boolean.", key);
  66       return TR_CFG_NOPARSE;
  67     }
  68   }
  69
  70   return TR_CFG_SUCCESS;
  71 }
  72
  73 /**
  74  * Parse an unsigned integer
  75  *
  76  * If the key does not exist in the src object, returns success but does fill in *dest.
  77  *
  78  * @param src JSON object to pull a value from
  79  * @param key key to pull
  80  * @param dest (output) pointer to an allocated unsigned integer
  81  * @return TR_CFG_SUCCESS or an error code
  82  */
  83 static TR_CFG_RC tr_cfg_parse_unsigned(json_t *src, const char *key, unsigned int *dest)
  84 {
  85   json_t *jtmp;
  86
  87   /* Validate parameters */
  88   if ((src == NULL) || (key == NULL) || (dest == NULL))
  89     return TR_CFG_BAD_PARAMS;
  90
  91   /* See if we have a value for this key; do nothing if not */
  92   jtmp = json_object_get(src, key);
  93   if (jtmp) {
  94     if (json_is_number(jtmp)) {
  95       *dest = (unsigned int) json_integer_value(jtmp);
  96     } else {
  97       tr_debug("tr_cfg_parse_unsigned: Parsing error, %s is not a number.", key);
  98       return TR_CFG_NOPARSE;
  99     }
 100   }
 101
 102   return TR_CFG_SUCCESS;
 103 }
 104
 105 /**
 106  * Parse a string
 107  *
 108  * If the key does not exist in the src object, returns success but does not allocate
 109  * a return value in dest. Nulls the destination pointer if there is no return value.
 110  *
 111  * Return value is allocated in talloc's NULL context and must be freed with talloc_free()
 112  * or put into a non-NULL context with talloc_steal()
 113  *
 114  * @param src JSON object to pull a value from
 115  * @param key key to pull
 116  * @param dest (output) pointer to a pointer that will hold the newly allocated return value
 117  * @return TR_CFG_SUCCESS or an error code
 118  */
 119 static TR_CFG_RC tr_cfg_parse_string(json_t *src, const char *key, const char **dest)
 120 {
 121   json_t *jtmp;
 122
 123   /* Validate parameters */
 124   if ((src == NULL) || (key == NULL) || (dest == NULL))
 125     return TR_CFG_BAD_PARAMS;
 126
 127   /* See if we have a value for this key; do nothing if not */
 128   jtmp = json_object_get(src, key);
 129   if (!jtmp) {
 130     *dest = NULL; /* No return value, null this out */
 131   } else {
 132     if (json_is_string(jtmp)) {
 133       *dest = talloc_strdup(NULL, json_string_value(jtmp));
 134     } else {
 135       tr_debug("tr_cfg_parse_string: Parsing error, %s is not a string.", key);
 136       return TR_CFG_NOPARSE;
 137     }
 138   }
 139
 140   return TR_CFG_SUCCESS;
 141 }
 142
 143 /**
 144  * Set default values for settings that have them
 145  *
 146  * @param cfg configuration structure to fill in, not null
 147  */
 148 static void set_defaults(TR_CFG_INTERNAL *cfg)
 149 {
 150   cfg->max_tree_depth = TR_DEFAULT_MAX_TREE_DEPTH;
 151   cfg->tids_port = TR_DEFAULT_TIDS_PORT;
 152   cfg->trps_port = TR_DEFAULT_TRPS_PORT;
 153   cfg->monitoring_port = TR_DEFAULT_MONITORING_PORT;
 154   cfg->cfg_poll_interval = TR_CFGWATCH_DEFAULT_POLL;
 155   cfg->cfg_settling_time = TR_CFGWATCH_DEFAULT_SETTLE;
 156   cfg->trp_connect_interval = TR_DEFAULT_TRP_CONNECT_INTERVAL;
 157   cfg->trp_sweep_interval = TR_DEFAULT_TRP_SWEEP_INTERVAL;
 158   cfg->trp_update_interval = TR_DEFAULT_TRP_UPDATE_INTERVAL;
 159   cfg->tid_req_timeout = TR_DEFAULT_TID_REQ_TIMEOUT;
 160   cfg->tid_resp_numer = TR_DEFAULT_TID_RESP_NUMER;
 161   cfg->tid_resp_denom = TR_DEFAULT_TID_RESP_DENOM;
 162   cfg->log_threshold = TR_DEFAULT_LOG_THRESHOLD;
 163   cfg->console_threshold = TR_DEFAULT_CONSOLE_THRESHOLD;
 164   cfg->monitoring_credentials = NULL;
 165 }
 166
 167 /* Helper that checks return value of a parse fn and returns if it failed */
 168 #define NOPARSE_UNLESS(x)    \
 169 do {                         \
 170   if ((x) != TR_CFG_SUCCESS) \
 171     return TR_CFG_NOPARSE;   \
 172 } while(0)
 173
 174 /**
 175  * Parse internal configuration JSON
 176  *
 177  * @param trc configuration structure to fill in
 178  * @param jint internal configuration JSON object
 179  * @return TR_CFG_SUCCESS or an error code
 180  */
 181 TR_CFG_RC tr_cfg_parse_internal(TR_CFG *trc, json_t *jint)
 182 {
 183   json_t *jtmp = NULL;
 184   const char *s = NULL;
 185
 186   if ((!trc) || (!jint))
 187     return TR_CFG_BAD_PARAMS;
 188
 189   /* If we don't yet have an internal config, allocate one and set defaults. If it
 190    * already exists, do not disturb existing settings. */
 191   if (NULL == trc->internal) {
 192     if (NULL == (trc->internal = talloc_zero(trc, TR_CFG_INTERNAL)))
 193       return TR_CFG_NOMEM;
 194     set_defaults(trc->internal); /* Install defaults for any unspecified settings */
 195   }
 196
 197   NOPARSE_UNLESS(tr_cfg_parse_string(jint, "hostname", &(trc->internal->hostname)));
 198   talloc_steal(trc->internal, trc->internal->hostname);
 199
 200   NOPARSE_UNLESS(tr_cfg_parse_unsigned(jint, "max_tree_depth",           &(trc->internal->max_tree_depth)));
 201   NOPARSE_UNLESS(tr_cfg_parse_unsigned(jint, "tids_port",                &(trc->internal->tids_port)));
 202   NOPARSE_UNLESS(tr_cfg_parse_unsigned(jint, "trps_port",                &(trc->internal->trps_port)));
 203   NOPARSE_UNLESS(tr_cfg_parse_unsigned(jint, "cfg_poll_interval",        &(trc->internal->cfg_poll_interval)));
 204   NOPARSE_UNLESS(tr_cfg_parse_unsigned(jint, "cfg_settling_time",        &(trc->internal->cfg_settling_time)));
 205   NOPARSE_UNLESS(tr_cfg_parse_unsigned(jint, "trp_connect_interval",     &(trc->internal->trp_connect_interval)));
 206   NOPARSE_UNLESS(tr_cfg_parse_unsigned(jint, "trp_sweep_interval",       &(trc->internal->trp_sweep_interval)));
 207   NOPARSE_UNLESS(tr_cfg_parse_unsigned(jint, "trp_update_interval",      &(trc->internal->trp_update_interval)));
 208   NOPARSE_UNLESS(tr_cfg_parse_unsigned(jint, "tid_request_timeout",      &(trc->internal->tid_req_timeout)));
 209   NOPARSE_UNLESS(tr_cfg_parse_unsigned(jint, "tid_response_numerator",   &(trc->internal->tid_resp_numer)));
 210   NOPARSE_UNLESS(tr_cfg_parse_unsigned(jint, "tid_response_denominator", &(trc->internal->tid_resp_denom)));
 211
 212   /* Parse the logging section */
 213   if (NULL != (jtmp = json_object_get(jint, "logging"))) {
 214     NOPARSE_UNLESS(tr_cfg_parse_string(jtmp, "log_threshold", &s));
 215     if (s) {
 216       trc->internal->log_threshold = str2sev(s);
 217       talloc_free((void *) s);
 218     }
 219
 220     NOPARSE_UNLESS(tr_cfg_parse_string(jtmp, "console_threshold", &s));
 221     if (s) {
 222       trc->internal->console_threshold = str2sev(s);
 223       talloc_free((void *) s);
 224     }
 225   }
 226
 227   /* Parse the monitoring section */
 228   if (NULL != (jtmp = json_object_get(jint, "monitoring"))) {
 229     NOPARSE_UNLESS(tr_cfg_parse_unsigned(jtmp, "port", &(trc->internal->monitoring_port)));
 230   }
 231
 232   tr_debug("tr_cfg_parse_internal: Internal config parsed.");
 233   return TR_CFG_SUCCESS;
 234 }