src/liblibc/README.md

   1 libc
   2 ====
   3
   4 A Rust library with native bindings to the types and functions commonly found on
   5 various systems, including libc.
   6
   7 [![Build Status](https://travis-ci.org/rust-lang/libc.svg?branch=master)](https://travis-ci.org/rust-lang/libc)
   8 [![Build status](https://ci.appveyor.com/api/projects/status/34csq3uurnw7c0rl?svg=true)](https://ci.appveyor.com/project/alexcrichton/libc)
   9
  10 [Documentation](#platforms-and-documentation)
  11
  12 ## Usage
  13
  14 First, add the following to your `Cargo.toml`:
  15
  16 ```toml
  17 [dependencies]
  18 libc = "0.2"
  19 ```
  20
  21 Next, add this to your crate root:
  22
  23 ```rust
  24 extern crate libc;
  25 ```
  26
  27 Currently libc by default links to the standard library, but if you would
  28 instead like to use libc in a `#![no_std]` situation or crate you can request
  29 this via:
  30
  31 ```toml
  32 [dependencies]
  33 libc = { version = "0.2", default-features = false }
  34 ```
  35
  36 ## What is libc?
  37
  38 The primary purpose of this crate is to provide all of the definitions necessary
  39 to easily interoperate with C code (or "C-like" code) on each of the platforms
  40 that Rust supports. This includes type definitions (e.g. `c_int`), constants
  41 (e.g. `EINVAL`) as well as function headers (e.g. `malloc`).
  42
  43 This crate does not strive to have any form of compatibility across platforms,
  44 but rather it is simply a straight binding to the system libraries on the
  45 platform in question.
  46
  47 ## Public API
  48
  49 This crate exports all underlying platform types, functions, and constants under
  50 the crate root, so all items are accessible as `libc::foo`. The types and values
  51 of all the exported APIs match the platform that libc is compiled for.
  52
  53 More detailed information about the design of this library can be found in its
  54 [associated RFC][rfc].
  55
  56 [rfc]: https://github.com/rust-lang/rfcs/blob/master/text/1291-promote-libc.md
  57
  58 ## Adding an API
  59
  60 Want to use an API which currently isn't bound in `libc`? It's quite easy to add
  61 one!
  62
  63 The internal structure of this crate is designed to minimize the number of
  64 `#[cfg]` attributes in order to easily be able to add new items which apply
  65 to all platforms in the future. As a result, the crate is organized
  66 hierarchically based on platform. Each module has a number of `#[cfg]`'d
  67 children, but only one is ever actually compiled. Each module then reexports all
  68 the contents of its children.
  69
  70 This means that for each platform that libc supports, the path from a
  71 leaf module to the root will contain all bindings for the platform in question.
  72 Consequently, this indicates where an API should be added! Adding an API at a
  73 particular level in the hierarchy means that it is supported on all the child
  74 platforms of that level. For example, when adding a Unix API it should be added
  75 to `src/unix/mod.rs`, but when adding a Linux-only API it should be added to
  76 `src/unix/notbsd/linux/mod.rs`.
  77
  78 If you're not 100% sure at what level of the hierarchy an API should be added
  79 at, fear not! This crate has CI support which tests any binding against all
  80 platforms supported, so you'll see failures if an API is added at the wrong
  81 level or has different signatures across platforms.
  82
  83 With that in mind, the steps for adding a new API are:
  84
  85 1. Determine where in the module hierarchy your API should be added.
  86 2. Add the API.
  87 3. Send a PR to this repo.
  88 4. Wait for CI to pass, fixing errors.
  89 5. Wait for a merge!
  90
  91 ### Test before you commit
  92
  93 We have two automated tests running on [Travis](https://travis-ci.org/rust-lang/libc):
  94
  95 1. [`libc-test`](https://github.com/alexcrichton/ctest)
  96   - `cd libc-test && cargo run`
  97   - Use the `skip_*()` functions in `build.rs` if you really need a workaround.
  98 2. Style checker
  99   - `rustc ci/style.rs && ./style src`
 100
 101 ## Platforms and Documentation
 102
 103 The following platforms are currently tested and have documentation available:
 104
 105 Tested:
 106   * [`i686-pc-windows-msvc`](https://doc.rust-lang.org/libc/i686-pc-windows-msvc/libc/)
 107   * [`x86_64-pc-windows-msvc`](https://doc.rust-lang.org/libc/x86_64-pc-windows-msvc/libc/)
 108     (Windows)
 109   * [`i686-pc-windows-gnu`](https://doc.rust-lang.org/libc/i686-pc-windows-gnu/libc/)
 110   * [`x86_64-pc-windows-gnu`](https://doc.rust-lang.org/libc/x86_64-pc-windows-gnu/libc/)
 111   * [`i686-apple-darwin`](https://doc.rust-lang.org/libc/i686-apple-darwin/libc/)
 112   * [`x86_64-apple-darwin`](https://doc.rust-lang.org/libc/x86_64-apple-darwin/libc/)
 113     (OSX)
 114   * `i686-apple-ios`
 115   * `x86_64-apple-ios`
 116   * [`i686-unknown-linux-gnu`](https://doc.rust-lang.org/libc/i686-unknown-linux-gnu/libc/)
 117   * [`x86_64-unknown-linux-gnu`](https://doc.rust-lang.org/libc/x86_64-unknown-linux-gnu/libc/)
 118     (Linux)
 119   * [`x86_64-unknown-linux-musl`](https://doc.rust-lang.org/libc/x86_64-unknown-linux-musl/libc/)
 120     (Linux MUSL)
 121   * [`aarch64-unknown-linux-gnu`](https://doc.rust-lang.org/libc/aarch64-unknown-linux-gnu/libc/)
 122   * [`mips-unknown-linux-gnu`](https://doc.rust-lang.org/libc/mips-unknown-linux-gnu/libc/)
 123   * [`arm-unknown-linux-gnueabihf`](https://doc.rust-lang.org/libc/arm-unknown-linux-gnueabihf/libc/)
 124   * [`arm-linux-androideabi`](https://doc.rust-lang.org/libc/arm-linux-androideabi/libc/)
 125     (Android)
 126   * [`x86_64-unknown-freebsd`](https://doc.rust-lang.org/libc/x86_64-unknown-freebsd/libc/)
 127   * [`x86_64-unknown-openbsd`](https://doc.rust-lang.org/libc/x86_64-unknown-openbsd/libc/)
 128   * [`x86_64-rumprun-netbsd`](https://doc.rust-lang.org/libc/x86_64-unknown-netbsd/libc/)
 129
 130 The following may be supported, but are not guaranteed to always work:
 131
 132   * `i686-unknown-freebsd`
 133   * [`x86_64-unknown-bitrig`](https://doc.rust-lang.org/libc/x86_64-unknown-bitrig/libc/)
 134   * [`x86_64-unknown-dragonfly`](https://doc.rust-lang.org/libc/x86_64-unknown-dragonfly/libc/)
 135   * `i686-unknown-haiku`
 136   * `x86_64-unknown-haiku`
 137   * [`x86_64-unknown-netbsd`](https://doc.rust-lang.org/libc/x86_64-unknown-netbsd/libc/)