Skip to content

Commit

Permalink
Updated documentation
Browse files Browse the repository at this point in the history
Signed-off-by: Github Action <[email protected]>
  • Loading branch information
Github Action committed Dec 12, 2023
1 parent ae339c8 commit 99d5622
Show file tree
Hide file tree
Showing 2 changed files with 36 additions and 42 deletions.
3 changes: 1 addition & 2 deletions ebpf__store__helper_8h.html
Original file line number Diff line number Diff line change
Expand Up @@ -75,9 +75,8 @@
</div><!--header-->
<div class="contents">
<div class="textblock"><code>#include &quot;<a class="el" href="ebpf__program__types_8h_source.html">ebpf_program_types.h</a>&quot;</code><br />
<code>#include &quot;<a class="el" href="ebpf__utilities_8h_source.html">ebpf_utilities.h</a>&quot;</code><br />
<code>#include &quot;<a class="el" href="ebpf__windows_8h_source.html">ebpf_windows.h</a>&quot;</code><br />
<code>#include &lt;ntifs.h&gt;</code><br />
<code>#include &lt;minwindef.h&gt;</code><br />
</div>
<p><a href="ebpf__store__helper_8h_source.html">Go to the source code of this file.</a></p>
<table class="memberdecls">
Expand Down
75 changes: 35 additions & 40 deletions ebpf__store__helper_8h_source.html
Original file line number Diff line number Diff line change
Expand Up @@ -75,52 +75,47 @@
<div class="line"><a name="l00004"></a><span class="lineno"> 4</span>&#160;<span class="preprocessor">#pragma once</span></div>
<div class="line"><a name="l00005"></a><span class="lineno"> 5</span>&#160; </div>
<div class="line"><a name="l00006"></a><span class="lineno"> 6</span>&#160;<span class="preprocessor">#include &quot;<a class="code" href="ebpf__program__types_8h.html">ebpf_program_types.h</a>&quot;</span></div>
<div class="line"><a name="l00007"></a><span class="lineno"> 7</span>&#160;<span class="preprocessor">#include &quot;<a class="code" href="ebpf__windows_8h.html">ebpf_windows.h</a>&quot;</span></div>
<div class="line"><a name="l00008"></a><span class="lineno"> 8</span>&#160;<span class="preprocessor">#ifdef USER_MODE</span></div>
<div class="line"><a name="l00009"></a><span class="lineno"> 9</span>&#160;<span class="preprocessor">#include &quot;<a class="code" href="ebpf__utilities_8h.html">ebpf_utilities.h</a>&quot;</span></div>
<div class="line"><a name="l00010"></a><span class="lineno"> 10</span>&#160;<span class="preprocessor">#else</span></div>
<div class="line"><a name="l00011"></a><span class="lineno"> 11</span>&#160;<span class="preprocessor">#include &lt;ntifs.h&gt;</span></div>
<div class="line"><a name="l00012"></a><span class="lineno"> 12</span>&#160;<span class="preprocessor">#include &lt;minwindef.h&gt;</span></div>
<div class="line"><a name="l00013"></a><span class="lineno"> 13</span>&#160;<span class="preprocessor">#endif</span></div>
<div class="line"><a name="l00014"></a><span class="lineno"> 14</span>&#160; </div>
<div class="line"><a name="l00015"></a><span class="lineno"><a class="line" href="ebpf__store__helper_8h.html#a873c1dcbf8d78289e723e355b127a800"> 15</a></span>&#160;<span class="preprocessor">#define GUID_STRING_LENGTH 38 </span><span class="comment">// not including the null terminator.</span></div>
<div class="line"><a name="l00007"></a><span class="lineno"> 7</span>&#160;<span class="preprocessor">#include &quot;<a class="code" href="ebpf__utilities_8h.html">ebpf_utilities.h</a>&quot;</span></div>
<div class="line"><a name="l00008"></a><span class="lineno"> 8</span>&#160;<span class="preprocessor">#include &quot;<a class="code" href="ebpf__windows_8h.html">ebpf_windows.h</a>&quot;</span></div>
<div class="line"><a name="l00009"></a><span class="lineno"> 9</span>&#160; </div>
<div class="line"><a name="l00010"></a><span class="lineno"><a class="line" href="ebpf__store__helper_8h.html#a873c1dcbf8d78289e723e355b127a800"> 10</a></span>&#160;<span class="preprocessor">#define GUID_STRING_LENGTH 38 </span><span class="comment">// not including the null terminator.</span></div>
<div class="line"><a name="l00011"></a><span class="lineno"> 11</span>&#160; </div>
<div class="line"><a name="l00012"></a><span class="lineno"> 12</span>&#160;<span class="preprocessor">#ifdef __cplusplus</span></div>
<div class="line"><a name="l00013"></a><span class="lineno"> 13</span>&#160;<span class="keyword">extern</span> <span class="stringliteral">&quot;C&quot;</span></div>
<div class="line"><a name="l00014"></a><span class="lineno"> 14</span>&#160;{</div>
<div class="line"><a name="l00015"></a><span class="lineno"> 15</span>&#160;<span class="preprocessor">#endif</span></div>
<div class="line"><a name="l00016"></a><span class="lineno"> 16</span>&#160; </div>
<div class="line"><a name="l00017"></a><span class="lineno"> 17</span>&#160;<span class="preprocessor">#ifdef __cplusplus</span></div>
<div class="line"><a name="l00018"></a><span class="lineno"> 18</span>&#160;<span class="keyword">extern</span> <span class="stringliteral">&quot;C&quot;</span></div>
<div class="line"><a name="l00019"></a><span class="lineno"> 19</span>&#160;{</div>
<div class="line"><a name="l00020"></a><span class="lineno"> 20</span>&#160;<span class="preprocessor">#endif</span></div>
<div class="line"><a name="l00017"></a><span class="lineno"><a class="line" href="ebpf__store__helper_8h.html#a2c2cbb58cc8cc7afd7f1e5177b6680b7"> 17</a></span>&#160; <span class="keyword">typedef</span> HKEY <a class="code" href="ebpf__store__helper_8h.html#a2c2cbb58cc8cc7afd7f1e5177b6680b7">ebpf_store_key_t</a>;</div>
<div class="line"><a name="l00018"></a><span class="lineno"> 18</span>&#160; </div>
<div class="line"><a name="l00019"></a><span class="lineno"> 19</span>&#160; <span class="keyword">extern</span> <a class="code" href="ebpf__store__helper_8h.html#a2c2cbb58cc8cc7afd7f1e5177b6680b7">ebpf_store_key_t</a> <a class="code" href="ebpf__store__helper_8h.html#a8013dd95cb462116d0de4432db68b77d">ebpf_store_root_key</a>;</div>
<div class="line"><a name="l00020"></a><span class="lineno"> 20</span>&#160; <span class="keyword">extern</span> <span class="keyword">const</span> <span class="keywordtype">wchar_t</span>* <a class="code" href="ebpf__store__helper_8h.html#abeb6d9f3883dcd0f30a8446e1a8012e7">ebpf_store_root_sub_key</a>;</div>
<div class="line"><a name="l00021"></a><span class="lineno"> 21</span>&#160; </div>
<div class="line"><a name="l00022"></a><span class="lineno"><a class="line" href="ebpf__store__helper_8h.html#a2c2cbb58cc8cc7afd7f1e5177b6680b7"> 22</a></span>&#160; <span class="keyword">typedef</span> HKEY <a class="code" href="ebpf__store__helper_8h.html#a2c2cbb58cc8cc7afd7f1e5177b6680b7">ebpf_store_key_t</a>;</div>
<div class="line"><a name="l00023"></a><span class="lineno"> 23</span>&#160; </div>
<div class="line"><a name="l00024"></a><span class="lineno"> 24</span>&#160; <span class="keyword">extern</span> <a class="code" href="ebpf__store__helper_8h.html#a2c2cbb58cc8cc7afd7f1e5177b6680b7">ebpf_store_key_t</a> <a class="code" href="ebpf__store__helper_8h.html#a8013dd95cb462116d0de4432db68b77d">ebpf_store_root_key</a>;</div>
<div class="line"><a name="l00025"></a><span class="lineno"> 25</span>&#160; <span class="keyword">extern</span> <span class="keyword">const</span> <span class="keywordtype">wchar_t</span>* <a class="code" href="ebpf__store__helper_8h.html#abeb6d9f3883dcd0f30a8446e1a8012e7">ebpf_store_root_sub_key</a>;</div>
<div class="line"><a name="l00026"></a><span class="lineno"> 26</span>&#160; </div>
<div class="line"><a name="l00035"></a><span class="lineno"> 35</span>&#160; <a class="code" href="ebpf__result_8h.html#ac40fcf7ca8c88cd1975ade33fda0b333">ebpf_result_t</a></div>
<div class="line"><a name="l00036"></a><span class="lineno"><a class="line" href="ebpf__store__helper_8h.html#ac1f7c8f5ce16a53eebb619bd0ccc1030"> 36</a></span>&#160; <a class="code" href="ebpf__store__helper_8h.html#ac1f7c8f5ce16a53eebb619bd0ccc1030">ebpf_store_update_global_helper_information</a>(</div>
<div class="line"><a name="l00037"></a><span class="lineno"> 37</span>&#160; _In_reads_(helper_info_count) <a class="code" href="struct__ebpf__helper__function__prototype.html">ebpf_helper_function_prototype_t</a>* helper_info, uint32_t helper_info_count);</div>
<div class="line"><a name="l00038"></a><span class="lineno"> 38</span>&#160; </div>
<div class="line"><a name="l00047"></a><span class="lineno"> 47</span>&#160; <a class="code" href="ebpf__result_8h.html#ac40fcf7ca8c88cd1975ade33fda0b333">ebpf_result_t</a></div>
<div class="line"><a name="l00048"></a><span class="lineno"><a class="line" href="ebpf__store__helper_8h.html#a0acd3f23560694f25c0fe93bdb2a1f3c"> 48</a></span>&#160; <a class="code" href="ebpf__store__helper_8h.html#a0acd3f23560694f25c0fe93bdb2a1f3c">ebpf_store_update_section_information</a>(</div>
<div class="line"><a name="l00049"></a><span class="lineno"> 49</span>&#160; _In_reads_(section_info_count) <span class="keyword">const</span> <a class="code" href="struct__ebpf__program__section__info.html">ebpf_program_section_info_t</a>* section_info, uint32_t section_info_count);</div>
<div class="line"><a name="l00050"></a><span class="lineno"> 50</span>&#160; </div>
<div class="line"><a name="l00059"></a><span class="lineno"> 59</span>&#160; <a class="code" href="ebpf__result_8h.html#ac40fcf7ca8c88cd1975ade33fda0b333">ebpf_result_t</a></div>
<div class="line"><a name="l00060"></a><span class="lineno"><a class="line" href="ebpf__store__helper_8h.html#a1a661e8bc901c25198f88497db7fcbeb"> 60</a></span>&#160; <a class="code" href="ebpf__store__helper_8h.html#a1a661e8bc901c25198f88497db7fcbeb">ebpf_store_update_program_information</a>(</div>
<div class="line"><a name="l00061"></a><span class="lineno"> 61</span>&#160; _In_reads_(program_info_count) <span class="keyword">const</span> <a class="code" href="struct__ebpf__program__info.html">ebpf_program_info_t</a>* program_info, uint32_t program_info_count);</div>
<div class="line"><a name="l00062"></a><span class="lineno"> 62</span>&#160; </div>
<div class="line"><a name="l00070"></a><span class="lineno"> 70</span>&#160; <a class="code" href="ebpf__result_8h.html#ac40fcf7ca8c88cd1975ade33fda0b333">ebpf_result_t</a></div>
<div class="line"><a name="l00071"></a><span class="lineno"><a class="line" href="ebpf__store__helper_8h.html#a83060ad08f2e024d37d1c1673229db3c"> 71</a></span>&#160; <a class="code" href="ebpf__store__helper_8h.html#a83060ad08f2e024d37d1c1673229db3c">ebpf_store_delete_program_information</a>(_In_ <span class="keyword">const</span> <a class="code" href="struct__ebpf__program__info.html">ebpf_program_info_t</a>* program_info);</div>
<div class="line"><a name="l00072"></a><span class="lineno"> 72</span>&#160; </div>
<div class="line"><a name="l00080"></a><span class="lineno"> 80</span>&#160; <a class="code" href="ebpf__result_8h.html#ac40fcf7ca8c88cd1975ade33fda0b333">ebpf_result_t</a></div>
<div class="line"><a name="l00081"></a><span class="lineno"><a class="line" href="ebpf__store__helper_8h.html#ad5f74d4ca63d4db326791eecb87424dd"> 81</a></span>&#160; <a class="code" href="ebpf__store__helper_8h.html#ad5f74d4ca63d4db326791eecb87424dd">ebpf_store_delete_section_information</a>(_In_ <span class="keyword">const</span> <a class="code" href="struct__ebpf__program__section__info.html">ebpf_program_section_info_t</a>* section_info);</div>
<div class="line"><a name="l00082"></a><span class="lineno"> 82</span>&#160; </div>
<div class="line"><a name="l00083"></a><span class="lineno"> 83</span>&#160;<span class="preprocessor">#ifdef __cplusplus</span></div>
<div class="line"><a name="l00084"></a><span class="lineno"> 84</span>&#160;}</div>
<div class="line"><a name="l00085"></a><span class="lineno"> 85</span>&#160;<span class="preprocessor">#endif</span></div>
<div class="line"><a name="l00030"></a><span class="lineno"> 30</span>&#160; <a class="code" href="ebpf__result_8h.html#ac40fcf7ca8c88cd1975ade33fda0b333">ebpf_result_t</a></div>
<div class="line"><a name="l00031"></a><span class="lineno"><a class="line" href="ebpf__store__helper_8h.html#ac1f7c8f5ce16a53eebb619bd0ccc1030"> 31</a></span>&#160; <a class="code" href="ebpf__store__helper_8h.html#ac1f7c8f5ce16a53eebb619bd0ccc1030">ebpf_store_update_global_helper_information</a>(</div>
<div class="line"><a name="l00032"></a><span class="lineno"> 32</span>&#160; _In_reads_(helper_info_count) <a class="code" href="struct__ebpf__helper__function__prototype.html">ebpf_helper_function_prototype_t</a>* helper_info, uint32_t helper_info_count);</div>
<div class="line"><a name="l00033"></a><span class="lineno"> 33</span>&#160; </div>
<div class="line"><a name="l00042"></a><span class="lineno"> 42</span>&#160; <a class="code" href="ebpf__result_8h.html#ac40fcf7ca8c88cd1975ade33fda0b333">ebpf_result_t</a></div>
<div class="line"><a name="l00043"></a><span class="lineno"><a class="line" href="ebpf__store__helper_8h.html#a0acd3f23560694f25c0fe93bdb2a1f3c"> 43</a></span>&#160; <a class="code" href="ebpf__store__helper_8h.html#a0acd3f23560694f25c0fe93bdb2a1f3c">ebpf_store_update_section_information</a>(</div>
<div class="line"><a name="l00044"></a><span class="lineno"> 44</span>&#160; _In_reads_(section_info_count) <span class="keyword">const</span> <a class="code" href="struct__ebpf__program__section__info.html">ebpf_program_section_info_t</a>* section_info, uint32_t section_info_count);</div>
<div class="line"><a name="l00045"></a><span class="lineno"> 45</span>&#160; </div>
<div class="line"><a name="l00054"></a><span class="lineno"> 54</span>&#160; <a class="code" href="ebpf__result_8h.html#ac40fcf7ca8c88cd1975ade33fda0b333">ebpf_result_t</a></div>
<div class="line"><a name="l00055"></a><span class="lineno"><a class="line" href="ebpf__store__helper_8h.html#a1a661e8bc901c25198f88497db7fcbeb"> 55</a></span>&#160; <a class="code" href="ebpf__store__helper_8h.html#a1a661e8bc901c25198f88497db7fcbeb">ebpf_store_update_program_information</a>(</div>
<div class="line"><a name="l00056"></a><span class="lineno"> 56</span>&#160; _In_reads_(program_info_count) <span class="keyword">const</span> <a class="code" href="struct__ebpf__program__info.html">ebpf_program_info_t</a>* program_info, uint32_t program_info_count);</div>
<div class="line"><a name="l00057"></a><span class="lineno"> 57</span>&#160; </div>
<div class="line"><a name="l00065"></a><span class="lineno"> 65</span>&#160; <a class="code" href="ebpf__result_8h.html#ac40fcf7ca8c88cd1975ade33fda0b333">ebpf_result_t</a></div>
<div class="line"><a name="l00066"></a><span class="lineno"><a class="line" href="ebpf__store__helper_8h.html#a83060ad08f2e024d37d1c1673229db3c"> 66</a></span>&#160; <a class="code" href="ebpf__store__helper_8h.html#a83060ad08f2e024d37d1c1673229db3c">ebpf_store_delete_program_information</a>(_In_ <span class="keyword">const</span> <a class="code" href="struct__ebpf__program__info.html">ebpf_program_info_t</a>* program_info);</div>
<div class="line"><a name="l00067"></a><span class="lineno"> 67</span>&#160; </div>
<div class="line"><a name="l00075"></a><span class="lineno"> 75</span>&#160; <a class="code" href="ebpf__result_8h.html#ac40fcf7ca8c88cd1975ade33fda0b333">ebpf_result_t</a></div>
<div class="line"><a name="l00076"></a><span class="lineno"><a class="line" href="ebpf__store__helper_8h.html#ad5f74d4ca63d4db326791eecb87424dd"> 76</a></span>&#160; <a class="code" href="ebpf__store__helper_8h.html#ad5f74d4ca63d4db326791eecb87424dd">ebpf_store_delete_section_information</a>(_In_ <span class="keyword">const</span> <a class="code" href="struct__ebpf__program__section__info.html">ebpf_program_section_info_t</a>* section_info);</div>
<div class="line"><a name="l00077"></a><span class="lineno"> 77</span>&#160; </div>
<div class="line"><a name="l00078"></a><span class="lineno"> 78</span>&#160;<span class="preprocessor">#ifdef __cplusplus</span></div>
<div class="line"><a name="l00079"></a><span class="lineno"> 79</span>&#160;}</div>
<div class="line"><a name="l00080"></a><span class="lineno"> 80</span>&#160;<span class="preprocessor">#endif</span></div>
<div class="ttc" id="aebpf__program__types_8h_html"><div class="ttname"><a href="ebpf__program__types_8h.html">ebpf_program_types.h</a></div></div>
<div class="ttc" id="aebpf__result_8h_html_ac40fcf7ca8c88cd1975ade33fda0b333"><div class="ttname"><a href="ebpf__result_8h.html#ac40fcf7ca8c88cd1975ade33fda0b333">ebpf_result_t</a></div><div class="ttdeci">enum ebpf_result ebpf_result_t</div></div>
<div class="ttc" id="aebpf__store__helper_8h_html_a0acd3f23560694f25c0fe93bdb2a1f3c"><div class="ttname"><a href="ebpf__store__helper_8h.html#a0acd3f23560694f25c0fe93bdb2a1f3c">ebpf_store_update_section_information</a></div><div class="ttdeci">ebpf_result_t ebpf_store_update_section_information(_In_reads_(section_info_count) const ebpf_program_section_info_t *section_info, uint32_t section_info_count)</div><div class="ttdoc">Update section information in the eBPF store.</div></div>
<div class="ttc" id="aebpf__store__helper_8h_html_a1a661e8bc901c25198f88497db7fcbeb"><div class="ttname"><a href="ebpf__store__helper_8h.html#a1a661e8bc901c25198f88497db7fcbeb">ebpf_store_update_program_information</a></div><div class="ttdeci">ebpf_result_t ebpf_store_update_program_information(_In_reads_(program_info_count) const ebpf_program_info_t *program_info, uint32_t program_info_count)</div><div class="ttdoc">Update program information in the eBPF store.</div></div>
<div class="ttc" id="aebpf__store__helper_8h_html_a2c2cbb58cc8cc7afd7f1e5177b6680b7"><div class="ttname"><a href="ebpf__store__helper_8h.html#a2c2cbb58cc8cc7afd7f1e5177b6680b7">ebpf_store_key_t</a></div><div class="ttdeci">HKEY ebpf_store_key_t</div><div class="ttdef"><b>Definition:</b> ebpf_store_helper.h:22</div></div>
<div class="ttc" id="aebpf__store__helper_8h_html_a2c2cbb58cc8cc7afd7f1e5177b6680b7"><div class="ttname"><a href="ebpf__store__helper_8h.html#a2c2cbb58cc8cc7afd7f1e5177b6680b7">ebpf_store_key_t</a></div><div class="ttdeci">HKEY ebpf_store_key_t</div><div class="ttdef"><b>Definition:</b> ebpf_store_helper.h:17</div></div>
<div class="ttc" id="aebpf__store__helper_8h_html_a8013dd95cb462116d0de4432db68b77d"><div class="ttname"><a href="ebpf__store__helper_8h.html#a8013dd95cb462116d0de4432db68b77d">ebpf_store_root_key</a></div><div class="ttdeci">ebpf_store_key_t ebpf_store_root_key</div></div>
<div class="ttc" id="aebpf__store__helper_8h_html_a83060ad08f2e024d37d1c1673229db3c"><div class="ttname"><a href="ebpf__store__helper_8h.html#a83060ad08f2e024d37d1c1673229db3c">ebpf_store_delete_program_information</a></div><div class="ttdeci">ebpf_result_t ebpf_store_delete_program_information(const ebpf_program_info_t *program_info)</div><div class="ttdoc">Delete program information from the eBPF store.</div></div>
<div class="ttc" id="aebpf__store__helper_8h_html_abeb6d9f3883dcd0f30a8446e1a8012e7"><div class="ttname"><a href="ebpf__store__helper_8h.html#abeb6d9f3883dcd0f30a8446e1a8012e7">ebpf_store_root_sub_key</a></div><div class="ttdeci">const wchar_t * ebpf_store_root_sub_key</div></div>
Expand Down

0 comments on commit 99d5622

Please sign in to comment.