345 lines
33 KiB
HTML
345 lines
33 KiB
HTML
<!-- HTML header for doxygen 1.9.1-->
|
|
<!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.15.0"/>
|
|
<meta name="viewport" content="width=device-width, initial-scale=1"/>
|
|
<title>L4Re Operating System Framework: pkg/l4re-core/ned/doc/tutorial.lua 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="navtreedata.js"></script>
|
|
<script type="text/javascript" src="navtree.js"></script>
|
|
<script type="text/javascript" src="cookie.js"></script>
|
|
<link href="search/search.css" rel="stylesheet" type="text/css"/>
|
|
<script type="text/javascript" src="search/searchdata.js"></script>
|
|
<script type="text/javascript" src="search/search.js"></script>
|
|
<link href="doxygen.css" rel="stylesheet" type="text/css" />
|
|
<link href="doxygen-awesome.css" rel="stylesheet" type="text/css"/>
|
|
<link href="l4re-awesome.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="projectlogo"><img alt="Logo" src="L4Re_rgb_logo_quer_hg_h55.png"/></td>
|
|
<td id="projectalign" style="padding-left: 0.5em;">
|
|
<div id="projectname">L4Re Operating System Framework
|
|
</div>
|
|
<div id="projectbrief">Interface and Usage Documentation</div>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<!-- end header part -->
|
|
<!-- Generated by Doxygen 1.15.0 -->
|
|
<script type="text/javascript">
|
|
var searchBox = new SearchBox("searchBox", "search/",'.html');
|
|
</script>
|
|
<script type="text/javascript">
|
|
$(function() { codefold.init(); });
|
|
</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',true);
|
|
$(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">
|
|
$(function(){initNavTree('tutorial_8lua_source.html','',''); });
|
|
</script>
|
|
<div id="container">
|
|
<div id="doc-content">
|
|
<!-- window showing the filter options -->
|
|
<div id="MSearchSelectWindow"
|
|
onmouseover="return searchBox.OnSearchSelectShow()"
|
|
onmouseout="return searchBox.OnSearchSelectHide()"
|
|
onkeydown="return searchBox.OnSearchSelectKey(event)">
|
|
</div>
|
|
|
|
<!-- iframe showing the search results (closed by default) -->
|
|
<div id="MSearchResultsWindow">
|
|
<div id="MSearchResults">
|
|
<div class="SRPage">
|
|
<div id="SRIndex">
|
|
<div id="SRResults"></div>
|
|
<div class="SRStatus" id="Loading">Loading...</div>
|
|
<div class="SRStatus" id="Searching">Searching...</div>
|
|
<div class="SRStatus" id="NoMatches">No Matches</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
<div class="header">
|
|
<div class="headertitle"><div class="title">tutorial.lua</div></div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
<div class="fragment"><div class="line"><a id="l00001" name="l00001"></a><span class="lineno"> 1</span>local _doc = [==[</div>
|
|
<div class="line"><a id="l00002" name="l00002"></a><span class="lineno"> 2</span> </div>
|
|
<div class="line"><a id="l00003" name="l00003"></a><span class="lineno"> 3</span>Tutorial lua script for Ned</div>
|
|
<div class="line"><a id="l00004" name="l00004"></a><span class="lineno"> 4</span>===========================</div>
|
|
<div class="line"><a id="l00005" name="l00005"></a><span class="lineno"> 5</span> </div>
|
|
<div class="line"><a id="l00006" name="l00006"></a><span class="lineno"> 6</span>Firstly we have a set of definitions available. Some come from 'ned.lua'</div>
|
|
<div class="line"><a id="l00007" name="l00007"></a><span class="lineno"> 7</span>embedded script and others from the C++ bindings within Ned. The whole L4</div>
|
|
<div class="line"><a id="l00008" name="l00008"></a><span class="lineno"> 8</span>functionality is in the lua module "L4" (use 'local L4 = require("L4");').</div>
|
|
<div class="line"><a id="l00009" name="l00009"></a><span class="lineno"> 9</span>The L4 module classes and functions cope with L4 capabilities and</div>
|
|
<div class="line"><a id="l00010" name="l00010"></a><span class="lineno"> 10</span>their invocations, provide a set of constants and access to the L4Re environment of</div>
|
|
<div class="line"><a id="l00011" name="l00011"></a><span class="lineno"> 11</span>the running program. Finally, of course it can also start L4 applications.</div>
|
|
<div class="line"><a id="l00012" name="l00012"></a><span class="lineno"> 12</span> </div>
|
|
<div class="line"><a id="l00013" name="l00013"></a><span class="lineno"> 13</span>L4 Capabilities</div>
|
|
<div class="line"><a id="l00014" name="l00014"></a><span class="lineno"> 14</span>===============</div>
|
|
<div class="line"><a id="l00015" name="l00015"></a><span class="lineno"> 15</span> </div>
|
|
<div class="line"><a id="l00016" name="l00016"></a><span class="lineno"> 16</span>The L4 module defines a user data type for capabilities. A capability in lua</div>
|
|
<div class="line"><a id="l00017" name="l00017"></a><span class="lineno"> 17</span>carries a typed L4 capability and is accompanied with a set of type specific</div>
|
|
<div class="line"><a id="l00018" name="l00018"></a><span class="lineno"> 18</span>methods that may be called on the object behind the capability. There also</div>
|
|
<div class="line"><a id="l00019" name="l00019"></a><span class="lineno"> 19</span>exists a way to cast a capability to a capability to a different type of</div>
|
|
<div class="line"><a id="l00020" name="l00020"></a><span class="lineno"> 20</span>object using L4.cast(type, cap).</div>
|
|
<div class="line"><a id="l00021" name="l00021"></a><span class="lineno"> 21</span> </div>
|
|
<div class="line"><a id="l00022" name="l00022"></a><span class="lineno"> 22</span>L4.cast(type, cap)</div>
|
|
<div class="line"><a id="l00023" name="l00023"></a><span class="lineno"> 23</span> </div>
|
|
<div class="line"><a id="l00024" name="l00024"></a><span class="lineno"> 24</span>Returns a cap transformed to a capability of the given type, whereas type</div>
|
|
<div class="line"><a id="l00025" name="l00025"></a><span class="lineno"> 25</span>is either the fully qualified C++ name of the class encapsulating the object</div>
|
|
<div class="line"><a id="l00026" name="l00026"></a><span class="lineno"> 26</span>or the L4 protocol ID assigned to all L4Re and L4 system objects.</div>
|
|
<div class="line"><a id="l00027" name="l00027"></a><span class="lineno"> 27</span>If the type is unknown then nil is returned.</div>
|
|
<div class="line"><a id="l00028" name="l00028"></a><span class="lineno"> 28</span> </div>
|
|
<div class="line"><a id="l00029" name="l00029"></a><span class="lineno"> 29</span>Generic capabilities provide the following methods:</div>
|
|
<div class="line"><a id="l00030" name="l00030"></a><span class="lineno"> 30</span> </div>
|
|
<div class="line"><a id="l00031" name="l00031"></a><span class="lineno"> 31</span>is_valid()</div>
|
|
<div class="line"><a id="l00032" name="l00032"></a><span class="lineno"> 32</span> </div>
|
|
<div class="line"><a id="l00033" name="l00033"></a><span class="lineno"> 33</span> Returns true if the capability is not the invalid cap (L4_INVALID_CAP), and</div>
|
|
<div class="line"><a id="l00034" name="l00034"></a><span class="lineno"> 34</span> false if it is the invalid cap.</div>
|
|
<div class="line"><a id="l00035" name="l00035"></a><span class="lineno"> 35</span> </div>
|
|
<div class="line"><a id="l00036" name="l00036"></a><span class="lineno"> 36</span> </div>
|
|
<div class="line"><a id="l00037" name="l00037"></a><span class="lineno"> 37</span>L4Re::Namespace object</div>
|
|
<div class="line"><a id="l00038" name="l00038"></a><span class="lineno"> 38</span>======================</div>
|
|
<div class="line"><a id="l00039" name="l00039"></a><span class="lineno"> 39</span> </div>
|
|
<div class="line"><a id="l00040" name="l00040"></a><span class="lineno"> 40</span>There is a lua type for name spaces that has the following methods:</div>
|
|
<div class="line"><a id="l00041" name="l00041"></a><span class="lineno"> 41</span> </div>
|
|
<div class="line"><a id="l00042" name="l00042"></a><span class="lineno"> 42</span>query(name), or q(name)</div>
|
|
<div class="line"><a id="l00043" name="l00043"></a><span class="lineno"> 43</span> </div>
|
|
<div class="line"><a id="l00044" name="l00044"></a><span class="lineno"> 44</span> Returns a closure (function) that initiates a query for the given name</div>
|
|
<div class="line"><a id="l00045" name="l00045"></a><span class="lineno"> 45</span> within the name space. The function takes no arguments and returns</div>
|
|
<div class="line"><a id="l00046" name="l00046"></a><span class="lineno"> 46</span> a capability if successful or nil if name is not found.</div>
|
|
<div class="line"><a id="l00047" name="l00047"></a><span class="lineno"> 47</span> </div>
|
|
<div class="line"><a id="l00048" name="l00048"></a><span class="lineno"> 48</span> </div>
|
|
<div class="line"><a id="l00049" name="l00049"></a><span class="lineno"> 49</span>link(name), or l(name)</div>
|
|
<div class="line"><a id="l00050" name="l00050"></a><span class="lineno"> 50</span> </div>
|
|
<div class="line"><a id="l00051" name="l00051"></a><span class="lineno"> 51</span> Returns a function that can create a link to the given object in the name</div>
|
|
<div class="line"><a id="l00052" name="l00052"></a><span class="lineno"> 52</span> space if put into another name space. The function takes two parameters</div>
|
|
<div class="line"><a id="l00053" name="l00053"></a><span class="lineno"> 53</span> the target name space and the name in the target name space.</div>
|
|
<div class="line"><a id="l00054" name="l00054"></a><span class="lineno"> 54</span> Loader:create_namespace and Loader.fill_namespace calls this function</div>
|
|
<div class="line"><a id="l00055" name="l00055"></a><span class="lineno"> 55</span> when things are really put into an L4Re::Namespace.</div>
|
|
<div class="line"><a id="l00056" name="l00056"></a><span class="lineno"> 56</span> </div>
|
|
<div class="line"><a id="l00057" name="l00057"></a><span class="lineno"> 57</span> </div>
|
|
<div class="line"><a id="l00058" name="l00058"></a><span class="lineno"> 58</span>register(name, cap), or r(name, cap)</div>
|
|
<div class="line"><a id="l00059" name="l00059"></a><span class="lineno"> 59</span> </div>
|
|
<div class="line"><a id="l00060" name="l00060"></a><span class="lineno"> 60</span> Registers the given object capability under the given name. cap can</div>
|
|
<div class="line"><a id="l00061" name="l00061"></a><span class="lineno"> 61</span> be either a real capability (note query returns a function), a string, or</div>
|
|
<div class="line"><a id="l00062" name="l00062"></a><span class="lineno"> 62</span> nil. If it is a capability it is just put into the name space.</div>
|
|
<div class="line"><a id="l00063" name="l00063"></a><span class="lineno"> 63</span> In the case cap is a string a placeholder will be put into the name space</div>
|
|
<div class="line"><a id="l00064" name="l00064"></a><span class="lineno"> 64</span> that will be replaced with a real capability later by some program.</div>
|
|
<div class="line"><a id="l00065" name="l00065"></a><span class="lineno"> 65</span> And if nil is use the name will be deleted from the name space.</div>
|
|
<div class="line"><a id="l00066" name="l00066"></a><span class="lineno"> 66</span> </div>
|
|
<div class="line"><a id="l00067" name="l00067"></a><span class="lineno"> 67</span> </div>
|
|
<div class="line"><a id="l00068" name="l00068"></a><span class="lineno"> 68</span>L4::Factory object</div>
|
|
<div class="line"><a id="l00069" name="l00069"></a><span class="lineno"> 69</span>==================</div>
|
|
<div class="line"><a id="l00070" name="l00070"></a><span class="lineno"> 70</span> </div>
|
|
<div class="line"><a id="l00071" name="l00071"></a><span class="lineno"> 71</span>The factory object provides an interface to the generic create method of a</div>
|
|
<div class="line"><a id="l00072" name="l00072"></a><span class="lineno"> 72</span>factory.</div>
|
|
<div class="line"><a id="l00073" name="l00073"></a><span class="lineno"> 73</span> </div>
|
|
<div class="line"><a id="l00074" name="l00074"></a><span class="lineno"> 74</span>create(proto, ...)</div>
|
|
<div class="line"><a id="l00075" name="l00075"></a><span class="lineno"> 75</span> </div>
|
|
<div class="line"><a id="l00076" name="l00076"></a><span class="lineno"> 76</span> This method calls the factory to create an object of the given type,</div>
|
|
<div class="line"><a id="l00077" name="l00077"></a><span class="lineno"> 77</span> via the L4 protocol number (see L4.Proto table for more) all further</div>
|
|
<div class="line"><a id="l00078" name="l00078"></a><span class="lineno"> 78</span> arguments are passed to the factory.</div>
|
|
<div class="line"><a id="l00079" name="l00079"></a><span class="lineno"> 79</span> </div>
|
|
<div class="line"><a id="l00080" name="l00080"></a><span class="lineno"> 80</span> </div>
|
|
<div class="line"><a id="l00081" name="l00081"></a><span class="lineno"> 81</span>Access to the L4Re Env capabilities</div>
|
|
<div class="line"><a id="l00082" name="l00082"></a><span class="lineno"> 82</span>===================================</div>
|
|
<div class="line"><a id="l00083" name="l00083"></a><span class="lineno"> 83</span> </div>
|
|
<div class="line"><a id="l00084" name="l00084"></a><span class="lineno"> 84</span>The L4 module defines a table L4.Env that contains the capabilities</div>
|
|
<div class="line"><a id="l00085" name="l00085"></a><span class="lineno"> 85</span>of the L4Re::Env::env() environment. Namely:</div>
|
|
<div class="line"><a id="l00086" name="l00086"></a><span class="lineno"> 86</span> </div>
|
|
<div class="line"><a id="l00087" name="l00087"></a><span class="lineno"> 87</span>factory The kernel factory of Ned</div>
|
|
<div class="line"><a id="l00088" name="l00088"></a><span class="lineno"> 88</span>log The log object of Ned</div>
|
|
<div class="line"><a id="l00089" name="l00089"></a><span class="lineno"> 89</span>user_factory The factory provided to Ned, including memory</div>
|
|
<div class="line"><a id="l00090" name="l00090"></a><span class="lineno"> 90</span>parent The parent of Ned</div>
|
|
<div class="line"><a id="l00091" name="l00091"></a><span class="lineno"> 91</span>rm The region map of Ned</div>
|
|
<div class="line"><a id="l00092" name="l00092"></a><span class="lineno"> 92</span>scheduler The scheduler of Ned</div>
|
|
<div class="line"><a id="l00093" name="l00093"></a><span class="lineno"> 93</span> </div>
|
|
<div class="line"><a id="l00094" name="l00094"></a><span class="lineno"> 94</span> </div>
|
|
<div class="line"><a id="l00095" name="l00095"></a><span class="lineno"> 95</span>Some useful constants</div>
|
|
<div class="line"><a id="l00096" name="l00096"></a><span class="lineno"> 96</span>=====================</div>
|
|
<div class="line"><a id="l00097" name="l00097"></a><span class="lineno"> 97</span> </div>
|
|
<div class="line"><a id="l00098" name="l00098"></a><span class="lineno"> 98</span>L4.Proto table contains the most important protocol values for</div>
|
|
<div class="line"><a id="l00099" name="l00099"></a><span class="lineno"> 99</span>L4 and L4Re objects.</div>
|
|
<div class="line"><a id="l00100" name="l00100"></a><span class="lineno"> 100</span> </div>
|
|
<div class="line"><a id="l00101" name="l00101"></a><span class="lineno"> 101</span> Namespace</div>
|
|
<div class="line"><a id="l00102" name="l00102"></a><span class="lineno"> 102</span> Goos</div>
|
|
<div class="line"><a id="l00103" name="l00103"></a><span class="lineno"> 103</span> Rm</div>
|
|
<div class="line"><a id="l00104" name="l00104"></a><span class="lineno"> 104</span> Irq</div>
|
|
<div class="line"><a id="l00105" name="l00105"></a><span class="lineno"> 105</span> Sigma0</div>
|
|
<div class="line"><a id="l00106" name="l00106"></a><span class="lineno"> 106</span> Factory</div>
|
|
<div class="line"><a id="l00107" name="l00107"></a><span class="lineno"> 107</span> Log</div>
|
|
<div class="line"><a id="l00108" name="l00108"></a><span class="lineno"> 108</span> Scheduler</div>
|
|
<div class="line"><a id="l00109" name="l00109"></a><span class="lineno"> 109</span> </div>
|
|
<div class="line"><a id="l00110" name="l00110"></a><span class="lineno"> 110</span>The L4.Info table contains the following functions:</div>
|
|
<div class="line"><a id="l00111" name="l00111"></a><span class="lineno"> 111</span> </div>
|
|
<div class="line"><a id="l00112" name="l00112"></a><span class="lineno"> 112</span> Kip.str() The banner string found in the kernel info page</div>
|
|
<div class="line"><a id="l00113" name="l00113"></a><span class="lineno"> 113</span> arch() Architecture name, such as: x86, amd64, arm, ppc32</div>
|
|
<div class="line"><a id="l00114" name="l00114"></a><span class="lineno"> 114</span> platform() Platform name, such as: pc, ux, realview, beagleboard</div>
|
|
<div class="line"><a id="l00115" name="l00115"></a><span class="lineno"> 115</span> mword_bits() Number of native machine word bits (32, 64)</div>
|
|
<div class="line"><a id="l00116" name="l00116"></a><span class="lineno"> 116</span> </div>
|
|
<div class="line"><a id="l00117" name="l00117"></a><span class="lineno"> 117</span> </div>
|
|
<div class="line"><a id="l00118" name="l00118"></a><span class="lineno"> 118</span>Support for starting L4 programs</div>
|
|
<div class="line"><a id="l00119" name="l00119"></a><span class="lineno"> 119</span>================================</div>
|
|
<div class="line"><a id="l00120" name="l00120"></a><span class="lineno"> 120</span> </div>
|
|
<div class="line"><a id="l00121" name="l00121"></a><span class="lineno"> 121</span>The L4 module defines two classes that are useful for starting L4 applications.</div>
|
|
<div class="line"><a id="l00122" name="l00122"></a><span class="lineno"> 122</span>The class L4.Loader that encapsulates a fairly high level policy</div>
|
|
<div class="line"><a id="l00123" name="l00123"></a><span class="lineno"> 123</span>that is useful for starting a whole set of processes. And the class L4.App_env</div>
|
|
<div class="line"><a id="l00124" name="l00124"></a><span class="lineno"> 124</span>that encapsulates a more fine-grained policy.</div>
|
|
<div class="line"><a id="l00125" name="l00125"></a><span class="lineno"> 125</span> </div>
|
|
<div class="line"><a id="l00126" name="l00126"></a><span class="lineno"> 126</span>L4.Loader</div>
|
|
<div class="line"><a id="l00127" name="l00127"></a><span class="lineno"> 127</span>---------</div>
|
|
<div class="line"><a id="l00128" name="l00128"></a><span class="lineno"> 128</span> </div>
|
|
<div class="line"><a id="l00129" name="l00129"></a><span class="lineno"> 129</span>The class L4.Loader encapsulates the policy for starting programs with the</div>
|
|
<div class="line"><a id="l00130" name="l00130"></a><span class="lineno"> 130</span>basic building blocks for the application coming from a dedicated loader,</div>
|
|
<div class="line"><a id="l00131" name="l00131"></a><span class="lineno"> 131</span>such as Moe or a Loader instance. These building blocks are a region map (Rm),</div>
|
|
<div class="line"><a id="l00132" name="l00132"></a><span class="lineno"> 132</span>a scheduler, a memory allocator, and a logging facility.</div>
|
|
<div class="line"><a id="l00133" name="l00133"></a><span class="lineno"> 133</span>A L4.Loader object is typically used to start multiple applications. There</div>
|
|
<div class="line"><a id="l00134" name="l00134"></a><span class="lineno"> 134</span>is a L4.default_loader instance of L4.Loader that uses the L4.Env.mem_alloc</div>
|
|
<div class="line"><a id="l00135" name="l00135"></a><span class="lineno"> 135</span>factory of the current Ned instance to create the objects for a new program.</div>
|
|
<div class="line"><a id="l00136" name="l00136"></a><span class="lineno"> 136</span>However you may also use a more restricted factory for applications and</div>
|
|
<div class="line"><a id="l00137" name="l00137"></a><span class="lineno"> 137</span>instantiate a loader for them. The L4.Loader objects can already be used</div>
|
|
<div class="line"><a id="l00138" name="l00138"></a><span class="lineno"> 138</span>to start a program with L4.Loader:start(app_spec, cmd, ...). Where app_spec</div>
|
|
<div class="line"><a id="l00139" name="l00139"></a><span class="lineno"> 139</span>is a table containing parameters for the new application. cmd is the</div>
|
|
<div class="line"><a id="l00140" name="l00140"></a><span class="lineno"> 140</span>command to run and the remaining arguments are the command-line options for</div>
|
|
<div class="line"><a id="l00141" name="l00141"></a><span class="lineno"> 141</span>the application.</div>
|
|
<div class="line"><a id="l00142" name="l00142"></a><span class="lineno"> 142</span> </div>
|
|
<div class="line"><a id="l00143" name="l00143"></a><span class="lineno"> 143</span>]==]</div>
|
|
<div class="line"><a id="l00144" name="l00144"></a><span class="lineno"> 144</span> </div>
|
|
<div class="line"><a id="l00145" name="l00145"></a><span class="lineno"> 145</span>L4.default_loader:start({}, "rom/hello");</div>
|
|
<div class="line"><a id="l00146" name="l00146"></a><span class="lineno"> 146</span> </div>
|
|
<div class="line"><a id="l00147" name="l00147"></a><span class="lineno"> 147</span>local _doc = [==[</div>
|
|
<div class="line"><a id="l00148" name="l00148"></a><span class="lineno"> 148</span> </div>
|
|
<div class="line"><a id="l00149" name="l00149"></a><span class="lineno"> 149</span>This statement does the following:</div>
|
|
<div class="line"><a id="l00150" name="l00150"></a><span class="lineno"> 150</span> 1. Create a new environment for the application</div>
|
|
<div class="line"><a id="l00151" name="l00151"></a><span class="lineno"> 151</span> 2. Add the rom name-space into the new environment (thus shares Ned's</div>
|
|
<div class="line"><a id="l00152" name="l00152"></a><span class="lineno"> 152</span> 'rom' directory with the new program).</div>
|
|
<div class="line"><a id="l00153" name="l00153"></a><span class="lineno"> 153</span> 3. Creates all the building blocks for the new process and starts the</div>
|
|
<div class="line"><a id="l00154" name="l00154"></a><span class="lineno"> 154</span> 'l4re' support kernel in the new process which in turn starts 'rom/hello'</div>
|
|
<div class="line"><a id="l00155" name="l00155"></a><span class="lineno"> 155</span> in the new process.</div>
|
|
<div class="line"><a id="l00156" name="l00156"></a><span class="lineno"> 156</span> </div>
|
|
<div class="line"><a id="l00157" name="l00157"></a><span class="lineno"> 157</span>Using the app_spec parameter you can modify the behavior in two ways. There are</div>
|
|
<div class="line"><a id="l00158" name="l00158"></a><span class="lineno"> 158</span>two supported options 'caps' for providing more capabilities for the</div>
|
|
<div class="line"><a id="l00159" name="l00159"></a><span class="lineno"> 159</span>application. And 'log' for modifying the logger tag and color.</div>
|
|
<div class="line"><a id="l00160" name="l00160"></a><span class="lineno"> 160</span> </div>
|
|
<div class="line"><a id="l00161" name="l00161"></a><span class="lineno"> 161</span>]==]</div>
|
|
<div class="line"><a id="l00162" name="l00162"></a><span class="lineno"> 162</span> </div>
|
|
<div class="line"><a id="l00163" name="l00163"></a><span class="lineno"> 163</span>local my_caps = {</div>
|
|
<div class="line"><a id="l00164" name="l00164"></a><span class="lineno"> 164</span> fb = L4.Env.vesa;</div>
|
|
<div class="line"><a id="l00165" name="l00165"></a><span class="lineno"> 165</span>};</div>
|
|
<div class="line"><a id="l00166" name="l00166"></a><span class="lineno"> 166</span> </div>
|
|
<div class="line"><a id="l00167" name="l00167"></a><span class="lineno"> 167</span>L4.default_loader:start({caps = my_caps, log = {"APP", "blue"}}, "rom/hello");</div>
|
|
<div class="line"><a id="l00168" name="l00168"></a><span class="lineno"> 168</span> </div>
|
|
<div class="line"><a id="l00169" name="l00169"></a><span class="lineno"> 169</span>local _doc = [==[</div>
|
|
<div class="line"><a id="l00170" name="l00170"></a><span class="lineno"> 170</span> </div>
|
|
<div class="line"><a id="l00171" name="l00171"></a><span class="lineno"> 171</span>This snippet creates a caps template (my_caps) and uses it for the</div>
|
|
<div class="line"><a id="l00172" name="l00172"></a><span class="lineno"> 172</span>new process and also sets user-defined log tags. The L4.Loader:start method,</div>
|
|
<div class="line"><a id="l00173" name="l00173"></a><span class="lineno"> 173</span>however, automatically adds the 'rom' directory to the caps environment if</div>
|
|
<div class="line"><a id="l00174" name="l00174"></a><span class="lineno"> 174</span>not already specified in the template.</div>
|
|
<div class="line"><a id="l00175" name="l00175"></a><span class="lineno"> 175</span> </div>
|
|
<div class="line"><a id="l00176" name="l00176"></a><span class="lineno"> 176</span>Environment variables may be given as a table in the third argument to</div>
|
|
<div class="line"><a id="l00177" name="l00177"></a><span class="lineno"> 177</span>start. Argument to the program are given space separated after the program</div>
|
|
<div class="line"><a id="l00178" name="l00178"></a><span class="lineno"> 178</span>name within a single string.</div>
|
|
<div class="line"><a id="l00179" name="l00179"></a><span class="lineno"> 179</span> </div>
|
|
<div class="line"><a id="l00180" name="l00180"></a><span class="lineno"> 180</span>]==]</div>
|
|
<div class="line"><a id="l00181" name="l00181"></a><span class="lineno"> 181</span> </div>
|
|
<div class="line"><a id="l00182" name="l00182"></a><span class="lineno"> 182</span>L4.default_loader:start({}, "rom/program arg1 " .. arg2, { LD_DEBUG = 1 });</div>
|
|
<div class="line"><a id="l00183" name="l00183"></a><span class="lineno"> 183</span> </div>
|
|
<div class="line"><a id="l00184" name="l00184"></a><span class="lineno"> 184</span>local _doc = [==[</div>
|
|
<div class="line"><a id="l00185" name="l00185"></a><span class="lineno"> 185</span> </div>
|
|
<div class="line"><a id="l00186" name="l00186"></a><span class="lineno"> 186</span>L4.default_loader:startv is a variant of the start function that takes the</div>
|
|
<div class="line"><a id="l00187" name="l00187"></a><span class="lineno"> 187</span>arguments of the program as a single argument each. If the last argument to</div>
|
|
<div class="line"><a id="l00188" name="l00188"></a><span class="lineno"> 188</span>startv is a table it is interpreted as environment variables for the program.</div>
|
|
<div class="line"><a id="l00189" name="l00189"></a><span class="lineno"> 189</span>The above example would translate to:</div>
|
|
<div class="line"><a id="l00190" name="l00190"></a><span class="lineno"> 190</span> </div>
|
|
<div class="line"><a id="l00191" name="l00191"></a><span class="lineno"> 191</span>]==]</div>
|
|
<div class="line"><a id="l00192" name="l00192"></a><span class="lineno"> 192</span> </div>
|
|
<div class="line"><a id="l00193" name="l00193"></a><span class="lineno"> 193</span>L4.default_loader:startv({}, "rom/program", "arg1", arg2, { LD_DEBUG = 1 });</div>
|
|
<div class="line"><a id="l00194" name="l00194"></a><span class="lineno"> 194</span> </div>
|
|
<div class="line"><a id="l00195" name="l00195"></a><span class="lineno"> 195</span>local _doc = [==[</div>
|
|
<div class="line"><a id="l00196" name="l00196"></a><span class="lineno"> 196</span> </div>
|
|
<div class="line"><a id="l00197" name="l00197"></a><span class="lineno"> 197</span>To create a new L4.Loader instance you may use a generic factory for all</div>
|
|
<div class="line"><a id="l00198" name="l00198"></a><span class="lineno"> 198</span>building blocks or set individual factories.</div>
|
|
<div class="line"><a id="l00199" name="l00199"></a><span class="lineno"> 199</span> </div>
|
|
<div class="line"><a id="l00200" name="l00200"></a><span class="lineno"> 200</span>]==]</div>
|
|
<div class="line"><a id="l00201" name="l00201"></a><span class="lineno"> 201</span> </div>
|
|
<div class="line"><a id="l00202" name="l00202"></a><span class="lineno"> 202</span>l = L4.Loader.new({</div>
|
|
<div class="line"><a id="l00203" name="l00203"></a><span class="lineno"> 203</span> mem = L4.Env.user_factory:create(L4.Proto.Factory, 512*1024):m("rs")</div>
|
|
<div class="line"><a id="l00204" name="l00204"></a><span class="lineno"> 204</span>});</div>
|
|
<div class="line"><a id="l00205" name="l00205"></a><span class="lineno"> 205</span> </div>
|
|
<div class="line"><a id="l00206" name="l00206"></a><span class="lineno"> 206</span>local _doc = [==[</div>
|
|
<div class="line"><a id="l00207" name="l00207"></a><span class="lineno"> 207</span> </div>
|
|
<div class="line"><a id="l00208" name="l00208"></a><span class="lineno"> 208</span>Creates a loader instance that uses the newly created 512 KB factory for</div>
|
|
<div class="line"><a id="l00209" name="l00209"></a><span class="lineno"> 209</span>all building blocks. To set individual factories use the options:</div>
|
|
<div class="line"><a id="l00210" name="l00210"></a><span class="lineno"> 210</span> 'mem' as memory allocator for the new processes and as</div>
|
|
<div class="line"><a id="l00211" name="l00211"></a><span class="lineno"> 211</span> default factory for all objects not explicitely set to a</div>
|
|
<div class="line"><a id="l00212" name="l00212"></a><span class="lineno"> 212</span> different factory</div>
|
|
<div class="line"><a id="l00213" name="l00213"></a><span class="lineno"> 213</span> 'log_fab' for creating log objects.</div>
|
|
<div class="line"><a id="l00214" name="l00214"></a><span class="lineno"> 214</span> 'ns_fab' for creating name-space objects.</div>
|
|
<div class="line"><a id="l00215" name="l00215"></a><span class="lineno"> 215</span> 'rm_fab' for creating region-map objects.</div>
|
|
<div class="line"><a id="l00216" name="l00216"></a><span class="lineno"> 216</span> </div>
|
|
<div class="line"><a id="l00217" name="l00217"></a><span class="lineno"> 217</span> </div>
|
|
<div class="line"><a id="l00218" name="l00218"></a><span class="lineno"> 218</span> </div>
|
|
<div class="line"><a id="l00219" name="l00219"></a><span class="lineno"> 219</span>L4.App_env</div>
|
|
<div class="line"><a id="l00220" name="l00220"></a><span class="lineno"> 220</span>----------</div>
|
|
<div class="line"><a id="l00221" name="l00221"></a><span class="lineno"> 221</span> </div>
|
|
<div class="line"><a id="l00222" name="l00222"></a><span class="lineno"> 222</span>L4.App_env provides a more fine-grained control for a single process or for a</div>
|
|
<div class="line"><a id="l00223" name="l00223"></a><span class="lineno"> 223</span>limited number of processes. L4.App_env uses an L4.Loader object as basic</div>
|
|
<div class="line"><a id="l00224" name="l00224"></a><span class="lineno"> 224</span>facility. However you can override the memory allocator 'mem' for for the new</div>
|
|
<div class="line"><a id="l00225" name="l00225"></a><span class="lineno"> 225</span>process as well as the kernel factory 'factory', the log capability etc.</div>
|
|
<div class="line"><a id="l00226" name="l00226"></a><span class="lineno"> 226</span> </div>
|
|
<div class="line"><a id="l00227" name="l00227"></a><span class="lineno"> 227</span>]==]</div>
|
|
<div class="line"><a id="l00228" name="l00228"></a><span class="lineno"> 228</span> </div>
|
|
<div class="line"><a id="l00229" name="l00229"></a><span class="lineno"> 229</span>local e = L4.App_env.new({</div>
|
|
<div class="line"><a id="l00230" name="l00230"></a><span class="lineno"> 230</span> loader = l,</div>
|
|
<div class="line"><a id="l00231" name="l00231"></a><span class="lineno"> 231</span> mem = L4.Env.user_factory:create(L4.Proto.Factory, 128*1024):m("rs")</div>
|
|
<div class="line"><a id="l00232" name="l00232"></a><span class="lineno"> 232</span>});</div>
|
|
<div class="line"><a id="l00233" name="l00233"></a><span class="lineno"> 233</span> </div>
|
|
<div class="line"><a id="l00234" name="l00234"></a><span class="lineno"> 234</span>e:start("rom/hello");</div>
|
|
</div><!-- fragment --></div><!-- contents -->
|
|
</div><!-- doc-content -->
|
|
</div><!-- container -->
|
|
<!-- HTML footer for doxygen 1.9.1-->
|
|
<!-- start footer part -->
|
|
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
|
|
<ul>
|
|
<li class="navelem"><b>pkg</b></li><li class="navelem"><b>l4re-core</b></li><li class="navelem"><b>ned</b></li><li class="navelem"><b>doc</b></li><li class="navelem"><b>tutorial.lua</b></li>
|
|
<li class="footer">Generated on <span class="timestamp"></span> for L4Re Operating System Framework by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.15.0 </li>
|
|
</ul>
|
|
</div>
|
|
</body>
|
|
</html>
|