]> git.proxmox.com Git - rustc.git/blame - src/liblibc/src/lib.rs
New upstream version 1.23.0+dfsg1
[rustc.git] / src / liblibc / src / lib.rs
CommitLineData
92a42be0
SL
1// Copyright 2012-2015 The Rust Project Developers. See the COPYRIGHT
2// file at the top-level directory of this distribution and at
3// http://rust-lang.org/COPYRIGHT.
4//
5// Licensed under the Apache License, Version 2.0 <LICENSE-APACHE or
6// http://www.apache.org/licenses/LICENSE-2.0> or the MIT license
7// <LICENSE-MIT or http://opensource.org/licenses/MIT>, at your
8// option. This file may not be copied, modified, or distributed
9// except according to those terms.
10
11//! Crate docs
12
13#![allow(bad_style, overflowing_literals, improper_ctypes)]
14#![crate_type = "rlib"]
15#![crate_name = "libc"]
16#![cfg_attr(dox, feature(no_core, lang_items))]
17#![cfg_attr(dox, no_core)]
18#![doc(html_logo_url = "https://www.rust-lang.org/logos/rust-logo-128x128-blk-v2.png",
19 html_favicon_url = "https://doc.rust-lang.org/favicon.ico")]
20
21#![cfg_attr(all(target_os = "linux", target_arch = "x86_64"), doc(
22 html_root_url = "https://doc.rust-lang.org/libc/x86_64-unknown-linux-gnu"
23))]
24#![cfg_attr(all(target_os = "linux", target_arch = "x86"), doc(
25 html_root_url = "https://doc.rust-lang.org/libc/i686-unknown-linux-gnu"
26))]
27#![cfg_attr(all(target_os = "linux", target_arch = "arm"), doc(
28 html_root_url = "https://doc.rust-lang.org/libc/arm-unknown-linux-gnueabihf"
29))]
30#![cfg_attr(all(target_os = "linux", target_arch = "mips"), doc(
31 html_root_url = "https://doc.rust-lang.org/libc/mips-unknown-linux-gnu"
32))]
33#![cfg_attr(all(target_os = "linux", target_arch = "aarch64"), doc(
34 html_root_url = "https://doc.rust-lang.org/libc/aarch64-unknown-linux-gnu"
35))]
36#![cfg_attr(all(target_os = "linux", target_env = "musl"), doc(
37 html_root_url = "https://doc.rust-lang.org/libc/x86_64-unknown-linux-musl"
38))]
39#![cfg_attr(all(target_os = "macos", target_arch = "x86_64"), doc(
40 html_root_url = "https://doc.rust-lang.org/libc/x86_64-apple-darwin"
41))]
42#![cfg_attr(all(target_os = "macos", target_arch = "x86"), doc(
43 html_root_url = "https://doc.rust-lang.org/libc/i686-apple-darwin"
44))]
45#![cfg_attr(all(windows, target_arch = "x86_64", target_env = "gnu"), doc(
46 html_root_url = "https://doc.rust-lang.org/libc/x86_64-pc-windows-gnu"
47))]
48#![cfg_attr(all(windows, target_arch = "x86", target_env = "gnu"), doc(
49 html_root_url = "https://doc.rust-lang.org/libc/i686-pc-windows-gnu"
50))]
51#![cfg_attr(all(windows, target_arch = "x86_64", target_env = "msvc"), doc(
52 html_root_url = "https://doc.rust-lang.org/libc/x86_64-pc-windows-msvc"
53))]
54#![cfg_attr(all(windows, target_arch = "x86", target_env = "msvc"), doc(
55 html_root_url = "https://doc.rust-lang.org/libc/i686-pc-windows-msvc"
56))]
9cc50fc6 57#![cfg_attr(target_os = "android", doc(
92a42be0
SL
58 html_root_url = "https://doc.rust-lang.org/libc/arm-linux-androideabi"
59))]
9cc50fc6
SL
60#![cfg_attr(target_os = "freebsd", doc(
61 html_root_url = "https://doc.rust-lang.org/libc/x86_64-unknown-freebsd"
62))]
63#![cfg_attr(target_os = "openbsd", doc(
64 html_root_url = "https://doc.rust-lang.org/libc/x86_64-unknown-openbsd"
65))]
66#![cfg_attr(target_os = "bitrig", doc(
67 html_root_url = "https://doc.rust-lang.org/libc/x86_64-unknown-bitrig"
68))]
69#![cfg_attr(target_os = "netbsd", doc(
70 html_root_url = "https://doc.rust-lang.org/libc/x86_64-unknown-netbsd"
71))]
72#![cfg_attr(target_os = "dragonfly", doc(
73 html_root_url = "https://doc.rust-lang.org/libc/x86_64-unknown-dragonfly"
74))]
3b2f2976
XL
75#![cfg_attr(all(target_os = "emscripten", target_arch = "asmjs"), doc(
76 html_root_url = "https://doc.rust-lang.org/libc/asmjs-unknown-emscripten"
77))]
78#![cfg_attr(all(target_os = "emscripten", target_arch = "wasm32"), doc(
79 html_root_url = "https://doc.rust-lang.org/libc/wasm32-unknown-emscripten"
80))]
81#![cfg_attr(all(target_os = "linux", target_arch = "xparc64"), doc(
82 html_root_url = "https://doc.rust-lang.org/libc/sparc64-unknown-linux-gnu"
83))]
92a42be0
SL
84
85// Attributes needed when building as part of the standard library
3b2f2976
XL
86#![cfg_attr(feature = "stdbuild", feature(no_std, staged_api, custom_attribute, cfg_target_vendor))]
87#![cfg_attr(feature = "stdbuild", feature(link_cfg))]
88#![cfg_attr(feature = "stdbuild", no_std)]
89#![cfg_attr(feature = "stdbuild", staged_api)]
90#![cfg_attr(feature = "stdbuild", allow(warnings))]
91#![cfg_attr(feature = "stdbuild", unstable(feature = "libc",
92a42be0
SL
92 reason = "use `libc` from crates.io",
93 issue = "27783"))]
94
7453a54e
SL
95#![cfg_attr(not(feature = "use_std"), no_std)]
96
3b2f2976 97#[cfg(all(not(dox), feature = "use_std"))]
92a42be0
SL
98extern crate std as core;
99
100#[macro_use] mod macros;
101mod dox;
102
abe05a73
XL
103cfg_if! {
104 if #[cfg(all(target_arch = "wasm32", not(target_os = "emscripten")))] {
105 // empty ...
106 } else {
92a42be0 107
abe05a73
XL
108 // Use repr(u8) as LLVM expects `void*` to be the same as `i8*` to help enable
109 // more optimization opportunities around it recognizing things like
110 // malloc/free.
111 #[repr(u8)]
112 pub enum c_void {
113 // Two dummy variants so the #[repr] attribute can be used.
114 #[doc(hidden)]
115 __variant1,
116 #[doc(hidden)]
117 __variant2,
118 }
92a42be0 119
abe05a73
XL
120 pub type int8_t = i8;
121 pub type int16_t = i16;
122 pub type int32_t = i32;
123 pub type int64_t = i64;
124 pub type uint8_t = u8;
125 pub type uint16_t = u16;
126 pub type uint32_t = u32;
127 pub type uint64_t = u64;
92a42be0 128
abe05a73
XL
129 pub type c_schar = i8;
130 pub type c_uchar = u8;
131 pub type c_short = i16;
132 pub type c_ushort = u16;
133 pub type c_int = i32;
134 pub type c_uint = u32;
135 pub type c_float = f32;
136 pub type c_double = f64;
137 pub type c_longlong = i64;
138 pub type c_ulonglong = u64;
139 pub type intmax_t = i64;
140 pub type uintmax_t = u64;
92a42be0 141
abe05a73
XL
142 pub type size_t = usize;
143 pub type ptrdiff_t = isize;
144 pub type intptr_t = isize;
145 pub type uintptr_t = usize;
146 pub type ssize_t = isize;
92a42be0 147
abe05a73
XL
148 pub enum FILE {}
149 pub enum fpos_t {} // TODO: fill this out with a struct
92a42be0 150
abe05a73
XL
151 extern {
152 pub fn isalnum(c: c_int) -> c_int;
153 pub fn isalpha(c: c_int) -> c_int;
154 pub fn iscntrl(c: c_int) -> c_int;
155 pub fn isdigit(c: c_int) -> c_int;
156 pub fn isgraph(c: c_int) -> c_int;
157 pub fn islower(c: c_int) -> c_int;
158 pub fn isprint(c: c_int) -> c_int;
159 pub fn ispunct(c: c_int) -> c_int;
160 pub fn isspace(c: c_int) -> c_int;
161 pub fn isupper(c: c_int) -> c_int;
162 pub fn isxdigit(c: c_int) -> c_int;
163 pub fn tolower(c: c_int) -> c_int;
164 pub fn toupper(c: c_int) -> c_int;
92a42be0 165
abe05a73
XL
166 #[cfg_attr(all(target_os = "macos", target_arch = "x86"),
167 link_name = "fopen$UNIX2003")]
168 pub fn fopen(filename: *const c_char,
169 mode: *const c_char) -> *mut FILE;
170 #[cfg_attr(all(target_os = "macos", target_arch = "x86"),
171 link_name = "freopen$UNIX2003")]
172 pub fn freopen(filename: *const c_char, mode: *const c_char,
173 file: *mut FILE) -> *mut FILE;
174 pub fn fflush(file: *mut FILE) -> c_int;
175 pub fn fclose(file: *mut FILE) -> c_int;
176 pub fn remove(filename: *const c_char) -> c_int;
177 pub fn rename(oldname: *const c_char, newname: *const c_char) -> c_int;
178 pub fn tmpfile() -> *mut FILE;
179 pub fn setvbuf(stream: *mut FILE,
180 buffer: *mut c_char,
181 mode: c_int,
182 size: size_t) -> c_int;
183 pub fn setbuf(stream: *mut FILE, buf: *mut c_char);
184 pub fn getchar() -> c_int;
185 pub fn putchar(c: c_int) -> c_int;
186 pub fn fgetc(stream: *mut FILE) -> c_int;
187 pub fn fgets(buf: *mut c_char, n: c_int, stream: *mut FILE) -> *mut c_char;
188 pub fn fputc(c: c_int, stream: *mut FILE) -> c_int;
189 #[cfg_attr(all(target_os = "macos", target_arch = "x86"),
190 link_name = "fputs$UNIX2003")]
191 pub fn fputs(s: *const c_char, stream: *mut FILE)-> c_int;
192 pub fn puts(s: *const c_char) -> c_int;
193 pub fn ungetc(c: c_int, stream: *mut FILE) -> c_int;
194 pub fn fread(ptr: *mut c_void,
195 size: size_t,
196 nobj: size_t,
197 stream: *mut FILE)
198 -> size_t;
199 #[cfg_attr(all(target_os = "macos", target_arch = "x86"),
200 link_name = "fwrite$UNIX2003")]
201 pub fn fwrite(ptr: *const c_void,
202 size: size_t,
203 nobj: size_t,
204 stream: *mut FILE)
205 -> size_t;
206 pub fn fseek(stream: *mut FILE, offset: c_long, whence: c_int) -> c_int;
207 pub fn ftell(stream: *mut FILE) -> c_long;
208 pub fn rewind(stream: *mut FILE);
209 #[cfg_attr(target_os = "netbsd", link_name = "__fgetpos50")]
210 pub fn fgetpos(stream: *mut FILE, ptr: *mut fpos_t) -> c_int;
211 #[cfg_attr(target_os = "netbsd", link_name = "__fsetpos50")]
212 pub fn fsetpos(stream: *mut FILE, ptr: *const fpos_t) -> c_int;
213 pub fn feof(stream: *mut FILE) -> c_int;
214 pub fn ferror(stream: *mut FILE) -> c_int;
215 pub fn perror(s: *const c_char);
216 pub fn atoi(s: *const c_char) -> c_int;
217 #[cfg_attr(all(target_os = "macos", target_arch = "x86"),
218 link_name = "strtod$UNIX2003")]
219 pub fn strtod(s: *const c_char, endp: *mut *mut c_char) -> c_double;
220 pub fn strtol(s: *const c_char,
221 endp: *mut *mut c_char, base: c_int) -> c_long;
222 pub fn strtoul(s: *const c_char, endp: *mut *mut c_char,
223 base: c_int) -> c_ulong;
224 pub fn calloc(nobj: size_t, size: size_t) -> *mut c_void;
225 pub fn malloc(size: size_t) -> *mut c_void;
226 pub fn realloc(p: *mut c_void, size: size_t) -> *mut c_void;
227 pub fn free(p: *mut c_void);
228 pub fn abort() -> !;
229 pub fn exit(status: c_int) -> !;
230 pub fn _exit(status: c_int) -> !;
231 pub fn atexit(cb: extern fn()) -> c_int;
232 #[cfg_attr(all(target_os = "macos", target_arch = "x86"),
233 link_name = "system$UNIX2003")]
234 pub fn system(s: *const c_char) -> c_int;
235 pub fn getenv(s: *const c_char) -> *mut c_char;
92a42be0 236
abe05a73
XL
237 pub fn strcpy(dst: *mut c_char, src: *const c_char) -> *mut c_char;
238 pub fn strncpy(dst: *mut c_char, src: *const c_char, n: size_t)
239 -> *mut c_char;
240 pub fn strcat(s: *mut c_char, ct: *const c_char) -> *mut c_char;
241 pub fn strncat(s: *mut c_char, ct: *const c_char, n: size_t) -> *mut c_char;
242 pub fn strcmp(cs: *const c_char, ct: *const c_char) -> c_int;
243 pub fn strncmp(cs: *const c_char, ct: *const c_char, n: size_t) -> c_int;
244 pub fn strcoll(cs: *const c_char, ct: *const c_char) -> c_int;
245 pub fn strchr(cs: *const c_char, c: c_int) -> *mut c_char;
246 pub fn strrchr(cs: *const c_char, c: c_int) -> *mut c_char;
247 pub fn strspn(cs: *const c_char, ct: *const c_char) -> size_t;
248 pub fn strcspn(cs: *const c_char, ct: *const c_char) -> size_t;
249 pub fn strdup(cs: *const c_char) -> *mut c_char;
250 pub fn strpbrk(cs: *const c_char, ct: *const c_char) -> *mut c_char;
251 pub fn strstr(cs: *const c_char, ct: *const c_char) -> *mut c_char;
252 pub fn strlen(cs: *const c_char) -> size_t;
253 pub fn strnlen(cs: *const c_char, maxlen: size_t) -> size_t;
254 #[cfg_attr(all(target_os = "macos", target_arch = "x86"),
255 link_name = "strerror$UNIX2003")]
256 pub fn strerror(n: c_int) -> *mut c_char;
257 pub fn strtok(s: *mut c_char, t: *const c_char) -> *mut c_char;
258 pub fn strxfrm(s: *mut c_char, ct: *const c_char, n: size_t) -> size_t;
259 pub fn wcslen(buf: *const wchar_t) -> size_t;
260 pub fn wcstombs(dest: *mut c_char, src: *const wchar_t, n: size_t) -> ::size_t;
261
262 pub fn memchr(cx: *const c_void, c: c_int, n: size_t) -> *mut c_void;
263 pub fn memcmp(cx: *const c_void, ct: *const c_void, n: size_t) -> c_int;
264 pub fn memcpy(dest: *mut c_void, src: *const c_void, n: size_t) -> *mut c_void;
265 pub fn memmove(dest: *mut c_void, src: *const c_void, n: size_t) -> *mut c_void;
266 pub fn memset(dest: *mut c_void, c: c_int, n: size_t) -> *mut c_void;
267 }
92a42be0 268
abe05a73
XL
269 // These are all inline functions on android, so they end up just being entirely
270 // missing on that platform.
271 #[cfg(not(target_os = "android"))]
272 extern {
273 pub fn abs(i: c_int) -> c_int;
274 pub fn atof(s: *const c_char) -> c_double;
275 pub fn labs(i: c_long) -> c_long;
276 pub fn rand() -> c_int;
277 pub fn srand(seed: c_uint);
278 }
279 }
92a42be0
SL
280}
281
282cfg_if! {
283 if #[cfg(windows)] {
284 mod windows;
285 pub use windows::*;
476ff2be
SL
286 } else if #[cfg(target_os = "redox")] {
287 mod redox;
288 pub use redox::*;
abe05a73
XL
289 } else if #[cfg(target_os = "fuchisa")] {
290 mod fuchsia;
291 pub use fuchsia::*;
54a0048b 292 } else if #[cfg(unix)] {
92a42be0
SL
293 mod unix;
294 pub use unix::*;
54a0048b
SL
295 } else {
296 // Unknown target_family
92a42be0
SL
297 }
298}