Fábio Coutada
7855eab092
MAJOR MILESTONE: Successfully imported complete PikeOS 5.0 ecosystem from Virtual Machine 100 (devvm-arch) on gigabyte Proxmox server. Import Summary: - Source Code: 4.3GB, 63,441 files, 14,829 C/C++/H files - Documentation: 78MB, 37+ PDF manuals covering all PikeOS aspects - XSD Schemas: 1.8MB, 158 schema files for configuration/code generation - Test Framework: Complete TFW infrastructure in src/tfw/ Key Components: ✅ Multi-architecture kernels (ARM v7/v8, PowerPC e500/e500mc/e5500, x86_64) ✅ Core source libraries (libstand, ssw, p4ext) ✅ Complete test framework with executables, includes, libraries ✅ 37+ comprehensive PDF documentation (installation, development, platform manuals) ✅ 158 XSD schemas for Eclipse-based code generation and configuration ✅ AUTOSAR/MISRA safety-critical compliance foundation ✅ Hardware virtualization support ✅ Eclipse IDE project configuration (.project, .cproject) Documentation Categories: - Installation & User Guides (pikeos-installation-guide.pdf, user manuals) - Development References (kernel, driver, test framework manuals) - API & Programming (C/C++ environments, native API extensions) - Platform Manuals (ARM, PowerPC, x86 specific guides) - CDK Documentation (gcc, binutils, ld, cpp internals) - Release Notes (all components for 5.0.3) - Specialized Topics (hardware virtualization, POSIX compliance) Technical Achievements: ✅ Complete PikeOS 5.0 codebase across multiple processor architectures ✅ Safety-critical foundation with AUTOSAR/MISRA compliance ✅ Eclipse IDE integration with XSD-driven code generation pipeline ✅ Comprehensive test framework for validation and verification ✅ Complete documentation covering development, deployment, and optimization Extraction Method: - Source: VM 100 (devvm-arch) on gigabyte server (192.168.0.104) - Method: Direct LVM disk mount via losetup, rsync transfer - Size: Total 4.4GB extracted and organized Next Phases: - Phase 3: XSD Workflow Analysis (Day 8-10) - Phase 4: Safety Standards Compliance Documentation (Day 11-12) - Phase 5: Component Categorization (Day 13-14) - Phase 6: Aurelio Brain Test (Day 15) Co-Authored-By: Claude <noreply@anthropic.com>
100 lines
63 KiB
HTML
100 lines
63 KiB
HTML
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://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.13"/>
|
|
<meta name="viewport" content="width=device-width, initial-scale=1"/>
|
|
<title>vp_fslib_svc.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">
|
|
$(document).ready(initResizable);
|
|
</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! -->
|
|
<!-- end header part -->
|
|
<!-- Generated by Doxygen 1.8.13 -->
|
|
<script type="text/javascript">
|
|
var searchBox = new SearchBox("searchBox", "search",false,'Search');
|
|
</script>
|
|
<script type="text/javascript" src="menudata.js"></script>
|
|
<script type="text/javascript" src="menu.js"></script>
|
|
<script type="text/javascript">
|
|
$(function() {
|
|
initMenu('',true,false,'search.php','Search');
|
|
$(document).ready(function() { init_search(); });
|
|
});
|
|
</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">
|
|
$(document).ready(function(){initNavTree('vp__fslib__svc_8h_source.html','');});
|
|
</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">
|
|
<iframe src="javascript:void(0)" frameborder="0"
|
|
name="MSearchResults" id="MSearchResults">
|
|
</iframe>
|
|
</div>
|
|
|
|
<div class="header">
|
|
<div class="headertitle">
|
|
<div class="title">vp_fslib_svc.h</div> </div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
<a href="vp__fslib__svc_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="preprocessor">#ifndef VM_FSP_SVC_H</span></div><div class="line"><a name="l00002"></a><span class="lineno"> 2</span> <span class="preprocessor">#define VM_FSP_SVC_H</span></div><div class="line"><a name="l00003"></a><span class="lineno"> 3</span> <span class="comment">/* -------------------------- FILE PROLOGUE -------------------------------- */</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">/**</span></div><div class="line"><a name="l00006"></a><span class="lineno"> 6</span> <span class="comment"> * @if INCLUDE_HEADER</span></div><div class="line"><a name="l00007"></a><span class="lineno"> 7</span> <span class="comment"> * @copyright</span></div><div class="line"><a name="l00008"></a><span class="lineno"> 8</span> <span class="comment"> * (C) Copyright SYSGO AG.</span></div><div class="line"><a name="l00009"></a><span class="lineno"> 9</span> <span class="comment"> * Klein-Winternheim, Germany</span></div><div class="line"><a name="l00010"></a><span class="lineno"> 10</span> <span class="comment"> * All rights reserved.</span></div><div class="line"><a name="l00011"></a><span class="lineno"> 11</span> <span class="comment"> * @endif</span></div><div class="line"><a name="l00012"></a><span class="lineno"> 12</span> <span class="comment"> *</span></div><div class="line"><a name="l00013"></a><span class="lineno"> 13</span> <span class="comment"> * @file</span></div><div class="line"><a name="l00014"></a><span class="lineno"> 14</span> <span class="comment"> *</span></div><div class="line"><a name="l00015"></a><span class="lineno"> 15</span> <span class="comment"> * @purpose</span></div><div class="line"><a name="l00016"></a><span class="lineno"> 16</span> <span class="comment"> * FSlib API: FS library service interface.</span></div><div class="line"><a name="l00017"></a><span class="lineno"> 17</span> <span class="comment"> *</span></div><div class="line"><a name="l00018"></a><span class="lineno"> 18</span> <span class="comment"> * @if INCLUDE_HEADER</span></div><div class="line"><a name="l00019"></a><span class="lineno"> 19</span> <span class="comment"> * @cfg_management</span></div><div class="line"><a name="l00020"></a><span class="lineno"> 20</span> <span class="comment"> * $Id: include/vp/vp_fslib_svc.h 2019-01-22 15:23:19 +0000 4a2e2b97102819fa19bae2d14ee340fc65add508 $</span></div><div class="line"><a name="l00021"></a><span class="lineno"> 21</span> <span class="comment"> * $Author$</span></div><div class="line"><a name="l00022"></a><span class="lineno"> 22</span> <span class="comment"> * $Date$</span></div><div class="line"><a name="l00023"></a><span class="lineno"> 23</span> <span class="comment"> * $Revision$</span></div><div class="line"><a name="l00024"></a><span class="lineno"> 24</span> <span class="comment"> * $State$</span></div><div class="line"><a name="l00025"></a><span class="lineno"> 25</span> <span class="comment"> * @endif</span></div><div class="line"><a name="l00026"></a><span class="lineno"> 26</span> <span class="comment"> */</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> <span class="comment">/* ------------------------- FILE INCLUSION -------------------------------- */</span></div><div class="line"><a name="l00029"></a><span class="lineno"> 29</span> </div><div class="line"><a name="l00030"></a><span class="lineno"> 30</span> <span class="preprocessor">#include <<a class="code" href="vp__fslib_8h.html">vp/vp_fslib.h</a>></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">/* ----------------------- FUNCTION PROTOTYPES ----------------------------- */</span><span class="comment"></span></div><div class="line"><a name="l00033"></a><span class="lineno"> 33</span> <span class="comment">/**</span></div><div class="line"><a name="l00034"></a><span class="lineno"> 34</span> <span class="comment"></span></div><div class="line"><a name="l00035"></a><span class="lineno"> 35</span> <span class="comment"> * @purpose</span></div><div class="line"><a name="l00036"></a><span class="lineno"> 36</span> <span class="comment"> * Declare a file system to be included into a volume provider.</span></div><div class="line"><a name="l00037"></a><span class="lineno"> 37</span> <span class="comment"> */</span></div><div class="line"><a name="l00038"></a><span class="lineno"><a class="line" href="vp__fslib__svc_8h.html#ae6c0484a969c20b96873d076d35a39bf"> 38</a></span> <span class="preprocessor">#define VP_DECLARE_FS(desc) \</span></div><div class="line"><a name="l00039"></a><span class="lineno"> 39</span> <span class="preprocessor"> static const void * const P4_CONCAT_SYM(_vp_fs_desc,__LINE__) \</span></div><div class="line"><a name="l00040"></a><span class="lineno"> 40</span> <span class="preprocessor"> __attribute__((used)) \</span></div><div class="line"><a name="l00041"></a><span class="lineno"> 41</span> <span class="preprocessor"> __attribute__((section(".vp_fs_desc"))) = (desc)</span></div><div class="line"><a name="l00042"></a><span class="lineno"> 42</span> <span class="comment">/* ------------------------ TYPE DECLARATIONS ------------------------------ */</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="comment">/* log level type */</span></div><div class="line"><a name="l00045"></a><span class="lineno"> 45</span> <span class="keyword">typedef</span> <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> vp_log_type_t;</div><div class="line"><a name="l00046"></a><span class="lineno"> 46</span> <span class="comment"></span></div><div class="line"><a name="l00047"></a><span class="lineno"> 47</span> <span class="comment">/**</span></div><div class="line"><a name="l00048"></a><span class="lineno"> 48</span> <span class="comment"> * \defgroup FSlib_svc FSlib Service API</span></div><div class="line"><a name="l00049"></a><span class="lineno"> 49</span> <span class="comment"> * This section presents the data types and functions available for the FS</span></div><div class="line"><a name="l00050"></a><span class="lineno"> 50</span> <span class="comment"> * Library service API.</span></div><div class="line"><a name="l00051"></a><span class="lineno"> 51</span> <span class="comment"> */</span></div><div class="line"><a name="l00052"></a><span class="lineno"> 52</span> <span class="comment"></span></div><div class="line"><a name="l00053"></a><span class="lineno"> 53</span> <span class="comment">/** @addtogroup FSlib_svc</span></div><div class="line"><a name="l00054"></a><span class="lineno"> 54</span> <span class="comment"> * @{</span></div><div class="line"><a name="l00055"></a><span class="lineno"> 55</span> <span class="comment"> */</span></div><div class="line"><a name="l00056"></a><span class="lineno"> 56</span> <span class="comment"></span></div><div class="line"><a name="l00057"></a><span class="lineno"> 57</span> <span class="comment">/**</span></div><div class="line"><a name="l00058"></a><span class="lineno"> 58</span> <span class="comment"> * @purpose</span></div><div class="line"><a name="l00059"></a><span class="lineno"> 59</span> <span class="comment"> * Allocate unmapped virtual memory.</span></div><div class="line"><a name="l00060"></a><span class="lineno"> 60</span> <span class="comment"> *</span></div><div class="line"><a name="l00061"></a><span class="lineno"> 61</span> <span class="comment"> * @detailed</span></div><div class="line"><a name="l00062"></a><span class="lineno"> 62</span> <span class="comment"> * Returns address of area of page aligned size \a size and</span></div><div class="line"><a name="l00063"></a><span class="lineno"> 63</span> <span class="comment"> * which does not contain memory mapping.</span></div><div class="line"><a name="l00064"></a><span class="lineno"> 64</span> <span class="comment"> *</span></div><div class="line"><a name="l00065"></a><span class="lineno"> 65</span> <span class="comment"> * @param size [IN] requested size of unmapped memory in bytes</span></div><div class="line"><a name="l00066"></a><span class="lineno"> 66</span> <span class="comment"> *</span></div><div class="line"><a name="l00067"></a><span class="lineno"> 67</span> <span class="comment"> * @returns</span></div><div class="line"><a name="l00068"></a><span class="lineno"> 68</span> <span class="comment"> * @retval starting address of the allocated area</span></div><div class="line"><a name="l00069"></a><span class="lineno"> 69</span> <span class="comment"> * @retval NULL</span></div><div class="line"><a name="l00070"></a><span class="lineno"> 70</span> <span class="comment"> * if there is not enough of virtual memory</span></div><div class="line"><a name="l00071"></a><span class="lineno"> 71</span> <span class="comment"> * @note</span></div><div class="line"><a name="l00072"></a><span class="lineno"> 72</span> <span class="comment"> * The requested size will be rounded up to whole page size.</span></div><div class="line"><a name="l00073"></a><span class="lineno"> 73</span> <span class="comment"> */</span></div><div class="line"><a name="l00074"></a><span class="lineno"> 74</span> P4_address_t <a class="code" href="group__FSlib__svc.html#gafd481e74ec100a34b5136dd3fb4fa212">vp_fs_vmem_alloc</a>(</div><div class="line"><a name="l00075"></a><span class="lineno"> 75</span>  P4_size_t size);</div><div class="line"><a name="l00076"></a><span class="lineno"> 76</span> </div><div class="line"><a name="l00077"></a><span class="lineno"> 77</span> <span class="comment"></span></div><div class="line"><a name="l00078"></a><span class="lineno"> 78</span> <span class="comment">/**</span></div><div class="line"><a name="l00079"></a><span class="lineno"> 79</span> <span class="comment"> * @purpose</span></div><div class="line"><a name="l00080"></a><span class="lineno"> 80</span> <span class="comment"> * Allocate memory area from the volume provider memory pool.</span></div><div class="line"><a name="l00081"></a><span class="lineno"> 81</span> <span class="comment"> *</span></div><div class="line"><a name="l00082"></a><span class="lineno"> 82</span> <span class="comment"> * @detailed</span></div><div class="line"><a name="l00083"></a><span class="lineno"> 83</span> <span class="comment"> * Allocate \a size bytes of physical memory conforming</span></div><div class="line"><a name="l00084"></a><span class="lineno"> 84</span> <span class="comment"> * to the specified alignment constraint.</span></div><div class="line"><a name="l00085"></a><span class="lineno"> 85</span> <span class="comment"> *</span></div><div class="line"><a name="l00086"></a><span class="lineno"> 86</span> <span class="comment"> * @param size [IN] Size of physical memory to allocate in bytes.</span></div><div class="line"><a name="l00087"></a><span class="lineno"> 87</span> <span class="comment"> * @param alignment [IN] Alignment constraint.</span></div><div class="line"><a name="l00088"></a><span class="lineno"> 88</span> <span class="comment"> *</span></div><div class="line"><a name="l00089"></a><span class="lineno"> 89</span> <span class="comment"> * @returns</span></div><div class="line"><a name="l00090"></a><span class="lineno"> 90</span> <span class="comment"> * @retval base address of allocated memory</span></div><div class="line"><a name="l00091"></a><span class="lineno"> 91</span> <span class="comment"> * @retval NULL</span></div><div class="line"><a name="l00092"></a><span class="lineno"> 92</span> <span class="comment"> * if there is not enough of contiguous memory in the pool</span></div><div class="line"><a name="l00093"></a><span class="lineno"> 93</span> <span class="comment"> *</span></div><div class="line"><a name="l00094"></a><span class="lineno"> 94</span> <span class="comment"> * @note</span></div><div class="line"><a name="l00095"></a><span class="lineno"> 95</span> <span class="comment"> * The content of the allocated memory is undefined.</span></div><div class="line"><a name="l00096"></a><span class="lineno"> 96</span> <span class="comment"> *</span></div><div class="line"><a name="l00097"></a><span class="lineno"> 97</span> <span class="comment"> */</span></div><div class="line"><a name="l00098"></a><span class="lineno"> 98</span> <span class="keywordtype">void</span>* <a class="code" href="group__FSlib__svc.html#ga98cb8c6911844089c3e31daef268af67">vp_fs_malloc</a>(</div><div class="line"><a name="l00099"></a><span class="lineno"> 99</span>  P4_size_t size,</div><div class="line"><a name="l00100"></a><span class="lineno"> 100</span>  P4_address_t alignment);</div><div class="line"><a name="l00101"></a><span class="lineno"> 101</span> </div><div class="line"><a name="l00102"></a><span class="lineno"> 102</span> <span class="comment"></span></div><div class="line"><a name="l00103"></a><span class="lineno"> 103</span> <span class="comment">/**</span></div><div class="line"><a name="l00104"></a><span class="lineno"> 104</span> <span class="comment"> * @purpose</span></div><div class="line"><a name="l00105"></a><span class="lineno"> 105</span> <span class="comment"> * Free memory back to the volume provider memory pool.</span></div><div class="line"><a name="l00106"></a><span class="lineno"> 106</span> <span class="comment"> *</span></div><div class="line"><a name="l00107"></a><span class="lineno"> 107</span> <span class="comment"> * @detailed</span></div><div class="line"><a name="l00108"></a><span class="lineno"> 108</span> <span class="comment"> * free the buffer allocated by vp_fs_malloc() function</span></div><div class="line"><a name="l00109"></a><span class="lineno"> 109</span> <span class="comment"> *</span></div><div class="line"><a name="l00110"></a><span class="lineno"> 110</span> <span class="comment"> * @param buf [IN] Base address of memory previously allocated by</span></div><div class="line"><a name="l00111"></a><span class="lineno"> 111</span> <span class="comment"> * vp_fs_malloc() that will be freed.</span></div><div class="line"><a name="l00112"></a><span class="lineno"> 112</span> <span class="comment"> *</span></div><div class="line"><a name="l00113"></a><span class="lineno"> 113</span> <span class="comment"> */</span></div><div class="line"><a name="l00114"></a><span class="lineno"> 114</span> <span class="keywordtype">void</span> <a class="code" href="group__FSlib__svc.html#ga4acf3b57f59a78b9d08b4c5fb4240c46">vp_fs_free</a>(</div><div class="line"><a name="l00115"></a><span class="lineno"> 115</span>  <span class="keywordtype">void</span> *buf);</div><div class="line"><a name="l00116"></a><span class="lineno"> 116</span> </div><div class="line"><a name="l00117"></a><span class="lineno"> 117</span> <span class="comment"></span></div><div class="line"><a name="l00118"></a><span class="lineno"> 118</span> <span class="comment">/**</span></div><div class="line"><a name="l00119"></a><span class="lineno"> 119</span> <span class="comment"> * @purpose</span></div><div class="line"><a name="l00120"></a><span class="lineno"> 120</span> <span class="comment"> * Get current time</span></div><div class="line"><a name="l00121"></a><span class="lineno"> 121</span> <span class="comment"> * @detailed</span></div><div class="line"><a name="l00122"></a><span class="lineno"> 122</span> <span class="comment"> * Get the current system time if supported.</span></div><div class="line"><a name="l00123"></a><span class="lineno"> 123</span> <span class="comment"> *</span></div><div class="line"><a name="l00124"></a><span class="lineno"> 124</span> <span class="comment"> * @returns</span></div><div class="line"><a name="l00125"></a><span class="lineno"> 125</span> <span class="comment"> * @retval current system time</span></div><div class="line"><a name="l00126"></a><span class="lineno"> 126</span> <span class="comment"> * @retval 0</span></div><div class="line"><a name="l00127"></a><span class="lineno"> 127</span> <span class="comment"> * if the system time is not supported on the system.</span></div><div class="line"><a name="l00128"></a><span class="lineno"> 128</span> <span class="comment"> *</span></div><div class="line"><a name="l00129"></a><span class="lineno"> 129</span> <span class="comment"> * @note</span></div><div class="line"><a name="l00130"></a><span class="lineno"> 130</span> <span class="comment"> * The FS library should use this time only for time stamping operations</span></div><div class="line"><a name="l00131"></a><span class="lineno"> 131</span> <span class="comment"> * like file creation or modification.</span></div><div class="line"><a name="l00132"></a><span class="lineno"> 132</span> <span class="comment"> * The function does not assure that the value will be greater than or</span></div><div class="line"><a name="l00133"></a><span class="lineno"> 133</span> <span class="comment"> * equal to the return value of the previous call of this function.</span></div><div class="line"><a name="l00134"></a><span class="lineno"> 134</span> <span class="comment"> *</span></div><div class="line"><a name="l00135"></a><span class="lineno"> 135</span> <span class="comment"> */</span></div><div class="line"><a name="l00136"></a><span class="lineno"> 136</span> </div><div class="line"><a name="l00137"></a><span class="lineno"> 137</span> P4_time_t <a class="code" href="group__FSlib__svc.html#ga9a6d7d25ba87fbba3a8bc35ea78e5df1">vp_fs_get_time</a>(</div><div class="line"><a name="l00138"></a><span class="lineno"> 138</span>  <span class="keywordtype">void</span>);</div><div class="line"><a name="l00139"></a><span class="lineno"> 139</span> </div><div class="line"><a name="l00140"></a><span class="lineno"> 140</span> <span class="comment"></span></div><div class="line"><a name="l00141"></a><span class="lineno"> 141</span> <span class="comment">/**</span></div><div class="line"><a name="l00142"></a><span class="lineno"> 142</span> <span class="comment"> * @purpose</span></div><div class="line"><a name="l00143"></a><span class="lineno"> 143</span> <span class="comment"> * Set thread local value</span></div><div class="line"><a name="l00144"></a><span class="lineno"> 144</span> <span class="comment"> *</span></div><div class="line"><a name="l00145"></a><span class="lineno"> 145</span> <span class="comment"> * @detailed</span></div><div class="line"><a name="l00146"></a><span class="lineno"> 146</span> <span class="comment"> * Set thread local value for FS worker thread.</span></div><div class="line"><a name="l00147"></a><span class="lineno"> 147</span> <span class="comment"> *</span></div><div class="line"><a name="l00148"></a><span class="lineno"> 148</span> <span class="comment"> * @param value [IN] Value to set</span></div><div class="line"><a name="l00149"></a><span class="lineno"> 149</span> <span class="comment"> */</span></div><div class="line"><a name="l00150"></a><span class="lineno"> 150</span> <span class="keywordtype">void</span> <a class="code" href="group__FSlib__svc.html#gad48c153eb28b51d682122bb49bf48fae">vp_fs_tls_set</a>(</div><div class="line"><a name="l00151"></a><span class="lineno"> 151</span>  P4_cpureg_t value);</div><div class="line"><a name="l00152"></a><span class="lineno"> 152</span> </div><div class="line"><a name="l00153"></a><span class="lineno"> 153</span> <span class="comment"></span></div><div class="line"><a name="l00154"></a><span class="lineno"> 154</span> <span class="comment">/**</span></div><div class="line"><a name="l00155"></a><span class="lineno"> 155</span> <span class="comment"> * @purpose</span></div><div class="line"><a name="l00156"></a><span class="lineno"> 156</span> <span class="comment"> * Retrieve thread local value</span></div><div class="line"><a name="l00157"></a><span class="lineno"> 157</span> <span class="comment"> *</span></div><div class="line"><a name="l00158"></a><span class="lineno"> 158</span> <span class="comment"> * @detailed</span></div><div class="line"><a name="l00159"></a><span class="lineno"> 159</span> <span class="comment"> * Retrieve thread local value for FS worker thread.</span></div><div class="line"><a name="l00160"></a><span class="lineno"> 160</span> <span class="comment"> *</span></div><div class="line"><a name="l00161"></a><span class="lineno"> 161</span> <span class="comment"> * @returns thread local value</span></div><div class="line"><a name="l00162"></a><span class="lineno"> 162</span> <span class="comment"> */</span></div><div class="line"><a name="l00163"></a><span class="lineno"> 163</span> P4_cpureg_t <a class="code" href="group__FSlib__svc.html#ga05a3682a8ab3c8f7a52fd15577a8e340">vp_fs_tls_get</a>(</div><div class="line"><a name="l00164"></a><span class="lineno"> 164</span>  <span class="keywordtype">void</span>);</div><div class="line"><a name="l00165"></a><span class="lineno"> 165</span> <span class="comment"></span></div><div class="line"><a name="l00166"></a><span class="lineno"> 166</span> <span class="comment">/**</span></div><div class="line"><a name="l00167"></a><span class="lineno"> 167</span> <span class="comment"> * @purpose</span></div><div class="line"><a name="l00168"></a><span class="lineno"> 168</span> <span class="comment"> * Get next open file descriptor</span></div><div class="line"><a name="l00169"></a><span class="lineno"> 169</span> <span class="comment"> *</span></div><div class="line"><a name="l00170"></a><span class="lineno"> 170</span> <span class="comment"> * @detailed</span></div><div class="line"><a name="l00171"></a><span class="lineno"> 171</span> <span class="comment"> * Iterate through opened file descriptors within the same mount.</span></div><div class="line"><a name="l00172"></a><span class="lineno"> 172</span> <span class="comment"> *</span></div><div class="line"><a name="l00173"></a><span class="lineno"> 173</span> <span class="comment"> * @param context [IN] Mount context provided passed to umount handler.</span></div><div class="line"><a name="l00174"></a><span class="lineno"> 174</span> <span class="comment"> *</span></div><div class="line"><a name="l00175"></a><span class="lineno"> 175</span> <span class="comment"> * @returns</span></div><div class="line"><a name="l00176"></a><span class="lineno"> 176</span> <span class="comment"> * @retval next open file descriptor or NULL after the last</span></div><div class="line"><a name="l00177"></a><span class="lineno"> 177</span> <span class="comment"> */</span></div><div class="line"><a name="l00178"></a><span class="lineno"> 178</span> <a class="code" href="structvp__fs__file__desc__str.html">vp_fs_file_desc_t</a> <a class="code" href="group__FSlib__svc.html#ga2a440f4fb7ee05e5f0bbd37fa4b54da0">vp_fs_next_fd</a>(</div><div class="line"><a name="l00179"></a><span class="lineno"> 179</span>  <a class="code" href="structvp__fs__mount__context__str.html">vp_fs_mount_context_t</a> context);</div><div class="line"><a name="l00180"></a><span class="lineno"> 180</span> </div><div class="line"><a name="l00181"></a><span class="lineno"> 181</span> <span class="comment"></span></div><div class="line"><a name="l00182"></a><span class="lineno"> 182</span> <span class="comment">/**</span></div><div class="line"><a name="l00183"></a><span class="lineno"> 183</span> <span class="comment"> * @purpose</span></div><div class="line"><a name="l00184"></a><span class="lineno"> 184</span> <span class="comment"> * Get next open directory descriptor</span></div><div class="line"><a name="l00185"></a><span class="lineno"> 185</span> <span class="comment"> *</span></div><div class="line"><a name="l00186"></a><span class="lineno"> 186</span> <span class="comment"> * @detailed</span></div><div class="line"><a name="l00187"></a><span class="lineno"> 187</span> <span class="comment"> * Iterate through opened directory descriptors within the same mount.</span></div><div class="line"><a name="l00188"></a><span class="lineno"> 188</span> <span class="comment"> *</span></div><div class="line"><a name="l00189"></a><span class="lineno"> 189</span> <span class="comment"> * @param context [IN] Mount context provided passed to umount handler.</span></div><div class="line"><a name="l00190"></a><span class="lineno"> 190</span> <span class="comment"> *</span></div><div class="line"><a name="l00191"></a><span class="lineno"> 191</span> <span class="comment"> * @returns</span></div><div class="line"><a name="l00192"></a><span class="lineno"> 192</span> <span class="comment"> * @retval next open directory descriptor or NULL after the last</span></div><div class="line"><a name="l00193"></a><span class="lineno"> 193</span> <span class="comment"> */</span></div><div class="line"><a name="l00194"></a><span class="lineno"> 194</span> <a class="code" href="structvp__fs__dir__str.html">vp_fs_dir_t</a> <a class="code" href="group__FSlib__svc.html#gad1838f4c9425ac0ff962aad12e02c41f">vp_fs_next_dd</a>(</div><div class="line"><a name="l00195"></a><span class="lineno"> 195</span>  <a class="code" href="structvp__fs__mount__context__str.html">vp_fs_mount_context_t</a> context);</div><div class="line"><a name="l00196"></a><span class="lineno"> 196</span> <span class="comment"></span></div><div class="line"><a name="l00197"></a><span class="lineno"> 197</span> <span class="comment">/**</span></div><div class="line"><a name="l00198"></a><span class="lineno"> 198</span> <span class="comment"> * @purpose</span></div><div class="line"><a name="l00199"></a><span class="lineno"> 199</span> <span class="comment"> * Retrieve the UID of the client for the current request</span></div><div class="line"><a name="l00200"></a><span class="lineno"> 200</span> <span class="comment"> *</span></div><div class="line"><a name="l00201"></a><span class="lineno"> 201</span> <span class="comment"> * @detailed</span></div><div class="line"><a name="l00202"></a><span class="lineno"> 202</span> <span class="comment"> * Retrieve the UID of the client for the current request</span></div><div class="line"><a name="l00203"></a><span class="lineno"> 203</span> <span class="comment"> *</span></div><div class="line"><a name="l00204"></a><span class="lineno"> 204</span> <span class="comment"> * @returns the UID of the client</span></div><div class="line"><a name="l00205"></a><span class="lineno"> 205</span> <span class="comment"> */</span></div><div class="line"><a name="l00206"></a><span class="lineno"> 206</span> P4_uid_t <a class="code" href="group__FSlib__svc.html#ga2eae16a49060574ab8aaa77e0673438e">vp_fs_get_client_uid</a>(</div><div class="line"><a name="l00207"></a><span class="lineno"> 207</span>  <span class="keywordtype">void</span>);</div><div class="line"><a name="l00208"></a><span class="lineno"> 208</span> <span class="comment"></span></div><div class="line"><a name="l00209"></a><span class="lineno"> 209</span> <span class="comment">/**</span></div><div class="line"><a name="l00210"></a><span class="lineno"> 210</span> <span class="comment"> * @purpose</span></div><div class="line"><a name="l00211"></a><span class="lineno"> 211</span> <span class="comment"> * Retrieve the flags used for resource locks within a volume provider</span></div><div class="line"><a name="l00212"></a><span class="lineno"> 212</span> <span class="comment"> *</span></div><div class="line"><a name="l00213"></a><span class="lineno"> 213</span> <span class="comment"> * @detailed</span></div><div class="line"><a name="l00214"></a><span class="lineno"> 214</span> <span class="comment"> * Retrieve the flags used for resource locks within a volume provider.</span></div><div class="line"><a name="l00215"></a><span class="lineno"> 215</span> <span class="comment"> * These can be used e.g. when initializing mutexes guarding volumes, file</span></div><div class="line"><a name="l00216"></a><span class="lineno"> 216</span> <span class="comment"> * descriptors etc. Flags are given by configuration. If priority based</span></div><div class="line"><a name="l00217"></a><span class="lineno"> 217</span> <span class="comment"> * queuing is configured the flags contain P4_MUTEX_PRIO.</span></div><div class="line"><a name="l00218"></a><span class="lineno"> 218</span> <span class="comment"> *</span></div><div class="line"><a name="l00219"></a><span class="lineno"> 219</span> <span class="comment"> * @returns locking flags to be used e.g. with p4_mutex_init()</span></div><div class="line"><a name="l00220"></a><span class="lineno"> 220</span> <span class="comment"> */</span></div><div class="line"><a name="l00221"></a><span class="lineno"> 221</span> P4_uint32_t <a class="code" href="group__FSlib__svc.html#ga2ca0c731ea866da11b17e6c53007dd83">vp_fs_get_locking_flags</a>(</div><div class="line"><a name="l00222"></a><span class="lineno"> 222</span>  <span class="keywordtype">void</span>);</div><div class="line"><a name="l00223"></a><span class="lineno"> 223</span> <span class="comment"></span></div><div class="line"><a name="l00224"></a><span class="lineno"> 224</span> <span class="comment">/**</span></div><div class="line"><a name="l00225"></a><span class="lineno"> 225</span> <span class="comment"> * @purpose</span></div><div class="line"><a name="l00226"></a><span class="lineno"> 226</span> <span class="comment"> * Print formatted output on PikeOS console.</span></div><div class="line"><a name="l00227"></a><span class="lineno"> 227</span> <span class="comment"> *</span></div><div class="line"><a name="l00228"></a><span class="lineno"> 228</span> <span class="comment"> * @detailed \n</span></div><div class="line"><a name="l00229"></a><span class="lineno"> 229</span> <span class="comment"> * The function formats and prints arguments on the PikeOS console according</span></div><div class="line"><a name="l00230"></a><span class="lineno"> 230</span> <span class="comment"> * to the C printf-like format string \a fmt. Depending on \a type, the message</span></div><div class="line"><a name="l00231"></a><span class="lineno"> 231</span> <span class="comment"> * may be prefixed with a string indicating type message, the integer value</span></div><div class="line"><a name="l00232"></a><span class="lineno"> 232</span> <span class="comment"> * \a code and the driver name. Refer to the descriptions of the logging</span></div><div class="line"><a name="l00233"></a><span class="lineno"> 233</span> <span class="comment"> * macros for details of message prefixes.</span></div><div class="line"><a name="l00234"></a><span class="lineno"> 234</span> <span class="comment"> *</span></div><div class="line"><a name="l00235"></a><span class="lineno"> 235</span> <span class="comment"> * @note</span></div><div class="line"><a name="l00236"></a><span class="lineno"> 236</span> <span class="comment"> * The actual display of the output string on the PikeOS console is controlled</span></div><div class="line"><a name="l00237"></a><span class="lineno"> 237</span> <span class="comment"> * by the logging verbosity threshold, set via the driver configuration. Refer</span></div><div class="line"><a name="l00238"></a><span class="lineno"> 238</span> <span class="comment"> * to the descriptions of the logging macros for details of the threshold</span></div><div class="line"><a name="l00239"></a><span class="lineno"> 239</span> <span class="comment"> * values.</span></div><div class="line"><a name="l00240"></a><span class="lineno"> 240</span> <span class="comment"> *</span></div><div class="line"><a name="l00241"></a><span class="lineno"> 241</span> <span class="comment"> * @param type [IN] Message type</span></div><div class="line"><a name="l00242"></a><span class="lineno"> 242</span> <span class="comment"> * @param fmt [IN] C printf-like format string</span></div><div class="line"><a name="l00243"></a><span class="lineno"> 243</span> <span class="comment"> * @param ... [IN] arguments for format string</span></div><div class="line"><a name="l00244"></a><span class="lineno"> 244</span> <span class="comment"> *</span></div><div class="line"><a name="l00245"></a><span class="lineno"> 245</span> <span class="comment"> */</span></div><div class="line"><a name="l00246"></a><span class="lineno"> 246</span> <span class="keyword">extern</span> <span class="keywordtype">void</span> <a class="code" href="group__FSlib__svc.html#gabcdec36146573423d45173c398953a02">vp_log_printf</a>(</div><div class="line"><a name="l00247"></a><span class="lineno"> 247</span>  vp_log_type_t type,</div><div class="line"><a name="l00248"></a><span class="lineno"> 248</span>  <span class="keyword">const</span> <span class="keywordtype">char</span> *fmt,</div><div class="line"><a name="l00249"></a><span class="lineno"> 249</span>  ...) __printflike(2, 3);</div><div class="line"><a name="l00250"></a><span class="lineno"> 250</span> <span class="comment"></span></div><div class="line"><a name="l00251"></a><span class="lineno"> 251</span> <span class="comment">/** absolute silence */</span></div><div class="line"><a name="l00252"></a><span class="lineno"><a class="line" href="group__FSlib__svc.html#ga66c87ca52376f7956a0cd7eb6fd97384"> 252</a></span> <span class="preprocessor">#define VP_LOG_TYPE_NONE 0x00UL</span></div><div class="line"><a name="l00253"></a><span class="lineno"> 253</span> <span class="comment">/** log fatal errors */</span></div><div class="line"><a name="l00254"></a><span class="lineno"><a class="line" href="group__FSlib__svc.html#gaba388c0d47fdd4f87c1dd476e9de62e7"> 254</a></span> <span class="preprocessor">#define VP_LOG_TYPE_FATAL 0x01UL</span></div><div class="line"><a name="l00255"></a><span class="lineno"> 255</span> <span class="comment">/** log errors */</span></div><div class="line"><a name="l00256"></a><span class="lineno"><a class="line" href="group__FSlib__svc.html#ga20dbc318afaadca70874479f31bbabf6"> 256</a></span> <span class="preprocessor">#define VP_LOG_TYPE_ERROR 0x02UL</span></div><div class="line"><a name="l00257"></a><span class="lineno"> 257</span> <span class="comment">/** log common messages */</span></div><div class="line"><a name="l00258"></a><span class="lineno"><a class="line" href="group__FSlib__svc.html#gaa579adcca010b69f86139f683a43cb99"> 258</a></span> <span class="preprocessor">#define VP_LOG_TYPE_MESSAGE 0x04UL</span></div><div class="line"><a name="l00259"></a><span class="lineno"> 259</span> <span class="comment">/** log info messages */</span></div><div class="line"><a name="l00260"></a><span class="lineno"><a class="line" href="group__FSlib__svc.html#gadb0b30cbaed746d0f922c0f825a16ccd"> 260</a></span> <span class="preprocessor">#define VP_LOG_TYPE_INFO 0x08UL</span></div><div class="line"><a name="l00261"></a><span class="lineno"> 261</span> <span class="comment">/** log debug messages */</span></div><div class="line"><a name="l00262"></a><span class="lineno"><a class="line" href="group__FSlib__svc.html#ga0b95c01b0f0ebacab9789a1779680bbb"> 262</a></span> <span class="preprocessor">#define VP_LOG_TYPE_DEBUG 0x10UL</span></div><div class="line"><a name="l00263"></a><span class="lineno"> 263</span> <span class="comment">/** log everything */</span></div><div class="line"><a name="l00264"></a><span class="lineno"><a class="line" href="group__FSlib__svc.html#ga4b90a33d13f2eb6053be1039d88a599f"> 264</a></span> <span class="preprocessor">#define VP_LOG_TYPE_ALL 0x7fUL</span></div><div class="line"><a name="l00265"></a><span class="lineno"> 265</span> </div><div class="line"><a name="l00266"></a><span class="lineno"> 266</span> <span class="preprocessor">#ifdef DOXYGEN</span></div><div class="line"><a name="l00267"></a><span class="lineno"> 267</span> <span class="comment">/**</span></div><div class="line"><a name="l00268"></a><span class="lineno"> 268</span> <span class="comment"> * @purpose</span></div><div class="line"><a name="l00269"></a><span class="lineno"> 269</span> <span class="comment"> * Print FATAL type message on PikeOS console.</span></div><div class="line"><a name="l00270"></a><span class="lineno"> 270</span> <span class="comment"> *</span></div><div class="line"><a name="l00271"></a><span class="lineno"> 271</span> <span class="comment"> * @detailed \n</span></div><div class="line"><a name="l00272"></a><span class="lineno"> 272</span> <span class="comment"> * The macro formats and prints arguments on the PikeOS console according to</span></div><div class="line"><a name="l00273"></a><span class="lineno"> 273</span> <span class="comment"> * the C printf-like format string \a fmt. The output string is prefixed with</span></div><div class="line"><a name="l00274"></a><span class="lineno"> 274</span> <span class="comment"> * a string indicating a "FATAL" type message, and the driver name.</span></div><div class="line"><a name="l00275"></a><span class="lineno"> 275</span> <span class="comment"> *</span></div><div class="line"><a name="l00276"></a><span class="lineno"> 276</span> <span class="comment"> * @note</span></div><div class="line"><a name="l00277"></a><span class="lineno"> 277</span> <span class="comment"> * The actual display of the output string on the PikeOS console is controlled</span></div><div class="line"><a name="l00278"></a><span class="lineno"> 278</span> <span class="comment"> * by the logging verbosity threshold, set via the driver configuration. FATAL</span></div><div class="line"><a name="l00279"></a><span class="lineno"> 279</span> <span class="comment"> * type messages are printed if the threshold is set to 1 or higher.</span></div><div class="line"><a name="l00280"></a><span class="lineno"> 280</span> <span class="comment"> */</span></div><div class="line"><a name="l00281"></a><span class="lineno"><a class="line" href="group__FSlib__svc.html#ga675d9c5e9766b289f6ecad85701298c6"> 281</a></span> <span class="preprocessor">#define VP_LOG_FATAL(fmt, args...)</span></div><div class="line"><a name="l00282"></a><span class="lineno"> 282</span> <span class="comment">/**</span></div><div class="line"><a name="l00283"></a><span class="lineno"> 283</span> <span class="comment"> * @purpose</span></div><div class="line"><a name="l00284"></a><span class="lineno"> 284</span> <span class="comment"> * Print ERROR type message on PikeOS console.</span></div><div class="line"><a name="l00285"></a><span class="lineno"> 285</span> <span class="comment"> *</span></div><div class="line"><a name="l00286"></a><span class="lineno"> 286</span> <span class="comment"> * @detailed \n</span></div><div class="line"><a name="l00287"></a><span class="lineno"> 287</span> <span class="comment"> * The macro formats and prints arguments on the PikeOS console according to</span></div><div class="line"><a name="l00288"></a><span class="lineno"> 288</span> <span class="comment"> * the C printf-like format string \a fmt. The output string is prefixed with</span></div><div class="line"><a name="l00289"></a><span class="lineno"> 289</span> <span class="comment"> * a string indicating an "ERROR" type message, and the driver name.</span></div><div class="line"><a name="l00290"></a><span class="lineno"> 290</span> <span class="comment"> *</span></div><div class="line"><a name="l00291"></a><span class="lineno"> 291</span> <span class="comment"> * @note</span></div><div class="line"><a name="l00292"></a><span class="lineno"> 292</span> <span class="comment"> * The actual display of the output string on the PikeOS console is controlled</span></div><div class="line"><a name="l00293"></a><span class="lineno"> 293</span> <span class="comment"> * by the logging verbosity threshold, set via the driver configuration. ERROR</span></div><div class="line"><a name="l00294"></a><span class="lineno"> 294</span> <span class="comment"> * type messages are printed if the threshold is set to 2 or higher.</span></div><div class="line"><a name="l00295"></a><span class="lineno"> 295</span> <span class="comment"> */</span></div><div class="line"><a name="l00296"></a><span class="lineno"><a class="line" href="group__FSlib__svc.html#ga698e1ff4112a53de677c573094196913"> 296</a></span> <span class="preprocessor">#define VP_LOG_ERROR(fmt, args...)</span></div><div class="line"><a name="l00297"></a><span class="lineno"> 297</span> <span class="comment">/**</span></div><div class="line"><a name="l00298"></a><span class="lineno"> 298</span> <span class="comment"> * @purpose</span></div><div class="line"><a name="l00299"></a><span class="lineno"> 299</span> <span class="comment"> * Print MESSAGE type message on PikeOS console</span></div><div class="line"><a name="l00300"></a><span class="lineno"> 300</span> <span class="comment"> *log_svc</span></div><div class="line"><a name="l00301"></a><span class="lineno"> 301</span> <span class="comment"> * @detailed \n</span></div><div class="line"><a name="l00302"></a><span class="lineno"> 302</span> <span class="comment"> * The macro formats and prints arguments on the PikeOS console according to</span></div><div class="line"><a name="l00303"></a><span class="lineno"> 303</span> <span class="comment"> * the C printf-like format string \a fmt. The output string is prefixed with</span></div><div class="line"><a name="l00304"></a><span class="lineno"> 304</span> <span class="comment"> * a string indicating a "MESSAGE" type message, and the driver name.</span></div><div class="line"><a name="l00305"></a><span class="lineno"> 305</span> <span class="comment"> *</span></div><div class="line"><a name="l00306"></a><span class="lineno"> 306</span> <span class="comment"> * @note</span></div><div class="line"><a name="l00307"></a><span class="lineno"> 307</span> <span class="comment"> * The actual display of the output string on the PikeOS console is controlled</span></div><div class="line"><a name="l00308"></a><span class="lineno"> 308</span> <span class="comment"> * by the logging verbosity threshold, set via the driver configuration. MESSAGE</span></div><div class="line"><a name="l00309"></a><span class="lineno"> 309</span> <span class="comment"> * type messages are printed if the threshold is set to 3 or higher.</span></div><div class="line"><a name="l00310"></a><span class="lineno"> 310</span> <span class="comment"> */</span></div><div class="line"><a name="l00311"></a><span class="lineno"><a class="line" href="group__FSlib__svc.html#gadd9f3effb525a7a53b7f7052616615af"> 311</a></span> <span class="preprocessor">#define VP_LOG_MESSAGE(fmt, args...)</span></div><div class="line"><a name="l00312"></a><span class="lineno"> 312</span> <span class="comment">/**</span></div><div class="line"><a name="l00313"></a><span class="lineno"> 313</span> <span class="comment"> * @purpose</span></div><div class="line"><a name="l00314"></a><span class="lineno"> 314</span> <span class="comment"> * Print INFO type message on PikeOS console</span></div><div class="line"><a name="l00315"></a><span class="lineno"> 315</span> <span class="comment"> *</span></div><div class="line"><a name="l00316"></a><span class="lineno"> 316</span> <span class="comment"> * @detailed \n</span></div><div class="line"><a name="l00317"></a><span class="lineno"> 317</span> <span class="comment"> * The macro formats and prints arguments on the PikeOS console according to</span></div><div class="line"><a name="l00318"></a><span class="lineno"> 318</span> <span class="comment"> * the C printf-like format string \a fmt.</span></div><div class="line"><a name="l00319"></a><span class="lineno"> 319</span> <span class="comment"> *</span></div><div class="line"><a name="l00320"></a><span class="lineno"> 320</span> <span class="comment"> * @note</span></div><div class="line"><a name="l00321"></a><span class="lineno"> 321</span> <span class="comment"> * The actual display of the output string on the PikeOS console is controlled</span></div><div class="line"><a name="l00322"></a><span class="lineno"> 322</span> <span class="comment"> * by the logging verbosity threshold, set via the driver configuration. INFO</span></div><div class="line"><a name="l00323"></a><span class="lineno"> 323</span> <span class="comment"> * type messages are printed if the threshold is set to 4 or higher.</span></div><div class="line"><a name="l00324"></a><span class="lineno"> 324</span> <span class="comment"> */</span></div><div class="line"><a name="l00325"></a><span class="lineno"><a class="line" href="group__FSlib__svc.html#ga1a4eb552d4363ce3ebf186fec892fdad"> 325</a></span> <span class="preprocessor">#define VP_LOG_INFO(fmt, args...)</span></div><div class="line"><a name="l00326"></a><span class="lineno"> 326</span> <span class="comment">/**</span></div><div class="line"><a name="l00327"></a><span class="lineno"> 327</span> <span class="comment"> * @purpose</span></div><div class="line"><a name="l00328"></a><span class="lineno"> 328</span> <span class="comment"> * Print DEBUG type message on PikeOS console</span></div><div class="line"><a name="l00329"></a><span class="lineno"> 329</span> <span class="comment"> *</span></div><div class="line"><a name="l00330"></a><span class="lineno"> 330</span> <span class="comment"> * @detailed \n</span></div><div class="line"><a name="l00331"></a><span class="lineno"> 331</span> <span class="comment"> * The macro formats and prints arguments on the PikeOS console according to</span></div><div class="line"><a name="l00332"></a><span class="lineno"> 332</span> <span class="comment"> * the C printf-like format string \a fmt. The output string is prefixed with</span></div><div class="line"><a name="l00333"></a><span class="lineno"> 333</span> <span class="comment"> * a string indicating the message type, and the driver name.</span></div><div class="line"><a name="l00334"></a><span class="lineno"> 334</span> <span class="comment"> *</span></div><div class="line"><a name="l00335"></a><span class="lineno"> 335</span> <span class="comment"> * @note</span></div><div class="line"><a name="l00336"></a><span class="lineno"> 336</span> <span class="comment"> * The actual display of the output string on the PikeOS console is controlled</span></div><div class="line"><a name="l00337"></a><span class="lineno"> 337</span> <span class="comment"> * by the logging verbosity threshold, set via the driver configuration. DEBUG</span></div><div class="line"><a name="l00338"></a><span class="lineno"> 338</span> <span class="comment"> * type messages are printed if the threshold is set to 5 or higher.</span></div><div class="line"><a name="l00339"></a><span class="lineno"> 339</span> <span class="comment"> */</span></div><div class="line"><a name="l00340"></a><span class="lineno"><a class="line" href="group__FSlib__svc.html#gab4a76467da00e77a1afb4066f160964b"> 340</a></span> <span class="preprocessor">#define VP_LOG_DEBUG(fmt, args...)</span></div><div class="line"><a name="l00341"></a><span class="lineno"> 341</span> </div><div class="line"><a name="l00342"></a><span class="lineno"> 342</span> <span class="preprocessor">#else</span></div><div class="line"><a name="l00343"></a><span class="lineno"> 343</span> <span class="preprocessor">#define VP_LOG_FATAL(...) \</span></div><div class="line"><a name="l00344"></a><span class="lineno"> 344</span> <span class="preprocessor"> vp_log_printf(VP_LOG_TYPE_FATAL, __VA_ARGS__)</span></div><div class="line"><a name="l00345"></a><span class="lineno"> 345</span> </div><div class="line"><a name="l00346"></a><span class="lineno"> 346</span> <span class="preprocessor">#define VP_LOG_ERROR(...) \</span></div><div class="line"><a name="l00347"></a><span class="lineno"> 347</span> <span class="preprocessor"> vp_log_printf(VP_LOG_TYPE_ERROR, __VA_ARGS__)</span></div><div class="line"><a name="l00348"></a><span class="lineno"> 348</span> </div><div class="line"><a name="l00349"></a><span class="lineno"> 349</span> <span class="preprocessor">#define VP_LOG_MESSAGE(...) \</span></div><div class="line"><a name="l00350"></a><span class="lineno"> 350</span> <span class="preprocessor"> vp_log_printf(VP_LOG_TYPE_MESSAGE, __VA_ARGS__)</span></div><div class="line"><a name="l00351"></a><span class="lineno"> 351</span> </div><div class="line"><a name="l00352"></a><span class="lineno"> 352</span> <span class="preprocessor">#define VP_LOG_INFO(...) \</span></div><div class="line"><a name="l00353"></a><span class="lineno"> 353</span> <span class="preprocessor"> vp_log_printf(VP_LOG_TYPE_INFO, __VA_ARGS__)</span></div><div class="line"><a name="l00354"></a><span class="lineno"> 354</span> </div><div class="line"><a name="l00355"></a><span class="lineno"> 355</span> <span class="preprocessor">#define VP_LOG_DEBUG(...) \</span></div><div class="line"><a name="l00356"></a><span class="lineno"> 356</span> <span class="preprocessor"> vp_log_printf(VP_LOG_TYPE_DEBUG, __VA_ARGS__)</span></div><div class="line"><a name="l00357"></a><span class="lineno"> 357</span> <span class="preprocessor">#endif </span><span class="comment">/* DOXYGEN */</span><span class="preprocessor"></span></div><div class="line"><a name="l00358"></a><span class="lineno"> 358</span> </div><div class="line"><a name="l00359"></a><span class="lineno"> 359</span> <span class="comment"></span></div><div class="line"><a name="l00360"></a><span class="lineno"> 360</span> <span class="comment">/**</span></div><div class="line"><a name="l00361"></a><span class="lineno"> 361</span> <span class="comment"> * @purpose</span></div><div class="line"><a name="l00362"></a><span class="lineno"> 362</span> <span class="comment"> * Maximum size of a log message, including terminating NUL character.</span></div><div class="line"><a name="l00363"></a><span class="lineno"> 363</span> <span class="comment"> *</span></div><div class="line"><a name="l00364"></a><span class="lineno"> 364</span> <span class="comment"> * @detailed \n</span></div><div class="line"><a name="l00365"></a><span class="lineno"> 365</span> <span class="comment"> * Log messages exceeding this limit are truncated.</span></div><div class="line"><a name="l00366"></a><span class="lineno"> 366</span> <span class="comment"> *</span></div><div class="line"><a name="l00367"></a><span class="lineno"> 367</span> <span class="comment"> * @hideinitializer</span></div><div class="line"><a name="l00368"></a><span class="lineno"> 368</span> <span class="comment"> */</span></div><div class="line"><a name="l00369"></a><span class="lineno"><a class="line" href="group__FSlib__svc.html#ga6fd0842cef5511a26821034950bb1c10"> 369</a></span> <span class="preprocessor">#define VP_LOG_MAX_BUFF_SIZE VM_CPRINTF_STRLEN</span></div><div class="line"><a name="l00370"></a><span class="lineno"> 370</span> <span class="comment"></span></div><div class="line"><a name="l00371"></a><span class="lineno"> 371</span> <span class="comment">/**</span></div><div class="line"><a name="l00372"></a><span class="lineno"> 372</span> <span class="comment"> * @purpose</span></div><div class="line"><a name="l00373"></a><span class="lineno"> 373</span> <span class="comment"> * Retrieve debug messages verbosity level set for VP application.</span></div><div class="line"><a name="l00374"></a><span class="lineno"> 374</span> <span class="comment"> * This is intended for case when the FS library has its own system of debug</span></div><div class="line"><a name="l00375"></a><span class="lineno"> 375</span> <span class="comment"> * messages, that allows setting verbosity in a similar way as other VP</span></div><div class="line"><a name="l00376"></a><span class="lineno"> 376</span> <span class="comment"> * parts.</span></div><div class="line"><a name="l00377"></a><span class="lineno"> 377</span> <span class="comment"> *</span></div><div class="line"><a name="l00378"></a><span class="lineno"> 378</span> <span class="comment"> * @returns</span></div><div class="line"><a name="l00379"></a><span class="lineno"> 379</span> <span class="comment"> * Logging verbosity level.</span></div><div class="line"><a name="l00380"></a><span class="lineno"> 380</span> <span class="comment"> * One or more (logical or) of VP_LOG_TYPE_xxxx.</span></div><div class="line"><a name="l00381"></a><span class="lineno"> 381</span> <span class="comment"> *</span></div><div class="line"><a name="l00382"></a><span class="lineno"> 382</span> <span class="comment"> */</span></div><div class="line"><a name="l00383"></a><span class="lineno"> 383</span> </div><div class="line"><a name="l00384"></a><span class="lineno"> 384</span> <span class="keyword">extern</span> P4_uint32_t <a class="code" href="group__FSlib__svc.html#ga1b5f81917e08aec521268a9d62c16c36">vp_log_get_level</a>(</div><div class="line"><a name="l00385"></a><span class="lineno"> 385</span>  <span class="keywordtype">void</span>);</div><div class="line"><a name="l00386"></a><span class="lineno"> 386</span> </div><div class="line"><a name="l00387"></a><span class="lineno"> 387</span> <span class="preprocessor">#endif </span><span class="comment">/* VM_FILE_H */</span><span class="preprocessor"></span></div><div class="ttc" id="group__FSlib__svc_html_ga2eae16a49060574ab8aaa77e0673438e"><div class="ttname"><a href="group__FSlib__svc.html#ga2eae16a49060574ab8aaa77e0673438e">vp_fs_get_client_uid</a></div><div class="ttdeci">P4_uid_t vp_fs_get_client_uid(void)</div><div class="ttdoc">Retrieve the UID of the client for the current request. </div></div>
|
|
<div class="ttc" id="group__FSlib__svc_html_ga9a6d7d25ba87fbba3a8bc35ea78e5df1"><div class="ttname"><a href="group__FSlib__svc.html#ga9a6d7d25ba87fbba3a8bc35ea78e5df1">vp_fs_get_time</a></div><div class="ttdeci">P4_time_t vp_fs_get_time(void)</div><div class="ttdoc">Get current time. </div></div>
|
|
<div class="ttc" id="structvp__fs__file__desc__str_html"><div class="ttname"><a href="structvp__fs__file__desc__str.html">vp_fs_file_desc_str</a></div><div class="ttdoc">Defines volume specific File Descriptor container type. </div><div class="ttdef"><b>Definition:</b> vp_fslib.h:55</div></div>
|
|
<div class="ttc" id="vp__fslib_8h_html"><div class="ttname"><a href="vp__fslib_8h.html">vp_fslib.h</a></div><div class="ttdoc">FSlib API: FS library interface. </div></div>
|
|
<div class="ttc" id="group__FSlib__svc_html_ga1b5f81917e08aec521268a9d62c16c36"><div class="ttname"><a href="group__FSlib__svc.html#ga1b5f81917e08aec521268a9d62c16c36">vp_log_get_level</a></div><div class="ttdeci">P4_uint32_t vp_log_get_level(void)</div><div class="ttdoc">Retrieve debug messages verbosity level set for VP application. This is intended for case when the FS...</div></div>
|
|
<div class="ttc" id="group__FSlib__svc_html_gafd481e74ec100a34b5136dd3fb4fa212"><div class="ttname"><a href="group__FSlib__svc.html#gafd481e74ec100a34b5136dd3fb4fa212">vp_fs_vmem_alloc</a></div><div class="ttdeci">P4_address_t vp_fs_vmem_alloc(P4_size_t size)</div><div class="ttdoc">Allocate unmapped virtual memory. </div></div>
|
|
<div class="ttc" id="group__FSlib__svc_html_gad1838f4c9425ac0ff962aad12e02c41f"><div class="ttname"><a href="group__FSlib__svc.html#gad1838f4c9425ac0ff962aad12e02c41f">vp_fs_next_dd</a></div><div class="ttdeci">vp_fs_dir_t vp_fs_next_dd(vp_fs_mount_context_t context)</div><div class="ttdoc">Get next open directory descriptor. </div></div>
|
|
<div class="ttc" id="structvp__fs__dir__str_html"><div class="ttname"><a href="structvp__fs__dir__str.html">vp_fs_dir_str</a></div><div class="ttdoc">Defines volume specific Directory Descriptor container type. </div><div class="ttdef"><b>Definition:</b> vp_fslib.h:65</div></div>
|
|
<div class="ttc" id="group__FSlib__svc_html_ga05a3682a8ab3c8f7a52fd15577a8e340"><div class="ttname"><a href="group__FSlib__svc.html#ga05a3682a8ab3c8f7a52fd15577a8e340">vp_fs_tls_get</a></div><div class="ttdeci">P4_cpureg_t vp_fs_tls_get(void)</div><div class="ttdoc">Retrieve thread local value. </div></div>
|
|
<div class="ttc" id="structvp__fs__mount__context__str_html"><div class="ttname"><a href="structvp__fs__mount__context__str.html">vp_fs_mount_context_str</a></div><div class="ttdoc">Mount specific context (open descriptors) </div><div class="ttdef"><b>Definition:</b> vp_fslib.h:75</div></div>
|
|
<div class="ttc" id="group__FSlib__svc_html_ga4acf3b57f59a78b9d08b4c5fb4240c46"><div class="ttname"><a href="group__FSlib__svc.html#ga4acf3b57f59a78b9d08b4c5fb4240c46">vp_fs_free</a></div><div class="ttdeci">void vp_fs_free(void *buf)</div><div class="ttdoc">Free memory back to the volume provider memory pool. </div></div>
|
|
<div class="ttc" id="group__FSlib__svc_html_ga2a440f4fb7ee05e5f0bbd37fa4b54da0"><div class="ttname"><a href="group__FSlib__svc.html#ga2a440f4fb7ee05e5f0bbd37fa4b54da0">vp_fs_next_fd</a></div><div class="ttdeci">vp_fs_file_desc_t vp_fs_next_fd(vp_fs_mount_context_t context)</div><div class="ttdoc">Get next open file descriptor. </div></div>
|
|
<div class="ttc" id="group__FSlib__svc_html_gad48c153eb28b51d682122bb49bf48fae"><div class="ttname"><a href="group__FSlib__svc.html#gad48c153eb28b51d682122bb49bf48fae">vp_fs_tls_set</a></div><div class="ttdeci">void vp_fs_tls_set(P4_cpureg_t value)</div><div class="ttdoc">Set thread local value. </div></div>
|
|
<div class="ttc" id="group__FSlib__svc_html_ga98cb8c6911844089c3e31daef268af67"><div class="ttname"><a href="group__FSlib__svc.html#ga98cb8c6911844089c3e31daef268af67">vp_fs_malloc</a></div><div class="ttdeci">void * vp_fs_malloc(P4_size_t size, P4_address_t alignment)</div><div class="ttdoc">Allocate memory area from the volume provider memory pool. </div></div>
|
|
<div class="ttc" id="group__FSlib__svc_html_gabcdec36146573423d45173c398953a02"><div class="ttname"><a href="group__FSlib__svc.html#gabcdec36146573423d45173c398953a02">vp_log_printf</a></div><div class="ttdeci">void vp_log_printf(vp_log_type_t type, const char *fmt,...) __printflike(2</div><div class="ttdoc">Print formatted output on PikeOS console. </div></div>
|
|
<div class="ttc" id="group__FSlib__svc_html_ga2ca0c731ea866da11b17e6c53007dd83"><div class="ttname"><a href="group__FSlib__svc.html#ga2ca0c731ea866da11b17e6c53007dd83">vp_fs_get_locking_flags</a></div><div class="ttdeci">P4_uint32_t vp_fs_get_locking_flags(void)</div><div class="ttdoc">Retrieve the flags used for resource locks within a volume provider. </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_a8adc0807d5a5926ebf6cd2ff2d915eb.html">localsrc</a></li><li class="navelem"><a class="el" href="dir_5e0329a75e12409e8c61ba1c17ed9f46.html">libvp</a></li><li class="navelem"><a class="el" href="dir_22f7562aacd6a1f65a9115ced94d98c2.html">vp</a></li><li class="navelem"><a class="el" href="vp__fslib__svc_8h.html">vp_fslib_svc.h</a></li>
|
|
<li class="footer">(C) Copyright SYSGO AG</li>
|
|
</ul>
|
|
</div>
|
|
</body>
|
|
</html>
|