<!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">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.9.1"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>winapi_common: src/shmem.cpp 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>
<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>
<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 style="height: 56px;">
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">winapi_common
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.1 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'Search','.html');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
/* @license-end */</script>
<div id="main-nav"></div>
<!-- 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">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="dir_68267d1309a1af8e8297ef4c3efbcdba.html">src</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="headertitle">
<div class="title">shmem.cpp</div> </div>
</div><!--header-->
<div class="contents">
<div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span> <span class="comment">// Copyright (c) 2020 Egor Tensin <Egor.Tensin@gmail.com></span></div>
<div class="line"><a name="l00002"></a><span class="lineno"> 2</span> <span class="comment">// This file is part of the "winapi-common" project.</span></div>
<div class="line"><a name="l00003"></a><span class="lineno"> 3</span> <span class="comment">// For details, see https://github.com/egor-tensin/winapi-common.</span></div>
<div class="line"><a name="l00004"></a><span class="lineno"> 4</span> <span class="comment">// Distributed under the MIT License.</span></div>
<div class="line"><a name="l00005"></a><span class="lineno"> 5</span>  </div>
<div class="line"><a name="l00006"></a><span class="lineno"> 6</span> <span class="preprocessor">#include <<a class="code" href="error_8hpp.html">winapi/error.hpp</a>></span></div>
<div class="line"><a name="l00007"></a><span class="lineno"> 7</span> <span class="preprocessor">#include <winapi/handle.hpp></span></div>
<div class="line"><a name="l00008"></a><span class="lineno"> 8</span> <span class="preprocessor">#include <winapi/shmem.hpp></span></div>
<div class="line"><a name="l00009"></a><span class="lineno"> 9</span> <span class="preprocessor">#include <winapi/utf8.hpp></span></div>
<div class="line"><a name="l00010"></a><span class="lineno"> 10</span> <span class="preprocessor">#include <winapi/utils.hpp></span></div>
<div class="line"><a name="l00011"></a><span class="lineno"> 11</span>  </div>
<div class="line"><a name="l00012"></a><span class="lineno"> 12</span> <span class="preprocessor">#include <windows.h></span></div>
<div class="line"><a name="l00013"></a><span class="lineno"> 13</span>  </div>
<div class="line"><a name="l00014"></a><span class="lineno"> 14</span> <span class="preprocessor">#include <cstddef></span></div>
<div class="line"><a name="l00015"></a><span class="lineno"> 15</span> <span class="preprocessor">#include <cstdint></span></div>
<div class="line"><a name="l00016"></a><span class="lineno"> 16</span> <span class="preprocessor">#include <string></span></div>
<div class="line"><a name="l00017"></a><span class="lineno"> 17</span> <span class="preprocessor">#include <utility></span></div>
<div class="line"><a name="l00018"></a><span class="lineno"> 18</span>  </div>
<div class="line"><a name="l00019"></a><span class="lineno"> 19</span> <span class="keyword">namespace </span>winapi {</div>
<div class="line"><a name="l00020"></a><span class="lineno"> 20</span> <span class="keyword">namespace </span>{</div>
<div class="line"><a name="l00021"></a><span class="lineno"> 21</span>  </div>
<div class="line"><a name="l00022"></a><span class="lineno"> 22</span> <span class="keywordtype">void</span>* do_map(<span class="keyword">const</span> Handle& mapping, std::size_t nb = 0) {</div>
<div class="line"><a name="l00023"></a><span class="lineno"> 23</span>  <span class="keyword">const</span> <span class="keyword">auto</span> addr = ::MapViewOfFile(<span class="keyword">static_cast<</span>HANDLE<span class="keyword">></span>(mapping), FILE_MAP_ALL_ACCESS, 0, 0, nb);</div>
<div class="line"><a name="l00024"></a><span class="lineno"> 24</span>  </div>
<div class="line"><a name="l00025"></a><span class="lineno"> 25</span>  <span class="keywordflow">if</span> (addr == NULL) {</div>
<div class="line"><a name="l00026"></a><span class="lineno"> 26</span>  <span class="keywordflow">throw</span> error::windows(GetLastError(), <span class="stringliteral">"MapViewOfFile"</span>);</div>
<div class="line"><a name="l00027"></a><span class="lineno"> 27</span>  }</div>
<div class="line"><a name="l00028"></a><span class="lineno"> 28</span>  </div>
<div class="line"><a name="l00029"></a><span class="lineno"> 29</span>  <span class="keywordflow">return</span> addr;</div>
<div class="line"><a name="l00030"></a><span class="lineno"> 30</span> }</div>
<div class="line"><a name="l00031"></a><span class="lineno"> 31</span>  </div>
<div class="line"><a name="l00032"></a><span class="lineno"> 32</span> } <span class="comment">// namespace</span></div>
<div class="line"><a name="l00033"></a><span class="lineno"> 33</span>  </div>
<div class="line"><a name="l00034"></a><span class="lineno"> 34</span> <span class="keywordtype">void</span> SharedMemory::Unmap::operator()(<span class="keywordtype">void</span>* ptr)<span class="keyword"> const </span>{</div>
<div class="line"><a name="l00035"></a><span class="lineno"> 35</span>  <span class="keyword">const</span> <span class="keyword">auto</span> ret = ::UnmapViewOfFile(ptr);</div>
<div class="line"><a name="l00036"></a><span class="lineno"> 36</span>  assert(ret);</div>
<div class="line"><a name="l00037"></a><span class="lineno"> 37</span>  WINAPI_UNUSED_PARAMETER(ret);</div>
<div class="line"><a name="l00038"></a><span class="lineno"> 38</span> };</div>
<div class="line"><a name="l00039"></a><span class="lineno"> 39</span>  </div>
<div class="line"><a name="l00040"></a><span class="lineno"><a class="line" href="classwinapi_1_1SharedMemory.html#a475d4dcdf99d777cb0968d7631cc6f7e"> 40</a></span> <a class="code" href="classwinapi_1_1SharedMemory.html">SharedMemory</a> <a class="code" href="classwinapi_1_1SharedMemory.html#a475d4dcdf99d777cb0968d7631cc6f7e">SharedMemory::create</a>(<span class="keyword">const</span> std::string& name, std::size_t nb) {</div>
<div class="line"><a name="l00041"></a><span class="lineno"> 41</span>  <span class="keyword">const</span> <span class="keyword">auto</span> nb64 = <span class="keyword">static_cast<</span>std::uint64_t<span class="keyword">></span>(nb);</div>
<div class="line"><a name="l00042"></a><span class="lineno"> 42</span>  static_assert(<span class="keyword">sizeof</span>(nb64) == 2 * <span class="keyword">sizeof</span>(DWORD), <span class="stringliteral">"sizeof(DWORD) != 32"</span>);</div>
<div class="line"><a name="l00043"></a><span class="lineno"> 43</span>  </div>
<div class="line"><a name="l00044"></a><span class="lineno"> 44</span>  <span class="keyword">const</span> <span class="keyword">auto</span> nb_low = <span class="keyword">static_cast<</span>DWORD<span class="keyword">></span>(nb64);</div>
<div class="line"><a name="l00045"></a><span class="lineno"> 45</span>  <span class="keyword">const</span> <span class="keyword">auto</span> nb_high = <span class="keyword">static_cast<</span>DWORD<span class="keyword">></span>(nb64 >> 32);</div>
<div class="line"><a name="l00046"></a><span class="lineno"> 46</span>  </div>
<div class="line"><a name="l00047"></a><span class="lineno"> 47</span>  <span class="keyword">const</span> <span class="keyword">auto</span> mapping_impl = ::CreateFileMappingW(</div>
<div class="line"><a name="l00048"></a><span class="lineno"> 48</span>  INVALID_HANDLE_VALUE, NULL, PAGE_READWRITE, nb_high, nb_low, widen(name).c_str());</div>
<div class="line"><a name="l00049"></a><span class="lineno"> 49</span>  </div>
<div class="line"><a name="l00050"></a><span class="lineno"> 50</span>  <span class="keywordflow">if</span> (mapping_impl == NULL) {</div>
<div class="line"><a name="l00051"></a><span class="lineno"> 51</span>  <span class="keywordflow">throw</span> error::windows(GetLastError(), <span class="stringliteral">"CreateFileMappingW"</span>);</div>
<div class="line"><a name="l00052"></a><span class="lineno"> 52</span>  }</div>
<div class="line"><a name="l00053"></a><span class="lineno"> 53</span>  </div>
<div class="line"><a name="l00054"></a><span class="lineno"> 54</span>  <a class="code" href="classwinapi_1_1Handle.html">Handle</a> mapping{mapping_impl};</div>
<div class="line"><a name="l00055"></a><span class="lineno"> 55</span>  <span class="keyword">const</span> <span class="keyword">auto</span> addr = do_map(mapping);</div>
<div class="line"><a name="l00056"></a><span class="lineno"> 56</span>  <span class="keywordflow">return</span> {std::move(mapping), addr};</div>
<div class="line"><a name="l00057"></a><span class="lineno"> 57</span> }</div>
<div class="line"><a name="l00058"></a><span class="lineno"> 58</span>  </div>
<div class="line"><a name="l00059"></a><span class="lineno"><a class="line" href="classwinapi_1_1SharedMemory.html#a82eafb0e7c2c6b5af1a7ff8945af2027"> 59</a></span> <a class="code" href="classwinapi_1_1SharedMemory.html">SharedMemory</a> <a class="code" href="classwinapi_1_1SharedMemory.html#a82eafb0e7c2c6b5af1a7ff8945af2027">SharedMemory::open</a>(<span class="keyword">const</span> std::string& name) {</div>
<div class="line"><a name="l00060"></a><span class="lineno"> 60</span>  <span class="keyword">const</span> <span class="keyword">auto</span> mapping_impl = ::OpenFileMappingW(FILE_MAP_ALL_ACCESS, FALSE, widen(name).c_str());</div>
<div class="line"><a name="l00061"></a><span class="lineno"> 61</span>  </div>
<div class="line"><a name="l00062"></a><span class="lineno"> 62</span>  <span class="keywordflow">if</span> (mapping_impl == NULL) {</div>
<div class="line"><a name="l00063"></a><span class="lineno"> 63</span>  <span class="keywordflow">throw</span> error::windows(GetLastError(), <span class="stringliteral">"OpenFileMappingW"</span>);</div>
<div class="line"><a name="l00064"></a><span class="lineno"> 64</span>  }</div>
<div class="line"><a name="l00065"></a><span class="lineno"> 65</span>  </div>
<div class="line"><a name="l00066"></a><span class="lineno"> 66</span>  <a class="code" href="classwinapi_1_1Handle.html">Handle</a> mapping{mapping_impl};</div>
<div class="line"><a name="l00067"></a><span class="lineno"> 67</span>  <span class="keyword">const</span> <span class="keyword">auto</span> addr = do_map(mapping);</div>
<div class="line"><a name="l00068"></a><span class="lineno"> 68</span>  <span class="keywordflow">return</span> {std::move(mapping), addr};</div>
<div class="line"><a name="l00069"></a><span class="lineno"> 69</span> }</div>
<div class="line"><a name="l00070"></a><span class="lineno"> 70</span>  </div>
<div class="line"><a name="l00071"></a><span class="lineno"> 71</span> } <span class="comment">// namespace winapi</span></div>
<div class="ttc" id="aclasswinapi_1_1Handle_html"><div class="ttname"><a href="classwinapi_1_1Handle.html">winapi::Handle</a></div><div class="ttdoc">HANDLE wrapper.</div><div class="ttdef"><b>Definition:</b> <a href="handle_8hpp_source.html#l00025">handle.hpp:25</a></div></div>
<div class="ttc" id="aclasswinapi_1_1SharedMemory_html"><div class="ttname"><a href="classwinapi_1_1SharedMemory.html">winapi::SharedMemory</a></div><div class="ttdoc">Named shared memory region.</div><div class="ttdef"><b>Definition:</b> <a href="shmem_8hpp_source.html#l00019">shmem.hpp:19</a></div></div>
<div class="ttc" id="aclasswinapi_1_1SharedMemory_html_a475d4dcdf99d777cb0968d7631cc6f7e"><div class="ttname"><a href="classwinapi_1_1SharedMemory.html#a475d4dcdf99d777cb0968d7631cc6f7e">winapi::SharedMemory::create</a></div><div class="ttdeci">static SharedMemory create(const std::string &name, std::size_t nb)</div><div class="ttdef"><b>Definition:</b> <a href="shmem_8cpp_source.html#l00040">shmem.cpp:40</a></div></div>
<div class="ttc" id="aclasswinapi_1_1SharedMemory_html_a82eafb0e7c2c6b5af1a7ff8945af2027"><div class="ttname"><a href="classwinapi_1_1SharedMemory.html#a82eafb0e7c2c6b5af1a7ff8945af2027">winapi::SharedMemory::open</a></div><div class="ttdeci">static SharedMemory open(const std::string &name)</div><div class="ttdef"><b>Definition:</b> <a href="shmem_8cpp_source.html#l00059">shmem.cpp:59</a></div></div>
<div class="ttc" id="aerror_8hpp_html"><div class="ttname"><a href="error_8hpp.html">error.hpp</a></div><div class="ttdoc">Make std::system_error work with GetLastError().</div></div>
</div><!-- fragment --></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.1
</small></address>
</body>
</html>
