2025-02-07 04:16:29 +08:00
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
< html xmlns = "http://www.w3.org/1999/xhtml" lang = "en-US" >
< head >
< meta http-equiv = "Content-Type" content = "text/xhtml;charset=UTF-8" / >
< meta http-equiv = "X-UA-Compatible" content = "IE=11" / >
< meta name = "generator" content = "Doxygen 1.13.2" / >
< meta name = "viewport" content = "width=device-width, initial-scale=1" / >
2025-03-21 06:37:22 +08:00
< title > MLX: mlx/fence.h Source File< / title >
2025-02-07 04:16:29 +08:00
< link href = "tabs.css" rel = "stylesheet" type = "text/css" / >
< script type = "text/javascript" src = "jquery.js" > < / script >
< script type = "text/javascript" src = "dynsections.js" > < / script >
< script type = "text/javascript" src = "clipboard.js" > < / script >
< link href = "navtree.css" rel = "stylesheet" type = "text/css" / >
< script type = "text/javascript" src = "navtreedata.js" > < / script >
< script type = "text/javascript" src = "navtree.js" > < / script >
< script type = "text/javascript" src = "resize.js" > < / script >
< script type = "text/javascript" src = "cookie.js" > < / script >
< link href = "search/search.css" rel = "stylesheet" type = "text/css" / >
< script type = "text/javascript" src = "search/searchdata.js" > < / script >
< script type = "text/javascript" src = "search/search.js" > < / script >
< script type = "text/javascript" >
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699& dn=expat.txt MIT */
$(function() { init_search(); });
/* @license-end */
< / script >
< link href = "doxygen.css" rel = "stylesheet" type = "text/css" / >
< / head >
< body >
< div id = "top" > <!-- do not remove this div, it is closed by doxygen! -->
< div id = "titlearea" >
< table cellspacing = "0" cellpadding = "0" >
< tbody >
< tr id = "projectrow" >
< td id = "projectalign" >
< div id = "projectname" > MLX
< / div >
< / td >
< td > < div id = "MSearchBox" class = "MSearchBoxInactive" >
< span class = "left" >
< span id = "MSearchSelect" onmouseover = "return searchBox.OnSearchSelectShow()" onmouseout = "return searchBox.OnSearchSelectHide()" >   < / span >
< input type = "text" id = "MSearchField" value = "" placeholder = "Search" accesskey = "S"
onfocus="searchBox.OnSearchFieldFocus(true)"
onblur="searchBox.OnSearchFieldFocus(false)"
onkeyup="searchBox.OnSearchFieldChange(event)"/>
< / span > < span class = "right" >
< a id = "MSearchClose" href = "javascript:searchBox.CloseResultsWindow()" > < img id = "MSearchCloseImg" border = "0" src = "search/close.svg" alt = "" / > < / a >
< / span >
< / div >
< / td >
< / tr >
< / tbody >
< / table >
< / div >
<!-- end header part -->
<!-- Generated by Doxygen 1.13.2 -->
< script type = "text/javascript" >
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699& dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "search/",'.html');
/* @license-end */
< / script >
< script type = "text/javascript" >
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699& dn=expat.txt MIT */
$(function() { codefold.init(0); });
/* @license-end */
< / script >
< / div > <!-- top -->
< div id = "side-nav" class = "ui-resizable side-nav-resizable" >
< div id = "nav-tree" >
< div id = "nav-tree-contents" >
< div id = "nav-sync" class = "sync" > < / div >
< / div >
< / div >
< div id = "splitbar" style = "-moz-user-select:none;"
class="ui-resizable-handle">
< / div >
< / div >
< script type = "text/javascript" >
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699& dn=expat.txt MIT */
$(function(){initNavTree('fence_8h_source.html',''); initResizable(true); });
/* @license-end */
< / script >
< div id = "doc-content" >
<!-- window showing the filter options -->
< div id = "MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
< / div >
<!-- iframe showing the search results (closed by default) -->
< div id = "MSearchResultsWindow" >
< div id = "MSearchResults" >
< div class = "SRPage" >
< div id = "SRIndex" >
< div id = "SRResults" > < / div >
< div class = "SRStatus" id = "Loading" > Loading...< / div >
< div class = "SRStatus" id = "Searching" > Searching...< / div >
< div class = "SRStatus" id = "NoMatches" > No Matches< / div >
< / div >
< / div >
< / div >
< / div >
< div class = "header" >
< div class = "headertitle" > < div class = "title" > fence.h< / div > < / div >
< / div > <!-- header -->
< div class = "contents" >
< a href = "fence_8h.html" > Go to the documentation of this file.< / a > < div class = "fragment" > < div class = "line" > < a id = "l00001" name = "l00001" > < / a > < span class = "lineno" > 1< / span > < span class = "comment" > // Copyright © 2024 Apple Inc.< / span > < / div >
< div class = "line" > < a id = "l00002" name = "l00002" > < / a > < span class = "lineno" > 2< / span > < / div >
2025-03-21 06:37:22 +08:00
< div class = "line" > < a id = "l00003" name = "l00003" > < / a > < span class = "lineno" > 3< / span > < span class = "preprocessor" > #include < vector> < / span > < / div >
2025-02-07 04:16:29 +08:00
< div class = "line" > < a id = "l00004" name = "l00004" > < / a > < span class = "lineno" > 4< / span > < / div >
2025-03-21 06:37:22 +08:00
< div class = "line" > < a id = "l00005" name = "l00005" > < / a > < span class = "lineno" > 5< / span > < span class = "preprocessor" > #include " < a class = "code" href = "array_8h.html" > mlx/array.h< / a > " < / span > < / div >
2025-02-07 04:16:29 +08:00
< div class = "line" > < a id = "l00006" name = "l00006" > < / a > < span class = "lineno" > 6< / span > < / div >
2025-03-21 06:37:22 +08:00
< div class = "line" > < a id = "l00007" name = "l00007" > < / a > < span class = "lineno" > 7< / span > < span class = "keyword" > namespace < / span > < a class = "code hl_namespace" href = "namespacemlx_1_1core.html" > mlx::core< / a > {< / div >
< div class = "line" > < a id = "l00008" name = "l00008" > < / a > < span class = "lineno" > 8< / span > < / div >
< div class = "line" > < a id = "l00009" name = "l00009" > < / a > < span class = "lineno" > 9< / span > < span class = "comment" > /* A fence to be used for synchronizing work between streams.< / span > < / div >
< div class = "line" > < a id = "l00010" name = "l00010" > < / a > < span class = "lineno" > 10< / span > < span class = "comment" > *< / span > < / div >
< div class = "line" > < a id = "l00011" name = "l00011" > < / a > < span class = "lineno" > 11< / span > < span class = "comment" > * Calls to `wait` wait in the given stream until all previous calls to update< / span > < / div >
< div class = "line" > < a id = "l00012" name = "l00012" > < / a > < span class = "lineno" > 12< / span > < span class = "comment" > * are complete on their given stream.< / span > < / div >
< div class = "line" > < a id = "l00013" name = "l00013" > < / a > < span class = "lineno" > 13< / span > < span class = "comment" > *< / span > < / div >
< div class = "line" > < a id = "l00014" name = "l00014" > < / a > < span class = "lineno" > 14< / span > < span class = "comment" > * The array passed to `update` is computed and visible after the call to< / span > < / div >
< div class = "line" > < a id = "l00015" name = "l00015" > < / a > < span class = "lineno" > 15< / span > < span class = "comment" > * `wait` returns. The array passed to `wait` will not be read until all< / span > < / div >
< div class = "line" > < a id = "l00016" name = "l00016" > < / a > < span class = "lineno" > 16< / span > < span class = "comment" > * previous calls to `update` have completed.< / span > < / div >
< div class = "line" > < a id = "l00017" name = "l00017" > < / a > < span class = "lineno" > 17< / span > < span class = "comment" > *< / span > < / div >
< div class = "line" > < a id = "l00018" name = "l00018" > < / a > < span class = "lineno" > 18< / span > < span class = "comment" > * Note, calls to `update` should always from the same thread or explicitly< / span > < / div >
< div class = "line" > < a id = "l00019" name = "l00019" > < / a > < span class = "lineno" > 19< / span > < span class = "comment" > * synchronized so that they occur in sequence. Calls to `wait` can be on any< / span > < / div >
< div class = "line" > < a id = "l00020" name = "l00020" > < / a > < span class = "lineno" > 20< / span > < span class = "comment" > * thread.< / span > < / div >
< div class = "line" > < a id = "l00021" name = "l00021" > < / a > < span class = "lineno" > 21< / span > < span class = "comment" > *< / span > < / div >
< div class = "line" > < a id = "l00022" name = "l00022" > < / a > < span class = "lineno" > 22< / span > < span class = "comment" > * For the Metal back-end the fence supports slow (default) and fast mode.< / span > < / div >
< div class = "line" > < a id = "l00023" name = "l00023" > < / a > < span class = "lineno" > 23< / span > < span class = "comment" > * Fast mode requires setting the environment variable< / span > < / div >
< div class = "line" > < a id = "l00024" name = "l00024" > < / a > < span class = "lineno" > 24< / span > < span class = "comment" > * `MLX_METAL_FAST_SYNCH=1`. Fast mode also requires Metal 3.2+ (macOS 15+,< / span > < / div >
< div class = "line" > < a id = "l00025" name = "l00025" > < / a > < span class = "lineno" > 25< / span > < span class = "comment" > * iOS 18+).< / span > < / div >
< div class = "line" > < a id = "l00026" name = "l00026" > < / a > < span class = "lineno" > 26< / span > < span class = "comment" > */< / span > < / div >
< div class = "foldopen" id = "foldopen00027" data-start = "{" data-end = "};" >
< div class = "line" > < a id = "l00027" name = "l00027" > < / a > < span class = "lineno" > < a class = "line" href = "classmlx_1_1core_1_1_fence.html" > 27< / a > < / span > < span class = "keyword" > class < / span > < a class = "code hl_function" href = "classmlx_1_1core_1_1_fence.html#aeb09655b3ef4db12810defebdbbdac33" > Fence< / a > {< / div >
< div class = "line" > < a id = "l00028" name = "l00028" > < / a > < span class = "lineno" > 28< / span > < span class = "keyword" > public< / span > :< / div >
< div class = "line" > < a id = "l00029" name = "l00029" > < / a > < span class = "lineno" > < a class = "line" href = "classmlx_1_1core_1_1_fence.html#aeb09655b3ef4db12810defebdbbdac33" > 29< / a > < / span > < a class = "code hl_function" href = "classmlx_1_1core_1_1_fence.html#aeb09655b3ef4db12810defebdbbdac33" > Fence< / a > () {};< / div >
< div class = "line" > < a id = "l00030" name = "l00030" > < / a > < span class = "lineno" > < a class = "line" href = "classmlx_1_1core_1_1_fence.html#a7cabe72d8b165344ff9f7118975b6214" > 30< / a > < / span > < span class = "keyword" > explicit< / span > < a class = "code hl_function" href = "classmlx_1_1core_1_1_fence.html#a7cabe72d8b165344ff9f7118975b6214" > Fence< / a > (< a class = "code hl_struct" href = "structmlx_1_1core_1_1_stream.html" > Stream< / a > stream);< / div >
< div class = "line" > < a id = "l00031" name = "l00031" > < / a > < span class = "lineno" > 31< / span > < / div >
< div class = "line" > < a id = "l00032" name = "l00032" > < / a > < span class = "lineno" > < a class = "line" href = "classmlx_1_1core_1_1_fence.html#a19438c60b5e9c6f64529c8f0329ead13" > 32< / a > < / span > < span class = "keywordtype" > void< / span > < a class = "code hl_function" href = "classmlx_1_1core_1_1_fence.html#a19438c60b5e9c6f64529c8f0329ead13" > update< / a > (< a class = "code hl_struct" href = "structmlx_1_1core_1_1_stream.html" > Stream< / a > stream, < span class = "keyword" > const< / span > < a class = "code hl_class" href = "classmlx_1_1core_1_1array.html" > array< / a > & x);< / div >
< div class = "line" > < a id = "l00033" name = "l00033" > < / a > < span class = "lineno" > < a class = "line" href = "classmlx_1_1core_1_1_fence.html#a9d9bc0b57f741577a34f8dfd3b1de8f2" > 33< / a > < / span > < span class = "keywordtype" > void< / span > < a class = "code hl_function" href = "classmlx_1_1core_1_1_fence.html#a9d9bc0b57f741577a34f8dfd3b1de8f2" > wait< / a > (< a class = "code hl_struct" href = "structmlx_1_1core_1_1_stream.html" > Stream< / a > stream, < span class = "keyword" > const< / span > < a class = "code hl_class" href = "classmlx_1_1core_1_1array.html" > array< / a > & x);< / div >
< div class = "line" > < a id = "l00034" name = "l00034" > < / a > < span class = "lineno" > 34< / span > < / div >
< div class = "line" > < a id = "l00035" name = "l00035" > < / a > < span class = "lineno" > 35< / span > < span class = "keyword" > private< / span > :< / div >
< div class = "line" > < a id = "l00036" name = "l00036" > < / a > < span class = "lineno" > 36< / span > std::shared_ptr< void> fence_{< span class = "keyword" > nullptr< / span > };< / div >
< div class = "line" > < a id = "l00037" name = "l00037" > < / a > < span class = "lineno" > 37< / span > };< / div >
2025-02-07 04:16:29 +08:00
< / div >
2025-03-21 06:37:22 +08:00
< div class = "line" > < a id = "l00038" name = "l00038" > < / a > < span class = "lineno" > 38< / span > < / div >
< div class = "line" > < a id = "l00039" name = "l00039" > < / a > < span class = "lineno" > 39< / span > } < span class = "comment" > // namespace mlx::core< / span > < / div >
< div class = "ttc" id = "aarray_8h_html" > < div class = "ttname" > < a href = "array_8h.html" > array.h< / a > < / div > < / div >
< div class = "ttc" id = "aclassmlx_1_1core_1_1_fence_html_a19438c60b5e9c6f64529c8f0329ead13" > < div class = "ttname" > < a href = "classmlx_1_1core_1_1_fence.html#a19438c60b5e9c6f64529c8f0329ead13" > mlx::core::Fence::update< / a > < / div > < div class = "ttdeci" > void update(Stream stream, const array & x)< / div > < / div >
< div class = "ttc" id = "aclassmlx_1_1core_1_1_fence_html_a7cabe72d8b165344ff9f7118975b6214" > < div class = "ttname" > < a href = "classmlx_1_1core_1_1_fence.html#a7cabe72d8b165344ff9f7118975b6214" > mlx::core::Fence::Fence< / a > < / div > < div class = "ttdeci" > Fence(Stream stream)< / div > < / div >
< div class = "ttc" id = "aclassmlx_1_1core_1_1_fence_html_a9d9bc0b57f741577a34f8dfd3b1de8f2" > < div class = "ttname" > < a href = "classmlx_1_1core_1_1_fence.html#a9d9bc0b57f741577a34f8dfd3b1de8f2" > mlx::core::Fence::wait< / a > < / div > < div class = "ttdeci" > void wait(Stream stream, const array & x)< / div > < / div >
< div class = "ttc" id = "aclassmlx_1_1core_1_1_fence_html_aeb09655b3ef4db12810defebdbbdac33" > < div class = "ttname" > < a href = "classmlx_1_1core_1_1_fence.html#aeb09655b3ef4db12810defebdbbdac33" > mlx::core::Fence::Fence< / a > < / div > < div class = "ttdeci" > Fence()< / div > < div class = "ttdef" > < b > Definition< / b > fence.h:29< / div > < / div >
2025-02-07 04:16:29 +08:00
< div class = "ttc" id = "aclassmlx_1_1core_1_1array_html" > < div class = "ttname" > < a href = "classmlx_1_1core_1_1array.html" > mlx::core::array< / a > < / div > < div class = "ttdef" > < b > Definition< / b > array.h:24< / div > < / div >
< div class = "ttc" id = "anamespacemlx_1_1core_html" > < div class = "ttname" > < a href = "namespacemlx_1_1core.html" > mlx::core< / a > < / div > < div class = "ttdef" > < b > Definition< / b > allocator.h:7< / div > < / div >
< div class = "ttc" id = "astructmlx_1_1core_1_1_stream_html" > < div class = "ttname" > < a href = "structmlx_1_1core_1_1_stream.html" > mlx::core::Stream< / a > < / div > < div class = "ttdef" > < b > Definition< / b > stream.h:9< / div > < / div >
< / div > <!-- fragment --> < / div > <!-- contents -->
< / div > <!-- doc - content -->
<!-- start footer part -->
< div id = "nav-path" class = "navpath" > <!-- id is needed for treeview function! -->
< ul >
2025-03-21 06:37:22 +08:00
< li class = "navelem" > < a class = "el" href = "dir_938ab0ecf10b8b860ff766c820f665fd.html" > mlx< / a > < / li > < li class = "navelem" > < a class = "el" href = "fence_8h.html" > fence.h< / a > < / li >
2025-02-07 04:16:29 +08:00
< li class = "footer" > Generated by < a href = "https://www.doxygen.org/index.html" > < img class = "footer" src = "doxygen.svg" width = "104" height = "31" alt = "doxygen" / > < / a > 1.13.2 < / li >
< / ul >
< / div >
< / body >
< / html >
