1dd7bc3319deb2b77c5d07a51b7d6cd7e11b5beb0The Android Open Source Project/* 2dd7bc3319deb2b77c5d07a51b7d6cd7e11b5beb0The Android Open Source Project * Copyright (C) 2006 The Android Open Source Project 3dd7bc3319deb2b77c5d07a51b7d6cd7e11b5beb0The Android Open Source Project * 4dd7bc3319deb2b77c5d07a51b7d6cd7e11b5beb0The Android Open Source Project * Licensed under the Apache License, Version 2.0 (the "License"); 5dd7bc3319deb2b77c5d07a51b7d6cd7e11b5beb0The Android Open Source Project * you may not use this file except in compliance with the License. 6dd7bc3319deb2b77c5d07a51b7d6cd7e11b5beb0The Android Open Source Project * You may obtain a copy of the License at 7dd7bc3319deb2b77c5d07a51b7d6cd7e11b5beb0The Android Open Source Project * 8dd7bc3319deb2b77c5d07a51b7d6cd7e11b5beb0The Android Open Source Project * http://www.apache.org/licenses/LICENSE-2.0 9dd7bc3319deb2b77c5d07a51b7d6cd7e11b5beb0The Android Open Source Project * 10dd7bc3319deb2b77c5d07a51b7d6cd7e11b5beb0The Android Open Source Project * Unless required by applicable law or agreed to in writing, software 11dd7bc3319deb2b77c5d07a51b7d6cd7e11b5beb0The Android Open Source Project * distributed under the License is distributed on an "AS IS" BASIS, 12dd7bc3319deb2b77c5d07a51b7d6cd7e11b5beb0The Android Open Source Project * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 13dd7bc3319deb2b77c5d07a51b7d6cd7e11b5beb0The Android Open Source Project * See the License for the specific language governing permissions and 14dd7bc3319deb2b77c5d07a51b7d6cd7e11b5beb0The Android Open Source Project * limitations under the License. 15dd7bc3319deb2b77c5d07a51b7d6cd7e11b5beb0The Android Open Source Project */ 16dd7bc3319deb2b77c5d07a51b7d6cd7e11b5beb0The Android Open Source Project 17dd7bc3319deb2b77c5d07a51b7d6cd7e11b5beb0The Android Open Source Project#ifndef __CUTILS_PROPERTIES_H 18dd7bc3319deb2b77c5d07a51b7d6cd7e11b5beb0The Android Open Source Project#define __CUTILS_PROPERTIES_H 19dd7bc3319deb2b77c5d07a51b7d6cd7e11b5beb0The Android Open Source Project 200e54ec825e6eae234a486c2049039fb6986a39b8Nick Kralevich#include <sys/cdefs.h> 210e54ec825e6eae234a486c2049039fb6986a39b8Nick Kralevich#include <stddef.h> 2253df3ade9bacce57099bb9eeb2a34bb5945d463eNick Kralevich#include <sys/system_properties.h> 23d8f2a8d34a5655d81fec2f56eb3ec36bd508886aIgor Murashkin#include <stdint.h> 2453df3ade9bacce57099bb9eeb2a34bb5945d463eNick Kralevich 25dd7bc3319deb2b77c5d07a51b7d6cd7e11b5beb0The Android Open Source Project#ifdef __cplusplus 26dd7bc3319deb2b77c5d07a51b7d6cd7e11b5beb0The Android Open Source Projectextern "C" { 27dd7bc3319deb2b77c5d07a51b7d6cd7e11b5beb0The Android Open Source Project#endif 28dd7bc3319deb2b77c5d07a51b7d6cd7e11b5beb0The Android Open Source Project 29dd7bc3319deb2b77c5d07a51b7d6cd7e11b5beb0The Android Open Source Project/* System properties are *small* name value pairs managed by the 30dd7bc3319deb2b77c5d07a51b7d6cd7e11b5beb0The Android Open Source Project** property service. If your data doesn't fit in the provided 31dd7bc3319deb2b77c5d07a51b7d6cd7e11b5beb0The Android Open Source Project** space it is not appropriate for a system property. 32dd7bc3319deb2b77c5d07a51b7d6cd7e11b5beb0The Android Open Source Project** 33dd7bc3319deb2b77c5d07a51b7d6cd7e11b5beb0The Android Open Source Project** WARNING: system/bionic/include/sys/system_properties.h also defines 34dd7bc3319deb2b77c5d07a51b7d6cd7e11b5beb0The Android Open Source Project** these, but with different names. (TODO: fix that) 35dd7bc3319deb2b77c5d07a51b7d6cd7e11b5beb0The Android Open Source Project*/ 3653df3ade9bacce57099bb9eeb2a34bb5945d463eNick Kralevich#define PROPERTY_KEY_MAX PROP_NAME_MAX 3753df3ade9bacce57099bb9eeb2a34bb5945d463eNick Kralevich#define PROPERTY_VALUE_MAX PROP_VALUE_MAX 38dd7bc3319deb2b77c5d07a51b7d6cd7e11b5beb0The Android Open Source Project 39dd7bc3319deb2b77c5d07a51b7d6cd7e11b5beb0The Android Open Source Project/* property_get: returns the length of the value which will never be 40dd7bc3319deb2b77c5d07a51b7d6cd7e11b5beb0The Android Open Source Project** greater than PROPERTY_VALUE_MAX - 1 and will always be zero terminated. 41dd7bc3319deb2b77c5d07a51b7d6cd7e11b5beb0The Android Open Source Project** (the length does not include the terminating zero). 42dd7bc3319deb2b77c5d07a51b7d6cd7e11b5beb0The Android Open Source Project** 43dd7bc3319deb2b77c5d07a51b7d6cd7e11b5beb0The Android Open Source Project** If the property read fails or returns an empty value, the default 44dd7bc3319deb2b77c5d07a51b7d6cd7e11b5beb0The Android Open Source Project** value is used (if nonnull). 45dd7bc3319deb2b77c5d07a51b7d6cd7e11b5beb0The Android Open Source Project*/ 469bf11c1d05d30cccdbd266bfcbd8060a4f37503bGeorge Burgess IVint property_get(const char* key, char* value, const char* default_value); 47dd7bc3319deb2b77c5d07a51b7d6cd7e11b5beb0The Android Open Source Project 48d8f2a8d34a5655d81fec2f56eb3ec36bd508886aIgor Murashkin/* property_get_bool: returns the value of key coerced into a 49d8f2a8d34a5655d81fec2f56eb3ec36bd508886aIgor Murashkin** boolean. If the property is not set, then the default value is returned. 50d8f2a8d34a5655d81fec2f56eb3ec36bd508886aIgor Murashkin** 51d8f2a8d34a5655d81fec2f56eb3ec36bd508886aIgor Murashkin* The following is considered to be true (1): 52d8f2a8d34a5655d81fec2f56eb3ec36bd508886aIgor Murashkin** "1", "true", "y", "yes", "on" 53d8f2a8d34a5655d81fec2f56eb3ec36bd508886aIgor Murashkin** 54d8f2a8d34a5655d81fec2f56eb3ec36bd508886aIgor Murashkin** The following is considered to be false (0): 55d8f2a8d34a5655d81fec2f56eb3ec36bd508886aIgor Murashkin** "0", "false", "n", "no", "off" 56d8f2a8d34a5655d81fec2f56eb3ec36bd508886aIgor Murashkin** 57d8f2a8d34a5655d81fec2f56eb3ec36bd508886aIgor Murashkin** The conversion is whitespace-sensitive (e.g. " off" will not be false). 58d8f2a8d34a5655d81fec2f56eb3ec36bd508886aIgor Murashkin** 59d8f2a8d34a5655d81fec2f56eb3ec36bd508886aIgor Murashkin** If no property with this key is set (or the key is NULL) or the boolean 60d8f2a8d34a5655d81fec2f56eb3ec36bd508886aIgor Murashkin** conversion fails, the default value is returned. 61d8f2a8d34a5655d81fec2f56eb3ec36bd508886aIgor Murashkin**/ 62d8f2a8d34a5655d81fec2f56eb3ec36bd508886aIgor Murashkinint8_t property_get_bool(const char *key, int8_t default_value); 63d8f2a8d34a5655d81fec2f56eb3ec36bd508886aIgor Murashkin 64d8f2a8d34a5655d81fec2f56eb3ec36bd508886aIgor Murashkin/* property_get_int64: returns the value of key truncated and coerced into a 65d8f2a8d34a5655d81fec2f56eb3ec36bd508886aIgor Murashkin** int64_t. If the property is not set, then the default value is used. 66d8f2a8d34a5655d81fec2f56eb3ec36bd508886aIgor Murashkin** 67d8f2a8d34a5655d81fec2f56eb3ec36bd508886aIgor Murashkin** The numeric conversion is identical to strtoimax with the base inferred: 68d8f2a8d34a5655d81fec2f56eb3ec36bd508886aIgor Murashkin** - All digits up to the first non-digit characters are read 69d8f2a8d34a5655d81fec2f56eb3ec36bd508886aIgor Murashkin** - The longest consecutive prefix of digits is converted to a long 70d8f2a8d34a5655d81fec2f56eb3ec36bd508886aIgor Murashkin** 71d8f2a8d34a5655d81fec2f56eb3ec36bd508886aIgor Murashkin** Valid strings of digits are: 72d8f2a8d34a5655d81fec2f56eb3ec36bd508886aIgor Murashkin** - An optional sign character + or - 73d8f2a8d34a5655d81fec2f56eb3ec36bd508886aIgor Murashkin** - An optional prefix indicating the base (otherwise base 10 is assumed) 74d8f2a8d34a5655d81fec2f56eb3ec36bd508886aIgor Murashkin** -- 0 prefix is octal 75d8f2a8d34a5655d81fec2f56eb3ec36bd508886aIgor Murashkin** -- 0x / 0X prefix is hex 76d8f2a8d34a5655d81fec2f56eb3ec36bd508886aIgor Murashkin** 77d8f2a8d34a5655d81fec2f56eb3ec36bd508886aIgor Murashkin** Leading/trailing whitespace is ignored. Overflow/underflow will cause 78d8f2a8d34a5655d81fec2f56eb3ec36bd508886aIgor Murashkin** numeric conversion to fail. 79d8f2a8d34a5655d81fec2f56eb3ec36bd508886aIgor Murashkin** 80d8f2a8d34a5655d81fec2f56eb3ec36bd508886aIgor Murashkin** If no property with this key is set (or the key is NULL) or the numeric 81d8f2a8d34a5655d81fec2f56eb3ec36bd508886aIgor Murashkin** conversion fails, the default value is returned. 82d8f2a8d34a5655d81fec2f56eb3ec36bd508886aIgor Murashkin**/ 83d8f2a8d34a5655d81fec2f56eb3ec36bd508886aIgor Murashkinint64_t property_get_int64(const char *key, int64_t default_value); 84d8f2a8d34a5655d81fec2f56eb3ec36bd508886aIgor Murashkin 85d8f2a8d34a5655d81fec2f56eb3ec36bd508886aIgor Murashkin/* property_get_int32: returns the value of key truncated and coerced into an 86d8f2a8d34a5655d81fec2f56eb3ec36bd508886aIgor Murashkin** int32_t. If the property is not set, then the default value is used. 87d8f2a8d34a5655d81fec2f56eb3ec36bd508886aIgor Murashkin** 88d8f2a8d34a5655d81fec2f56eb3ec36bd508886aIgor Murashkin** The numeric conversion is identical to strtoimax with the base inferred: 89d8f2a8d34a5655d81fec2f56eb3ec36bd508886aIgor Murashkin** - All digits up to the first non-digit characters are read 90d8f2a8d34a5655d81fec2f56eb3ec36bd508886aIgor Murashkin** - The longest consecutive prefix of digits is converted to a long 91d8f2a8d34a5655d81fec2f56eb3ec36bd508886aIgor Murashkin** 92d8f2a8d34a5655d81fec2f56eb3ec36bd508886aIgor Murashkin** Valid strings of digits are: 93d8f2a8d34a5655d81fec2f56eb3ec36bd508886aIgor Murashkin** - An optional sign character + or - 94d8f2a8d34a5655d81fec2f56eb3ec36bd508886aIgor Murashkin** - An optional prefix indicating the base (otherwise base 10 is assumed) 95d8f2a8d34a5655d81fec2f56eb3ec36bd508886aIgor Murashkin** -- 0 prefix is octal 96d8f2a8d34a5655d81fec2f56eb3ec36bd508886aIgor Murashkin** -- 0x / 0X prefix is hex 97d8f2a8d34a5655d81fec2f56eb3ec36bd508886aIgor Murashkin** 98d8f2a8d34a5655d81fec2f56eb3ec36bd508886aIgor Murashkin** Leading/trailing whitespace is ignored. Overflow/underflow will cause 99d8f2a8d34a5655d81fec2f56eb3ec36bd508886aIgor Murashkin** numeric conversion to fail. 100d8f2a8d34a5655d81fec2f56eb3ec36bd508886aIgor Murashkin** 101d8f2a8d34a5655d81fec2f56eb3ec36bd508886aIgor Murashkin** If no property with this key is set (or the key is NULL) or the numeric 102d8f2a8d34a5655d81fec2f56eb3ec36bd508886aIgor Murashkin** conversion fails, the default value is returned. 103d8f2a8d34a5655d81fec2f56eb3ec36bd508886aIgor Murashkin**/ 104d8f2a8d34a5655d81fec2f56eb3ec36bd508886aIgor Murashkinint32_t property_get_int32(const char *key, int32_t default_value); 105d8f2a8d34a5655d81fec2f56eb3ec36bd508886aIgor Murashkin 106dd7bc3319deb2b77c5d07a51b7d6cd7e11b5beb0The Android Open Source Project/* property_set: returns 0 on success, < 0 on failure 107dd7bc3319deb2b77c5d07a51b7d6cd7e11b5beb0The Android Open Source Project*/ 108dd7bc3319deb2b77c5d07a51b7d6cd7e11b5beb0The Android Open Source Projectint property_set(const char *key, const char *value); 109dd7bc3319deb2b77c5d07a51b7d6cd7e11b5beb0The Android Open Source Project 11067959bceb2e15fdf6e114e34eb6b6d013a3b0fafGeorge Burgess IVint property_list(void (*propfn)(const char *key, const char *value, void *cookie), void *cookie); 11167959bceb2e15fdf6e114e34eb6b6d013a3b0fafGeorge Burgess IV 11267959bceb2e15fdf6e114e34eb6b6d013a3b0fafGeorge Burgess IV#if defined(__BIONIC_FORTIFY) 11367959bceb2e15fdf6e114e34eb6b6d013a3b0fafGeorge Burgess IV#define __property_get_err_str "property_get() called with too small of a buffer" 11467959bceb2e15fdf6e114e34eb6b6d013a3b0fafGeorge Burgess IV 11567959bceb2e15fdf6e114e34eb6b6d013a3b0fafGeorge Burgess IV#if defined(__clang__) 11667959bceb2e15fdf6e114e34eb6b6d013a3b0fafGeorge Burgess IV 1179bf11c1d05d30cccdbd266bfcbd8060a4f37503bGeorge Burgess IV/* Some projects use -Weverything; diagnose_if is clang-specific. */ 11867959bceb2e15fdf6e114e34eb6b6d013a3b0fafGeorge Burgess IV#pragma clang diagnostic push 11967959bceb2e15fdf6e114e34eb6b6d013a3b0fafGeorge Burgess IV#pragma clang diagnostic ignored "-Wgcc-compat" 1209bf11c1d05d30cccdbd266bfcbd8060a4f37503bGeorge Burgess IVint property_get(const char* key, char* value, const char* default_value) 1219bf11c1d05d30cccdbd266bfcbd8060a4f37503bGeorge Burgess IV __clang_error_if(__bos(value) != __BIONIC_FORTIFY_UNKNOWN_SIZE && 1229bf11c1d05d30cccdbd266bfcbd8060a4f37503bGeorge Burgess IV __bos(value) < PROPERTY_VALUE_MAX, 1239bf11c1d05d30cccdbd266bfcbd8060a4f37503bGeorge Burgess IV __property_get_err_str); 12467959bceb2e15fdf6e114e34eb6b6d013a3b0fafGeorge Burgess IV#pragma clang diagnostic pop 12567959bceb2e15fdf6e114e34eb6b6d013a3b0fafGeorge Burgess IV 12667959bceb2e15fdf6e114e34eb6b6d013a3b0fafGeorge Burgess IV#else /* defined(__clang__) */ 1270e54ec825e6eae234a486c2049039fb6986a39b8Nick Kralevich 1280e54ec825e6eae234a486c2049039fb6986a39b8Nick Kralevichextern int __property_get_real(const char *, char *, const char *) 1290e54ec825e6eae234a486c2049039fb6986a39b8Nick Kralevich __asm__(__USER_LABEL_PREFIX__ "property_get"); 13067959bceb2e15fdf6e114e34eb6b6d013a3b0fafGeorge Burgess IV__errordecl(__property_get_too_small_error, __property_get_err_str); 1310e54ec825e6eae234a486c2049039fb6986a39b8Nick Kralevich 1320e54ec825e6eae234a486c2049039fb6986a39b8Nick Kralevich__BIONIC_FORTIFY_INLINE 1330e54ec825e6eae234a486c2049039fb6986a39b8Nick Kralevichint property_get(const char *key, char *value, const char *default_value) { 1340e54ec825e6eae234a486c2049039fb6986a39b8Nick Kralevich size_t bos = __bos(value); 1350e54ec825e6eae234a486c2049039fb6986a39b8Nick Kralevich if (bos < PROPERTY_VALUE_MAX) { 1360e54ec825e6eae234a486c2049039fb6986a39b8Nick Kralevich __property_get_too_small_error(); 1370e54ec825e6eae234a486c2049039fb6986a39b8Nick Kralevich } 1380e54ec825e6eae234a486c2049039fb6986a39b8Nick Kralevich return __property_get_real(key, value, default_value); 1390e54ec825e6eae234a486c2049039fb6986a39b8Nick Kralevich} 1400e54ec825e6eae234a486c2049039fb6986a39b8Nick Kralevich 14167959bceb2e15fdf6e114e34eb6b6d013a3b0fafGeorge Burgess IV#endif /* defined(__clang__) */ 14267959bceb2e15fdf6e114e34eb6b6d013a3b0fafGeorge Burgess IV 14367959bceb2e15fdf6e114e34eb6b6d013a3b0fafGeorge Burgess IV#undef __property_get_err_str 14467959bceb2e15fdf6e114e34eb6b6d013a3b0fafGeorge Burgess IV#endif /* defined(__BIONIC_FORTIFY) */ 145dd7bc3319deb2b77c5d07a51b7d6cd7e11b5beb0The Android Open Source Project 146dd7bc3319deb2b77c5d07a51b7d6cd7e11b5beb0The Android Open Source Project#ifdef __cplusplus 147dd7bc3319deb2b77c5d07a51b7d6cd7e11b5beb0The Android Open Source Project} 148dd7bc3319deb2b77c5d07a51b7d6cd7e11b5beb0The Android Open Source Project#endif 149dd7bc3319deb2b77c5d07a51b7d6cd7e11b5beb0The Android Open Source Project 150dd7bc3319deb2b77c5d07a51b7d6cd7e11b5beb0The Android Open Source Project#endif 151