blob: a5bac61ce7c5262c2c896756488ffca5f5469378 [file] [log] [blame]
The Android Open Source Project1dc9e472009-03-03 19:28:35 -08001/*
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 */
Elliott Hughes76f89162015-01-26 13:34:58 -080028
29#ifndef _STDLIB_H
30#define _STDLIB_H
The Android Open Source Project1dc9e472009-03-03 19:28:35 -080031
The Android Open Source Project1dc9e472009-03-03 19:28:35 -080032#include <alloca.h>
Elliott Hughes21b56eb2017-10-20 17:57:17 -070033#include <bits/wait.h>
Elliott Hughes76f89162015-01-26 13:34:58 -080034#include <malloc.h>
35#include <stddef.h>
Elliott Hughes21b56eb2017-10-20 17:57:17 -070036#include <sys/cdefs.h>
37#include <xlocale.h>
The Android Open Source Project1dc9e472009-03-03 19:28:35 -080038
39__BEGIN_DECLS
40
41#define EXIT_FAILURE 1
42#define EXIT_SUCCESS 0
43
Elliott Hughes504d0482021-06-07 11:20:28 -070044__noreturn void abort(void) __attribute__((__nomerge__));
Elliott Hughesfaa74342017-08-11 17:34:44 -070045__noreturn void exit(int __status);
Elliott Hughes655e4302023-06-16 12:39:33 -070046__noreturn void _Exit(int __status);
Elliott Hughes2f94a292017-09-18 14:40:01 -070047
zijunzhao5a918d92022-11-28 21:05:55 +000048int atexit(void (* _Nonnull __fn)(void));
The Android Open Source Project1dc9e472009-03-03 19:28:35 -080049
Elliott Hughes655e4302023-06-16 12:39:33 -070050int at_quick_exit(void (* _Nonnull __fn)(void));
51void quick_exit(int __status) __noreturn;
Dan Albertb8425c52014-04-29 17:49:06 -070052
zijunzhao5a918d92022-11-28 21:05:55 +000053char* _Nullable getenv(const char* _Nonnull __name);
54int putenv(char* _Nonnull __assignment);
55int setenv(const char* _Nonnull __name, const char* _Nonnull __value, int __overwrite);
56int unsetenv(const char* _Nonnull __name);
Elliott Hughes3b2096a2016-07-22 18:57:12 -070057int clearenv(void);
The Android Open Source Project1dc9e472009-03-03 19:28:35 -080058
zijunzhao5a918d92022-11-28 21:05:55 +000059char* _Nullable mkdtemp(char* _Nonnull __template);
60char* _Nullable mktemp(char* _Nonnull __template) __attribute__((deprecated("mktemp is unsafe, use mkstemp or tmpfile instead")));
Elliott Hughes31165ed2014-09-23 17:34:29 -070061
zijunzhao5a918d92022-11-28 21:05:55 +000062int mkostemp64(char* _Nonnull __template, int __flags) __INTRODUCED_IN(23);
63int mkostemp(char* _Nonnull __template, int __flags) __INTRODUCED_IN(23);
64int mkostemps64(char* _Nonnull __template, int __suffix_length, int __flags) __INTRODUCED_IN(23);
65int mkostemps(char* _Nonnull __template, int __suffix_length, int __flags) __INTRODUCED_IN(23);
Elliott Hughes655e4302023-06-16 12:39:33 -070066int mkstemp64(char* _Nonnull __template);
zijunzhao5a918d92022-11-28 21:05:55 +000067int mkstemp(char* _Nonnull __template);
68int mkstemps64(char* _Nonnull __template, int __flags) __INTRODUCED_IN(23);
69int mkstemps(char* _Nonnull __template, int __flags);
The Android Open Source Project1dc9e472009-03-03 19:28:35 -080070
zijunzhao5a918d92022-11-28 21:05:55 +000071long strtol(const char* _Nonnull __s, char* _Nullable * _Nullable __end_ptr, int __base);
72long long strtoll(const char* _Nonnull __s, char* _Nullable * _Nullable __end_ptr, int __base);
73unsigned long strtoul(const char* _Nonnull __s, char* _Nullable * _Nullable __end_ptr, int __base);
74unsigned long long strtoull(const char* _Nonnull __s, char* _Nullable * _Nullable __end_ptr, int __base);
The Android Open Source Project1dc9e472009-03-03 19:28:35 -080075
Elliott Hughes655e4302023-06-16 12:39:33 -070076int posix_memalign(void* _Nullable * _Nullable __memptr, size_t __alignment, size_t __size);
Ken Sumrall85aad902011-12-14 20:50:01 -080077
zijunzhao5a918d92022-11-28 21:05:55 +000078void* _Nullable aligned_alloc(size_t __alignment, size_t __size) __INTRODUCED_IN(28);
Christopher Ferriscae21a92018-02-05 18:14:55 -080079
zijunzhao5a918d92022-11-28 21:05:55 +000080double strtod(const char* _Nonnull __s, char* _Nullable * _Nullable __end_ptr);
Elliott Hughes655e4302023-06-16 12:39:33 -070081long double strtold(const char* _Nonnull __s, char* _Nullable * _Nullable __end_ptr);
The Android Open Source Project1dc9e472009-03-03 19:28:35 -080082
zijunzhao5a918d92022-11-28 21:05:55 +000083unsigned long strtoul_l(const char* _Nonnull __s, char* _Nullable * _Nullable __end_ptr, int __base, locale_t _Nonnull __l) __INTRODUCED_IN(26);
Dan Albertdfb5ce42014-07-09 22:51:34 +000084
zijunzhao5a918d92022-11-28 21:05:55 +000085int atoi(const char* _Nonnull __s) __attribute_pure__;
86long atol(const char* _Nonnull __s) __attribute_pure__;
87long long atoll(const char* _Nonnull __s) __attribute_pure__;
The Android Open Source Project1dc9e472009-03-03 19:28:35 -080088
zijunzhao5a918d92022-11-28 21:05:55 +000089__wur char* _Nullable realpath(const char* _Nonnull __path, char* _Nullable __resolved);
90int system(const char* _Nonnull __command);
The Android Open Source Project1dc9e472009-03-03 19:28:35 -080091
zijunzhao5a918d92022-11-28 21:05:55 +000092void* _Nullable bsearch(const void* _Nonnull __key, const void* _Nullable __base, size_t __nmemb, size_t __size, int (* _Nonnull __comparator)(const void* _Nonnull __lhs, const void* _Nonnull __rhs));
The Android Open Source Project1dc9e472009-03-03 19:28:35 -080093
zijunzhao99dd5b12023-03-28 01:54:57 +000094void qsort(void* _Nullable __base, size_t __nmemb, size_t __size, int (* _Nonnull __comparator)(const void* _Nullable __lhs, const void* _Nullable __rhs));
The Android Open Source Project1dc9e472009-03-03 19:28:35 -080095
Yabin Cuia39f9392014-10-28 12:04:02 -070096uint32_t arc4random(void);
Elliott Hughesfaa74342017-08-11 17:34:44 -070097uint32_t arc4random_uniform(uint32_t __upper_bound);
zijunzhao5a918d92022-11-28 21:05:55 +000098void arc4random_buf(void* _Nonnull __buf, size_t __n);
The Android Open Source Project1dc9e472009-03-03 19:28:35 -080099
100#define RAND_MAX 0x7fffffff
Elliott Hughesa0beeea2014-06-12 11:48:04 -0700101
Elliott Hughes655e4302023-06-16 12:39:33 -0700102int rand_r(unsigned int* _Nonnull __seed_ptr);
Elliott Hughesa0beeea2014-06-12 11:48:04 -0700103
Elliott Hughes274afe82014-11-06 12:40:08 -0800104double drand48(void);
zijunzhao5a918d92022-11-28 21:05:55 +0000105double erand48(unsigned short __xsubi[_Nonnull 3]);
106long jrand48(unsigned short __xsubi[_Nonnull 3]);
107void lcong48(unsigned short __param[_Nonnull 7]) __INTRODUCED_IN(23);
Elliott Hughes274afe82014-11-06 12:40:08 -0800108long lrand48(void);
109long mrand48(void);
zijunzhao5a918d92022-11-28 21:05:55 +0000110long nrand48(unsigned short __xsubi[_Nonnull 3]);
111unsigned short* _Nonnull seed48(unsigned short __seed16v[_Nonnull 3]);
Elliott Hughesfaa74342017-08-11 17:34:44 -0700112void srand48(long __seed);
Elliott Hughes274afe82014-11-06 12:40:08 -0800113
Elliott Hughes655e4302023-06-16 12:39:33 -0700114char* _Nullable initstate(unsigned int __seed, char* _Nonnull __state, size_t __n);
115char* _Nullable setstate(char* _Nonnull __state);
The Android Open Source Project1dc9e472009-03-03 19:28:35 -0800116
Elliott Hughes49167062014-07-25 17:24:00 -0700117int getpt(void);
Elliott Hughes655e4302023-06-16 12:39:33 -0700118int posix_openpt(int __flags);
zijunzhao5a918d92022-11-28 21:05:55 +0000119char* _Nullable ptsname(int __fd);
120int ptsname_r(int __fd, char* _Nonnull __buf, size_t __n);
Elliott Hughesfaa74342017-08-11 17:34:44 -0700121int unlockpt(int __fd);
The Android Open Source Project1dc9e472009-03-03 19:28:35 -0800122
zijunzhao5a918d92022-11-28 21:05:55 +0000123int getsubopt(char* _Nonnull * _Nonnull __option, char* _Nonnull const* _Nonnull __tokens, char* _Nullable * _Nonnull __value_ptr) __INTRODUCED_IN(26);
Elliott Hughesdf143f82016-04-04 17:34:04 -0700124
The Android Open Source Project1dc9e472009-03-03 19:28:35 -0800125typedef struct {
Elliott Hughesfaa74342017-08-11 17:34:44 -0700126 int quot;
127 int rem;
The Android Open Source Project1dc9e472009-03-03 19:28:35 -0800128} div_t;
129
Elliott Hughesfaa74342017-08-11 17:34:44 -0700130div_t div(int __numerator, int __denominator) __attribute_const__;
The Android Open Source Project1dc9e472009-03-03 19:28:35 -0800131
132typedef struct {
Elliott Hughesfaa74342017-08-11 17:34:44 -0700133 long int quot;
134 long int rem;
The Android Open Source Project1dc9e472009-03-03 19:28:35 -0800135} ldiv_t;
136
Elliott Hughesfaa74342017-08-11 17:34:44 -0700137ldiv_t ldiv(long __numerator, long __denominator) __attribute_const__;
The Android Open Source Project1dc9e472009-03-03 19:28:35 -0800138
139typedef struct {
Elliott Hughesfaa74342017-08-11 17:34:44 -0700140 long long int quot;
141 long long int rem;
The Android Open Source Project1dc9e472009-03-03 19:28:35 -0800142} lldiv_t;
143
Elliott Hughesfaa74342017-08-11 17:34:44 -0700144lldiv_t lldiv(long long __numerator, long long __denominator) __attribute_const__;
The Android Open Source Project1dc9e472009-03-03 19:28:35 -0800145
Elliott Hughes2d0b28b2018-10-23 11:23:00 -0700146/**
147 * [getloadavg(3)](http://man7.org/linux/man-pages/man3/getloadavg.3.html) queries the
148 * number of runnable processes averaged over time. The Linux kernel supports averages
149 * over the last 1, 5, and 15 minutes.
150 *
151 * Returns the number of samples written to `__averages` (at most 3), and returns -1 on failure.
152 */
zijunzhao5a918d92022-11-28 21:05:55 +0000153int getloadavg(double __averages[_Nonnull], int __n) __INTRODUCED_IN(29);
Elliott Hughes2d0b28b2018-10-23 11:23:00 -0700154
Elliott Hughes692207e2014-02-28 16:23:27 -0800155/* BSD compatibility. */
Elliott Hughes655e4302023-06-16 12:39:33 -0700156const char* _Nullable getprogname(void);
157void setprogname(const char* _Nonnull __name);
Elliott Hughes692207e2014-02-28 16:23:27 -0800158
zijunzhao5a918d92022-11-28 21:05:55 +0000159int mblen(const char* _Nullable __s, size_t __n) __INTRODUCED_IN_NO_GUARD_FOR_NDK(26);
160size_t mbstowcs(wchar_t* _Nullable __dst, const char* _Nullable __src, size_t __n) __INTRODUCED_IN_NO_GUARD_FOR_NDK(21);
161int mbtowc(wchar_t* _Nullable __wc_ptr, const char* _Nullable __s, size_t __n) __INTRODUCED_IN_NO_GUARD_FOR_NDK(21);
162int wctomb(char* _Nullable __dst, wchar_t __wc) __INTRODUCED_IN_NO_GUARD_FOR_NDK(21);
Dan Albertcb0b1432016-09-06 16:51:00 -0700163
zijunzhao5a918d92022-11-28 21:05:55 +0000164size_t wcstombs(char* _Nullable __dst, const wchar_t* _Nullable __src, size_t __n) __INTRODUCED_IN_NO_GUARD_FOR_NDK(21);
David 'Digit' Turnerbb5581a2010-10-09 17:56:55 +0200165
Elliott Hughes655e4302023-06-16 12:39:33 -0700166size_t __ctype_get_mb_cur_max(void);
Dan Albert224ff042014-08-14 13:56:51 -0700167#define MB_CUR_MAX __ctype_get_mb_cur_max()
The Android Open Source Project1dc9e472009-03-03 19:28:35 -0800168
George Burgess IVb97049c2017-07-24 15:05:05 -0700169#if defined(__BIONIC_INCLUDE_FORTIFY_HEADERS)
170#include <bits/fortify/stdlib.h>
171#endif
Daniel Micay3244d9f2015-04-18 13:04:19 -0400172
Elliott Hughes655e4302023-06-16 12:39:33 -0700173int abs(int __x) __attribute_const__;
174long labs(long __x) __attribute_const__;
175long long llabs(long long __x) __attribute_const__;
Ryan Prichard51a7fe82018-01-08 16:18:48 -0800176
Elliott Hughes655e4302023-06-16 12:39:33 -0700177float strtof(const char* _Nonnull __s, char* _Nullable * _Nullable __end_ptr);
178double atof(const char* _Nonnull __s) __attribute_pure__;
179int rand(void);
180void srand(unsigned int __seed);
181long random(void);
182void srandom(unsigned int __seed);
183int grantpt(int __fd);
Josh Gao6cd9fb02016-09-23 14:06:05 -0700184
Elliott Hughes655e4302023-06-16 12:39:33 -0700185long long strtoll_l(const char* _Nonnull __s, char* _Nullable * _Nullable __end_ptr, int __base, locale_t _Nonnull __l);
186unsigned long long strtoull_l(const char* _Nonnull __s, char* _Nullable * _Nullable __end_ptr, int __base, locale_t _Nonnull __l);
187long double strtold_l(const char* _Nonnull __s, char* _Nullable * _Nullable __end_ptr, locale_t _Nonnull __l);
Josh Gao8778d642016-07-22 15:26:36 -0700188
Elliott Hughes95c6cd72019-12-20 13:26:14 -0800189#if __ANDROID_API__ >= 26
zijunzhao5a918d92022-11-28 21:05:55 +0000190double strtod_l(const char* _Nonnull __s, char* _Nullable * _Nullable __end_ptr, locale_t _Nonnull __l) __INTRODUCED_IN(26);
191float strtof_l(const char* _Nonnull __s, char* _Nullable * _Nullable __end_ptr, locale_t _Nonnull __l) __INTRODUCED_IN(26);
192long strtol_l(const char* _Nonnull __s, char* _Nullable * _Nullable __end_ptr, int, locale_t _Nonnull __l) __INTRODUCED_IN(26);
Josh Gao6cd9fb02016-09-23 14:06:05 -0700193#else
Elliott Hughes4cae5c32017-07-10 11:51:00 -0700194// Implemented as static inlines before 26.
Josh Gao6cd9fb02016-09-23 14:06:05 -0700195#endif
196
The Android Open Source Project1dc9e472009-03-03 19:28:35 -0800197__END_DECLS
198
Josh Gaob8e1b7052016-04-13 17:18:20 -0700199#include <android/legacy_stdlib_inlines.h>
200
Elliott Hughes76f89162015-01-26 13:34:58 -0800201#endif /* _STDLIB_H */