Skip to content

Commit 7af2fb5

Browse files
committed
---
yaml --- r: 96062 b: refs/heads/dist-snap c: 3b0d486 h: refs/heads/master v: v3
1 parent e802fa5 commit 7af2fb5

File tree

216 files changed

+974
-1695
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

216 files changed

+974
-1695
lines changed

[refs]

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ refs/heads/try: c274a6888410ce3e357e014568b43310ed787d36
66
refs/tags/release-0.1: 1f5c5126e96c79d22cb7862f75304136e204f105
77
refs/heads/ndm: f3868061cd7988080c30d6d5bf352a5a5fe2460b
88
refs/heads/try2: 147ecfdd8221e4a4d4e090486829a06da1e0ca3c
9-
refs/heads/dist-snap: 5fdbcc4020a440e18a3c570ffad5d2bb089c08db
9+
refs/heads/dist-snap: 3b0d48634f546055e17cf23a6bcde1bbfbc16b15
1010
refs/tags/release-0.2: c870d2dffb391e14efb05aa27898f1f6333a9596
1111
refs/tags/release-0.3: b5f0d0f648d9a6153664837026ba1be43d3e2503
1212
refs/heads/try3: 9387340aab40a73e8424c48fd42f0c521a4875c0

branches/dist-snap/doc/tutorial-conditions.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -351,7 +351,7 @@ The `raise` method maps a value of the condition's input type to its output type
351351
The input type should therefore convey all relevant information to the condition handler.
352352
The output type should convey all relevant information _for continuing execution at the site of error_.
353353
When the error site raises a condition handler,
354-
the `Condition::raise` method searches task-local storage (TLS) for the innermost installed _handler_,
354+
the `Condition::raise` method searches for the innermost installed task-local condition _handler_,
355355
and if any such handler is found, calls it with the provided input value.
356356
If no handler is found, `Condition::raise` will fail the task with an appropriate error message.
357357

branches/dist-snap/doc/tutorial-ffi.md

Lines changed: 25 additions & 143 deletions
Original file line numberDiff line numberDiff line change
@@ -19,10 +19,9 @@ extern {
1919
fn snappy_max_compressed_length(source_length: size_t) -> size_t;
2020
}
2121
22-
#[fixed_stack_segment]
2322
fn main() {
2423
let x = unsafe { snappy_max_compressed_length(100) };
25-
println(fmt!("max compressed length of a 100 byte buffer: %?", x));
24+
println!("max compressed length of a 100 byte buffer: {}", x);
2625
}
2726
~~~~
2827

@@ -36,11 +35,6 @@ interfaces that aren't thread-safe, and almost any function that takes a pointer
3635
valid for all possible inputs since the pointer could be dangling, and raw pointers fall outside of
3736
Rust's safe memory model.
3837

39-
Finally, the `#[fixed_stack_segment]` annotation that appears on
40-
`main()` instructs the Rust compiler that when `main()` executes, it
41-
should request a "very large" stack segment. More details on
42-
stack management can be found in the following sections.
43-
4438
When declaring the argument types to a foreign function, the Rust compiler will not check if the
4539
declaration is correct, so specifying it correctly is part of keeping the binding correct at
4640
runtime.
@@ -81,8 +75,6 @@ length is number of elements currently contained, and the capacity is the total
8175
the allocated memory. The length is less than or equal to the capacity.
8276

8377
~~~~ {.xfail-test}
84-
#[fixed_stack_segment]
85-
#[inline(never)]
8678
pub fn validate_compressed_buffer(src: &[u8]) -> bool {
8779
unsafe {
8880
snappy_validate_compressed_buffer(vec::raw::to_ptr(src), src.len() as size_t) == 0
@@ -94,36 +86,6 @@ The `validate_compressed_buffer` wrapper above makes use of an `unsafe` block, b
9486
guarantee that calling it is safe for all inputs by leaving off `unsafe` from the function
9587
signature.
9688

97-
The `validate_compressed_buffer` wrapper is also annotated with two
98-
attributes `#[fixed_stack_segment]` and `#[inline(never)]`. The
99-
purpose of these attributes is to guarantee that there will be
100-
sufficient stack for the C function to execute. This is necessary
101-
because Rust, unlike C, does not assume that the stack is allocated in
102-
one continuous chunk. Instead, we rely on a *segmented stack* scheme,
103-
in which the stack grows and shrinks as necessary. C code, however,
104-
expects one large stack, and so callers of C functions must request a
105-
large stack segment to ensure that the C routine will not run off the
106-
end of the stack.
107-
108-
The compiler includes a lint mode that will report an error if you
109-
call a C function without a `#[fixed_stack_segment]` attribute. More
110-
details on the lint mode are given in a later section.
111-
112-
You may be wondering why we include a `#[inline(never)]` directive.
113-
This directive informs the compiler never to inline this function.
114-
While not strictly necessary, it is usually a good idea to use an
115-
`#[inline(never)]` directive in concert with `#[fixed_stack_segment]`.
116-
The reason is that if a fn annotated with `fixed_stack_segment` is
117-
inlined, then its caller also inherits the `fixed_stack_segment`
118-
annotation. This means that rather than requesting a large stack
119-
segment only for the duration of the call into C, the large stack
120-
segment would be used for the entire duration of the caller. This is
121-
not necessarily *bad* -- it can for example be more efficient,
122-
particularly if `validate_compressed_buffer()` is called multiple
123-
times in a row -- but it does work against the purpose of the
124-
segmented stack scheme, which is to keep stacks small and thus
125-
conserve address space.
126-
12789
The `snappy_compress` and `snappy_uncompress` functions are more complex, since a buffer has to be
12890
allocated to hold the output too.
12991

@@ -134,8 +96,6 @@ the true length after compression for setting the length.
13496

13597
~~~~ {.xfail-test}
13698
pub fn compress(src: &[u8]) -> ~[u8] {
137-
#[fixed_stack_segment]; #[inline(never)];
138-
13999
unsafe {
140100
let srclen = src.len() as size_t;
141101
let psrc = vec::raw::to_ptr(src);
@@ -156,8 +116,6 @@ format and `snappy_uncompressed_length` will retrieve the exact buffer size requ
156116

157117
~~~~ {.xfail-test}
158118
pub fn uncompress(src: &[u8]) -> Option<~[u8]> {
159-
#[fixed_stack_segment]; #[inline(never)];
160-
161119
unsafe {
162120
let srclen = src.len() as size_t;
163121
let psrc = vec::raw::to_ptr(src);
@@ -181,98 +139,28 @@ pub fn uncompress(src: &[u8]) -> Option<~[u8]> {
181139
For reference, the examples used here are also available as an [library on
182140
GitHub](https://github.com/thestinger/rust-snappy).
183141

184-
# Automatic wrappers
185-
186-
Sometimes writing Rust wrappers can be quite tedious. For example, if
187-
function does not take any pointer arguments, often there is no need
188-
for translating types. In such cases, it is usually still a good idea
189-
to have a Rust wrapper so as to manage the segmented stacks, but you
190-
can take advantage of the (standard) `externfn!` macro to remove some
191-
of the tedium.
192-
193-
In the initial section, we showed an extern block that added a call
194-
to a specific snappy API:
195-
196-
~~~~ {.xfail-test}
197-
use std::libc::size_t;
198-
199-
#[link_args = "-lsnappy"]
200-
extern {
201-
fn snappy_max_compressed_length(source_length: size_t) -> size_t;
202-
}
203-
204-
#[fixed_stack_segment]
205-
fn main() {
206-
let x = unsafe { snappy_max_compressed_length(100) };
207-
println(fmt!("max compressed length of a 100 byte buffer: %?", x));
208-
}
209-
~~~~
210-
211-
To avoid the need to create a wrapper fn for `snappy_max_compressed_length()`,
212-
and also to avoid the need to think about `#[fixed_stack_segment]`, we
213-
could simply use the `externfn!` macro instead, as shown here:
214-
215-
~~~~ {.xfail-test}
216-
use std::libc::size_t;
217-
218-
externfn!(#[link_args = "-lsnappy"]
219-
fn snappy_max_compressed_length(source_length: size_t) -> size_t)
220-
221-
fn main() {
222-
let x = unsafe { snappy_max_compressed_length(100) };
223-
println(fmt!("max compressed length of a 100 byte buffer: %?", x));
224-
}
225-
~~~~
226-
227-
As you can see from the example, `externfn!` replaces the extern block
228-
entirely. After macro expansion, it will create something like this:
229-
230-
~~~~ {.xfail-test}
231-
use std::libc::size_t;
232-
233-
// Automatically generated by
234-
// externfn!(#[link_args = "-lsnappy"]
235-
// fn snappy_max_compressed_length(source_length: size_t) -> size_t)
236-
unsafe fn snappy_max_compressed_length(source_length: size_t) -> size_t {
237-
#[fixed_stack_segment]; #[inline(never)];
238-
return snappy_max_compressed_length(source_length);
239-
240-
#[link_args = "-lsnappy"]
241-
extern {
242-
fn snappy_max_compressed_length(source_length: size_t) -> size_t;
243-
}
244-
}
245-
246-
fn main() {
247-
let x = unsafe { snappy_max_compressed_length(100) };
248-
println(fmt!("max compressed length of a 100 byte buffer: %?", x));
249-
}
250-
~~~~
251-
252-
# Segmented stacks and the linter
253-
254-
By default, whenever you invoke a non-Rust fn, the `cstack` lint will
255-
check that one of the following conditions holds:
256-
257-
1. The call occurs inside of a fn that has been annotated with
258-
`#[fixed_stack_segment]`;
259-
2. The call occurs inside of an `extern fn`;
260-
3. The call occurs within a stack closure created by some other
261-
safe fn.
262-
263-
All of these conditions ensure that you are running on a large stack
264-
segment. However, they are sometimes too strict. If your application
265-
will be making many calls into C, it is often beneficial to promote
266-
the `#[fixed_stack_segment]` attribute higher up the call chain. For
267-
example, the Rust compiler actually labels main itself as requiring a
268-
`#[fixed_stack_segment]`. In such cases, the linter is just an
269-
annoyance, because all C calls that occur from within the Rust
270-
compiler are made on a large stack. Another situation where this
271-
frequently occurs is on a 64-bit architecture, where large stacks are
272-
the default. In cases, you can disable the linter by including a
273-
`#[allow(cstack)]` directive somewhere, which permits violations of
274-
the "cstack" rules given above (you can also use `#[warn(cstack)]` to
275-
convert the errors into warnings, if you prefer).
142+
# Stack management
143+
144+
Rust tasks by default run on a "large stack". This is actually implemented as a
145+
reserving a large segment of the address space and then lazily mapping in pages
146+
as they are needed. When calling an external C function, the code is invoked on
147+
the same stack as the rust stack. This means that there is no extra
148+
stack-switching mechanism in place because it is assumed that the large stack
149+
for the rust task is plenty for the C function to have.
150+
151+
A planned future improvement (net yet implemented at the time of this writing)
152+
is to have a guard page at the end of every rust stack. No rust function will
153+
hit this guard page (due to rust's usage of LLVM's __morestack). The intention
154+
for this unmapped page is to prevent infinite recursion in C from overflowing
155+
onto other rust stacks. If the guard page is hit, then the process will be
156+
terminated with a message saying that the guard page was hit.
157+
158+
For normal external function usage, this all means that there shouldn't be any
159+
need for any extra effort on a user's perspective. The C stack naturally
160+
interleaves with the rust stack, and it's "large enough" for both to
161+
interoperate. If, however, it is determined that a larger stack is necessary,
162+
there are appropriate functions in the task spawning API to control the size of
163+
the stack of the task which is spawned.
276164

277165
# Destructors
278166

@@ -296,9 +184,6 @@ pub struct Unique<T> {
296184
297185
impl<T: Send> Unique<T> {
298186
pub fn new(value: T) -> Unique<T> {
299-
#[fixed_stack_segment];
300-
#[inline(never)];
301-
302187
unsafe {
303188
let ptr = malloc(std::mem::size_of::<T>() as size_t) as *mut T;
304189
assert!(!ptr::is_null(ptr));
@@ -322,9 +207,6 @@ impl<T: Send> Unique<T> {
322207
#[unsafe_destructor]
323208
impl<T: Send> Drop for Unique<T> {
324209
fn drop(&mut self) {
325-
#[fixed_stack_segment];
326-
#[inline(never)];
327-
328210
unsafe {
329211
let x = intrinsics::init(); // dummy value to swap in
330212
// moving the object out is needed to call the destructor
@@ -384,8 +266,8 @@ extern {
384266
}
385267
386268
fn main() {
387-
println(fmt!("You have readline version %d installed.",
388-
rl_readline_version as int));
269+
println!("You have readline version {} installed.",
270+
rl_readline_version as int);
389271
}
390272
~~~
391273

branches/dist-snap/doc/tutorial.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2839,12 +2839,12 @@ you just have to import it with an `use` statement.
28392839
For example, it re-exports `println` which is defined in `std::io::println`:
28402840

28412841
~~~
2842-
use puts = std::rt::io::stdio::println;
2842+
use puts = std::io::stdio::println;
28432843
28442844
fn main() {
28452845
println("println is imported per default.");
28462846
puts("Doesn't hinder you from importing it under an different name yourself.");
2847-
::std::rt::io::stdio::println("Or from not using the automatic import.");
2847+
::std::io::stdio::println("Or from not using the automatic import.");
28482848
}
28492849
~~~
28502850

branches/dist-snap/src/compiletest/compiletest.rs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ extern mod extra;
1717

1818
use std::os;
1919
use std::rt;
20-
use std::rt::io::fs;
20+
use std::io::fs;
2121

2222
use extra::getopts;
2323
use extra::getopts::groups::{optopt, optflag, reqopt};

branches/dist-snap/src/compiletest/errors.rs

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,8 +8,8 @@
88
// option. This file may not be copied, modified, or distributed
99
// except according to those terms.
1010

11-
use std::rt::io::buffered::BufferedReader;
12-
use std::rt::io::File;
11+
use std::io::buffered::BufferedReader;
12+
use std::io::File;
1313

1414
pub struct ExpectedError { line: uint, kind: ~str, msg: ~str }
1515

branches/dist-snap/src/compiletest/header.rs

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -103,8 +103,8 @@ pub fn is_test_ignored(config: &config, testfile: &Path) -> bool {
103103
}
104104

105105
fn iter_header(testfile: &Path, it: &fn(&str) -> bool) -> bool {
106-
use std::rt::io::buffered::BufferedReader;
107-
use std::rt::io::File;
106+
use std::io::buffered::BufferedReader;
107+
use std::io::File;
108108

109109
let mut rdr = BufferedReader::new(File::open(testfile).unwrap());
110110
loop {

branches/dist-snap/src/compiletest/procsrv.rs

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,7 @@
1111
use std::os;
1212
use std::run;
1313
use std::str;
14+
use std::io::process::ProcessExit;
1415

1516
#[cfg(target_os = "win32")]
1617
fn target_env(lib_path: &str, prog: &str) -> ~[(~str,~str)] {
@@ -39,7 +40,7 @@ fn target_env(_lib_path: &str, _prog: &str) -> ~[(~str,~str)] {
3940
os::env()
4041
}
4142

42-
pub struct Result {status: int, out: ~str, err: ~str}
43+
pub struct Result {status: ProcessExit, out: ~str, err: ~str}
4344

4445
pub fn run(lib_path: &str,
4546
prog: &str,

0 commit comments

Comments
 (0)