<!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.8.16"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>UbixOS: include/fs/pipe_fs.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>
<link href="../../navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="../../resize.js"></script>
<script type="text/javascript" src="../../navtreedata.js"></script>
<script type="text/javascript" src="../../navtree.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
$(document).ready(initResizable);
/* @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 style="height: 56px;">
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">UbixOS
 <span id="projectnumber">2.0</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.16 -->
<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('../../',false,false,'search.php','Search');
});
/* @license-end */</script>
<div id="main-nav"></div>
</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:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
$(document).ready(function(){initNavTree('d1/d7d/pipe__fs_8h_source.html','../../');});
/* @license-end */
</script>
<div id="doc-content">
<div class="header">
<div class="headertitle">
<div class="title">pipe_fs.h</div> </div>
</div><!--header-->
<div class="contents">
<a href="../../d1/d7d/pipe__fs_8h.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span> <span class="comment">/*-</span></div>
<div class="line"><a name="l00002"></a><span class="lineno"> 2</span> <span class="comment"> * Copyright (c) 2002-2018 The UbixOS Project.</span></div>
<div class="line"><a name="l00003"></a><span class="lineno"> 3</span> <span class="comment"> * All rights reserved.</span></div>
<div class="line"><a name="l00004"></a><span class="lineno"> 4</span> <span class="comment"> *</span></div>
<div class="line"><a name="l00005"></a><span class="lineno"> 5</span> <span class="comment"> * This was developed by Christopher W. Olsen for the UbixOS Project.</span></div>
<div class="line"><a name="l00006"></a><span class="lineno"> 6</span> <span class="comment"> *</span></div>
<div class="line"><a name="l00007"></a><span class="lineno"> 7</span> <span class="comment"> * Redistribution and use in source and binary forms, with or without modification, are permitted</span></div>
<div class="line"><a name="l00008"></a><span class="lineno"> 8</span> <span class="comment"> * provided that the following conditions are met:</span></div>
<div class="line"><a name="l00009"></a><span class="lineno"> 9</span> <span class="comment"> *</span></div>
<div class="line"><a name="l00010"></a><span class="lineno"> 10</span> <span class="comment"> * 1) Redistributions of source code must retain the above copyright notice, this list of</span></div>
<div class="line"><a name="l00011"></a><span class="lineno"> 11</span> <span class="comment"> * conditions, the following disclaimer and the list of authors.</span></div>
<div class="line"><a name="l00012"></a><span class="lineno"> 12</span> <span class="comment"> * 2) Redistributions in binary form must reproduce the above copyright notice, this list of</span></div>
<div class="line"><a name="l00013"></a><span class="lineno"> 13</span> <span class="comment"> * conditions, the following disclaimer and the list of authors in the documentation and/or</span></div>
<div class="line"><a name="l00014"></a><span class="lineno"> 14</span> <span class="comment"> * other materials provided with the distribution.</span></div>
<div class="line"><a name="l00015"></a><span class="lineno"> 15</span> <span class="comment"> * 3) Neither the name of the UbixOS Project nor the names of its contributors may be used to</span></div>
<div class="line"><a name="l00016"></a><span class="lineno"> 16</span> <span class="comment"> * endorse or promote products derived from this software without specific prior written</span></div>
<div class="line"><a name="l00017"></a><span class="lineno"> 17</span> <span class="comment"> * permission.</span></div>
<div class="line"><a name="l00018"></a><span class="lineno"> 18</span> <span class="comment"> *</span></div>
<div class="line"><a name="l00019"></a><span class="lineno"> 19</span> <span class="comment"> * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED</span></div>
<div class="line"><a name="l00020"></a><span class="lineno"> 20</span> <span class="comment"> * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS</span></div>
<div class="line"><a name="l00021"></a><span class="lineno"> 21</span> <span class="comment"> * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS</span></div>
<div class="line"><a name="l00022"></a><span class="lineno"> 22</span> <span class="comment"> * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES</span></div>
<div class="line"><a name="l00023"></a><span class="lineno"> 23</span> <span class="comment"> * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA,</span></div>
<div class="line"><a name="l00024"></a><span class="lineno"> 24</span> <span class="comment"> * OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN</span></div>
<div class="line"><a name="l00025"></a><span class="lineno"> 25</span> <span class="comment"> * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT</span></div>
<div class="line"><a name="l00026"></a><span class="lineno"> 26</span> <span class="comment"> * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.</span></div>
<div class="line"><a name="l00027"></a><span class="lineno"> 27</span> <span class="comment"> */</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="preprocessor">#ifndef _FS_PIPE_FS_H</span></div>
<div class="line"><a name="l00030"></a><span class="lineno"> 30</span> <span class="preprocessor">#define _FS_PIPE_FS_H</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"><a class="line" href="../../db/d62/structpipe__inode__info.html"> 32</a></span> <span class="keyword">struct </span><a class="code" href="../../db/d62/structpipe__inode__info.html">pipe_inode_info</a> {</div>
<div class="line"><a name="l00033"></a><span class="lineno"><a class="line" href="../../db/d62/structpipe__inode__info.html#a158fa7070bb093ac3ef1e4083ae631e4"> 33</a></span>  <span class="keyword">struct </span><a class="code" href="../../d6/d6e/structwait__queue.html">wait_queue</a> *<a class="code" href="../../db/d62/structpipe__inode__info.html#a158fa7070bb093ac3ef1e4083ae631e4">wait</a>;</div>
<div class="line"><a name="l00034"></a><span class="lineno"><a class="line" href="../../db/d62/structpipe__inode__info.html#aeca1c5755a30dc21dc68d5c5ebc2ae17"> 34</a></span>  <span class="keywordtype">char</span> *<a class="code" href="../../db/d62/structpipe__inode__info.html#aeca1c5755a30dc21dc68d5c5ebc2ae17">base</a>;</div>
<div class="line"><a name="l00035"></a><span class="lineno"><a class="line" href="../../db/d62/structpipe__inode__info.html#a45b010eacdfe99a07d1328d79d418275"> 35</a></span>  <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> <a class="code" href="../../db/d62/structpipe__inode__info.html#a45b010eacdfe99a07d1328d79d418275">start</a>;</div>
<div class="line"><a name="l00036"></a><span class="lineno"><a class="line" href="../../db/d62/structpipe__inode__info.html#ad1ec05b5e8dd1f2950623764260f71a8"> 36</a></span>  <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> <a class="code" href="../../db/d62/structpipe__inode__info.html#ad1ec05b5e8dd1f2950623764260f71a8">len</a>;</div>
<div class="line"><a name="l00037"></a><span class="lineno"><a class="line" href="../../db/d62/structpipe__inode__info.html#a94fa88494fec0ef6f4545d83a656ed78"> 37</a></span>  <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> <a class="code" href="../../db/d62/structpipe__inode__info.html#a94fa88494fec0ef6f4545d83a656ed78">lock</a>;</div>
<div class="line"><a name="l00038"></a><span class="lineno"><a class="line" href="../../db/d62/structpipe__inode__info.html#a8d18d8e3a6ab06a03ed650c8ebf5251e"> 38</a></span>  <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> <a class="code" href="../../db/d62/structpipe__inode__info.html#a8d18d8e3a6ab06a03ed650c8ebf5251e">rd_openers</a>;</div>
<div class="line"><a name="l00039"></a><span class="lineno"><a class="line" href="../../db/d62/structpipe__inode__info.html#a1464d5b2a72f792a709cedfd52fc62f1"> 39</a></span>  <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> <a class="code" href="../../db/d62/structpipe__inode__info.html#a1464d5b2a72f792a709cedfd52fc62f1">wr_openers</a>;</div>
<div class="line"><a name="l00040"></a><span class="lineno"><a class="line" href="../../db/d62/structpipe__inode__info.html#a23107b0c1c367d98f422b2912acd449a"> 40</a></span>  <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> <a class="code" href="../../db/d62/structpipe__inode__info.html#a23107b0c1c367d98f422b2912acd449a">readers</a>;</div>
<div class="line"><a name="l00041"></a><span class="lineno"><a class="line" href="../../db/d62/structpipe__inode__info.html#afd04d304b1e68679da654e66e2a4d840"> 41</a></span>  <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> <a class="code" href="../../db/d62/structpipe__inode__info.html#afd04d304b1e68679da654e66e2a4d840">writers</a>;</div>
<div class="line"><a name="l00042"></a><span class="lineno"> 42</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"><a class="line" href="../../d1/d7d/pipe__fs_8h.html#a31347e078a788d04497fbdac84ec83f2"> 44</a></span> <span class="preprocessor">#define PIPE_WAIT(inode) ((inode).u.pipe_i.wait)</span></div>
<div class="line"><a name="l00045"></a><span class="lineno"><a class="line" href="../../d1/d7d/pipe__fs_8h.html#aa0861b0348be87a27260843e3cdd0845"> 45</a></span> <span class="preprocessor">#define PIPE_BASE(inode) ((inode).u.pipe_i.base)</span></div>
<div class="line"><a name="l00046"></a><span class="lineno"><a class="line" href="../../d1/d7d/pipe__fs_8h.html#a3c72093c56c0408524cb8c74d4112f10"> 46</a></span> <span class="preprocessor">#define PIPE_START(inode) ((inode).u.pipe_i.start)</span></div>
<div class="line"><a name="l00047"></a><span class="lineno"><a class="line" href="../../d1/d7d/pipe__fs_8h.html#a4998f7dacb1169a01cb3ae550439f427"> 47</a></span> <span class="preprocessor">#define PIPE_LEN(inode) ((inode).u.pipe_i.len)</span></div>
<div class="line"><a name="l00048"></a><span class="lineno"><a class="line" href="../../d1/d7d/pipe__fs_8h.html#a6921a0f096044f502508dfbc740ed890"> 48</a></span> <span class="preprocessor">#define PIPE_RD_OPENERS(inode) ((inode).u.pipe_i.rd_openers)</span></div>
<div class="line"><a name="l00049"></a><span class="lineno"><a class="line" href="../../d1/d7d/pipe__fs_8h.html#aa3ce3f511cd1022008f9b174cf660cf4"> 49</a></span> <span class="preprocessor">#define PIPE_WR_OPENERS(inode) ((inode).u.pipe_i.wr_openers)</span></div>
<div class="line"><a name="l00050"></a><span class="lineno"><a class="line" href="../../d1/d7d/pipe__fs_8h.html#a9356a40ce2bf10fd89a3ccdc7793035c"> 50</a></span> <span class="preprocessor">#define PIPE_READERS(inode) ((inode).u.pipe_i.readers)</span></div>
<div class="line"><a name="l00051"></a><span class="lineno"><a class="line" href="../../d1/d7d/pipe__fs_8h.html#abaffc56b7a35f1401db3b6a09082892f"> 51</a></span> <span class="preprocessor">#define PIPE_WRITERS(inode) ((inode).u.pipe_i.writers)</span></div>
<div class="line"><a name="l00052"></a><span class="lineno"><a class="line" href="../../d1/d7d/pipe__fs_8h.html#adfda87f6768a1b2563ea90a43877ba5b"> 52</a></span> <span class="preprocessor">#define PIPE_LOCK(inode) ((inode).u.pipe_i.lock)</span></div>
<div class="line"><a name="l00053"></a><span class="lineno"><a class="line" href="../../d1/d7d/pipe__fs_8h.html#aad891c9d4a6092e3051327d88b454f2e"> 53</a></span> <span class="preprocessor">#define PIPE_SIZE(inode) PIPE_LEN(inode)</span></div>
<div class="line"><a name="l00054"></a><span class="lineno"> 54</span>  </div>
<div class="line"><a name="l00055"></a><span class="lineno"><a class="line" href="../../d1/d7d/pipe__fs_8h.html#aa460d6f2b8cf2a121bfa29f22d90f19f"> 55</a></span> <span class="preprocessor">#define PIPE_EMPTY(inode) (PIPE_SIZE(inode)==0)</span></div>
<div class="line"><a name="l00056"></a><span class="lineno"><a class="line" href="../../d1/d7d/pipe__fs_8h.html#ace0b0dd5f3ecf5d9e436fe7f5b4bbd7d"> 56</a></span> <span class="preprocessor">#define PIPE_FULL(inode) (PIPE_SIZE(inode)==PIPE_BUF)</span></div>
<div class="line"><a name="l00057"></a><span class="lineno"><a class="line" href="../../d1/d7d/pipe__fs_8h.html#a7ba3cd6b4aaef5b989ce92d225660a70"> 57</a></span> <span class="preprocessor">#define PIPE_FREE(inode) (PIPE_BUF - PIPE_LEN(inode))</span></div>
<div class="line"><a name="l00058"></a><span class="lineno"><a class="line" href="../../d1/d7d/pipe__fs_8h.html#a849736e3b2dddc0b9fc76cc9813bd7a9"> 58</a></span> <span class="preprocessor">#define PIPE_END(inode) ((PIPE_START(inode)+PIPE_LEN(inode))&\</span></div>
<div class="line"><a name="l00059"></a><span class="lineno"> 59</span> <span class="preprocessor"> (PIPE_BUF-1))</span></div>
<div class="line"><a name="l00060"></a><span class="lineno"><a class="line" href="../../d1/d7d/pipe__fs_8h.html#ae04c91383666188f17fc023a7a9cf77e"> 60</a></span> <span class="preprocessor">#define PIPE_MAX_RCHUNK(inode) (PIPE_BUF - PIPE_START(inode))</span></div>
<div class="line"><a name="l00061"></a><span class="lineno"><a class="line" href="../../d1/d7d/pipe__fs_8h.html#a5ee4bfbae869bbab3b88324067b5b97d"> 61</a></span> <span class="preprocessor">#define PIPE_MAX_WCHUNK(inode) (PIPE_BUF - PIPE_END(inode))</span></div>
<div class="line"><a name="l00062"></a><span class="lineno"> 62</span>  </div>
<div class="line"><a name="l00063"></a><span class="lineno"> 63</span> <span class="preprocessor">#endif</span></div>
</div><!-- fragment --></div><!-- contents -->
</div><!-- doc-content -->
<div class="ttc" id="astructpipe__inode__info_html_a23107b0c1c367d98f422b2912acd449a"><div class="ttname"><a href="../../db/d62/structpipe__inode__info.html#a23107b0c1c367d98f422b2912acd449a">pipe_inode_info::readers</a></div><div class="ttdeci">unsigned int readers</div><div class="ttdef"><b>Definition:</b> <a href="../../d1/d7d/pipe__fs_8h_source.html#l00040">pipe_fs.h:40</a></div></div>
<div class="ttc" id="astructpipe__inode__info_html_a45b010eacdfe99a07d1328d79d418275"><div class="ttname"><a href="../../db/d62/structpipe__inode__info.html#a45b010eacdfe99a07d1328d79d418275">pipe_inode_info::start</a></div><div class="ttdeci">unsigned int start</div><div class="ttdef"><b>Definition:</b> <a href="../../d1/d7d/pipe__fs_8h_source.html#l00035">pipe_fs.h:35</a></div></div>
<div class="ttc" id="astructpipe__inode__info_html_ad1ec05b5e8dd1f2950623764260f71a8"><div class="ttname"><a href="../../db/d62/structpipe__inode__info.html#ad1ec05b5e8dd1f2950623764260f71a8">pipe_inode_info::len</a></div><div class="ttdeci">unsigned int len</div><div class="ttdef"><b>Definition:</b> <a href="../../d1/d7d/pipe__fs_8h_source.html#l00036">pipe_fs.h:36</a></div></div>
<div class="ttc" id="astructpipe__inode__info_html_a8d18d8e3a6ab06a03ed650c8ebf5251e"><div class="ttname"><a href="../../db/d62/structpipe__inode__info.html#a8d18d8e3a6ab06a03ed650c8ebf5251e">pipe_inode_info::rd_openers</a></div><div class="ttdeci">unsigned int rd_openers</div><div class="ttdef"><b>Definition:</b> <a href="../../d1/d7d/pipe__fs_8h_source.html#l00038">pipe_fs.h:38</a></div></div>
<div class="ttc" id="astructpipe__inode__info_html_a1464d5b2a72f792a709cedfd52fc62f1"><div class="ttname"><a href="../../db/d62/structpipe__inode__info.html#a1464d5b2a72f792a709cedfd52fc62f1">pipe_inode_info::wr_openers</a></div><div class="ttdeci">unsigned int wr_openers</div><div class="ttdef"><b>Definition:</b> <a href="../../d1/d7d/pipe__fs_8h_source.html#l00039">pipe_fs.h:39</a></div></div>
<div class="ttc" id="astructpipe__inode__info_html"><div class="ttname"><a href="../../db/d62/structpipe__inode__info.html">pipe_inode_info</a></div><div class="ttdef"><b>Definition:</b> <a href="../../d1/d7d/pipe__fs_8h_source.html#l00032">pipe_fs.h:32</a></div></div>
<div class="ttc" id="astructpipe__inode__info_html_a158fa7070bb093ac3ef1e4083ae631e4"><div class="ttname"><a href="../../db/d62/structpipe__inode__info.html#a158fa7070bb093ac3ef1e4083ae631e4">pipe_inode_info::wait</a></div><div class="ttdeci">struct wait_queue * wait</div><div class="ttdef"><b>Definition:</b> <a href="../../d1/d7d/pipe__fs_8h_source.html#l00033">pipe_fs.h:33</a></div></div>
<div class="ttc" id="astructwait__queue_html"><div class="ttname"><a href="../../d6/d6e/structwait__queue.html">wait_queue</a></div><div class="ttdef"><b>Definition:</b> <a href="../../d1/df2/wait_8h_source.html#l00034">wait.h:34</a></div></div>
<div class="ttc" id="astructpipe__inode__info_html_afd04d304b1e68679da654e66e2a4d840"><div class="ttname"><a href="../../db/d62/structpipe__inode__info.html#afd04d304b1e68679da654e66e2a4d840">pipe_inode_info::writers</a></div><div class="ttdeci">unsigned int writers</div><div class="ttdef"><b>Definition:</b> <a href="../../d1/d7d/pipe__fs_8h_source.html#l00041">pipe_fs.h:41</a></div></div>
<div class="ttc" id="astructpipe__inode__info_html_aeca1c5755a30dc21dc68d5c5ebc2ae17"><div class="ttname"><a href="../../db/d62/structpipe__inode__info.html#aeca1c5755a30dc21dc68d5c5ebc2ae17">pipe_inode_info::base</a></div><div class="ttdeci">char * base</div><div class="ttdef"><b>Definition:</b> <a href="../../d1/d7d/pipe__fs_8h_source.html#l00034">pipe_fs.h:34</a></div></div>
<div class="ttc" id="astructpipe__inode__info_html_a94fa88494fec0ef6f4545d83a656ed78"><div class="ttname"><a href="../../db/d62/structpipe__inode__info.html#a94fa88494fec0ef6f4545d83a656ed78">pipe_inode_info::lock</a></div><div class="ttdeci">unsigned int lock</div><div class="ttdef"><b>Definition:</b> <a href="../../d1/d7d/pipe__fs_8h_source.html#l00037">pipe_fs.h:37</a></div></div>
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="navelem"><a class="el" href="../../dir_d44c64559bbebec7f509842c48db8b23.html">include</a></li><li class="navelem"><a class="el" href="../../dir_203f267fac8cf3dfe9f5770a10d988c8.html">fs</a></li><li class="navelem"><a class="el" href="../../d1/d7d/pipe__fs_8h.html">pipe_fs.h</a></li>
<li class="footer">Generated by
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="../../doxygen.png" alt="doxygen"/></a> 1.8.16 </li>
</ul>
</div>
</body>
</html>
