OpenE2K/libc-rs
2
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity
519 Commits 2 Branches 0 Tags 10 MiB
Rust 98%
Shell 1%
Dockerfile 0.7%
CSS 0.3%
a6a64d17a0
Go to file
Michael Neumann a6a64d17a0 Squashed commit of the following: 
Running libc-test: PASSED 3426 tests

commit 1a7ee714db34f17abd33dc9262d3e10275eec68d
Author: Michael Neumann <mneumann@ntecs.de>
Date:   Sat Feb 20 13:30:56 2016 +0100

    Fix RLIM_POSIXLOCKS ->  RLIMIT_POSIXLOCKS

commit 09c49a97ebebf087486659ef8277610d99e5c7b3
Author: Michael Neumann <mneumann@ntecs.de>
Date:   Sat Feb 20 13:29:24 2016 +0100

    Ignore signedness check for uuid_t on DragonFly

commit aab4d11f59917686280c271683bf00ff34c8040d
Author: Michael Neumann <mneumann@ntecs.de>
Date:   Sat Feb 20 13:23:21 2016 +0100

    Move FreeBSD-only function into freebsd/mod.rs

commit 9921f030b103dbccb37930ab1d64cf1dd587bd48
Author: Michael Neumann <mneumann@ntecs.de>
Date:   Sat Feb 20 13:21:42 2016 +0100

    Move POSIX_FADV_* to freebsd/mod.rs

commit 2921c2db1e3d0314375aa371936bd227cc6c6e2a
Author: Michael Neumann <mneumann@ntecs.de>
Date:   Sat Feb 20 13:20:11 2016 +0100

    Fix signedness of blksize_t for DragonFly

commit 65e817baee9e01d2d7c86c6202c63ee46d218914
Author: Michael Neumann <mneumann@ntecs.de>
Date:   Sat Feb 20 13:19:02 2016 +0100

    Fix Q_{GET,SET}QUOTA for DragonFly

commit a0d2d63ef88206d321222140ae6b3d92c93b51bd
Author: Michael Neumann <mneumann@ntecs.de>
Date:   Sat Feb 20 13:17:27 2016 +0100

    Fix RLIMIT_* for DragonFly

commit d04a1600a7c66a792a481e1524a1652234a69939
Author: Michael Neumann <mneumann@ntecs.de>
Date:   Sat Feb 20 13:12:09 2016 +0100

    Fix ELAST for DragonFly

commit d120b9278426a76ee106e91e6c999885c1f5c7f4
Author: Michael Neumann <mneumann@ntecs.de>
Date:   Sat Feb 20 13:10:28 2016 +0100

    Fix F_GETLK, F_SETLK, F_SETLKW for DragonFly

commit 963f7da270a14f4d12ea1a52301e363ce745c897
Author: Michael Neumann <mneumann@ntecs.de>
Date:   Sat Feb 20 13:08:51 2016 +0100

    Fix O_CLOEXEC for DragonFly

commit f4d6c9d5991d690c7cb4460790a8e37e713bc034
Author: Michael Neumann <mneumann@ntecs.de>
Date:   Sat Feb 20 13:07:18 2016 +0100

    Fix RAND_MAX for DragonFly

commit ba48336da7be613a49702ad9de445ab3850ebb7c
Author: Michael Neumann <mneumann@ntecs.de>
Date:   Sat Feb 20 13:04:48 2016 +0100

    Fix statvfs for DragonFly

commit 9ae480c60a7d77b31a17d34320464f4179e40a4a
Author: Michael Neumann <mneumann@ntecs.de>
Date:   Sat Feb 20 12:51:47 2016 +0100

    Fix fd_set for DragonFly

commit a15e027838288c4980371c503252cca7e32356c0
Author: Michael Neumann <mneumann@ntecs.de>
Date:   Sat Feb 20 12:42:24 2016 +0100

    Fix all remaining issues on DragonFly

    Missing functions and missing constats.

commit 3966e4fce0cb81bd0b3ed8cdf50611e6982f7767
Author: Michael Neumann <mneumann@ntecs.de>
Date:   Sat Feb 20 12:27:14 2016 +0100

    Use a macro instead of a constant.

    When using a constant, the libc-test thinks this constant
    exists as an C equivalent.

commit 9b5659aaf54419f317250cb3a4692a1c14fdbc33
Author: Michael Neumann <mneumann@ntecs.de>
Date:   Sat Feb 20 12:21:01 2016 +0100

    Use a constant in utsname

commit 50484eda3c978a9c0a9652f6fc619c41ad349c2d
Author: Michael Neumann <mneumann@ntecs.de>
Date:   Sat Feb 20 12:17:55 2016 +0100

    Fix struct utsname

commit 832e94248fabc91574d6d42630168da3542c153f
Author: Michael Neumann <mneumann@ntecs.de>
Date:   Sat Feb 20 12:07:08 2016 +0100

    DragonFly has different stat, dirent, clock_t, ino_t, nlink_t, blksize_t

commit f3152a369d75ae8c1558afa5a59aa55e33b33ec6
Author: Michael Neumann <mneumann@ntecs.de>
Date:   Sat Feb 20 11:52:54 2016 +0100

    Move DragonFly related stuff into dragonfly/*

    Replicate x86_64.rs from FreeBSD. Need some twists.

commit 9fe35124064aa92303171d019004df119f948223
Author: Michael Neumann <mneumann@ntecs.de>
Date:   Sat Feb 20 11:49:38 2016 +0100

    Move FreeBSD code under freebsd/*.

    Next commit will replicate some of the architecture dependent stuff
    for DragonFly.

commit e91983df8deb14004f7a0fe47878f0e4eb31198d
Author: Michael Neumann <mneumann@ntecs.de>
Date:   Sat Feb 20 11:44:25 2016 +0100

    struct utsname has a different size on DragonFly
2016-02-20 13:34:01 +01:00
ci Move iOS back to a known good date 2016-02-18 13:53:46 -08:00
libc-test Squashed commit of the following: 2016-02-20 13:34:01 +01:00
src Squashed commit of the following: 2016-02-20 13:34:01 +01:00
.gitignore Add ~ to .gitignore 2016-01-29 21:34:19 +00:00
.travis.yml Move iOS back to a known good date 2016-02-18 13:53:46 -08:00
appveyor.yml AppVeyor has MSYS2 installed by default now! 2015-10-07 14:38:47 -07:00
Cargo.toml Add a default-on "use_std" feature 2016-02-10 17:21:21 -08:00
LICENSE-APACHE Initial commit 2015-01-13 08:22:00 -08:00
LICENSE-MIT Initial commit 2015-01-13 08:22:00 -08:00
README.md Update links in README for transition to rust-lang 2016-02-11 18:37:10 -08:00

README.md

libc

A Rust library with native bindings to the types and functions commonly found on various systems, including libc.

Build Status Build status

Documentation

Usage

First, add the following to your Cargo.toml:

[dependencies]
libc = "0.2"

Next, add this to your crate root:

extern crate libc;

Currently libc by default links to the standard library, but if you would instead like to use libc in a #![no_std] situation or crate you can request this via:

[dependencies]
libc = { version = "0.2", default-features = false }

What is libc?

The primary purpose of this crate is to provide all of the definitions necessary to easily interoperate with C code (or "C-like" code) on each of the platforms that Rust supports. This includes type definitions (e.g. c_int), constants (e.g. EINVAL) as well as function headers (e.g. malloc).

This crate does not strive to have any form of compatibility across platforms, but rather it is simply a straight binding to the system libraries on the platform in question.

Public API

This crate exports all underlying platform types, functions, and constants under the crate root, so all items are accessible as libc::foo. The types and values of all the exported APIs match the platform that libc is compiled for.

More detailed information about the design of this library can be found in its associated RFC.

Adding an API

Want to use an API which currently isn't bound in libc? It's quite easy to add one!

The internal structure of this crate is designed to minimize the number of #[cfg] attributes in order to easily be able to add new items which apply to all platforms in the future. As a result, the crate is organized hierarchically based on platform. Each module has a number of #[cfg]'d children, but only one is ever actually compiled. Each module then reexports all the contents of its children.

This means that for each platform that libc supports, the path from a leaf module to the root will contain all bindings for the platform in question. Consequently, this indicates where an API should be added! Adding an API at a particular level in the hierarchy means that it is supported on all the child platforms of that level. For example, when adding a Unix API it should be added to src/unix/mod.rs, but when adding a Linux-only API it should be added to src/unix/notbsd/linux/mod.rs.

If you're not 100% sure at what level of the hierarchy an API should be added at, fear not! This crate has CI support which tests any binding against all platforms supported, so you'll see failures if an API is added at the wrong level or has different signatures across platforms.

With that in mind, the steps for adding a new API are:

  1. Determine where in the module hierarchy your API should be added.
  2. Add the API.
  3. Send a PR to this repo.
  4. Wait for CI to pass, fixing errors.
  5. Wait for a merge!

Platforms and Documentation

The following platforms are currently tested and have documentation available:

Tested:

The following may be supported, but are not guaranteed to always work: