Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Reference cycle graph potentially misleading? #1855

Closed
ElliotSis opened this issue Mar 11, 2019 · 3 comments · Fixed by rust-lang/rust#80285
Closed

Reference cycle graph potentially misleading? #1855

ElliotSis opened this issue Mar 11, 2019 · 3 comments · Fixed by rust-lang/rust#80285

Comments

@ElliotSis
Copy link

Hi,

As a beginner, I recently got confused when reading the chapter about reference cycles:
https://doc.rust-lang.org/stable/book/ch15-06-reference-cycles.html

fn main() {
    let a = Rc::new(Cons(5, RefCell::new(Rc::new(Nil))));

    println!("a initial rc count = {}", Rc::strong_count(&a));
    println!("a next item = {:?}", a.tail());

    let b = Rc::new(Cons(10, RefCell::new(Rc::clone(&a))));

    println!("a rc count after b creation = {}", Rc::strong_count(&a));
    println!("b initial rc count = {}", Rc::strong_count(&b));
    println!("b next item = {:?}", b.tail());

    if let Some(link) = a.tail() {
        *link.borrow_mut() = Rc::clone(&b);
    }

    println!("b rc count after changing a = {}", Rc::strong_count(&b));
    println!("a rc count after changing a = {}", Rc::strong_count(&a));

    // Uncomment the next line to see that we have a cycle;
    // it will overflow the stack
    // println!("a next item = {:?}", a.tail());
}

cycle

I found the representation of this cycle to be a bit misleading considering that it is later mentioned that the variables a and b are dropped at the end of the scope.
However, if we base ourselves solely on this graph, if somehow a and b are dropped then we shouldn't be left with a cycle?

My understanding is that a and b are Rc; and these variables are indeed dropped (i.e. the count of the managing shared pointers is decreased from 2 to 1).
However, the values these Rc were pointing to are not cleaned up since what is essentially left over is trapped in a cycle between two Rc of count 1.
I could be wrong, but I had something closer to this representation in my mind by looking at the code:

cycle_other

I went on #rust-beginners because I thought I was missing something, and the person I ended up talking to seemed to agree that there was a potential issue here.

PS: The .dot file for this cycle graph seems to be missing, I created the above graph with the following .dot file.

digraph {
    node[shape=record];
    rankdir=LR;
    
    l1[label="{<data> 5| <next>}"];
    l2[label="{<data> 10| <next>}"];
    
    {node[shape=point height=0] invisible_start invisible_end}

    a -> l1:n;
    b -> l2:n;
    invisible_start:n -> l1[arrowtail=none];
    invisible_start:s -> invisible_end:s[dir=none];
    l1:next:c -> l2:data;
    l2:next:c -> invisible_end:n[arrowhead=none];
}
@steveklabnik
Copy link
Member

Yes, your graph is more accurate. Most of the time, you can think of the Rc/Arc as just being the value, but technically, RcBox exists as an implementation detail. yours exposes this, ours does not. I'm open to adjusting it. @carols10cents what do you think?

@carols10cents
Copy link
Member

Sure, I'm up for changing this!

@carols10cents
Copy link
Member

Thanks! I incorporated the dot file you provided, that was very helpful, thank you!!

GuillaumeGomez added a commit to GuillaumeGomez/rust that referenced this issue Dec 22, 2020
Update books

## nomicon

2 commits in d8383b65f7948c2ca19191b3b4bd709b403aaf45..a5a48441d411f61556b57d762b03d6874afe575d
2020-11-22 10:24:42 -0500 to 2020-12-06 10:39:41 +0900
- Update atomics.md (rust-lang/nomicon#249)
- Rename `AllocRef` to `Allocator` and `(de)alloc` to `(de)allocate` (rust-lang/nomicon#248)

## reference

2 commits in a8afdca5d0715b2257b6f8b9a032fd4dd7dae855..b278478b766178491a8b6f67afa4bcd6b64d977a
2020-11-30 06:44:46 -0800 to 2020-12-21 18:18:03 -0800
- Update unions for safe ManuallyDrop assignment. (rust-lang/reference#912)
- Removing ambiguity in type-layout.md (rust-lang/reference#911)

## book

25 commits in a190438d77d28041f24da4f6592e287fab073a61..5bb44f8b5b0aa105c8b22602e9b18800484afa21
2020-11-16 10:44:08 -0600 to 2020-12-18 20:07:31 -0500
- Make some further edits to rust-lang/book#2447
- Merge remote-tracking branch 'origin/pr/2447'
- Remove copied and dangling link brackets
- Merge remote-tracking branch 'origin/pr/2359'
- Override toolchain to nightly for run lints action. (rust-lang/book#2528)
- Remove an uneeded 'static lifetime (rust-lang/book#1752)
- Fixes rust-lang/book#2330. Clarify why the lock is held too long
- Update paragraph about rustfmt in Chapter 1.2 (rust-lang/book#2304)
- Clarify language around  further from rust-lang/book#2418
- Merge remote-tracking branch 'origin/pr/2418'
- Merge remote-tracking branch 'origin/pr/2475'
- Add some further edits to rust-lang/book#2433
- Merge remote-tracking branch 'origin/pr/2433'
- Note all the method families to handle integer overflow
- Merge remote-tracking branch 'origin/pr/2405'
- Fix rust-lang/book#1855 - incorporate new reference cycle diagram
- Make some further edits to the changes in rust-lang/book#1886
- Merge remote-tracking branch 'origin/pr/1886'
- Make some further edits to rust-lang/book#1998
- Merge remote-tracking branch 'origin/pr/1998'
- Update Rust version and output (rust-lang/book#2518)
- Fix typo, regarding privileged ports being up to 1023 instead of 1024 (rust-lang/book#2509)
- Change "appendixes" to "appendices" in intro. (rust-lang/book#2498)
- Update 16-11 to use method call expression for `clone` (rust-lang/book#2511)
- Correct chapter 20 final listing (rust-lang/book#2516)

## rust-by-example

7 commits in 236c734a2cb323541b3394f98682cb981b9ec086..1cce0737d6a7d3ceafb139b4a206861fb1dcb2ab
2020-11-30 14:05:49 -0300 to 2020-12-21 17:36:29 -0300
- Add book.description in book.toml (rust-lang/rust-by-example#1397)
- Simplify the call of filter_map (rust-lang/rust-by-example#1396)
- Update README.md (rust-lang/rust-by-example#1382)
- Add missing main function in static life time example. (rust-lang/rust-by-example#1383)
- Clarify first matching arm and all possible values (rust-lang/rust-by-example#1395)
- Clarify distinction between for iter and into_iter (rust-lang/rust-by-example#1394)
- Drop extern crate (rust-lang/rust-by-example#1393)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants