1 /* 2 * Copyright (C) 2008 The Android Open Source Project 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 * * Redistributions of source code must retain the above copyright 9 * notice, this list of conditions and the following disclaimer. 10 * * Redistributions in binary form must reproduce the above copyright 11 * notice, this list of conditions and the following disclaimer in 12 * the documentation and/or other materials provided with the 13 * distribution. 14 * 15 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 16 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 17 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS 18 * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE 19 * COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, 20 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, 21 * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS 22 * OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED 23 * AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, 24 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT 25 * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 26 * SUCH DAMAGE. 27 */ 28 29 #pragma once 30 31 /** 32 * @defgroup apilevels API Levels 33 * 34 * Defines functions and constants for working with Android API levels. 35 * @{ 36 */ 37 38 /** 39 * @file android/api-level.h 40 * @brief Functions and constants for dealing with multiple API levels. 41 * 42 * See 43 * https://android.googlesource.com/platform/bionic/+/master/docs/defines.md. 44 */ 45 46 #include <sys/cdefs.h> 47 48 __BEGIN_DECLS 49 50 /** 51 * Magic version number for an Android OS build which has not yet turned 52 * into an official release, for comparison against `__ANDROID_API__`. See 53 * https://android.googlesource.com/platform/bionic/+/master/docs/defines.md. 54 */ 55 #define __ANDROID_API_FUTURE__ 10000 56 57 /* This #ifndef should never be true except when doxygen is generating docs. */ 58 #ifndef __ANDROID_API__ 59 /** 60 * `__ANDROID_API__` is the [API 61 * level](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels) 62 * this code is being built for. The resulting binaries are only guaranteed to 63 * be compatible with devices which have an API level greater than or equal to 64 * `__ANDROID_API__`. 65 * 66 * For NDK and APEX builds, this macro will always be defined. It is set 67 * automatically by Clang using the version suffix that is a part of the target 68 * name. For example, `__ANDROID_API__` will be 24 when Clang is given the 69 * argument `-target aarch64-linux-android24`. 70 * 71 * For non-APEX OS code, this defaults to __ANDROID_API_FUTURE__. 72 * 73 * The value of `__ANDROID_API__` can be compared to the named constants in 74 * `<android/api-level.h>`. 75 * 76 * The interpretation of `__ANDROID_API__` is similar to the AndroidManifest.xml 77 * `minSdkVersion`. In most cases `__ANDROID_API__` will be identical to 78 * `minSdkVersion`, but as it is a build time constant it is possible for 79 * library code to use a different value than the app it will be included in. 80 * When libraries and applications build for different API levels, the 81 * `minSdkVersion` of the application must be at least as high as the highest 82 * API level used by any of its libraries which are loaded unconditionally. 83 * 84 * Note that in some cases the resulting binaries may load successfully on 85 * devices with an older API level. That behavior should not be relied upon, 86 * even if you are careful to avoid using new APIs, as the toolchain may make 87 * use of new features by default. For example, additional FORTIFY features may 88 * implicitly make use of new APIs, SysV hashes may be omitted in favor of GNU 89 * hashes to improve library load times, or relocation packing may be enabled to 90 * reduce binary size. 91 * 92 * See android_get_device_api_level(), 93 * android_get_application_target_sdk_version() and 94 * https://android.googlesource.com/platform/bionic/+/master/docs/defines.md. 95 */ 96 #define __ANDROID_API__ __ANDROID_API_FUTURE__ 97 #endif 98 99 /** Names the Gingerbread API level (9), for comparison against `__ANDROID_API__`. */ 100 #define __ANDROID_API_G__ 9 101 102 /** Names the Ice-Cream Sandwich API level (14), for comparison against `__ANDROID_API__`. */ 103 #define __ANDROID_API_I__ 14 104 105 /** Names the Jellybean API level (16), for comparison against `__ANDROID_API__`. */ 106 #define __ANDROID_API_J__ 16 107 108 /** Names the Jellybean MR1 API level (17), for comparison against `__ANDROID_API__`. */ 109 #define __ANDROID_API_J_MR1__ 17 110 111 /** Names the Jellybean MR2 API level (18), for comparison against `__ANDROID_API__`. */ 112 #define __ANDROID_API_J_MR2__ 18 113 114 /** Names the KitKat API level (19), for comparison against `__ANDROID_API__`. */ 115 #define __ANDROID_API_K__ 19 116 117 /** Names the Lollipop API level (21), for comparison against `__ANDROID_API__`. */ 118 #define __ANDROID_API_L__ 21 119 120 /** Names the Lollipop MR1 API level (22), for comparison against `__ANDROID_API__`. */ 121 #define __ANDROID_API_L_MR1__ 22 122 123 /** Names the Marshmallow API level (23), for comparison against `__ANDROID_API__`. */ 124 #define __ANDROID_API_M__ 23 125 126 /** Names the Nougat API level (24), for comparison against `__ANDROID_API__`. */ 127 #define __ANDROID_API_N__ 24 128 129 /** Names the Nougat MR1 API level (25), for comparison against `__ANDROID_API__`. */ 130 #define __ANDROID_API_N_MR1__ 25 131 132 /** Names the Oreo API level (26), for comparison against `__ANDROID_API__`. */ 133 #define __ANDROID_API_O__ 26 134 135 /** Names the Oreo MR1 API level (27), for comparison against `__ANDROID_API__`. */ 136 #define __ANDROID_API_O_MR1__ 27 137 138 /** Names the Pie API level (28), for comparison against `__ANDROID_API__`. */ 139 #define __ANDROID_API_P__ 28 140 141 /** 142 * Names the "Q" API level (29), for comparison against `__ANDROID_API__`. 143 * This release was called Android 10 publicly, not to be (but sure to be) 144 * confused with API level 10. 145 */ 146 #define __ANDROID_API_Q__ 29 147 148 /** Names the "R" API level (30), for comparison against `__ANDROID_API__`. */ 149 #define __ANDROID_API_R__ 30 150 151 /** Names the "S" API level (31), for comparison against `__ANDROID_API__`. */ 152 #define __ANDROID_API_S__ 31 153 154 /* This file is included in <features.h>, and might be used from .S files. */ 155 #if !defined(__ASSEMBLY__) 156 157 /** 158 * Returns the `targetSdkVersion` of the caller, or `__ANDROID_API_FUTURE__` if 159 * there is no known target SDK version (for code not running in the context of 160 * an app). 161 * 162 * The returned values correspond to the named constants in `<android/api-level.h>`, 163 * and is equivalent to the AndroidManifest.xml `targetSdkVersion`. 164 * 165 * See also android_get_device_api_level(). 166 * 167 * Available since API level 24. 168 */ 169 int android_get_application_target_sdk_version() __INTRODUCED_IN(24); 170 171 #if __ANDROID_API__ < 29 172 173 /* android_get_device_api_level is a static inline before API level 29. */ 174 #define __BIONIC_GET_DEVICE_API_LEVEL_INLINE static __inline 175 #include <bits/get_device_api_level_inlines.h> 176 #undef __BIONIC_GET_DEVICE_API_LEVEL_INLINE 177 178 #else 179 180 /** 181 * Returns the API level of the device we're actually running on, or -1 on failure. 182 * The returned values correspond to the named constants in `<android/api-level.h>`, 183 * and is equivalent to the Java `Build.VERSION.SDK_INT` API. 184 * 185 * See also android_get_application_target_sdk_version(). 186 */ 187 int android_get_device_api_level() __INTRODUCED_IN(29); 188 189 #endif 190 191 #endif /* defined(__ASSEMBLY__) */ 192 193 __END_DECLS 194 195 /** @} */ 196