563 lines
41 KiB
HTML
563 lines
41 KiB
HTML
<!DOCTYPE HTML>
|
||
<html lang="en" class="light sidebar-visible" dir="ltr">
|
||
<head>
|
||
<!-- Book generated using mdBook -->
|
||
<meta charset="UTF-8">
|
||
<title>Shared-State Concurrency - The Rust Programming Language</title>
|
||
|
||
|
||
<!-- Custom HTML head -->
|
||
|
||
<meta name="description" content="">
|
||
<meta name="viewport" content="width=device-width, initial-scale=1">
|
||
<meta name="theme-color" content="#ffffff">
|
||
|
||
<link rel="icon" href="favicon-de23e50b.svg">
|
||
<link rel="shortcut icon" href="favicon-8114d1fc.png">
|
||
<link rel="stylesheet" href="css/variables-8adf115d.css">
|
||
<link rel="stylesheet" href="css/general-0392ca55.css">
|
||
<link rel="stylesheet" href="css/chrome-fc474251.css">
|
||
<link rel="stylesheet" href="css/print-9e4910d8.css" media="print">
|
||
|
||
<!-- Fonts -->
|
||
<link rel="stylesheet" href="fonts/fonts-9644e21d.css">
|
||
|
||
<!-- Highlight.js Stylesheets -->
|
||
<link rel="stylesheet" id="mdbook-highlight-css" href="highlight-493f70e1.css">
|
||
<link rel="stylesheet" id="mdbook-tomorrow-night-css" href="tomorrow-night-4c0ae647.css">
|
||
<link rel="stylesheet" id="mdbook-ayu-highlight-css" href="ayu-highlight-3fdfc3ac.css">
|
||
|
||
<!-- Custom theme stylesheets -->
|
||
<link rel="stylesheet" href="ferris-d33b75bf.css">
|
||
<link rel="stylesheet" href="theme/2018-edition-4e126c62.css">
|
||
<link rel="stylesheet" href="theme/semantic-notes-9b5766c0.css">
|
||
<link rel="stylesheet" href="theme/listing-cab26221.css">
|
||
|
||
|
||
<!-- Provide site root and default themes to javascript -->
|
||
<script>
|
||
const path_to_root = "";
|
||
const default_light_theme = "light";
|
||
const default_dark_theme = "navy";
|
||
window.path_to_searchindex_js = "searchindex-6a1da8cc.js";
|
||
</script>
|
||
<!-- Start loading toc.js asap -->
|
||
<script src="toc-0e4ce700.js"></script>
|
||
</head>
|
||
<body>
|
||
<div id="mdbook-help-container">
|
||
<div id="mdbook-help-popup">
|
||
<h2 class="mdbook-help-title">Keyboard shortcuts</h2>
|
||
<div>
|
||
<p>Press <kbd>←</kbd> or <kbd>→</kbd> to navigate between chapters</p>
|
||
<p>Press <kbd>S</kbd> or <kbd>/</kbd> to search in the book</p>
|
||
<p>Press <kbd>?</kbd> to show this help</p>
|
||
<p>Press <kbd>Esc</kbd> to hide this help</p>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<div id="mdbook-body-container">
|
||
<!-- Work around some values being stored in localStorage wrapped in quotes -->
|
||
<script>
|
||
try {
|
||
let theme = localStorage.getItem('mdbook-theme');
|
||
let sidebar = localStorage.getItem('mdbook-sidebar');
|
||
|
||
if (theme.startsWith('"') && theme.endsWith('"')) {
|
||
localStorage.setItem('mdbook-theme', theme.slice(1, theme.length - 1));
|
||
}
|
||
|
||
if (sidebar.startsWith('"') && sidebar.endsWith('"')) {
|
||
localStorage.setItem('mdbook-sidebar', sidebar.slice(1, sidebar.length - 1));
|
||
}
|
||
} catch (e) { }
|
||
</script>
|
||
|
||
<!-- Set the theme before any content is loaded, prevents flash -->
|
||
<script>
|
||
const default_theme = window.matchMedia("(prefers-color-scheme: dark)").matches ? default_dark_theme : default_light_theme;
|
||
let theme;
|
||
try { theme = localStorage.getItem('mdbook-theme'); } catch(e) { }
|
||
if (theme === null || theme === undefined) { theme = default_theme; }
|
||
const html = document.documentElement;
|
||
html.classList.remove('light')
|
||
html.classList.add(theme);
|
||
html.classList.add("js");
|
||
</script>
|
||
|
||
<input type="checkbox" id="mdbook-sidebar-toggle-anchor" class="hidden">
|
||
|
||
<!-- Hide / unhide sidebar before it is displayed -->
|
||
<script>
|
||
let sidebar = null;
|
||
const sidebar_toggle = document.getElementById("mdbook-sidebar-toggle-anchor");
|
||
if (document.body.clientWidth >= 1080) {
|
||
try { sidebar = localStorage.getItem('mdbook-sidebar'); } catch(e) { }
|
||
sidebar = sidebar || 'visible';
|
||
} else {
|
||
sidebar = 'hidden';
|
||
sidebar_toggle.checked = false;
|
||
}
|
||
if (sidebar === 'visible') {
|
||
sidebar_toggle.checked = true;
|
||
} else {
|
||
html.classList.remove('sidebar-visible');
|
||
}
|
||
</script>
|
||
|
||
<nav id="mdbook-sidebar" class="sidebar" aria-label="Table of contents">
|
||
<!-- populated by js -->
|
||
<mdbook-sidebar-scrollbox class="sidebar-scrollbox"></mdbook-sidebar-scrollbox>
|
||
<noscript>
|
||
<iframe class="sidebar-iframe-outer" src="toc.html"></iframe>
|
||
</noscript>
|
||
<div id="mdbook-sidebar-resize-handle" class="sidebar-resize-handle">
|
||
<div class="sidebar-resize-indicator"></div>
|
||
</div>
|
||
</nav>
|
||
|
||
<div id="mdbook-page-wrapper" class="page-wrapper">
|
||
|
||
<div class="page">
|
||
<div id="mdbook-menu-bar-hover-placeholder"></div>
|
||
<div id="mdbook-menu-bar" class="menu-bar sticky">
|
||
<div class="left-buttons">
|
||
<label id="mdbook-sidebar-toggle" class="icon-button" for="mdbook-sidebar-toggle-anchor" title="Toggle Table of Contents" aria-label="Toggle Table of Contents" aria-controls="mdbook-sidebar">
|
||
<span class=fa-svg><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 448 512"><!--! Font Awesome Free 6.2.0 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2022 Fonticons, Inc. --><path d="M0 96C0 78.3 14.3 64 32 64H416c17.7 0 32 14.3 32 32s-14.3 32-32 32H32C14.3 128 0 113.7 0 96zM0 256c0-17.7 14.3-32 32-32H416c17.7 0 32 14.3 32 32s-14.3 32-32 32H32c-17.7 0-32-14.3-32-32zM448 416c0 17.7-14.3 32-32 32H32c-17.7 0-32-14.3-32-32s14.3-32 32-32H416c17.7 0 32 14.3 32 32z"/></svg></span>
|
||
</label>
|
||
<button id="mdbook-theme-toggle" class="icon-button" type="button" title="Change theme" aria-label="Change theme" aria-haspopup="true" aria-expanded="false" aria-controls="mdbook-theme-list">
|
||
<span class=fa-svg><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 576 512"><!--! Font Awesome Free 6.2.0 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2022 Fonticons, Inc. --><path d="M371.3 367.1c27.3-3.9 51.9-19.4 67.2-42.9L600.2 74.1c12.6-19.5 9.4-45.3-7.6-61.2S549.7-4.4 531.1 9.6L294.4 187.2c-24 18-38.2 46.1-38.4 76.1L371.3 367.1zm-19.6 25.4l-116-104.4C175.9 290.3 128 339.6 128 400c0 3.9 .2 7.8 .6 11.6c1.8 17.5-10.2 36.4-27.8 36.4H96c-17.7 0-32 14.3-32 32s14.3 32 32 32H240c61.9 0 112-50.1 112-112c0-2.5-.1-5-.2-7.5z"/></svg></span>
|
||
</button>
|
||
<ul id="mdbook-theme-list" class="theme-popup" aria-label="Themes" role="menu">
|
||
<li role="none"><button role="menuitem" class="theme" id="mdbook-theme-default_theme">Auto</button></li>
|
||
<li role="none"><button role="menuitem" class="theme" id="mdbook-theme-light">Light</button></li>
|
||
<li role="none"><button role="menuitem" class="theme" id="mdbook-theme-rust">Rust</button></li>
|
||
<li role="none"><button role="menuitem" class="theme" id="mdbook-theme-coal">Coal</button></li>
|
||
<li role="none"><button role="menuitem" class="theme" id="mdbook-theme-navy">Navy</button></li>
|
||
<li role="none"><button role="menuitem" class="theme" id="mdbook-theme-ayu">Ayu</button></li>
|
||
</ul>
|
||
<button id="mdbook-search-toggle" class="icon-button" type="button" title="Search (`/`)" aria-label="Toggle Searchbar" aria-expanded="false" aria-keyshortcuts="/ s" aria-controls="mdbook-searchbar">
|
||
<span class=fa-svg><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 512 512"><!--! Font Awesome Free 6.2.0 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2022 Fonticons, Inc. --><path d="M416 208c0 45.9-14.9 88.3-40 122.7L502.6 457.4c12.5 12.5 12.5 32.8 0 45.3s-32.8 12.5-45.3 0L330.7 376c-34.4 25.2-76.8 40-122.7 40C93.1 416 0 322.9 0 208S93.1 0 208 0S416 93.1 416 208zM208 352c79.5 0 144-64.5 144-144s-64.5-144-144-144S64 128.5 64 208s64.5 144 144 144z"/></svg></span>
|
||
</button>
|
||
</div>
|
||
|
||
<h1 class="menu-title">The Rust Programming Language</h1>
|
||
|
||
<div class="right-buttons">
|
||
<a href="print.html" title="Print this book" aria-label="Print this book">
|
||
<span class=fa-svg id="print-button"><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 512 512"><!--! Font Awesome Free 6.2.0 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2022 Fonticons, Inc. --><path d="M128 0C92.7 0 64 28.7 64 64v96h64V64H354.7L384 93.3V160h64V93.3c0-17-6.7-33.3-18.7-45.3L400 18.7C388 6.7 371.7 0 354.7 0H128zM384 352v32 64H128V384 368 352H384zm64 32h32c17.7 0 32-14.3 32-32V256c0-35.3-28.7-64-64-64H64c-35.3 0-64 28.7-64 64v96c0 17.7 14.3 32 32 32H64v64c0 35.3 28.7 64 64 64H384c35.3 0 64-28.7 64-64V384zm-16-88c-13.3 0-24-10.7-24-24s10.7-24 24-24s24 10.7 24 24s-10.7 24-24 24z"/></svg></span>
|
||
</a>
|
||
<a href="https://github.com/rust-lang/book" title="Git repository" aria-label="Git repository">
|
||
<span class=fa-svg><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 496 512"><!--! Font Awesome Free 6.2.0 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2022 Fonticons, Inc. --><path d="M165.9 397.4c0 2-2.3 3.6-5.2 3.6-3.3.3-5.6-1.3-5.6-3.6 0-2 2.3-3.6 5.2-3.6 3-.3 5.6 1.3 5.6 3.6zm-31.1-4.5c-.7 2 1.3 4.3 4.3 4.9 2.6 1 5.6 0 6.2-2s-1.3-4.3-4.3-5.2c-2.6-.7-5.5.3-6.2 2.3zm44.2-1.7c-2.9.7-4.9 2.6-4.6 4.9.3 2 2.9 3.3 5.9 2.6 2.9-.7 4.9-2.6 4.6-4.6-.3-1.9-3-3.2-5.9-2.9zM244.8 8C106.1 8 0 113.3 0 252c0 110.9 69.8 205.8 169.5 239.2 12.8 2.3 17.3-5.6 17.3-12.1 0-6.2-.3-40.4-.3-61.4 0 0-70 15-84.7-29.8 0 0-11.4-29.1-27.8-36.6 0 0-22.9-15.7 1.6-15.4 0 0 24.9 2 38.6 25.8 21.9 38.6 58.6 27.5 72.9 20.9 2.3-16 8.8-27.1 16-33.7-55.9-6.2-112.3-14.3-112.3-110.5 0-27.5 7.6-41.3 23.6-58.9-2.6-6.5-11.1-33.3 2.6-67.9 20.9-6.5 69 27 69 27 20-5.6 41.5-8.5 62.8-8.5s42.8 2.9 62.8 8.5c0 0 48.1-33.6 69-27 13.7 34.7 5.2 61.4 2.6 67.9 16 17.7 25.8 31.5 25.8 58.9 0 96.5-58.9 104.2-114.8 110.5 9.2 7.9 17 22.9 17 46.4 0 33.7-.3 75.4-.3 83.6 0 6.5 4.6 14.4 17.3 12.1C428.2 457.8 496 362.9 496 252 496 113.3 383.5 8 244.8 8zM97.2 352.9c-1.3 1-1 3.3.7 5.2 1.6 1.6 3.9 2.3 5.2 1 1.3-1 1-3.3-.7-5.2-1.6-1.6-3.9-2.3-5.2-1zm-10.8-8.1c-.7 1.3.3 2.9 2.3 3.9 1.6 1 3.6.7 4.3-.7.7-1.3-.3-2.9-2.3-3.9-2-.6-3.6-.3-4.3.7zm32.4 35.6c-1.6 1.3-1 4.3 1.3 6.2 2.3 2.3 5.2 2.6 6.5 1 1.3-1.3.7-4.3-1.3-6.2-2.2-2.3-5.2-2.6-6.5-1zm-11.4-14.7c-1.6 1-1.6 3.6 0 5.9 1.6 2.3 4.3 3.3 5.6 2.3 1.6-1.3 1.6-3.9 0-6.2-1.4-2.3-4-3.3-5.6-2z"/></svg></span>
|
||
</a>
|
||
|
||
</div>
|
||
</div>
|
||
|
||
<div id="mdbook-search-wrapper" class="hidden">
|
||
<form id="mdbook-searchbar-outer" class="searchbar-outer">
|
||
<div class="search-wrapper">
|
||
<input type="search" id="mdbook-searchbar" name="searchbar" placeholder="Search this book ..." aria-controls="mdbook-searchresults-outer" aria-describedby="searchresults-header">
|
||
<div class="spinner-wrapper">
|
||
<span class=fa-svg id="fa-spin"><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 512 512"><!--! Font Awesome Free 6.2.0 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2022 Fonticons, Inc. --><path d="M304 48c0-26.5-21.5-48-48-48s-48 21.5-48 48s21.5 48 48 48s48-21.5 48-48zm0 416c0-26.5-21.5-48-48-48s-48 21.5-48 48s21.5 48 48 48s48-21.5 48-48zM48 304c26.5 0 48-21.5 48-48s-21.5-48-48-48s-48 21.5-48 48s21.5 48 48 48zm464-48c0-26.5-21.5-48-48-48s-48 21.5-48 48s21.5 48 48 48s48-21.5 48-48zM142.9 437c18.7-18.7 18.7-49.1 0-67.9s-49.1-18.7-67.9 0s-18.7 49.1 0 67.9s49.1 18.7 67.9 0zm0-294.2c18.7-18.7 18.7-49.1 0-67.9S93.7 56.2 75 75s-18.7 49.1 0 67.9s49.1 18.7 67.9 0zM369.1 437c18.7 18.7 49.1 18.7 67.9 0s18.7-49.1 0-67.9s-49.1-18.7-67.9 0s-18.7 49.1 0 67.9z"/></svg></span>
|
||
</div>
|
||
</div>
|
||
</form>
|
||
<div id="mdbook-searchresults-outer" class="searchresults-outer hidden">
|
||
<div id="mdbook-searchresults-header" class="searchresults-header"></div>
|
||
<ul id="mdbook-searchresults">
|
||
</ul>
|
||
</div>
|
||
</div>
|
||
|
||
<!-- Apply ARIA attributes after the sidebar and the sidebar toggle button are added to the DOM -->
|
||
<script>
|
||
document.getElementById('mdbook-sidebar-toggle').setAttribute('aria-expanded', sidebar === 'visible');
|
||
document.getElementById('mdbook-sidebar').setAttribute('aria-hidden', sidebar !== 'visible');
|
||
Array.from(document.querySelectorAll('#mdbook-sidebar a')).forEach(function(link) {
|
||
link.setAttribute('tabIndex', sidebar === 'visible' ? 0 : -1);
|
||
});
|
||
</script>
|
||
|
||
<div id="mdbook-content" class="content">
|
||
<main>
|
||
<h2 id="shared-state-concurrency"><a class="header" href="#shared-state-concurrency">Shared-State Concurrency</a></h2>
|
||
<p>Message passing is a fine way to handle concurrency, but it’s not the only way.
|
||
Another method would be for multiple threads to access the same shared data.
|
||
Consider this part of the slogan from the Go language documentation again: “Do
|
||
not communicate by sharing memory.”</p>
|
||
<p>What would communicating by sharing memory look like? In addition, why would
|
||
message-passing enthusiasts caution not to use memory sharing?</p>
|
||
<p>In a way, channels in any programming language are similar to single ownership
|
||
because once you transfer a value down a channel, you should no longer use that
|
||
value. Shared-memory concurrency is like multiple ownership: Multiple threads
|
||
can access the same memory location at the same time. As you saw in Chapter 15,
|
||
where smart pointers made multiple ownership possible, multiple ownership can
|
||
add complexity because these different owners need managing. Rust’s type system
|
||
and ownership rules greatly assist in getting this management correct. For an
|
||
example, let’s look at mutexes, one of the more common concurrency primitives
|
||
for shared memory.</p>
|
||
<!-- Old headings. Do not remove or links may break. -->
|
||
<p><a id="using-mutexes-to-allow-access-to-data-from-one-thread-at-a-time"></a></p>
|
||
<h3 id="controlling-access-with-mutexes"><a class="header" href="#controlling-access-with-mutexes">Controlling Access with Mutexes</a></h3>
|
||
<p><em>Mutex</em> is an abbreviation for <em>mutual exclusion</em>, as in a mutex allows only
|
||
one thread to access some data at any given time. To access the data in a
|
||
mutex, a thread must first signal that it wants access by asking to acquire the
|
||
mutex’s lock. The <em>lock</em> is a data structure that is part of the mutex that
|
||
keeps track of who currently has exclusive access to the data. Therefore, the
|
||
mutex is described as <em>guarding</em> the data it holds via the locking system.</p>
|
||
<p>Mutexes have a reputation for being difficult to use because you have to
|
||
remember two rules:</p>
|
||
<ol>
|
||
<li>You must attempt to acquire the lock before using the data.</li>
|
||
<li>When you’re done with the data that the mutex guards, you must unlock the
|
||
data so that other threads can acquire the lock.</li>
|
||
</ol>
|
||
<p>For a real-world metaphor for a mutex, imagine a panel discussion at a
|
||
conference with only one microphone. Before a panelist can speak, they have to
|
||
ask or signal that they want to use the microphone. When they get the
|
||
microphone, they can talk for as long as they want to and then hand the
|
||
microphone to the next panelist who requests to speak. If a panelist forgets to
|
||
hand the microphone off when they’re finished with it, no one else is able to
|
||
speak. If management of the shared microphone goes wrong, the panel won’t work
|
||
as planned!</p>
|
||
<p>Management of mutexes can be incredibly tricky to get right, which is why so
|
||
many people are enthusiastic about channels. However, thanks to Rust’s type
|
||
system and ownership rules, you can’t get locking and unlocking wrong.</p>
|
||
<h4 id="the-api-of-mutext"><a class="header" href="#the-api-of-mutext">The API of <code>Mutex<T></code></a></h4>
|
||
<p>As an example of how to use a mutex, let’s start by using a mutex in a
|
||
single-threaded context, as shown in Listing 16-12.</p>
|
||
<figure class="listing" id="listing-16-12">
|
||
<span class="file-name">Filename: src/main.rs</span>
|
||
<pre class="playground"><code class="language-rust edition2024">use std::sync::Mutex;
|
||
|
||
fn main() {
|
||
let m = Mutex::new(5);
|
||
|
||
{
|
||
let mut num = m.lock().unwrap();
|
||
*num = 6;
|
||
}
|
||
|
||
println!("m = {m:?}");
|
||
}</code></pre>
|
||
<figcaption><a href="#listing-16-12">Listing 16-12</a>: Exploring the API of <code>Mutex<T></code> in a single-threaded context for simplicity</figcaption>
|
||
</figure>
|
||
<p>As with many types, we create a <code>Mutex<T></code> using the associated function <code>new</code>.
|
||
To access the data inside the mutex, we use the <code>lock</code> method to acquire the
|
||
lock. This call will block the current thread so that it can’t do any work
|
||
until it’s our turn to have the lock.</p>
|
||
<p>The call to <code>lock</code> would fail if another thread holding the lock panicked. In
|
||
that case, no one would ever be able to get the lock, so we’ve chosen to
|
||
<code>unwrap</code> and have this thread panic if we’re in that situation.</p>
|
||
<p>After we’ve acquired the lock, we can treat the return value, named <code>num</code> in
|
||
this case, as a mutable reference to the data inside. The type system ensures
|
||
that we acquire a lock before using the value in <code>m</code>. The type of <code>m</code> is
|
||
<code>Mutex<i32></code>, not <code>i32</code>, so we <em>must</em> call <code>lock</code> to be able to use the <code>i32</code>
|
||
value. We can’t forget; the type system won’t let us access the inner <code>i32</code>
|
||
otherwise.</p>
|
||
<p>The call to <code>lock</code> returns a type called <code>MutexGuard</code>, wrapped in a
|
||
<code>LockResult</code> that we handled with the call to <code>unwrap</code>. The <code>MutexGuard</code> type
|
||
implements <code>Deref</code> to point at our inner data; the type also has a <code>Drop</code>
|
||
implementation that releases the lock automatically when a <code>MutexGuard</code> goes
|
||
out of scope, which happens at the end of the inner scope. As a result, we
|
||
don’t risk forgetting to release the lock and blocking the mutex from being
|
||
used by other threads because the lock release happens automatically.</p>
|
||
<p>After dropping the lock, we can print the mutex value and see that we were able
|
||
to change the inner <code>i32</code> to <code>6</code>.</p>
|
||
<!-- Old headings. Do not remove or links may break. -->
|
||
<p><a id="sharing-a-mutext-between-multiple-threads"></a></p>
|
||
<h4 id="shared-access-to-mutext"><a class="header" href="#shared-access-to-mutext">Shared Access to <code>Mutex<T></code></a></h4>
|
||
<p>Now let’s try to share a value between multiple threads using <code>Mutex<T></code>. We’ll
|
||
spin up 10 threads and have them each increment a counter value by 1, so the
|
||
counter goes from 0 to 10. The example in Listing 16-13 will have a compiler
|
||
error, and we’ll use that error to learn more about using <code>Mutex<T></code> and how
|
||
Rust helps us use it correctly.</p>
|
||
<figure class="listing" id="listing-16-13">
|
||
<span class="file-name">Filename: src/main.rs</span>
|
||
<pre><code class="language-rust ignore does_not_compile">use std::sync::Mutex;
|
||
use std::thread;
|
||
|
||
fn main() {
|
||
let counter = Mutex::new(0);
|
||
let mut handles = vec![];
|
||
|
||
for _ in 0..10 {
|
||
let handle = thread::spawn(move || {
|
||
let mut num = counter.lock().unwrap();
|
||
|
||
*num += 1;
|
||
});
|
||
handles.push(handle);
|
||
}
|
||
|
||
for handle in handles {
|
||
handle.join().unwrap();
|
||
}
|
||
|
||
println!("Result: {}", *counter.lock().unwrap());
|
||
}</code></pre>
|
||
<figcaption><a href="#listing-16-13">Listing 16-13</a>: Ten threads, each incrementing a counter guarded by a <code>Mutex<T></code></figcaption>
|
||
</figure>
|
||
<p>We create a <code>counter</code> variable to hold an <code>i32</code> inside a <code>Mutex<T></code>, as we did
|
||
in Listing 16-12. Next, we create 10 threads by iterating over a range of
|
||
numbers. We use <code>thread::spawn</code> and give all the threads the same closure: one
|
||
that moves the counter into the thread, acquires a lock on the <code>Mutex<T></code> by
|
||
calling the <code>lock</code> method, and then adds 1 to the value in the mutex. When a
|
||
thread finishes running its closure, <code>num</code> will go out of scope and release the
|
||
lock so that another thread can acquire it.</p>
|
||
<p>In the main thread, we collect all the join handles. Then, as we did in Listing
|
||
16-2, we call <code>join</code> on each handle to make sure all the threads finish. At
|
||
that point, the main thread will acquire the lock and print the result of this
|
||
program.</p>
|
||
<p>We hinted that this example wouldn’t compile. Now let’s find out why!</p>
|
||
<pre><code class="language-console">$ cargo run
|
||
Compiling shared-state v0.1.0 (file:///projects/shared-state)
|
||
error[E0382]: borrow of moved value: `counter`
|
||
--> src/main.rs:21:29
|
||
|
|
||
5 | let counter = Mutex::new(0);
|
||
| ------- move occurs because `counter` has type `std::sync::Mutex<i32>`, which does not implement the `Copy` trait
|
||
...
|
||
8 | for _ in 0..10 {
|
||
| -------------- inside of this loop
|
||
9 | let handle = thread::spawn(move || {
|
||
| ------- value moved into closure here, in previous iteration of loop
|
||
...
|
||
21 | println!("Result: {}", *counter.lock().unwrap());
|
||
| ^^^^^^^ value borrowed here after move
|
||
|
|
||
help: consider moving the expression out of the loop so it is only moved once
|
||
|
|
||
8 ~ let mut value = counter.lock();
|
||
9 ~ for _ in 0..10 {
|
||
10 | let handle = thread::spawn(move || {
|
||
11 ~ let mut num = value.unwrap();
|
||
|
|
||
|
||
For more information about this error, try `rustc --explain E0382`.
|
||
error: could not compile `shared-state` (bin "shared-state") due to 1 previous error
|
||
</code></pre>
|
||
<p>The error message states that the <code>counter</code> value was moved in the previous
|
||
iteration of the loop. Rust is telling us that we can’t move the ownership of
|
||
lock <code>counter</code> into multiple threads. Let’s fix the compiler error with the
|
||
multiple-ownership method we discussed in Chapter 15.</p>
|
||
<h4 id="multiple-ownership-with-multiple-threads"><a class="header" href="#multiple-ownership-with-multiple-threads">Multiple Ownership with Multiple Threads</a></h4>
|
||
<p>In Chapter 15, we gave a value to multiple owners by using the smart pointer
|
||
<code>Rc<T></code> to create a reference-counted value. Let’s do the same here and see
|
||
what happens. We’ll wrap the <code>Mutex<T></code> in <code>Rc<T></code> in Listing 16-14 and clone
|
||
the <code>Rc<T></code> before moving ownership to the thread.</p>
|
||
<figure class="listing" id="listing-16-14">
|
||
<span class="file-name">Filename: src/main.rs</span>
|
||
<pre><code class="language-rust ignore does_not_compile">use std::rc::Rc;
|
||
use std::sync::Mutex;
|
||
use std::thread;
|
||
|
||
fn main() {
|
||
let counter = Rc::new(Mutex::new(0));
|
||
let mut handles = vec![];
|
||
|
||
for _ in 0..10 {
|
||
let counter = Rc::clone(&counter);
|
||
let handle = thread::spawn(move || {
|
||
let mut num = counter.lock().unwrap();
|
||
|
||
*num += 1;
|
||
});
|
||
handles.push(handle);
|
||
}
|
||
|
||
for handle in handles {
|
||
handle.join().unwrap();
|
||
}
|
||
|
||
println!("Result: {}", *counter.lock().unwrap());
|
||
}</code></pre>
|
||
<figcaption><a href="#listing-16-14">Listing 16-14</a>: Attempting to use <code>Rc<T></code> to allow multiple threads to own the <code>Mutex<T></code></figcaption>
|
||
</figure>
|
||
<p>Once again, we compile and get… different errors! The compiler is teaching us
|
||
a lot:</p>
|
||
<pre><code class="language-console">$ cargo run
|
||
Compiling shared-state v0.1.0 (file:///projects/shared-state)
|
||
error[E0277]: `Rc<std::sync::Mutex<i32>>` cannot be sent between threads safely
|
||
--> src/main.rs:11:36
|
||
|
|
||
11 | let handle = thread::spawn(move || {
|
||
| ------------- ^------
|
||
| | |
|
||
| ______________________|_____________within this `{closure@src/main.rs:11:36: 11:43}`
|
||
| | |
|
||
| | required by a bound introduced by this call
|
||
12 | | let mut num = counter.lock().unwrap();
|
||
13 | |
|
||
14 | | *num += 1;
|
||
15 | | });
|
||
| |_________^ `Rc<std::sync::Mutex<i32>>` cannot be sent between threads safely
|
||
|
|
||
= help: within `{closure@src/main.rs:11:36: 11:43}`, the trait `Send` is not implemented for `Rc<std::sync::Mutex<i32>>`
|
||
note: required because it's used within this closure
|
||
--> src/main.rs:11:36
|
||
|
|
||
11 | let handle = thread::spawn(move || {
|
||
| ^^^^^^^
|
||
note: required by a bound in `spawn`
|
||
--> /rustc/1159e78c4747b02ef996e55082b704c09b970588/library/std/src/thread/mod.rs:723:1
|
||
|
||
For more information about this error, try `rustc --explain E0277`.
|
||
error: could not compile `shared-state` (bin "shared-state") due to 1 previous error
|
||
</code></pre>
|
||
<p>Wow, that error message is very wordy! Here’s the important part to focus on:
|
||
<code>`Rc<Mutex<i32>>` cannot be sent between threads safely</code>. The compiler is
|
||
also telling us the reason why: <code>the trait `Send` is not implemented for `Rc<Mutex<i32>>`</code>. We’ll talk about <code>Send</code> in the next section: It’s one of
|
||
the traits that ensures that the types we use with threads are meant for use in
|
||
concurrent situations.</p>
|
||
<p>Unfortunately, <code>Rc<T></code> is not safe to share across threads. When <code>Rc<T></code>
|
||
manages the reference count, it adds to the count for each call to <code>clone</code> and
|
||
subtracts from the count when each clone is dropped. But it doesn’t use any
|
||
concurrency primitives to make sure that changes to the count can’t be
|
||
interrupted by another thread. This could lead to wrong counts—subtle bugs that
|
||
could in turn lead to memory leaks or a value being dropped before we’re done
|
||
with it. What we need is a type that is exactly like <code>Rc<T></code>, but that makes
|
||
changes to the reference count in a thread-safe way.</p>
|
||
<h4 id="atomic-reference-counting-with-arct"><a class="header" href="#atomic-reference-counting-with-arct">Atomic Reference Counting with <code>Arc<T></code></a></h4>
|
||
<p>Fortunately, <code>Arc<T></code> <em>is</em> a type like <code>Rc<T></code> that is safe to use in
|
||
concurrent situations. The <em>a</em> stands for <em>atomic</em>, meaning it’s an <em>atomically
|
||
reference-counted</em> type. Atomics are an additional kind of concurrency
|
||
primitive that we won’t cover in detail here: See the standard library
|
||
documentation for <a href="../std/sync/atomic/index.html"><code>std::sync::atomic</code></a><!-- ignore --> for more
|
||
details. At this point, you just need to know that atomics work like primitive
|
||
types but are safe to share across threads.</p>
|
||
<p>You might then wonder why all primitive types aren’t atomic and why standard
|
||
library types aren’t implemented to use <code>Arc<T></code> by default. The reason is that
|
||
thread safety comes with a performance penalty that you only want to pay when
|
||
you really need to. If you’re just performing operations on values within a
|
||
single thread, your code can run faster if it doesn’t have to enforce the
|
||
guarantees atomics provide.</p>
|
||
<p>Let’s return to our example: <code>Arc<T></code> and <code>Rc<T></code> have the same API, so we fix
|
||
our program by changing the <code>use</code> line, the call to <code>new</code>, and the call to
|
||
<code>clone</code>. The code in Listing 16-15 will finally compile and run.</p>
|
||
<figure class="listing" id="listing-16-15">
|
||
<span class="file-name">Filename: src/main.rs</span>
|
||
<pre class="playground"><code class="language-rust edition2024">use std::sync::{Arc, Mutex};
|
||
use std::thread;
|
||
|
||
fn main() {
|
||
let counter = Arc::new(Mutex::new(0));
|
||
let mut handles = vec![];
|
||
|
||
for _ in 0..10 {
|
||
let counter = Arc::clone(&counter);
|
||
let handle = thread::spawn(move || {
|
||
let mut num = counter.lock().unwrap();
|
||
|
||
*num += 1;
|
||
});
|
||
handles.push(handle);
|
||
}
|
||
|
||
for handle in handles {
|
||
handle.join().unwrap();
|
||
}
|
||
|
||
println!("Result: {}", *counter.lock().unwrap());
|
||
}</code></pre>
|
||
<figcaption><a href="#listing-16-15">Listing 16-15</a>: Using an <code>Arc<T></code> to wrap the <code>Mutex<T></code> to be able to share ownership across multiple threads</figcaption>
|
||
</figure>
|
||
<p>This code will print the following:</p>
|
||
<!-- Not extracting output because changes to this output aren't significant;
|
||
the changes are likely to be due to the threads running differently rather than
|
||
changes in the compiler -->
|
||
<pre><code class="language-text">Result: 10
|
||
</code></pre>
|
||
<p>We did it! We counted from 0 to 10, which may not seem very impressive, but it
|
||
did teach us a lot about <code>Mutex<T></code> and thread safety. You could also use this
|
||
program’s structure to do more complicated operations than just incrementing a
|
||
counter. Using this strategy, you can divide a calculation into independent
|
||
parts, split those parts across threads, and then use a <code>Mutex<T></code> to have each
|
||
thread update the final result with its part.</p>
|
||
<p>Note that if you are doing simple numerical operations, there are types simpler
|
||
than <code>Mutex<T></code> types provided by the <a href="../std/sync/atomic/index.html"><code>std::sync::atomic</code> module of the
|
||
standard library</a><!-- ignore -->. These types provide safe, concurrent,
|
||
atomic access to primitive types. We chose to use <code>Mutex<T></code> with a primitive
|
||
type for this example so that we could concentrate on how <code>Mutex<T></code> works.</p>
|
||
<!-- Old headings. Do not remove or links may break. -->
|
||
<p><a id="similarities-between-refcelltrct-and-mutextarct"></a></p>
|
||
<h3 id="comparing-refcelltrct-and-mutextarct"><a class="header" href="#comparing-refcelltrct-and-mutextarct">Comparing <code>RefCell<T></code>/<code>Rc<T></code> and <code>Mutex<T></code>/<code>Arc<T></code></a></h3>
|
||
<p>You might have noticed that <code>counter</code> is immutable but that we could get a
|
||
mutable reference to the value inside it; this means <code>Mutex<T></code> provides
|
||
interior mutability, as the <code>Cell</code> family does. In the same way we used
|
||
<code>RefCell<T></code> in Chapter 15 to allow us to mutate contents inside an <code>Rc<T></code>, we
|
||
use <code>Mutex<T></code> to mutate contents inside an <code>Arc<T></code>.</p>
|
||
<p>Another detail to note is that Rust can’t protect you from all kinds of logic
|
||
errors when you use <code>Mutex<T></code>. Recall from Chapter 15 that using <code>Rc<T></code> came
|
||
with the risk of creating reference cycles, where two <code>Rc<T></code> values refer to
|
||
each other, causing memory leaks. Similarly, <code>Mutex<T></code> comes with the risk of
|
||
creating <em>deadlocks</em>. These occur when an operation needs to lock two resources
|
||
and two threads have each acquired one of the locks, causing them to wait for
|
||
each other forever. If you’re interested in deadlocks, try creating a Rust
|
||
program that has a deadlock; then, research deadlock mitigation strategies for
|
||
mutexes in any language and have a go at implementing them in Rust. The
|
||
standard library API documentation for <code>Mutex<T></code> and <code>MutexGuard</code> offers
|
||
useful information.</p>
|
||
<p>We’ll round out this chapter by talking about the <code>Send</code> and <code>Sync</code> traits and
|
||
how we can use them with custom types.</p>
|
||
|
||
</main>
|
||
|
||
<nav class="nav-wrapper" aria-label="Page navigation">
|
||
<!-- Mobile navigation buttons -->
|
||
<a rel="prev" href="ch16-02-message-passing.html" class="mobile-nav-chapters previous" title="Previous chapter" aria-label="Previous chapter" aria-keyshortcuts="Left">
|
||
<span class=fa-svg><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 320 512"><!--! Font Awesome Free 6.2.0 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2022 Fonticons, Inc. --><path d="M41.4 233.4c-12.5 12.5-12.5 32.8 0 45.3l160 160c12.5 12.5 32.8 12.5 45.3 0s12.5-32.8 0-45.3L109.3 256 246.6 118.6c12.5-12.5 12.5-32.8 0-45.3s-32.8-12.5-45.3 0l-160 160z"/></svg></span>
|
||
</a>
|
||
|
||
<a rel="next prefetch" href="ch16-04-extensible-concurrency-sync-and-send.html" class="mobile-nav-chapters next" title="Next chapter" aria-label="Next chapter" aria-keyshortcuts="Right">
|
||
<span class=fa-svg><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 320 512"><!--! Font Awesome Free 6.2.0 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2022 Fonticons, Inc. --><path d="M278.6 233.4c12.5 12.5 12.5 32.8 0 45.3l-160 160c-12.5 12.5-32.8 12.5-45.3 0s-12.5-32.8 0-45.3L210.7 256 73.4 118.6c-12.5-12.5-12.5-32.8 0-45.3s32.8-12.5 45.3 0l160 160z"/></svg></span>
|
||
</a>
|
||
|
||
<div style="clear: both"></div>
|
||
</nav>
|
||
</div>
|
||
</div>
|
||
|
||
<nav class="nav-wide-wrapper" aria-label="Page navigation">
|
||
<a rel="prev" href="ch16-02-message-passing.html" class="nav-chapters previous" title="Previous chapter" aria-label="Previous chapter" aria-keyshortcuts="Left">
|
||
<span class=fa-svg><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 320 512"><!--! Font Awesome Free 6.2.0 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2022 Fonticons, Inc. --><path d="M41.4 233.4c-12.5 12.5-12.5 32.8 0 45.3l160 160c12.5 12.5 32.8 12.5 45.3 0s12.5-32.8 0-45.3L109.3 256 246.6 118.6c12.5-12.5 12.5-32.8 0-45.3s-32.8-12.5-45.3 0l-160 160z"/></svg></span>
|
||
</a>
|
||
|
||
<a rel="next prefetch" href="ch16-04-extensible-concurrency-sync-and-send.html" class="nav-chapters next" title="Next chapter" aria-label="Next chapter" aria-keyshortcuts="Right">
|
||
<span class=fa-svg><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 320 512"><!--! Font Awesome Free 6.2.0 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2022 Fonticons, Inc. --><path d="M278.6 233.4c12.5 12.5 12.5 32.8 0 45.3l-160 160c-12.5 12.5-32.8 12.5-45.3 0s-12.5-32.8 0-45.3L210.7 256 73.4 118.6c-12.5-12.5-12.5-32.8 0-45.3s32.8-12.5 45.3 0l160 160z"/></svg></span>
|
||
</a>
|
||
</nav>
|
||
|
||
</div>
|
||
|
||
<template id=fa-eye><span class=fa-svg><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 576 512"><!--! Font Awesome Free 6.2.0 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2022 Fonticons, Inc. --><path d="M288 32c-80.8 0-145.5 36.8-192.6 80.6C48.6 156 17.3 208 2.5 243.7c-3.3 7.9-3.3 16.7 0 24.6C17.3 304 48.6 356 95.4 399.4C142.5 443.2 207.2 480 288 480s145.5-36.8 192.6-80.6c46.8-43.5 78.1-95.4 93-131.1c3.3-7.9 3.3-16.7 0-24.6c-14.9-35.7-46.2-87.7-93-131.1C433.5 68.8 368.8 32 288 32zM432 256c0 79.5-64.5 144-144 144s-144-64.5-144-144s64.5-144 144-144s144 64.5 144 144zM288 192c0 35.3-28.7 64-64 64c-11.5 0-22.3-3-31.6-8.4c-.2 2.8-.4 5.5-.4 8.4c0 53 43 96 96 96s96-43 96-96s-43-96-96-96c-2.8 0-5.6 .1-8.4 .4c5.3 9.3 8.4 20.1 8.4 31.6z"/></svg></span></template>
|
||
<template id=fa-eye-slash><span class=fa-svg><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 640 512"><!--! Font Awesome Free 6.2.0 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2022 Fonticons, Inc. --><path d="M38.8 5.1C28.4-3.1 13.3-1.2 5.1 9.2S-1.2 34.7 9.2 42.9l592 464c10.4 8.2 25.5 6.3 33.7-4.1s6.3-25.5-4.1-33.7L525.6 386.7c39.6-40.6 66.4-86.1 79.9-118.4c3.3-7.9 3.3-16.7 0-24.6c-14.9-35.7-46.2-87.7-93-131.1C465.5 68.8 400.8 32 320 32c-68.2 0-125 26.3-169.3 60.8L38.8 5.1zM223.1 149.5C248.6 126.2 282.7 112 320 112c79.5 0 144 64.5 144 144c0 24.9-6.3 48.3-17.4 68.7L408 294.5c5.2-11.8 8-24.8 8-38.5c0-53-43-96-96-96c-2.8 0-5.6 .1-8.4 .4c5.3 9.3 8.4 20.1 8.4 31.6c0 10.2-2.4 19.8-6.6 28.3l-90.3-70.8zm223.1 298L373 389.9c-16.4 6.5-34.3 10.1-53 10.1c-79.5 0-144-64.5-144-144c0-6.9 .5-13.6 1.4-20.2L83.1 161.5C60.3 191.2 44 220.8 34.5 243.7c-3.3 7.9-3.3 16.7 0 24.6c14.9 35.7 46.2 87.7 93 131.1C174.5 443.2 239.2 480 320 480c47.8 0 89.9-12.9 126.2-32.5z"/></svg></span></template>
|
||
<template id=fa-copy><span class=fa-svg><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 512 512"><!--! Font Awesome Free 6.2.0 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2022 Fonticons, Inc. --><path d="M502.6 70.63l-61.25-61.25C435.4 3.371 427.2 0 418.7 0H255.1c-35.35 0-64 28.66-64 64l.0195 256C192 355.4 220.7 384 256 384h192c35.2 0 64-28.8 64-64V93.25C512 84.77 508.6 76.63 502.6 70.63zM464 320c0 8.836-7.164 16-16 16H255.1c-8.838 0-16-7.164-16-16L239.1 64.13c0-8.836 7.164-16 16-16h128L384 96c0 17.67 14.33 32 32 32h47.1V320zM272 448c0 8.836-7.164 16-16 16H63.1c-8.838 0-16-7.164-16-16L47.98 192.1c0-8.836 7.164-16 16-16H160V128H63.99c-35.35 0-64 28.65-64 64l.0098 256C.002 483.3 28.66 512 64 512h192c35.2 0 64-28.8 64-64v-32h-47.1L272 448z"/></svg></span></template>
|
||
<template id=fa-play><span class=fa-svg><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 384 512"><!--! Font Awesome Free 6.2.0 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2022 Fonticons, Inc. --><path d="M73 39c-14.8-9.1-33.4-9.4-48.5-.9S0 62.6 0 80V432c0 17.4 9.4 33.4 24.5 41.9s33.7 8.1 48.5-.9L361 297c14.3-8.7 23-24.2 23-41s-8.7-32.2-23-41L73 39z"/></svg></span></template>
|
||
<template id=fa-clock-rotate-left><span class=fa-svg><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 512 512"><!--! Font Awesome Free 6.2.0 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2022 Fonticons, Inc. --><path d="M75 75L41 41C25.9 25.9 0 36.6 0 57.9V168c0 13.3 10.7 24 24 24H134.1c21.4 0 32.1-25.9 17-41l-30.8-30.8C155 85.5 203 64 256 64c106 0 192 86 192 192s-86 192-192 192c-40.8 0-78.6-12.7-109.7-34.4c-14.5-10.1-34.4-6.6-44.6 7.9s-6.6 34.4 7.9 44.6C151.2 495 201.7 512 256 512c141.4 0 256-114.6 256-256S397.4 0 256 0C185.3 0 121.3 28.7 75 75zm181 53c-13.3 0-24 10.7-24 24V256c0 6.4 2.5 12.5 7 17l72 72c9.4 9.4 24.6 9.4 33.9 0s9.4-24.6 0-33.9l-65-65V152c0-13.3-10.7-24-24-24z"/></svg></span></template>
|
||
|
||
|
||
|
||
<script>
|
||
window.playground_copyable = true;
|
||
</script>
|
||
|
||
|
||
<script src="elasticlunr-ef4e11c1.min.js"></script>
|
||
<script src="mark-09e88c2c.min.js"></script>
|
||
<script src="searcher-09f2665d.js"></script>
|
||
|
||
<script src="clipboard-1626706a.min.js"></script>
|
||
<script src="highlight-abc7f01d.js"></script>
|
||
<script src="book-c22b7243.js"></script>
|
||
|
||
<!-- Custom JS scripts -->
|
||
<script src="ferris-2317480c.js"></script>
|
||
|
||
|
||
|
||
</div>
|
||
</body>
|
||
</html>
|