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> 23d4507e9246e4855c5431cac5c3d1a9155caebc87Igor 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*/ 46dd7bc3319deb2b77c5d07a51b7d6cd7e11b5beb0The Android Open Source Projectint property_get(const char *key, char *value, const char *default_value); 47dd7bc3319deb2b77c5d07a51b7d6cd7e11b5beb0The Android Open Source Project 48d4507e9246e4855c5431cac5c3d1a9155caebc87Igor Murashkin/* property_get_bool: returns the value of key coerced into a 49d4507e9246e4855c5431cac5c3d1a9155caebc87Igor Murashkin** boolean. If the property is not set, then the default value is returned. 50d4507e9246e4855c5431cac5c3d1a9155caebc87Igor Murashkin** 51d4507e9246e4855c5431cac5c3d1a9155caebc87Igor Murashkin* The following is considered to be true (1): 52d4507e9246e4855c5431cac5c3d1a9155caebc87Igor Murashkin** "1", "true", "y", "yes", "on" 53d4507e9246e4855c5431cac5c3d1a9155caebc87Igor Murashkin** 54d4507e9246e4855c5431cac5c3d1a9155caebc87Igor Murashkin** The following is considered to be false (0): 55d4507e9246e4855c5431cac5c3d1a9155caebc87Igor Murashkin** "0", "false", "n", "no", "off" 56d4507e9246e4855c5431cac5c3d1a9155caebc87Igor Murashkin** 57d4507e9246e4855c5431cac5c3d1a9155caebc87Igor Murashkin** The conversion is whitespace-sensitive (e.g. " off" will not be false). 58d4507e9246e4855c5431cac5c3d1a9155caebc87Igor Murashkin** 59d4507e9246e4855c5431cac5c3d1a9155caebc87Igor Murashkin** If no property with this key is set (or the key is NULL) or the boolean 60d4507e9246e4855c5431cac5c3d1a9155caebc87Igor Murashkin** conversion fails, the default value is returned. 61d4507e9246e4855c5431cac5c3d1a9155caebc87Igor Murashkin**/ 62d4507e9246e4855c5431cac5c3d1a9155caebc87Igor Murashkinint8_t property_get_bool(const char *key, int8_t default_value); 63d4507e9246e4855c5431cac5c3d1a9155caebc87Igor Murashkin 64d4507e9246e4855c5431cac5c3d1a9155caebc87Igor Murashkin/* property_get_int64: returns the value of key truncated and coerced into a 65d4507e9246e4855c5431cac5c3d1a9155caebc87Igor Murashkin** int64_t. If the property is not set, then the default value is used. 66d4507e9246e4855c5431cac5c3d1a9155caebc87Igor Murashkin** 67d4507e9246e4855c5431cac5c3d1a9155caebc87Igor Murashkin** The numeric conversion is identical to strtoimax with the base inferred: 68d4507e9246e4855c5431cac5c3d1a9155caebc87Igor Murashkin** - All digits up to the first non-digit characters are read 69d4507e9246e4855c5431cac5c3d1a9155caebc87Igor Murashkin** - The longest consecutive prefix of digits is converted to a long 70d4507e9246e4855c5431cac5c3d1a9155caebc87Igor Murashkin** 71d4507e9246e4855c5431cac5c3d1a9155caebc87Igor Murashkin** Valid strings of digits are: 72d4507e9246e4855c5431cac5c3d1a9155caebc87Igor Murashkin** - An optional sign character + or - 73d4507e9246e4855c5431cac5c3d1a9155caebc87Igor Murashkin** - An optional prefix indicating the base (otherwise base 10 is assumed) 74d4507e9246e4855c5431cac5c3d1a9155caebc87Igor Murashkin** -- 0 prefix is octal 75d4507e9246e4855c5431cac5c3d1a9155caebc87Igor Murashkin** -- 0x / 0X prefix is hex 76d4507e9246e4855c5431cac5c3d1a9155caebc87Igor Murashkin** 77d4507e9246e4855c5431cac5c3d1a9155caebc87Igor Murashkin** Leading/trailing whitespace is ignored. Overflow/underflow will cause 78d4507e9246e4855c5431cac5c3d1a9155caebc87Igor Murashkin** numeric conversion to fail. 79d4507e9246e4855c5431cac5c3d1a9155caebc87Igor Murashkin** 80d4507e9246e4855c5431cac5c3d1a9155caebc87Igor Murashkin** If no property with this key is set (or the key is NULL) or the numeric 81d4507e9246e4855c5431cac5c3d1a9155caebc87Igor Murashkin** conversion fails, the default value is returned. 82d4507e9246e4855c5431cac5c3d1a9155caebc87Igor Murashkin**/ 83d4507e9246e4855c5431cac5c3d1a9155caebc87Igor Murashkinint64_t property_get_int64(const char *key, int64_t default_value); 84d4507e9246e4855c5431cac5c3d1a9155caebc87Igor Murashkin 85d4507e9246e4855c5431cac5c3d1a9155caebc87Igor Murashkin/* property_get_int32: returns the value of key truncated and coerced into an 86d4507e9246e4855c5431cac5c3d1a9155caebc87Igor Murashkin** int32_t. If the property is not set, then the default value is used. 87d4507e9246e4855c5431cac5c3d1a9155caebc87Igor Murashkin** 88d4507e9246e4855c5431cac5c3d1a9155caebc87Igor Murashkin** The numeric conversion is identical to strtoimax with the base inferred: 89d4507e9246e4855c5431cac5c3d1a9155caebc87Igor Murashkin** - All digits up to the first non-digit characters are read 90d4507e9246e4855c5431cac5c3d1a9155caebc87Igor Murashkin** - The longest consecutive prefix of digits is converted to a long 91d4507e9246e4855c5431cac5c3d1a9155caebc87Igor Murashkin** 92d4507e9246e4855c5431cac5c3d1a9155caebc87Igor Murashkin** Valid strings of digits are: 93d4507e9246e4855c5431cac5c3d1a9155caebc87Igor Murashkin** - An optional sign character + or - 94d4507e9246e4855c5431cac5c3d1a9155caebc87Igor Murashkin** - An optional prefix indicating the base (otherwise base 10 is assumed) 95d4507e9246e4855c5431cac5c3d1a9155caebc87Igor Murashkin** -- 0 prefix is octal 96d4507e9246e4855c5431cac5c3d1a9155caebc87Igor Murashkin** -- 0x / 0X prefix is hex 97d4507e9246e4855c5431cac5c3d1a9155caebc87Igor Murashkin** 98d4507e9246e4855c5431cac5c3d1a9155caebc87Igor Murashkin** Leading/trailing whitespace is ignored. Overflow/underflow will cause 99d4507e9246e4855c5431cac5c3d1a9155caebc87Igor Murashkin** numeric conversion to fail. 100d4507e9246e4855c5431cac5c3d1a9155caebc87Igor Murashkin** 101d4507e9246e4855c5431cac5c3d1a9155caebc87Igor Murashkin** If no property with this key is set (or the key is NULL) or the numeric 102d4507e9246e4855c5431cac5c3d1a9155caebc87Igor Murashkin** conversion fails, the default value is returned. 103d4507e9246e4855c5431cac5c3d1a9155caebc87Igor Murashkin**/ 104d4507e9246e4855c5431cac5c3d1a9155caebc87Igor Murashkinint32_t property_get_int32(const char *key, int32_t default_value); 105d4507e9246e4855c5431cac5c3d1a9155caebc87Igor 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 110dd7bc3319deb2b77c5d07a51b7d6cd7e11b5beb0The Android Open Source Projectint property_list(void (*propfn)(const char *key, const char *value, void *cookie), void *cookie); 111dd7bc3319deb2b77c5d07a51b7d6cd7e11b5beb0The Android Open Source Project 1120e54ec825e6eae234a486c2049039fb6986a39b8Nick Kralevich#if defined(__BIONIC_FORTIFY) 1130e54ec825e6eae234a486c2049039fb6986a39b8Nick Kralevich 1140e54ec825e6eae234a486c2049039fb6986a39b8Nick Kralevichextern int __property_get_real(const char *, char *, const char *) 1150e54ec825e6eae234a486c2049039fb6986a39b8Nick Kralevich __asm__(__USER_LABEL_PREFIX__ "property_get"); 116bda25e4ed5f2fdd65cf32e7454774f5937c4ede4Nick Kralevich__errordecl(__property_get_too_small_error, "property_get() called with too small of a buffer"); 1170e54ec825e6eae234a486c2049039fb6986a39b8Nick Kralevich 1180e54ec825e6eae234a486c2049039fb6986a39b8Nick Kralevich__BIONIC_FORTIFY_INLINE 1190e54ec825e6eae234a486c2049039fb6986a39b8Nick Kralevichint property_get(const char *key, char *value, const char *default_value) { 1200e54ec825e6eae234a486c2049039fb6986a39b8Nick Kralevich size_t bos = __bos(value); 1210e54ec825e6eae234a486c2049039fb6986a39b8Nick Kralevich if (bos < PROPERTY_VALUE_MAX) { 1220e54ec825e6eae234a486c2049039fb6986a39b8Nick Kralevich __property_get_too_small_error(); 1230e54ec825e6eae234a486c2049039fb6986a39b8Nick Kralevich } 1240e54ec825e6eae234a486c2049039fb6986a39b8Nick Kralevich return __property_get_real(key, value, default_value); 1250e54ec825e6eae234a486c2049039fb6986a39b8Nick Kralevich} 1260e54ec825e6eae234a486c2049039fb6986a39b8Nick Kralevich 1270e54ec825e6eae234a486c2049039fb6986a39b8Nick Kralevich#endif 128dd7bc3319deb2b77c5d07a51b7d6cd7e11b5beb0The Android Open Source Project 129dd7bc3319deb2b77c5d07a51b7d6cd7e11b5beb0The Android Open Source Project#ifdef HAVE_SYSTEM_PROPERTY_SERVER 130dd7bc3319deb2b77c5d07a51b7d6cd7e11b5beb0The Android Open Source Project/* 131dd7bc3319deb2b77c5d07a51b7d6cd7e11b5beb0The Android Open Source Project * We have an external property server instead of built-in libc support. 132dd7bc3319deb2b77c5d07a51b7d6cd7e11b5beb0The Android Open Source Project * Used by the simulator. 133dd7bc3319deb2b77c5d07a51b7d6cd7e11b5beb0The Android Open Source Project */ 134dd7bc3319deb2b77c5d07a51b7d6cd7e11b5beb0The Android Open Source Project#define SYSTEM_PROPERTY_PIPE_NAME "/tmp/android-sysprop" 135dd7bc3319deb2b77c5d07a51b7d6cd7e11b5beb0The Android Open Source Project 136dd7bc3319deb2b77c5d07a51b7d6cd7e11b5beb0The Android Open Source Projectenum { 137dd7bc3319deb2b77c5d07a51b7d6cd7e11b5beb0The Android Open Source Project kSystemPropertyUnknown = 0, 138dd7bc3319deb2b77c5d07a51b7d6cd7e11b5beb0The Android Open Source Project kSystemPropertyGet, 139dd7bc3319deb2b77c5d07a51b7d6cd7e11b5beb0The Android Open Source Project kSystemPropertySet, 140dd7bc3319deb2b77c5d07a51b7d6cd7e11b5beb0The Android Open Source Project kSystemPropertyList 141dd7bc3319deb2b77c5d07a51b7d6cd7e11b5beb0The Android Open Source Project}; 142dd7bc3319deb2b77c5d07a51b7d6cd7e11b5beb0The Android Open Source Project#endif /*HAVE_SYSTEM_PROPERTY_SERVER*/ 143dd7bc3319deb2b77c5d07a51b7d6cd7e11b5beb0The Android Open Source Project 144dd7bc3319deb2b77c5d07a51b7d6cd7e11b5beb0The Android Open Source Project 145dd7bc3319deb2b77c5d07a51b7d6cd7e11b5beb0The Android Open Source Project#ifdef __cplusplus 146dd7bc3319deb2b77c5d07a51b7d6cd7e11b5beb0The Android Open Source Project} 147dd7bc3319deb2b77c5d07a51b7d6cd7e11b5beb0The Android Open Source Project#endif 148dd7bc3319deb2b77c5d07a51b7d6cd7e11b5beb0The Android Open Source Project 149dd7bc3319deb2b77c5d07a51b7d6cd7e11b5beb0The Android Open Source Project#endif 150