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 ))] 57 #![cfg_attr(target_os = "android", doc( 58 html_root_url = "https://doc.rust-lang.org/libc/arm-linux-androideabi" 59 ))] 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 ))] 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 ))] 84 85 // Attributes needed when building as part of the standard library 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", 92 reason = "use `libc` from crates.io", 93 issue = "27783"))] 94 95 #![cfg_attr(not(feature = "use_std"), no_std)] 96 97 #[cfg(all(not(dox), feature = "use_std"))] 98 extern crate std as core; 99 100 #[macro_use] mod macros; 101 mod dox; 102 103 // Use repr(u8) as LLVM expects `void*` to be the same as `i8*` to help enable 104 // more optimization opportunities around it recognizing things like 105 // malloc/free. 106 #[repr(u8)] 107 pub enum c_void { 108 // Two dummy variants so the #[repr] attribute can be used. 109 #[doc(hidden)] 110 __variant1, 111 #[doc(hidden)] 112 __variant2, 113 } 114 115 pub type int8_t = i8; 116 pub type int16_t = i16; 117 pub type int32_t = i32; 118 pub type int64_t = i64; 119 pub type uint8_t = u8; 120 pub type uint16_t = u16; 121 pub type uint32_t = u32; 122 pub type uint64_t = u64; 123 124 pub type c_schar = i8; 125 pub type c_uchar = u8; 126 pub type c_short = i16; 127 pub type c_ushort = u16; 128 pub type c_int = i32; 129 pub type c_uint = u32; 130 pub type c_float = f32; 131 pub type c_double = f64; 132 pub type c_longlong = i64; 133 pub type c_ulonglong = u64; 134 pub type intmax_t = i64; 135 pub type uintmax_t = u64; 136 137 pub type size_t = usize; 138 pub type ptrdiff_t = isize; 139 pub type intptr_t = isize; 140 pub type uintptr_t = usize; 141 pub type ssize_t = isize; 142 143 pub enum FILE {} 144 pub enum fpos_t {} // TODO: fill this out with a struct 145 146 extern { 147 pub fn isalnum(c: c_int) -> c_int; 148 pub fn isalpha(c: c_int) -> c_int; 149 pub fn iscntrl(c: c_int) -> c_int; 150 pub fn isdigit(c: c_int) -> c_int; 151 pub fn isgraph(c: c_int) -> c_int; 152 pub fn islower(c: c_int) -> c_int; 153 pub fn isprint(c: c_int) -> c_int; 154 pub fn ispunct(c: c_int) -> c_int; 155 pub fn isspace(c: c_int) -> c_int; 156 pub fn isupper(c: c_int) -> c_int; 157 pub fn isxdigit(c: c_int) -> c_int; 158 pub fn tolower(c: c_int) -> c_int; 159 pub fn toupper(c: c_int) -> c_int; 160 161 #[cfg_attr(all(target_os = "macos", target_arch = "x86"), 162 link_name = "fopen$UNIX2003")] 163 pub fn fopen(filename: *const c_char, 164 mode: *const c_char) -> *mut FILE; 165 #[cfg_attr(all(target_os = "macos", target_arch = "x86"), 166 link_name = "freopen$UNIX2003")] 167 pub fn freopen(filename: *const c_char, mode: *const c_char, 168 file: *mut FILE) -> *mut FILE; 169 pub fn fflush(file: *mut FILE) -> c_int; 170 pub fn fclose(file: *mut FILE) -> c_int; 171 pub fn remove(filename: *const c_char) -> c_int; 172 pub fn rename(oldname: *const c_char, newname: *const c_char) -> c_int; 173 pub fn tmpfile() -> *mut FILE; 174 pub fn setvbuf(stream: *mut FILE, 175 buffer: *mut c_char, 176 mode: c_int, 177 size: size_t) -> c_int; 178 pub fn setbuf(stream: *mut FILE, buf: *mut c_char); 179 pub fn getchar() -> c_int; 180 pub fn putchar(c: c_int) -> c_int; 181 pub fn fgetc(stream: *mut FILE) -> c_int; 182 pub fn fgets(buf: *mut c_char, n: c_int, stream: *mut FILE) -> *mut c_char; 183 pub fn fputc(c: c_int, stream: *mut FILE) -> c_int; 184 #[cfg_attr(all(target_os = "macos", target_arch = "x86"), 185 link_name = "fputs$UNIX2003")] 186 pub fn fputs(s: *const c_char, stream: *mut FILE)-> c_int; 187 pub fn puts(s: *const c_char) -> c_int; 188 pub fn ungetc(c: c_int, stream: *mut FILE) -> c_int; 189 pub fn fread(ptr: *mut c_void, 190 size: size_t, 191 nobj: size_t, 192 stream: *mut FILE) 193 -> size_t; 194 #[cfg_attr(all(target_os = "macos", target_arch = "x86"), 195 link_name = "fwrite$UNIX2003")] 196 pub fn fwrite(ptr: *const c_void, 197 size: size_t, 198 nobj: size_t, 199 stream: *mut FILE) 200 -> size_t; 201 pub fn fseek(stream: *mut FILE, offset: c_long, whence: c_int) -> c_int; 202 pub fn ftell(stream: *mut FILE) -> c_long; 203 pub fn rewind(stream: *mut FILE); 204 #[cfg_attr(target_os = "netbsd", link_name = "__fgetpos50")] 205 pub fn fgetpos(stream: *mut FILE, ptr: *mut fpos_t) -> c_int; 206 #[cfg_attr(target_os = "netbsd", link_name = "__fsetpos50")] 207 pub fn fsetpos(stream: *mut FILE, ptr: *const fpos_t) -> c_int; 208 pub fn feof(stream: *mut FILE) -> c_int; 209 pub fn ferror(stream: *mut FILE) -> c_int; 210 pub fn perror(s: *const c_char); 211 pub fn atoi(s: *const c_char) -> c_int; 212 #[cfg_attr(all(target_os = "macos", target_arch = "x86"), 213 link_name = "strtod$UNIX2003")] 214 pub fn strtod(s: *const c_char, endp: *mut *mut c_char) -> c_double; 215 pub fn strtol(s: *const c_char, 216 endp: *mut *mut c_char, base: c_int) -> c_long; 217 pub fn strtoul(s: *const c_char, endp: *mut *mut c_char, 218 base: c_int) -> c_ulong; 219 pub fn calloc(nobj: size_t, size: size_t) -> *mut c_void; 220 pub fn malloc(size: size_t) -> *mut c_void; 221 pub fn realloc(p: *mut c_void, size: size_t) -> *mut c_void; 222 pub fn free(p: *mut c_void); 223 pub fn abort() -> !; 224 pub fn exit(status: c_int) -> !; 225 pub fn _exit(status: c_int) -> !; 226 pub fn atexit(cb: extern fn()) -> c_int; 227 #[cfg_attr(all(target_os = "macos", target_arch = "x86"), 228 link_name = "system$UNIX2003")] 229 pub fn system(s: *const c_char) -> c_int; 230 pub fn getenv(s: *const c_char) -> *mut c_char; 231 232 pub fn strcpy(dst: *mut c_char, src: *const c_char) -> *mut c_char; 233 pub fn strncpy(dst: *mut c_char, src: *const c_char, n: size_t) 234 -> *mut c_char; 235 pub fn strcat(s: *mut c_char, ct: *const c_char) -> *mut c_char; 236 pub fn strncat(s: *mut c_char, ct: *const c_char, n: size_t) -> *mut c_char; 237 pub fn strcmp(cs: *const c_char, ct: *const c_char) -> c_int; 238 pub fn strncmp(cs: *const c_char, ct: *const c_char, n: size_t) -> c_int; 239 pub fn strcoll(cs: *const c_char, ct: *const c_char) -> c_int; 240 pub fn strchr(cs: *const c_char, c: c_int) -> *mut c_char; 241 pub fn strrchr(cs: *const c_char, c: c_int) -> *mut c_char; 242 pub fn strspn(cs: *const c_char, ct: *const c_char) -> size_t; 243 pub fn strcspn(cs: *const c_char, ct: *const c_char) -> size_t; 244 pub fn strdup(cs: *const c_char) -> *mut c_char; 245 pub fn strpbrk(cs: *const c_char, ct: *const c_char) -> *mut c_char; 246 pub fn strstr(cs: *const c_char, ct: *const c_char) -> *mut c_char; 247 pub fn strlen(cs: *const c_char) -> size_t; 248 pub fn strnlen(cs: *const c_char, maxlen: size_t) -> size_t; 249 #[cfg_attr(all(target_os = "macos", target_arch = "x86"), 250 link_name = "strerror$UNIX2003")] 251 pub fn strerror(n: c_int) -> *mut c_char; 252 pub fn strtok(s: *mut c_char, t: *const c_char) -> *mut c_char; 253 pub fn strxfrm(s: *mut c_char, ct: *const c_char, n: size_t) -> size_t; 254 pub fn wcslen(buf: *const wchar_t) -> size_t; 255 pub fn wcstombs(dest: *mut c_char, src: *const wchar_t, n: size_t) -> ::size_t; 256 257 pub fn memchr(cx: *const c_void, c: c_int, n: size_t) -> *mut c_void; 258 pub fn memcmp(cx: *const c_void, ct: *const c_void, n: size_t) -> c_int; 259 pub fn memcpy(dest: *mut c_void, src: *const c_void, n: size_t) -> *mut c_void; 260 pub fn memmove(dest: *mut c_void, src: *const c_void, n: size_t) -> *mut c_void; 261 pub fn memset(dest: *mut c_void, c: c_int, n: size_t) -> *mut c_void; 262 } 263 264 // These are all inline functions on android, so they end up just being entirely 265 // missing on that platform. 266 #[cfg(not(target_os = "android"))] 267 extern { 268 pub fn abs(i: c_int) -> c_int; 269 pub fn atof(s: *const c_char) -> c_double; 270 pub fn labs(i: c_long) -> c_long; 271 pub fn rand() -> c_int; 272 pub fn srand(seed: c_uint); 273 } 274 275 cfg_if! { 276 if #[cfg(windows)] { 277 mod windows; 278 pub use windows::*; 279 } else if #[cfg(target_os = "redox")] { 280 mod redox; 281 pub use redox::*; 282 } else if #[cfg(unix)] { 283 mod unix; 284 pub use unix::*; 285 } else { 286 // Unknown target_family 287 } 288 } 289