Fork: 0
ohpnjrpnicow / UbixOS
Transfer to URL with SHA Find file
Newer
Older
UbixOS / doc / html / d7 / d3a / structfile.html
@Christopher W. Olsen Christopher W. Olsen on 30 Jan 2020 18 KB Cleaning up and adding documentation.
Raw Blame History 
<!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: file Struct Reference</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&amp;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
   &#160;<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&amp;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&amp;dn=gpl-2.0.txt GPL-v2 */
$(document).ready(function(){initNavTree('d7/d3a/structfile.html','../../');});
/* @license-end */
</script>
<div id="doc-content">
<div class="header">
  <div class="summary">
<a href="#pub-attribs">Data Fields</a>  </div>
  <div class="headertitle">
<div class="title">file Struct Reference</div>  </div>
</div><!--header-->
<div class="contents">

<p><code>#include &lt;<a class="el" href="../../d3/df4/descrip_8h_source.html">descrip.h</a>&gt;</code></p>
<div class="dynheader">
Collaboration diagram for file:</div>
<div class="dyncontent">
<div class="center"><img src="../../d9/da3/structfile__coll__graph.png" border="0" usemap="#file_coll__map" alt="Collaboration graph"/></div>
<map name="file_coll__map" id="file_coll__map">
<area shape="rect" title=" " alt="" coords="209,1240,285,1376"/>
<area shape="rect" href="../../d0/d22/structfileDescriptor.html" title=" " alt="" coords="287,851,385,1133"/>
<area shape="rect" href="../../d1/dff/structtaskStruct.html" title=" " alt="" coords="641,1196,740,1420"/>
<area shape="rect" href="../../d0/df8/structinode.html" title=" " alt="" coords="717,2207,824,2431"/>
<area shape="rect" href="../../df/d3d/structmsdos__inode__info.html" title=" " alt="" coords="709,2552,835,2673"/>
<area shape="rect" href="../../de/d37/structsuper__block.html" title=" " alt="" coords="1133,2508,1264,2717"/>
<area shape="rect" href="../../db/d28/structmsdos__sb__info.html" title=" " alt="" coords="1169,1959,1279,2183"/>
<area shape="rect" href="../../d6/d6e/structwait__queue.html" title=" " alt="" coords="674,1483,761,1560"/>
<area shape="rect" href="../../d1/df3/structsemaphore.html" title=" " alt="" coords="555,1755,642,1832"/>
<area shape="rect" href="../../db/d62/structpipe__inode__info.html" title=" " alt="" coords="666,1703,777,1883"/>
<area shape="rect" href="../../de/dcd/structi387Struct.html" title=" " alt="" coords="517,902,603,1082"/>
<area shape="rect" href="../../d3/dc5/structthread.html" title=" " alt="" coords="627,909,717,1075"/>
<area shape="rect" href="../../df/d05/structtrapframe.html" title=" " alt="" coords="525,564,624,788"/>
<area shape="rect" href="../../d7/d12/struct____sigset.html" title=" " alt="" coords="750,365,821,443"/>
<area shape="rect" href="../../d7/def/structsigaction.html" title=" " alt="" coords="869,615,990,737"/>
<area shape="rect" href="../../da/d56/structrlimit.html" title=" " alt="" coords="758,630,845,722"/>
<area shape="rect" href="../../df/d2f/structtty__termNode.html" title=" " alt="" coords="741,902,841,1082"/>
<area shape="rect" href="../../de/da3/structosInfo.html" title=" " alt="" coords="865,895,967,1089"/>
<area shape="rect" href="../../d1/d27/structtssStruct.html" title=" " alt="" coords="992,880,1136,1104"/>
<area shape="rect" href="../../d1/d80/structsuper__operations.html" title=" " alt="" coords="1347,2229,1469,2409"/>
<area shape="rect" href="../../d9/dde/structufs2__dinode.html" title=" " alt="" coords="801,1681,911,1905"/>
<area shape="rect" href="../../dd/d5f/structinode__operations.html" title=" " alt="" coords="936,1652,1059,1935"/>
<area shape="rect" href="../../d5/d02/structufs1__dinode.html" title=" " alt="" coords="1083,1681,1194,1905"/>
<area shape="rect" href="../../de/deb/structcacheNode.html" title=" " alt="" coords="5,586,109,766"/>
<area shape="rect" href="../../d5/d8b/structdmadat.html" title=" " alt="" coords="233,615,305,737"/>
<area shape="rect" href="../../d3/d57/structvfs__mountPoint.html" title=" " alt="" coords="330,615,441,737"/>
<area shape="rect" href="../../db/d6d/structubixDiskLabel.html" title=" " alt="" coords="171,343,285,465"/>
<area shape="rect" href="../../d7/d5e/structubixDiskLabel_1_1ubixPartitions.html" title=" " alt="" coords="113,49,303,200"/>
<area shape="rect" href="../../de/d35/structdevice__node.html" title=" " alt="" coords="339,358,432,450"/>
<area shape="rect" href="../../d6/dcb/structdevice__resource.html" title=" " alt="" coords="328,86,443,163"/>
<area shape="rect" href="../../dc/de2/structdevice__interface.html" title=" " alt="" coords="467,5,581,244"/>
<area shape="rect" href="../../de/dfb/structfileSystem.html" title="filesSystem Structure" alt="" coords="516,307,617,501"/>
<area shape="rect" href="../../de/d79/structfileOps.html" title=" " alt="" coords="193,931,258,1053"/>
</map>
</div>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-attribs"></a>
Data Fields</h2></td></tr>
<tr class="memitem:adfb0c6311589d1d62b720c9610430ad0"><td class="memItemLeft" align="right" valign="top">void *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d7/d3a/structfile.html#adfb0c6311589d1d62b720c9610430ad0">data</a></td></tr>
<tr class="separator:adfb0c6311589d1d62b720c9610430ad0"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad549b6a207bd14d3a8a8f8b5c3ee1b9a"><td class="memItemLeft" align="right" valign="top"><a class="el" href="../../d0/d27/include_2sys_2types_8h.html#a0238af00180b6d9278fa1c6aa790fdf4">uint32_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d7/d3a/structfile.html#ad549b6a207bd14d3a8a8f8b5c3ee1b9a">f_flag</a></td></tr>
<tr class="separator:ad549b6a207bd14d3a8a8f8b5c3ee1b9a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad028f15c75ffe1607632f78ada7bcfbd"><td class="memItemLeft" align="right" valign="top">struct <a class="el" href="../../de/d79/structfileOps.html">fileOps</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d7/d3a/structfile.html#ad028f15c75ffe1607632f78ada7bcfbd">f_ops</a></td></tr>
<tr class="separator:ad028f15c75ffe1607632f78ada7bcfbd"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad5d0e9ab60915cc757d73bf3f6bc2e15"><td class="memItemLeft" align="right" valign="top"><a class="el" href="../../d0/d27/include_2sys_2types_8h.html#a281b4b5562236420969a830503b0ba19">uint16_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d7/d3a/structfile.html#ad5d0e9ab60915cc757d73bf3f6bc2e15">f_type</a></td></tr>
<tr class="separator:ad5d0e9ab60915cc757d73bf3f6bc2e15"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af2108e4a1620fe81b2b5e7b6db5d41d4"><td class="memItemLeft" align="right" valign="top"><a class="el" href="../../d6/db4/include_2vfs_2file_8h.html#acc7b57f2d3766b4977ebbe64aa38608b">fileDescriptor_t</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d7/d3a/structfile.html#af2108e4a1620fe81b2b5e7b6db5d41d4">fd</a></td></tr>
<tr class="separator:af2108e4a1620fe81b2b5e7b6db5d41d4"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac43cc1da8bee1eb339249ad88518f769"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d7/d3a/structfile.html#ac43cc1da8bee1eb339249ad88518f769">fd_type</a></td></tr>
<tr class="separator:ac43cc1da8bee1eb339249ad88518f769"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aaad1c900a9ee26ad1aa91be70b6f98ec"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d7/d3a/structfile.html#aaad1c900a9ee26ad1aa91be70b6f98ec">socket</a></td></tr>
<tr class="separator:aaad1c900a9ee26ad1aa91be70b6f98ec"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock">
<p class="definition">Definition at line <a class="el" href="../../d3/df4/descrip_8h_source.html#l00067">67</a> of file <a class="el" href="../../d3/df4/descrip_8h_source.html">descrip.h</a>.</p>
</div><h2 class="groupheader">Field Documentation</h2>
<a id="adfb0c6311589d1d62b720c9610430ad0"></a>
<h2 class="memtitle"><span class="permalink"><a href="#adfb0c6311589d1d62b720c9610430ad0">&#9670;&nbsp;</a></span>data</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void* file::data</td>
        </tr>
      </table>
</div><div class="memdoc">

<p class="definition">Definition at line <a class="el" href="../../d3/df4/descrip_8h_source.html#l00074">74</a> of file <a class="el" href="../../d3/df4/descrip_8h_source.html">descrip.h</a>.</p>

<p class="reference">Referenced by <a class="el" href="../../d7/d42/vfs__calls_8c_source.html#l00094">sys_close()</a>, <a class="el" href="../../d6/dba/kern__pipe_8c_source.html#l00036">sys_pipe2()</a>, <a class="el" href="../../d7/d42/vfs__calls_8c_source.html#l00148">sys_read()</a>, and <a class="el" href="../../d7/d42/vfs__calls_8c_source.html#l00291">sys_write()</a>.</p>

</div>
</div>
<a id="ad549b6a207bd14d3a8a8f8b5c3ee1b9a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad549b6a207bd14d3a8a8f8b5c3ee1b9a">&#9670;&nbsp;</a></span>f_flag</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="../../d0/d27/include_2sys_2types_8h.html#a0238af00180b6d9278fa1c6aa790fdf4">uint32_t</a> file::f_flag</td>
        </tr>
      </table>
</div><div class="memdoc">

<p class="definition">Definition at line <a class="el" href="../../d3/df4/descrip_8h_source.html#l00068">68</a> of file <a class="el" href="../../d3/df4/descrip_8h_source.html">descrip.h</a>.</p>

<p class="reference">Referenced by <a class="el" href="../../d2/d3f/descrip_8c_source.html#l00041">fcntl()</a>, <a class="el" href="../../d7/d42/vfs__calls_8c_source.html#l00397">kern_openat()</a>, <a class="el" href="../../d1/d47/pipe_8c_source.html#l00039">pipe()</a>, and <a class="el" href="../../d3/d02/armv6_2sched_8c_source.html#l00135">schedNewTask()</a>.</p>

</div>
</div>
<a id="ad028f15c75ffe1607632f78ada7bcfbd"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad028f15c75ffe1607632f78ada7bcfbd">&#9670;&nbsp;</a></span>f_ops</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">struct <a class="el" href="../../de/d79/structfileOps.html">fileOps</a>* file::f_ops</td>
        </tr>
      </table>
</div><div class="memdoc">

<p class="definition">Definition at line <a class="el" href="../../d3/df4/descrip_8h_source.html#l00070">70</a> of file <a class="el" href="../../d3/df4/descrip_8h_source.html">descrip.h</a>.</p>

</div>
</div>
<a id="ad5d0e9ab60915cc757d73bf3f6bc2e15"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad5d0e9ab60915cc757d73bf3f6bc2e15">&#9670;&nbsp;</a></span>f_type</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="../../d0/d27/include_2sys_2types_8h.html#a281b4b5562236420969a830503b0ba19">uint16_t</a> file::f_type</td>
        </tr>
      </table>
</div><div class="memdoc">

<p class="definition">Definition at line <a class="el" href="../../d3/df4/descrip_8h_source.html#l00069">69</a> of file <a class="el" href="../../d3/df4/descrip_8h_source.html">descrip.h</a>.</p>

</div>
</div>
<a id="af2108e4a1620fe81b2b5e7b6db5d41d4"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af2108e4a1620fe81b2b5e7b6db5d41d4">&#9670;&nbsp;</a></span>fd</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="../../d6/db4/include_2vfs_2file_8h.html#acc7b57f2d3766b4977ebbe64aa38608b">fileDescriptor_t</a>* file::fd</td>
        </tr>
      </table>
</div><div class="memdoc">

<p class="definition">Definition at line <a class="el" href="../../d3/df4/descrip_8h_source.html#l00071">71</a> of file <a class="el" href="../../d3/df4/descrip_8h_source.html">descrip.h</a>.</p>

<p class="reference">Referenced by <a class="el" href="../../d2/d3f/descrip_8c_source.html#l00347">dup2()</a>, <a class="el" href="../../d6/d13/file_8c_source.html#l00533">fclose()</a>, <a class="el" href="../../d2/d3f/descrip_8c_source.html#l00147">fdestroy()</a>, <a class="el" href="../../d6/d13/file_8c_source.html#l00343">feof()</a>, <a class="el" href="../../d6/d13/file_8c_source.html#l00372">fgetc()</a>, <a class="el" href="../../d6/d13/file_8c_source.html#l00356">fputc()</a>, <a class="el" href="../../d6/d13/file_8c_source.html#l00297">fread()</a>, <a class="el" href="../../d2/d3f/descrip_8c_source.html#l00213">getfd()</a>, <a class="el" href="../../d7/d42/vfs__calls_8c_source.html#l00397">kern_openat()</a>, <a class="el" href="../../d1/d47/pipe_8c_source.html#l00039">pipe()</a>, <a class="el" href="../../d3/d0a/gen__calls_8c_source.html#l00100">read()</a>, <a class="el" href="../../d7/d42/vfs__calls_8c_source.html#l00094">sys_close()</a>, <a class="el" href="../../d6/d13/file_8c_source.html#l00203">sys_fchdir()</a>, <a class="el" href="../../db/d66/stat_8c_source.html#l00091">sys_fstat()</a>, <a class="el" href="../../db/d66/stat_8c_source.html#l00133">sys_fstatat()</a>, <a class="el" href="../../db/d66/stat_8c_source.html#l00182">sys_fstatfs()</a>, <a class="el" href="../../d7/d42/vfs__calls_8c_source.html#l00371">sys_getdirentries()</a>, <a class="el" href="../../d6/d13/file_8c_source.html#l00154">sys_lseek()</a>, <a class="el" href="../../da/d53/vmm__mmap_8c_source.html#l00162">sys_mmap()</a>, <a class="el" href="../../d7/d42/vfs__calls_8c_source.html#l00045">sys_openat()</a>, <a class="el" href="../../d7/d42/vfs__calls_8c_source.html#l00237">sys_pread()</a>, <a class="el" href="../../d7/d42/vfs__calls_8c_source.html#l00148">sys_read()</a>, <a class="el" href="../../d9/d56/sys__arch_8c_source.html#l00539">sys_sendto()</a>, <a class="el" href="../../d9/d56/sys__arch_8c_source.html#l00528">sys_setsockopt()</a>, <a class="el" href="../../d9/d56/sys__arch_8c_source.html#l00500">sys_socket()</a>, <a class="el" href="../../db/d66/stat_8c_source.html#l00239">sys_statfs()</a>, and <a class="el" href="../../d7/d42/vfs__calls_8c_source.html#l00291">sys_write()</a>.</p>

</div>
</div>
<a id="ac43cc1da8bee1eb339249ad88518f769"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ac43cc1da8bee1eb339249ad88518f769">&#9670;&nbsp;</a></span>fd_type</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">int file::fd_type</td>
        </tr>
      </table>
</div><div class="memdoc">

<p class="definition">Definition at line <a class="el" href="../../d3/df4/descrip_8h_source.html#l00072">72</a> of file <a class="el" href="../../d3/df4/descrip_8h_source.html">descrip.h</a>.</p>

<p class="reference">Referenced by <a class="el" href="../../d7/d42/vfs__calls_8c_source.html#l00094">sys_close()</a>, <a class="el" href="../../d6/dba/kern__pipe_8c_source.html#l00036">sys_pipe2()</a>, <a class="el" href="../../d7/d42/vfs__calls_8c_source.html#l00148">sys_read()</a>, <a class="el" href="../../d9/d56/sys__arch_8c_source.html#l00500">sys_socket()</a>, and <a class="el" href="../../d7/d42/vfs__calls_8c_source.html#l00291">sys_write()</a>.</p>

</div>
</div>
<a id="aaad1c900a9ee26ad1aa91be70b6f98ec"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aaad1c900a9ee26ad1aa91be70b6f98ec">&#9670;&nbsp;</a></span>socket</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">int file::socket</td>
        </tr>
      </table>
</div><div class="memdoc">

<p class="definition">Definition at line <a class="el" href="../../d3/df4/descrip_8h_source.html#l00073">73</a> of file <a class="el" href="../../d3/df4/descrip_8h_source.html">descrip.h</a>.</p>

<p class="reference">Referenced by <a class="el" href="../../d9/d56/sys__arch_8c_source.html#l00500">sys_socket()</a>.</p>

</div>
</div>
<hr/>The documentation for this struct was generated from the following file:<ul>
<li>include/sys/<a class="el" href="../../d3/df4/descrip_8h_source.html">descrip.h</a></li>
</ul>
</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="../../d7/d3a/structfile.html">file</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>