mirror of
https://github.com/ml-explore/mlx.git
synced 2025-11-04 18:48:15 +08:00
204 lines
19 KiB
HTML
204 lines
19 KiB
HTML
<!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"/>
|
|
<title>MLX: mlx/event.h Source File</title>
|
|
<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('event_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">event.h</div></div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
<a href="event_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><span class="preprocessor">#pragma once</span></div>
|
|
<div class="line"><a id="l00003" name="l00003"></a><span class="lineno"> 3</span> </div>
|
|
<div class="line"><a id="l00004" name="l00004"></a><span class="lineno"> 4</span><span class="preprocessor">#include <memory></span></div>
|
|
<div class="line"><a id="l00005" name="l00005"></a><span class="lineno"> 5</span><span class="preprocessor">#include <stdexcept></span></div>
|
|
<div class="line"><a id="l00006" name="l00006"></a><span class="lineno"> 6</span> </div>
|
|
<div class="line"><a id="l00007" name="l00007"></a><span class="lineno"> 7</span><span class="preprocessor">#include "<a class="code" href="stream_8h.html">mlx/stream.h</a>"</span></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="keyword">namespace </span><a class="code hl_namespace" href="namespacemlx_1_1core.html">mlx::core</a> {</div>
|
|
<div class="line"><a id="l00010" name="l00010"></a><span class="lineno"> 10</span> </div>
|
|
<div class="foldopen" id="foldopen00011" data-start="{" data-end="};">
|
|
<div class="line"><a id="l00011" name="l00011"></a><span class="lineno"><a class="line" href="classmlx_1_1core_1_1_event.html"> 11</a></span><span class="keyword">class </span><a class="code hl_function" href="classmlx_1_1core_1_1_event.html#a833506419b2110ad1abd89b2dd238b4d">Event</a> {</div>
|
|
<div class="line"><a id="l00012" name="l00012"></a><span class="lineno"> 12</span> <span class="keyword">public</span>:</div>
|
|
<div class="line"><a id="l00013" name="l00013"></a><span class="lineno"><a class="line" href="classmlx_1_1core_1_1_event.html#a833506419b2110ad1abd89b2dd238b4d"> 13</a></span> <a class="code hl_function" href="classmlx_1_1core_1_1_event.html#a833506419b2110ad1abd89b2dd238b4d">Event</a>() = <span class="keywordflow">default</span>;</div>
|
|
<div class="line"><a id="l00014" name="l00014"></a><span class="lineno"> 14</span> </div>
|
|
<div class="line"><a id="l00015" name="l00015"></a><span class="lineno"><a class="line" href="classmlx_1_1core_1_1_event.html#a13e4835f2ffb2cc22e29148a448ea184"> 15</a></span> <a class="code hl_function" href="classmlx_1_1core_1_1_event.html#a13e4835f2ffb2cc22e29148a448ea184">Event</a>(<span class="keyword">const</span> <a class="code hl_struct" href="structmlx_1_1core_1_1_stream.html">Stream</a>& steam);</div>
|
|
<div class="line"><a id="l00016" name="l00016"></a><span class="lineno"> 16</span> </div>
|
|
<div class="line"><a id="l00017" name="l00017"></a><span class="lineno"> 17</span> <span class="comment">// Wait for the event to be signaled at its current value</span></div>
|
|
<div class="line"><a id="l00018" name="l00018"></a><span class="lineno"><a class="line" href="classmlx_1_1core_1_1_event.html#a634afd918e6ed847f354531ba9f48252"> 18</a></span> <span class="keywordtype">void</span> <a class="code hl_function" href="classmlx_1_1core_1_1_event.html#a634afd918e6ed847f354531ba9f48252">wait</a>();</div>
|
|
<div class="line"><a id="l00019" name="l00019"></a><span class="lineno"> 19</span> </div>
|
|
<div class="line"><a id="l00020" name="l00020"></a><span class="lineno"> 20</span> <span class="comment">// Signal the event at its current value</span></div>
|
|
<div class="line"><a id="l00021" name="l00021"></a><span class="lineno"><a class="line" href="classmlx_1_1core_1_1_event.html#a65a858445506a61be5889ae0e3651b89"> 21</a></span> <span class="keywordtype">void</span> <a class="code hl_function" href="classmlx_1_1core_1_1_event.html#a65a858445506a61be5889ae0e3651b89">signal</a>();</div>
|
|
<div class="line"><a id="l00022" name="l00022"></a><span class="lineno"> 22</span> </div>
|
|
<div class="line"><a id="l00023" name="l00023"></a><span class="lineno"> 23</span> <span class="comment">// Check if the event has been signaled at its current value</span></div>
|
|
<div class="line"><a id="l00024" name="l00024"></a><span class="lineno"><a class="line" href="classmlx_1_1core_1_1_event.html#a05a9a3de88185b4a89e154242b4e770a"> 24</a></span> <span class="keywordtype">bool</span> <a class="code hl_function" href="classmlx_1_1core_1_1_event.html#a05a9a3de88185b4a89e154242b4e770a">is_signaled</a>() <span class="keyword">const</span>;</div>
|
|
<div class="line"><a id="l00025" name="l00025"></a><span class="lineno"> 25</span> </div>
|
|
<div class="line"><a id="l00026" name="l00026"></a><span class="lineno"> 26</span> <span class="comment">// Check if the event is valid</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_event.html#aa77afd9669e2ef9d5e9ae1c2c6fd24fa"> 27</a></span> <span class="keywordtype">bool</span> <a class="code hl_function" href="classmlx_1_1core_1_1_event.html#aa77afd9669e2ef9d5e9ae1c2c6fd24fa">valid</a>()<span class="keyword"> const </span>{</div>
|
|
<div class="line"><a id="l00028" name="l00028"></a><span class="lineno"> 28</span> <span class="keywordflow">return</span> event_ != <span class="keyword">nullptr</span>;</div>
|
|
<div class="line"><a id="l00029" name="l00029"></a><span class="lineno"> 29</span> }</div>
|
|
</div>
|
|
<div class="line"><a id="l00030" name="l00030"></a><span class="lineno"> 30</span> </div>
|
|
<div class="foldopen" id="foldopen00031" data-start="{" data-end="}">
|
|
<div class="line"><a id="l00031" name="l00031"></a><span class="lineno"><a class="line" href="classmlx_1_1core_1_1_event.html#ab71c7baee3d1d02ad6a2001bbf90b970"> 31</a></span> uint64_t <a class="code hl_function" href="classmlx_1_1core_1_1_event.html#ab71c7baee3d1d02ad6a2001bbf90b970">value</a>()<span class="keyword"> const </span>{</div>
|
|
<div class="line"><a id="l00032" name="l00032"></a><span class="lineno"> 32</span> <span class="keywordflow">return</span> value_;</div>
|
|
<div class="line"><a id="l00033" name="l00033"></a><span class="lineno"> 33</span> }</div>
|
|
</div>
|
|
<div class="line"><a id="l00034" name="l00034"></a><span class="lineno"> 34</span> </div>
|
|
<div class="foldopen" id="foldopen00035" data-start="{" data-end="}">
|
|
<div class="line"><a id="l00035" name="l00035"></a><span class="lineno"><a class="line" href="classmlx_1_1core_1_1_event.html#a0d077b11f4b28f882b42440b7ac6d40d"> 35</a></span> <span class="keywordtype">void</span> <a class="code hl_function" href="classmlx_1_1core_1_1_event.html#a0d077b11f4b28f882b42440b7ac6d40d">set_value</a>(uint64_t v) {</div>
|
|
<div class="line"><a id="l00036" name="l00036"></a><span class="lineno"> 36</span> value_ = v;</div>
|
|
<div class="line"><a id="l00037" name="l00037"></a><span class="lineno"> 37</span> }</div>
|
|
</div>
|
|
<div class="line"><a id="l00038" name="l00038"></a><span class="lineno"> 38</span> </div>
|
|
<div class="foldopen" id="foldopen00039" data-start="{" data-end="}">
|
|
<div class="line"><a id="l00039" name="l00039"></a><span class="lineno"><a class="line" href="classmlx_1_1core_1_1_event.html#a193143bad31b68c699fa27f135b45614"> 39</a></span> <span class="keyword">const</span> <a class="code hl_struct" href="structmlx_1_1core_1_1_stream.html">Stream</a>& <a class="code hl_function" href="classmlx_1_1core_1_1_event.html#a193143bad31b68c699fa27f135b45614">stream</a>()<span class="keyword"> const </span>{</div>
|
|
<div class="line"><a id="l00040" name="l00040"></a><span class="lineno"> 40</span> <span class="keywordflow">if</span> (!<a class="code hl_function" href="classmlx_1_1core_1_1_event.html#aa77afd9669e2ef9d5e9ae1c2c6fd24fa">valid</a>()) {</div>
|
|
<div class="line"><a id="l00041" name="l00041"></a><span class="lineno"> 41</span> <span class="keywordflow">throw</span> std::runtime_error(</div>
|
|
<div class="line"><a id="l00042" name="l00042"></a><span class="lineno"> 42</span> <span class="stringliteral">"[Event::stream] Cannot access stream on invalid event."</span>);</div>
|
|
<div class="line"><a id="l00043" name="l00043"></a><span class="lineno"> 43</span> }</div>
|
|
<div class="line"><a id="l00044" name="l00044"></a><span class="lineno"> 44</span> <span class="keywordflow">return</span> stream_;</div>
|
|
<div class="line"><a id="l00045" name="l00045"></a><span class="lineno"> 45</span> }</div>
|
|
</div>
|
|
<div class="line"><a id="l00046" name="l00046"></a><span class="lineno"> 46</span> </div>
|
|
<div class="foldopen" id="foldopen00047" data-start="{" data-end="}">
|
|
<div class="line"><a id="l00047" name="l00047"></a><span class="lineno"><a class="line" href="classmlx_1_1core_1_1_event.html#af408d30df17c4771e9e2aa550cb6e921"> 47</a></span> <span class="keyword">const</span> std::shared_ptr<void>& <a class="code hl_function" href="classmlx_1_1core_1_1_event.html#af408d30df17c4771e9e2aa550cb6e921">raw_event</a>()<span class="keyword"> const </span>{</div>
|
|
<div class="line"><a id="l00048" name="l00048"></a><span class="lineno"> 48</span> <span class="keywordflow">return</span> event_;</div>
|
|
<div class="line"><a id="l00049" name="l00049"></a><span class="lineno"> 49</span> }</div>
|
|
</div>
|
|
<div class="line"><a id="l00050" name="l00050"></a><span class="lineno"> 50</span> </div>
|
|
<div class="line"><a id="l00051" name="l00051"></a><span class="lineno"> 51</span> <span class="keyword">private</span>:</div>
|
|
<div class="line"><a id="l00052" name="l00052"></a><span class="lineno"> 52</span> <span class="comment">// Default constructed stream should never be used</span></div>
|
|
<div class="line"><a id="l00053" name="l00053"></a><span class="lineno"> 53</span> <span class="comment">// since the event is not yet valid</span></div>
|
|
<div class="line"><a id="l00054" name="l00054"></a><span class="lineno"> 54</span> <a class="code hl_struct" href="structmlx_1_1core_1_1_stream.html">Stream</a> stream_{0, <a class="code hl_variable" href="structmlx_1_1core_1_1_device.html#a69ee81924251dec96f1945c9d91506fd">Device::cpu</a>};</div>
|
|
<div class="line"><a id="l00055" name="l00055"></a><span class="lineno"> 55</span> std::shared_ptr<void> event_;</div>
|
|
<div class="line"><a id="l00056" name="l00056"></a><span class="lineno"> 56</span> uint64_t value_{0};</div>
|
|
<div class="line"><a id="l00057" name="l00057"></a><span class="lineno"> 57</span>};</div>
|
|
</div>
|
|
<div class="line"><a id="l00058" name="l00058"></a><span class="lineno"> 58</span> </div>
|
|
<div class="line"><a id="l00059" name="l00059"></a><span class="lineno"> 59</span>} <span class="comment">// namespace mlx::core</span></div>
|
|
<div class="ttc" id="aclassmlx_1_1core_1_1_event_html_a05a9a3de88185b4a89e154242b4e770a"><div class="ttname"><a href="classmlx_1_1core_1_1_event.html#a05a9a3de88185b4a89e154242b4e770a">mlx::core::Event::is_signaled</a></div><div class="ttdeci">bool is_signaled() const</div></div>
|
|
<div class="ttc" id="aclassmlx_1_1core_1_1_event_html_a0d077b11f4b28f882b42440b7ac6d40d"><div class="ttname"><a href="classmlx_1_1core_1_1_event.html#a0d077b11f4b28f882b42440b7ac6d40d">mlx::core::Event::set_value</a></div><div class="ttdeci">void set_value(uint64_t v)</div><div class="ttdef"><b>Definition</b> event.h:35</div></div>
|
|
<div class="ttc" id="aclassmlx_1_1core_1_1_event_html_a13e4835f2ffb2cc22e29148a448ea184"><div class="ttname"><a href="classmlx_1_1core_1_1_event.html#a13e4835f2ffb2cc22e29148a448ea184">mlx::core::Event::Event</a></div><div class="ttdeci">Event(const Stream &steam)</div></div>
|
|
<div class="ttc" id="aclassmlx_1_1core_1_1_event_html_a193143bad31b68c699fa27f135b45614"><div class="ttname"><a href="classmlx_1_1core_1_1_event.html#a193143bad31b68c699fa27f135b45614">mlx::core::Event::stream</a></div><div class="ttdeci">const Stream & stream() const</div><div class="ttdef"><b>Definition</b> event.h:39</div></div>
|
|
<div class="ttc" id="aclassmlx_1_1core_1_1_event_html_a634afd918e6ed847f354531ba9f48252"><div class="ttname"><a href="classmlx_1_1core_1_1_event.html#a634afd918e6ed847f354531ba9f48252">mlx::core::Event::wait</a></div><div class="ttdeci">void wait()</div></div>
|
|
<div class="ttc" id="aclassmlx_1_1core_1_1_event_html_a65a858445506a61be5889ae0e3651b89"><div class="ttname"><a href="classmlx_1_1core_1_1_event.html#a65a858445506a61be5889ae0e3651b89">mlx::core::Event::signal</a></div><div class="ttdeci">void signal()</div></div>
|
|
<div class="ttc" id="aclassmlx_1_1core_1_1_event_html_a833506419b2110ad1abd89b2dd238b4d"><div class="ttname"><a href="classmlx_1_1core_1_1_event.html#a833506419b2110ad1abd89b2dd238b4d">mlx::core::Event::Event</a></div><div class="ttdeci">Event()=default</div></div>
|
|
<div class="ttc" id="aclassmlx_1_1core_1_1_event_html_aa77afd9669e2ef9d5e9ae1c2c6fd24fa"><div class="ttname"><a href="classmlx_1_1core_1_1_event.html#aa77afd9669e2ef9d5e9ae1c2c6fd24fa">mlx::core::Event::valid</a></div><div class="ttdeci">bool valid() const</div><div class="ttdef"><b>Definition</b> event.h:27</div></div>
|
|
<div class="ttc" id="aclassmlx_1_1core_1_1_event_html_ab71c7baee3d1d02ad6a2001bbf90b970"><div class="ttname"><a href="classmlx_1_1core_1_1_event.html#ab71c7baee3d1d02ad6a2001bbf90b970">mlx::core::Event::value</a></div><div class="ttdeci">uint64_t value() const</div><div class="ttdef"><b>Definition</b> event.h:31</div></div>
|
|
<div class="ttc" id="aclassmlx_1_1core_1_1_event_html_af408d30df17c4771e9e2aa550cb6e921"><div class="ttname"><a href="classmlx_1_1core_1_1_event.html#af408d30df17c4771e9e2aa550cb6e921">mlx::core::Event::raw_event</a></div><div class="ttdeci">const std::shared_ptr< void > & raw_event() const</div><div class="ttdef"><b>Definition</b> event.h:47</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="astream_8h_html"><div class="ttname"><a href="stream_8h.html">stream.h</a></div></div>
|
|
<div class="ttc" id="astructmlx_1_1core_1_1_device_html_a69ee81924251dec96f1945c9d91506fd"><div class="ttname"><a href="structmlx_1_1core_1_1_device.html#a69ee81924251dec96f1945c9d91506fd">mlx::core::Device::cpu</a></div><div class="ttdeci">static constexpr DeviceType cpu</div><div class="ttdef"><b>Definition</b> device.h:13</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>
|
|
<li class="navelem"><a class="el" href="dir_938ab0ecf10b8b860ff766c820f665fd.html">mlx</a></li><li class="navelem"><a class="el" href="event_8h.html">event.h</a></li>
|
|
<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>
|