Go to file
bors 467e4a6681 Auto merge of #25952 - alexcrichton:fix-scoped-tls, r=aturon
Currently the compiler has no knowledge of `#[thread_local]` which forces users
to take on two burdens of unsafety:

* The lifetime of the borrow of a `#[thread_local]` static is **not** `'static`
* Types in `static`s are required to be `Sync`

The thread-local modules mostly curb these facets of unsafety by only allowing
very limited scopes of borrows as well as allowing all types to be stored in a
thread-local key (regardless of whether they are `Sync`) through an `unsafe
impl`.

Unfortunately these measures have the consequence of being able to take the
address of the key itself and send it to another thread, allowing the same key
to be accessed from two different threads. This is clearly unsafe, and this
commit fixes this problem with the same trick used by `LocalKey`, which is to
have an indirect function call to find the address of the *current thread's*
thread local. This way the address of thread local keys can safely be sent among
threads as their lifetime truly is `'static`.

This commit will reduce the performance of cross-crate scoped thread locals as
it now requires an indirect function call, but this can likely be overcome in a
future commit.

Closes #25894
2015-06-16 20:00:46 +00:00
man Update rustc manpage. 2015-05-26 16:29:32 -07:00
mk Auto merge of #26296 - aidanhs:aphs-fix-musl-make-install, r=alexcrichton 2015-06-14 17:18:25 +00:00
src Auto merge of #25952 - alexcrichton:fix-scoped-tls, r=aturon 2015-06-16 20:00:46 +00:00
.gitattributes webfonts: proper fix 2014-07-08 20:29:36 +02:00
.gitignore gitignore: Add the autogenerated/downloaded unicode data files. 2014-08-03 17:32:53 +10:00
.gitmodules Use rust-installer for installation 2014-12-11 17:14:17 -08:00
.mailmap Update .mailmap 2014-10-23 23:01:31 +02:00
.travis.yml point to buildbot 2015-06-11 19:57:16 +01:00
AUTHORS.txt Typo fixed in AUTHORS.txt 2015-06-04 13:20:27 +09:00
configure mk: Build crates with relative paths to rustc 2015-06-13 01:41:52 +02:00
CONTRIBUTING.md Document issue tracker tags 2015-05-28 16:00:04 -07:00
COPYRIGHT copyright: update paths and entries 2015-01-22 15:45:47 +01:00
LICENSE-APACHE
LICENSE-MIT Bump LICENSE copyright year 2015-01-17 10:51:07 -05:00
Makefile.in mk: Remove generation of .d files 2015-05-19 10:36:00 -07:00
README.md Update README 2015-05-15 00:43:40 -05:00
RELEASES.md std: Stabilize a number of new fs features 2015-06-09 17:44:13 -07:00

The Rust Programming Language

Rust is a systems programming language that is fast, memory safe and multithreaded, but does not employ a garbage collector or otherwise impose significant runtime overhead.

This repo contains the code for rustc, the Rust compiler, as well as standard libraries, tools and documentation for Rust.

Quick Start

Read "Installing Rust" from The Book.

Building from Source

  1. Make sure you have installed the dependencies:

    • g++ 4.7 or clang++ 3.x
    • python 2.6 or later (but not 3.x)
    • GNU make 3.81 or later
    • curl
    • git
  2. Clone the source with git:

    $ git clone https://github.com/rust-lang/rust.git
    $ cd rust
    
  1. Build and install:

    $ ./configure
    $ make && make install
    

    Note: You may need to use sudo make install if you do not normally have permission to modify the destination directory. The install locations can be adjusted by passing a --prefix argument to configure. Various other options are also supported pass --help for more information on them.

    When complete, make install will place several programs into /usr/local/bin: rustc, the Rust compiler, and rustdoc, the API-documentation tool. This install does not include Cargo, Rust's package manager, which you may also want to build.

Building on Windows

MSYS2 can be used to easily build Rust on Windows:

  1. Grab the latest MSYS2 installer and go through the installer.

  2. From the MSYS2 terminal, install the mingw64 toolchain and other required tools.

    # Choose one based on platform:
    $ pacman -S mingw-w64-i686-toolchain
    $ pacman -S mingw-w64-x86_64-toolchain
    
    $ pacman -S base-devel
    
  3. Run mingw32_shell.bat or mingw64_shell.bat from wherever you installed MYSY2 (i.e. C:\msys), depending on whether you want 32-bit or 64-bit Rust.

  4. Navigate to Rust's source code, configure and build it:

    $ ./configure
    $ make && make install
    

Notes

Since the Rust compiler is written in Rust, it must be built by a precompiled "snapshot" version of itself (made in an earlier state of development). As such, source builds require a connection to the Internet, to fetch snapshots, and an OS that can execute the available snapshot binaries.

Snapshot binaries are currently built and tested on several platforms:

Platform \ Architecture x86 x86_64
Windows (7, 8, Server 2008 R2)
Linux (2.6.18 or later)
OSX (10.7 Lion or later)

You may find that other platforms work, but these are our officially supported build environments that are most likely to work.

Rust currently needs about 1.5 GiB of RAM to build without swapping; if it hits swap, it will take a very long time to build.

There is more advice about hacking on Rust in CONTRIBUTING.md.

Getting Help

The Rust community congregates in a few places:

Contributing

To contribute to Rust, please see CONTRIBUTING.

Rust has an IRC culture and most real-time collaboration happens in a variety of channels on Mozilla's IRC network, irc.mozilla.org. The most popular channel is #rust, a venue for general discussion about Rust, and a good place to ask for help.

License

Rust is primarily distributed under the terms of both the MIT license and the Apache License (Version 2.0), with portions covered by various BSD-like licenses.

See LICENSE-APACHE, LICENSE-MIT, and COPYRIGHT for details.