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