Dima Zavin | 0fad7d0 | 2011-03-24 11:11:06 -0700 | [diff] [blame] | 1 | /* |
Mark Salyzyn | b957bac | 2013-11-22 07:38:46 -0800 | [diff] [blame] | 2 | * Copyright (C) 2011-2013 The Android Open Source Project |
Dima Zavin | 0fad7d0 | 2011-03-24 11:11:06 -0700 | [diff] [blame] | 3 | * |
| 4 | * Licensed under the Apache License, Version 2.0 (the "License"); |
| 5 | * you may not use this file except in compliance with the License. |
| 6 | * You may obtain a copy of the License at |
| 7 | * |
| 8 | * http://www.apache.org/licenses/LICENSE-2.0 |
| 9 | * |
| 10 | * Unless required by applicable law or agreed to in writing, software |
| 11 | * distributed under the License is distributed on an "AS IS" BASIS, |
| 12 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
| 13 | * See the License for the specific language governing permissions and |
| 14 | * limitations under the License. |
| 15 | */ |
| 16 | |
| 17 | #define LOG_TAG "str_params" |
| 18 | //#define LOG_NDEBUG 0 |
| 19 | |
| 20 | #define _GNU_SOURCE 1 |
| 21 | #include <errno.h> |
| 22 | #include <stdint.h> |
| 23 | #include <stdio.h> |
| 24 | #include <stdlib.h> |
| 25 | #include <string.h> |
| 26 | |
| 27 | #include <cutils/hashmap.h> |
Dima Zavin | 0fad7d0 | 2011-03-24 11:11:06 -0700 | [diff] [blame] | 28 | #include <cutils/memory.h> |
Dima Zavin | 0fad7d0 | 2011-03-24 11:11:06 -0700 | [diff] [blame] | 29 | #include <cutils/str_parms.h> |
Mark Salyzyn | 1271716 | 2014-04-29 15:49:14 -0700 | [diff] [blame^] | 30 | #include <log/log.h> |
Dima Zavin | 0fad7d0 | 2011-03-24 11:11:06 -0700 | [diff] [blame] | 31 | |
Mark Salyzyn | 2b94cc2 | 2013-11-22 07:36:45 -0800 | [diff] [blame] | 32 | #define UNUSED __attribute__((unused)) |
| 33 | |
Dima Zavin | 0fad7d0 | 2011-03-24 11:11:06 -0700 | [diff] [blame] | 34 | struct str_parms { |
| 35 | Hashmap *map; |
| 36 | }; |
| 37 | |
| 38 | |
| 39 | static bool str_eq(void *key_a, void *key_b) |
| 40 | { |
| 41 | return !strcmp((const char *)key_a, (const char *)key_b); |
| 42 | } |
| 43 | |
| 44 | /* use djb hash unless we find it inadequate */ |
| 45 | static int str_hash_fn(void *str) |
| 46 | { |
| 47 | uint32_t hash = 5381; |
| 48 | char *p; |
| 49 | |
| 50 | for (p = str; p && *p; p++) |
| 51 | hash = ((hash << 5) + hash) + *p; |
| 52 | return (int)hash; |
| 53 | } |
| 54 | |
| 55 | struct str_parms *str_parms_create(void) |
| 56 | { |
| 57 | struct str_parms *str_parms; |
| 58 | |
| 59 | str_parms = calloc(1, sizeof(struct str_parms)); |
| 60 | if (!str_parms) |
| 61 | return NULL; |
| 62 | |
| 63 | str_parms->map = hashmapCreate(5, str_hash_fn, str_eq); |
| 64 | if (!str_parms->map) |
| 65 | goto err; |
| 66 | |
| 67 | return str_parms; |
| 68 | |
| 69 | err: |
| 70 | free(str_parms); |
| 71 | return NULL; |
| 72 | } |
| 73 | |
Dima Zavin | efd7501 | 2012-03-14 23:12:40 -0700 | [diff] [blame] | 74 | struct remove_ctxt { |
| 75 | struct str_parms *str_parms; |
| 76 | const char *key; |
| 77 | }; |
| 78 | |
Dima Zavin | 0fad7d0 | 2011-03-24 11:11:06 -0700 | [diff] [blame] | 79 | static bool remove_pair(void *key, void *value, void *context) |
| 80 | { |
Dima Zavin | efd7501 | 2012-03-14 23:12:40 -0700 | [diff] [blame] | 81 | struct remove_ctxt *ctxt = context; |
| 82 | bool should_continue; |
Dima Zavin | 0fad7d0 | 2011-03-24 11:11:06 -0700 | [diff] [blame] | 83 | |
Dima Zavin | efd7501 | 2012-03-14 23:12:40 -0700 | [diff] [blame] | 84 | /* |
| 85 | * - if key is not supplied, then we are removing all entries, |
| 86 | * so remove key and continue (i.e. return true) |
| 87 | * - if key is supplied and matches, then remove it and don't |
| 88 | * continue (return false). Otherwise, return true and keep searching |
| 89 | * for key. |
| 90 | * |
| 91 | */ |
| 92 | if (!ctxt->key) { |
| 93 | should_continue = true; |
| 94 | goto do_remove; |
| 95 | } else if (!strcmp(ctxt->key, key)) { |
| 96 | should_continue = false; |
| 97 | goto do_remove; |
| 98 | } |
| 99 | |
| 100 | return true; |
| 101 | |
| 102 | do_remove: |
| 103 | hashmapRemove(ctxt->str_parms->map, key); |
Dima Zavin | 0fad7d0 | 2011-03-24 11:11:06 -0700 | [diff] [blame] | 104 | free(key); |
| 105 | free(value); |
Dima Zavin | efd7501 | 2012-03-14 23:12:40 -0700 | [diff] [blame] | 106 | return should_continue; |
| 107 | } |
| 108 | |
| 109 | void str_parms_del(struct str_parms *str_parms, const char *key) |
| 110 | { |
| 111 | struct remove_ctxt ctxt = { |
| 112 | .str_parms = str_parms, |
| 113 | .key = key, |
| 114 | }; |
| 115 | hashmapForEach(str_parms->map, remove_pair, &ctxt); |
Dima Zavin | 0fad7d0 | 2011-03-24 11:11:06 -0700 | [diff] [blame] | 116 | } |
| 117 | |
| 118 | void str_parms_destroy(struct str_parms *str_parms) |
| 119 | { |
Dima Zavin | efd7501 | 2012-03-14 23:12:40 -0700 | [diff] [blame] | 120 | struct remove_ctxt ctxt = { |
| 121 | .str_parms = str_parms, |
| 122 | }; |
| 123 | |
| 124 | hashmapForEach(str_parms->map, remove_pair, &ctxt); |
Dima Zavin | 0fad7d0 | 2011-03-24 11:11:06 -0700 | [diff] [blame] | 125 | hashmapFree(str_parms->map); |
| 126 | free(str_parms); |
| 127 | } |
| 128 | |
| 129 | struct str_parms *str_parms_create_str(const char *_string) |
| 130 | { |
| 131 | struct str_parms *str_parms; |
| 132 | char *str; |
| 133 | char *kvpair; |
| 134 | char *tmpstr; |
| 135 | int items = 0; |
| 136 | |
| 137 | str_parms = str_parms_create(); |
| 138 | if (!str_parms) |
| 139 | goto err_create_str_parms; |
| 140 | |
| 141 | str = strdup(_string); |
| 142 | if (!str) |
| 143 | goto err_strdup; |
| 144 | |
Steve Block | 69f4cd7 | 2011-10-20 11:54:09 +0100 | [diff] [blame] | 145 | ALOGV("%s: source string == '%s'\n", __func__, _string); |
Dima Zavin | 0fad7d0 | 2011-03-24 11:11:06 -0700 | [diff] [blame] | 146 | |
| 147 | kvpair = strtok_r(str, ";", &tmpstr); |
| 148 | while (kvpair && *kvpair) { |
| 149 | char *eq = strchr(kvpair, '='); /* would love strchrnul */ |
| 150 | char *value; |
| 151 | char *key; |
| 152 | void *old_val; |
| 153 | |
| 154 | if (eq == kvpair) |
| 155 | goto next_pair; |
| 156 | |
| 157 | if (eq) { |
| 158 | key = strndup(kvpair, eq - kvpair); |
| 159 | if (*(++eq)) |
| 160 | value = strdup(eq); |
| 161 | else |
| 162 | value = strdup(""); |
| 163 | } else { |
| 164 | key = strdup(kvpair); |
| 165 | value = strdup(""); |
| 166 | } |
| 167 | |
| 168 | /* if we replaced a value, free it */ |
| 169 | old_val = hashmapPut(str_parms->map, key, value); |
Dima Zavin | 86bfbe3 | 2012-03-14 23:10:06 -0700 | [diff] [blame] | 170 | if (old_val) { |
Dima Zavin | 0fad7d0 | 2011-03-24 11:11:06 -0700 | [diff] [blame] | 171 | free(old_val); |
Dima Zavin | 86bfbe3 | 2012-03-14 23:10:06 -0700 | [diff] [blame] | 172 | free(key); |
| 173 | } |
Dima Zavin | 0fad7d0 | 2011-03-24 11:11:06 -0700 | [diff] [blame] | 174 | |
| 175 | items++; |
| 176 | next_pair: |
| 177 | kvpair = strtok_r(NULL, ";", &tmpstr); |
| 178 | } |
| 179 | |
| 180 | if (!items) |
Steve Block | 69f4cd7 | 2011-10-20 11:54:09 +0100 | [diff] [blame] | 181 | ALOGV("%s: no items found in string\n", __func__); |
Dima Zavin | 0fad7d0 | 2011-03-24 11:11:06 -0700 | [diff] [blame] | 182 | |
| 183 | free(str); |
| 184 | |
| 185 | return str_parms; |
| 186 | |
| 187 | err_strdup: |
| 188 | str_parms_destroy(str_parms); |
| 189 | err_create_str_parms: |
| 190 | return NULL; |
| 191 | } |
| 192 | |
Dima Zavin | 0fad7d0 | 2011-03-24 11:11:06 -0700 | [diff] [blame] | 193 | int str_parms_add_str(struct str_parms *str_parms, const char *key, |
| 194 | const char *value) |
| 195 | { |
Jens Gulin | d3c8d5b | 2014-03-06 18:15:43 +0100 | [diff] [blame] | 196 | void *tmp_key = NULL; |
| 197 | void *tmp_val = NULL; |
| 198 | void *old_val = NULL; |
| 199 | |
| 200 | // strdup and hashmapPut both set errno on failure. |
| 201 | // Set errno to 0 so we can recognize whether anything went wrong. |
| 202 | int saved_errno = errno; |
| 203 | errno = 0; |
Dima Zavin | 0fad7d0 | 2011-03-24 11:11:06 -0700 | [diff] [blame] | 204 | |
Dima Zavin | 70b9303 | 2012-03-12 11:01:16 -0700 | [diff] [blame] | 205 | tmp_key = strdup(key); |
Jens Gulin | d3c8d5b | 2014-03-06 18:15:43 +0100 | [diff] [blame] | 206 | if (tmp_key == NULL) { |
| 207 | goto clean_up; |
Dima Zavin | 0fad7d0 | 2011-03-24 11:11:06 -0700 | [diff] [blame] | 208 | } |
Jens Gulin | d3c8d5b | 2014-03-06 18:15:43 +0100 | [diff] [blame] | 209 | |
| 210 | tmp_val = strdup(value); |
| 211 | if (tmp_val == NULL) { |
| 212 | goto clean_up; |
| 213 | } |
| 214 | |
| 215 | old_val = hashmapPut(str_parms->map, tmp_key, tmp_val); |
| 216 | if (old_val == NULL) { |
| 217 | // Did hashmapPut fail? |
| 218 | if (errno == ENOMEM) { |
| 219 | goto clean_up; |
| 220 | } |
| 221 | // For new keys, hashmap takes ownership of tmp_key and tmp_val. |
| 222 | tmp_key = tmp_val = NULL; |
| 223 | } else { |
| 224 | // For existing keys, hashmap takes ownership of tmp_val. |
| 225 | // (It also gives up ownership of old_val.) |
| 226 | tmp_val = NULL; |
| 227 | } |
| 228 | |
| 229 | clean_up: |
| 230 | free(tmp_key); |
| 231 | free(tmp_val); |
| 232 | free(old_val); |
| 233 | int result = -errno; |
| 234 | errno = saved_errno; |
| 235 | return result; |
Dima Zavin | 0fad7d0 | 2011-03-24 11:11:06 -0700 | [diff] [blame] | 236 | } |
| 237 | |
| 238 | int str_parms_add_int(struct str_parms *str_parms, const char *key, int value) |
| 239 | { |
| 240 | char val_str[12]; |
| 241 | int ret; |
| 242 | |
| 243 | ret = snprintf(val_str, sizeof(val_str), "%d", value); |
| 244 | if (ret < 0) |
| 245 | return -EINVAL; |
| 246 | |
| 247 | ret = str_parms_add_str(str_parms, key, val_str); |
| 248 | return ret; |
| 249 | } |
| 250 | |
| 251 | int str_parms_add_float(struct str_parms *str_parms, const char *key, |
| 252 | float value) |
| 253 | { |
| 254 | char val_str[23]; |
| 255 | int ret; |
| 256 | |
| 257 | ret = snprintf(val_str, sizeof(val_str), "%.10f", value); |
| 258 | if (ret < 0) |
| 259 | return -EINVAL; |
| 260 | |
| 261 | ret = str_parms_add_str(str_parms, key, val_str); |
| 262 | return ret; |
| 263 | } |
| 264 | |
| 265 | int str_parms_get_str(struct str_parms *str_parms, const char *key, char *val, |
| 266 | int len) |
| 267 | { |
| 268 | char *value; |
| 269 | |
| 270 | value = hashmapGet(str_parms->map, (void *)key); |
| 271 | if (value) |
| 272 | return strlcpy(val, value, len); |
| 273 | |
| 274 | return -ENOENT; |
| 275 | } |
| 276 | |
| 277 | int str_parms_get_int(struct str_parms *str_parms, const char *key, int *val) |
| 278 | { |
| 279 | char *value; |
| 280 | char *end; |
| 281 | |
| 282 | value = hashmapGet(str_parms->map, (void *)key); |
| 283 | if (!value) |
| 284 | return -ENOENT; |
| 285 | |
| 286 | *val = (int)strtol(value, &end, 0); |
| 287 | if (*value != '\0' && *end == '\0') |
| 288 | return 0; |
| 289 | |
| 290 | return -EINVAL; |
| 291 | } |
| 292 | |
| 293 | int str_parms_get_float(struct str_parms *str_parms, const char *key, |
| 294 | float *val) |
| 295 | { |
| 296 | float out; |
| 297 | char *value; |
| 298 | char *end; |
| 299 | |
| 300 | value = hashmapGet(str_parms->map, (void *)key); |
| 301 | if (!value) |
| 302 | return -ENOENT; |
| 303 | |
| 304 | out = strtof(value, &end); |
Mark Salyzyn | b957bac | 2013-11-22 07:38:46 -0800 | [diff] [blame] | 305 | if (*value == '\0' || *end != '\0') |
| 306 | return -EINVAL; |
Dima Zavin | 0fad7d0 | 2011-03-24 11:11:06 -0700 | [diff] [blame] | 307 | |
Mark Salyzyn | b957bac | 2013-11-22 07:38:46 -0800 | [diff] [blame] | 308 | *val = out; |
| 309 | return 0; |
Dima Zavin | 0fad7d0 | 2011-03-24 11:11:06 -0700 | [diff] [blame] | 310 | } |
| 311 | |
| 312 | static bool combine_strings(void *key, void *value, void *context) |
| 313 | { |
| 314 | char **old_str = context; |
| 315 | char *new_str; |
| 316 | int ret; |
| 317 | |
| 318 | ret = asprintf(&new_str, "%s%s%s=%s", |
| 319 | *old_str ? *old_str : "", |
| 320 | *old_str ? ";" : "", |
| 321 | (char *)key, |
| 322 | (char *)value); |
| 323 | if (*old_str) |
| 324 | free(*old_str); |
| 325 | |
| 326 | if (ret >= 0) { |
| 327 | *old_str = new_str; |
| 328 | return true; |
| 329 | } |
| 330 | |
| 331 | *old_str = NULL; |
| 332 | return false; |
| 333 | } |
| 334 | |
| 335 | char *str_parms_to_str(struct str_parms *str_parms) |
| 336 | { |
| 337 | char *str = NULL; |
| 338 | |
| 339 | if (hashmapSize(str_parms->map) > 0) |
| 340 | hashmapForEach(str_parms->map, combine_strings, &str); |
| 341 | else |
| 342 | str = strdup(""); |
| 343 | return str; |
| 344 | } |
| 345 | |
Mark Salyzyn | 2b94cc2 | 2013-11-22 07:36:45 -0800 | [diff] [blame] | 346 | static bool dump_entry(void *key, void *value, void *context UNUSED) |
Dima Zavin | 0fad7d0 | 2011-03-24 11:11:06 -0700 | [diff] [blame] | 347 | { |
Steve Block | fe71a61 | 2012-01-04 19:19:03 +0000 | [diff] [blame] | 348 | ALOGI("key: '%s' value: '%s'\n", (char *)key, (char *)value); |
Dima Zavin | 0fad7d0 | 2011-03-24 11:11:06 -0700 | [diff] [blame] | 349 | return true; |
| 350 | } |
| 351 | |
| 352 | void str_parms_dump(struct str_parms *str_parms) |
| 353 | { |
| 354 | hashmapForEach(str_parms->map, dump_entry, str_parms); |
| 355 | } |
| 356 | |
| 357 | #ifdef TEST_STR_PARMS |
| 358 | static void test_str_parms_str(const char *str) |
| 359 | { |
| 360 | struct str_parms *str_parms; |
| 361 | char *out_str; |
Dima Zavin | 0fad7d0 | 2011-03-24 11:11:06 -0700 | [diff] [blame] | 362 | |
| 363 | str_parms = str_parms_create_str(str); |
Dima Zavin | a603e40 | 2012-03-12 11:02:00 -0700 | [diff] [blame] | 364 | str_parms_add_str(str_parms, "dude", "woah"); |
Dima Zavin | efd7501 | 2012-03-14 23:12:40 -0700 | [diff] [blame] | 365 | str_parms_add_str(str_parms, "dude", "woah"); |
| 366 | str_parms_del(str_parms, "dude"); |
Dima Zavin | 0fad7d0 | 2011-03-24 11:11:06 -0700 | [diff] [blame] | 367 | str_parms_dump(str_parms); |
| 368 | out_str = str_parms_to_str(str_parms); |
| 369 | str_parms_destroy(str_parms); |
Steve Block | fe71a61 | 2012-01-04 19:19:03 +0000 | [diff] [blame] | 370 | ALOGI("%s: '%s' stringified is '%s'", __func__, str, out_str); |
Dima Zavin | 0fad7d0 | 2011-03-24 11:11:06 -0700 | [diff] [blame] | 371 | free(out_str); |
| 372 | } |
| 373 | |
| 374 | int main(void) |
| 375 | { |
Dima Zavin | 0fad7d0 | 2011-03-24 11:11:06 -0700 | [diff] [blame] | 376 | test_str_parms_str(""); |
| 377 | test_str_parms_str(";"); |
| 378 | test_str_parms_str("="); |
| 379 | test_str_parms_str("=;"); |
| 380 | test_str_parms_str("=bar"); |
| 381 | test_str_parms_str("=bar;"); |
| 382 | test_str_parms_str("foo="); |
| 383 | test_str_parms_str("foo=;"); |
| 384 | test_str_parms_str("foo=bar"); |
| 385 | test_str_parms_str("foo=bar;"); |
| 386 | test_str_parms_str("foo=bar;baz"); |
| 387 | test_str_parms_str("foo=bar;baz="); |
| 388 | test_str_parms_str("foo=bar;baz=bat"); |
| 389 | test_str_parms_str("foo=bar;baz=bat;"); |
Dima Zavin | 86bfbe3 | 2012-03-14 23:10:06 -0700 | [diff] [blame] | 390 | test_str_parms_str("foo=bar;baz=bat;foo=bar"); |
Dima Zavin | 0fad7d0 | 2011-03-24 11:11:06 -0700 | [diff] [blame] | 391 | |
Jens Gulin | d3c8d5b | 2014-03-06 18:15:43 +0100 | [diff] [blame] | 392 | // hashmapPut reports errors by setting errno to ENOMEM. |
| 393 | // Test that we're not confused by running in an environment where this is already true. |
| 394 | errno = ENOMEM; |
| 395 | test_str_parms_str("foo=bar;baz="); |
| 396 | if (errno != ENOMEM) { |
| 397 | abort(); |
| 398 | } |
| 399 | test_str_parms_str("foo=bar;baz="); |
| 400 | |
Dima Zavin | 0fad7d0 | 2011-03-24 11:11:06 -0700 | [diff] [blame] | 401 | return 0; |
| 402 | } |
| 403 | #endif |