disallow creation of objects larger than PTRDIFF_MAX via mmap
[musl] / README
1
2 musl libc - a new standard library to power a new generation of
3 Linux-based devices. musl is lightweight, fast, simple, free, and
4 strives to be correct in the sense of standards-conformance and
5 safety.
6
7 musl is an alternative to glibc, eglibc, uClibc, dietlibc, and klibc.
8 For reasons why one might prefer musl, please see the FAQ and libc
9 comparison chart on the project website,
10
11     http://www.musl-libc.org/
12
13 For installation instructions, see the INSTALL file.
14
15 Please refer to the COPYRIGHT file for details on the copyright and
16 license status of code included in musl (standard MIT license).
17
18
19
20 Greetings!
21
22 The 0.9.x release series for musl features interface coverage for all
23 interfaces defined in ISO C99 and POSIX 2008 base, along with a number
24 of non-standardized interfaces for compatibility with Linux, BSD, and
25 glibc functionality. As the release series progresses, we are
26 gradually adding support for incomplete functionality in existing
27 interfaces, additional functions that are deemed to be important due
28 to their use in real-world software, and support for new library and
29 language features in C11 such as thread-local storage, which is now
30 supported on all targets. In addition, support for additional target
31 cpu architectures is being added.
32
33 The number of packages build successfully against musl - either
34 out-of-the-box or with minor patches to address portability errors -
35 has exceeded 5000 and is steadily growing. In addition to application
36 compatibility testing, unit testing has been conducted using three
37 separate test frameworks and numerous additional standalone test cases
38 to verify the correctness of the implementation.
39
40 Included with this package is a gcc wrapper script (musl-gcc) which
41 allows you to build musl-linked programs using an existing gcc 3.x or
42 4.x toolchain on the host. There are also now at several mini
43 distributions (in the form of build scripts) which provide a
44 self-hosting musl-based toolchain and system root. These are much
45 better options than the wrapper script if you wish to use dynamic
46 linking or build packages with many library dependencies. See the musl
47 website for details.
48
49 The musl project is actively seeking contributors, mostly in the areas
50 of porting, testing, and application compatibility improvement. For
51 bug reports, support requests, or to get involved in development,
52 please visit #musl on Freenode IRC or subscribe to the musl mailing
53 list by sending a blank email to musl-subscribe AT lists DOT openwall
54 DOT com.
55
56 Thank you for using musl.
57
58 Cheers,
59
60 Rich Felker / dalias
61
62