%PDF- %PDF-
Direktori : /proc/self/root/proc/self/root/usr/share/nagios/html/docs/ |
Current File : //proc/self/root/proc/self/root/usr/share/nagios/html/docs/nsutils_8h_source.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.5"/> <title>Nagios: nsutils.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="search/search.css" rel="stylesheet" type="text/css"/> <script type="text/javascript" src="search/search.js"></script> <script type="text/javascript"> $(document).ready(function() { searchBox.OnSelectItem(0); }); </script> <link href="doxygen.css" rel="stylesheet" type="text/css" /> </head> <body> <div id="top"><!-- do not remove this div, it is closed by doxygen! --> <div id="titlearea"> <table cellspacing="0" cellpadding="0"> <tbody> <tr style="height: 56px;"> <td style="padding-left: 0.5em;"> <div id="projectname">Nagios  <span id="projectnumber">4.4.3</span> </div> <div id="projectbrief">Dev docs for Nagios core and neb-module hackers</div> </td> </tr> </tbody> </table> </div> <!-- end header part --> <!-- Generated by Doxygen 1.8.5 --> <script type="text/javascript"> var searchBox = new SearchBox("searchBox", "search",false,'Search'); </script> <div id="navrow1" class="tabs"> <ul class="tablist"> <li><a href="index.html"><span>Main Page</span></a></li> <li><a href="pages.html"><span>Related Pages</span></a></li> <li><a href="annotated.html"><span>Data Structures</span></a></li> <li class="current"><a href="files.html"><span>Files</span></a></li> <li> <div id="MSearchBox" class="MSearchBoxInactive"> <span class="left"> <img id="MSearchSelect" src="search/mag_sel.png" onmouseover="return searchBox.OnSearchSelectShow()" onmouseout="return searchBox.OnSearchSelectHide()" alt=""/> <input type="text" id="MSearchField" value="Search" accesskey="S" onfocus="searchBox.OnSearchFieldFocus(true)" onblur="searchBox.OnSearchFieldFocus(false)" onkeyup="searchBox.OnSearchFieldChange(event)"/> </span><span class="right"> <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a> </span> </div> </li> </ul> </div> <div id="navrow2" class="tabs2"> <ul class="tablist"> <li><a href="files.html"><span>File List</span></a></li> <li><a href="globals.html"><span>Globals</span></a></li> </ul> </div> <!-- window showing the filter options --> <div id="MSearchSelectWindow" onmouseover="return searchBox.OnSearchSelectShow()" onmouseout="return searchBox.OnSearchSelectHide()" onkeydown="return searchBox.OnSearchSelectKey(event)"> <a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark"> </span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark"> </span>Data Structures</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark"> </span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark"> </span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark"> </span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark"> </span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark"> </span>Macros</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark"> </span>Pages</a></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 id="nav-path" class="navpath"> <ul> <li class="navelem"><a class="el" href="dir_97aefd0d527b934f1d99a682da8fe6a9.html">lib</a></li> </ul> </div> </div><!-- top --> <div class="header"> <div class="headertitle"> <div class="title">nsutils.h</div> </div> </div><!--header--> <div class="contents"> <a href="nsutils_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 LIBNAGIOS_NSUTILS_H_INCLUDED</span></div> <div class="line"><a name="l00002"></a><span class="lineno"> 2</span> <span class="preprocessor"></span><span class="preprocessor">#define LIBNAGIOS_NSUTILS_H_INCLUDED</span></div> <div class="line"><a name="l00003"></a><span class="lineno"> 3</span> <span class="preprocessor"></span><span class="preprocessor">#include <sys/types.h></span></div> <div class="line"><a name="l00004"></a><span class="lineno"> 4</span> <span class="preprocessor">#include <sys/time.h></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">/**</span></div> <div class="line"><a name="l00007"></a><span class="lineno"> 7</span> <span class="comment"> * @file nsutils.h</span></div> <div class="line"><a name="l00008"></a><span class="lineno"> 8</span> <span class="comment"> * @brief Non-Standard (or Nagios) utility functions and macros.</span></div> <div class="line"><a name="l00009"></a><span class="lineno"> 9</span> <span class="comment"> *</span></div> <div class="line"><a name="l00010"></a><span class="lineno"> 10</span> <span class="comment"> * This is where we house all helpers and macros that fall outside</span></div> <div class="line"><a name="l00011"></a><span class="lineno"> 11</span> <span class="comment"> * the "standard-ish" norm. The prefixes "nsu_" and NSU_ are</span></div> <div class="line"><a name="l00012"></a><span class="lineno"> 12</span> <span class="comment"> * reserved for this purpose, so we avoid clashing with other</span></div> <div class="line"><a name="l00013"></a><span class="lineno"> 13</span> <span class="comment"> * applications that may have similarly-acting functions with</span></div> <div class="line"><a name="l00014"></a><span class="lineno"> 14</span> <span class="comment"> * identical names.</span></div> <div class="line"><a name="l00015"></a><span class="lineno"> 15</span> <span class="comment"> *</span></div> <div class="line"><a name="l00016"></a><span class="lineno"> 16</span> <span class="comment"> * The functions already here lack the nsu_ prefix for backwards</span></div> <div class="line"><a name="l00017"></a><span class="lineno"> 17</span> <span class="comment"> * compatibility reasons. It's possible we'll have to fix that</span></div> <div class="line"><a name="l00018"></a><span class="lineno"> 18</span> <span class="comment"> * some day, but let's leave that for later.</span></div> <div class="line"><a name="l00019"></a><span class="lineno"> 19</span> <span class="comment"> *</span></div> <div class="line"><a name="l00020"></a><span class="lineno"> 20</span> <span class="comment"> * @{</span></div> <div class="line"><a name="l00021"></a><span class="lineno"> 21</span> <span class="comment"> */</span></div> <div class="line"><a name="l00022"></a><span class="lineno"> 22</span> <span class="comment"></span></div> <div class="line"><a name="l00023"></a><span class="lineno"> 23</span> <span class="comment">/** Macro for dynamically increasing vector lengths */</span></div> <div class="line"><a name="l00024"></a><span class="lineno"><a class="line" href="nsutils_8h.html#a96824974fc1cbb6da7418f3ac5e4d57d"> 24</a></span> <span class="preprocessor">#define alloc_nr(x) (((x)+16)*3/2)</span></div> <div class="line"><a name="l00025"></a><span class="lineno"> 25</span> <span class="preprocessor"></span><span class="comment"></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> <span class="comment"> * Check if a number is a power of 2</span></div> <div class="line"><a name="l00028"></a><span class="lineno"> 28</span> <span class="comment"> * @param x The number to check</span></div> <div class="line"><a name="l00029"></a><span class="lineno"> 29</span> <span class="comment"> * @return 1 if the number is a power of 2, 0 if it's not</span></div> <div class="line"><a name="l00030"></a><span class="lineno"> 30</span> <span class="comment"> */</span></div> <div class="line"><a name="l00031"></a><span class="lineno"> 31</span> <span class="keyword">static</span> <span class="keyword">inline</span> <span class="keywordtype">int</span> nsu_ispow2(<span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> x)</div> <div class="line"><a name="l00032"></a><span class="lineno"> 32</span> {</div> <div class="line"><a name="l00033"></a><span class="lineno"> 33</span>  <span class="keywordflow">return</span> x > 1 ? !(x & (x - 1)) : 0;</div> <div class="line"><a name="l00034"></a><span class="lineno"> 34</span> }</div> <div class="line"><a name="l00035"></a><span class="lineno"> 35</span> <span class="comment"></span></div> <div class="line"><a name="l00036"></a><span class="lineno"> 36</span> <span class="comment">/**</span></div> <div class="line"><a name="l00037"></a><span class="lineno"> 37</span> <span class="comment"> * Round up to a power of 2</span></div> <div class="line"><a name="l00038"></a><span class="lineno"> 38</span> <span class="comment"> * Yes, this is the most cryptic function name in all of Nagios, but I</span></div> <div class="line"><a name="l00039"></a><span class="lineno"> 39</span> <span class="comment"> * like it, so shush.</span></div> <div class="line"><a name="l00040"></a><span class="lineno"> 40</span> <span class="comment"> * @param r The number to round up</span></div> <div class="line"><a name="l00041"></a><span class="lineno"> 41</span> <span class="comment"> * @return r, rounded up to the nearest power of 2.</span></div> <div class="line"><a name="l00042"></a><span class="lineno"> 42</span> <span class="comment"> */</span></div> <div class="line"><a name="l00043"></a><span class="lineno"> 43</span> <span class="keyword">static</span> <span class="keyword">inline</span> <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> rup2pof2(<span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> r)</div> <div class="line"><a name="l00044"></a><span class="lineno"> 44</span> {</div> <div class="line"><a name="l00045"></a><span class="lineno"> 45</span>  r--;</div> <div class="line"><a name="l00046"></a><span class="lineno"> 46</span>  <span class="keywordflow">if</span> (!r)</div> <div class="line"><a name="l00047"></a><span class="lineno"> 47</span>  <span class="keywordflow">return</span> 2;</div> <div class="line"><a name="l00048"></a><span class="lineno"> 48</span>  r |= r >> 1;</div> <div class="line"><a name="l00049"></a><span class="lineno"> 49</span>  r |= r >> 2;</div> <div class="line"><a name="l00050"></a><span class="lineno"> 50</span>  r |= r >> 4;</div> <div class="line"><a name="l00051"></a><span class="lineno"> 51</span>  r |= r >> 8;</div> <div class="line"><a name="l00052"></a><span class="lineno"> 52</span>  r |= r >> 16;</div> <div class="line"><a name="l00053"></a><span class="lineno"> 53</span> </div> <div class="line"><a name="l00054"></a><span class="lineno"> 54</span>  <span class="keywordflow">return</span> r + 1;</div> <div class="line"><a name="l00055"></a><span class="lineno"> 55</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"> * Grab a random unsigned int in the range between low and high.</span></div> <div class="line"><a name="l00059"></a><span class="lineno"> 59</span> <span class="comment"> * Note that the PRNG has to be seeded prior to calling this.</span></div> <div class="line"><a name="l00060"></a><span class="lineno"> 60</span> <span class="comment"> * @param low The lower bound, inclusive</span></div> <div class="line"><a name="l00061"></a><span class="lineno"> 61</span> <span class="comment"> * @param high The higher bound, inclusive</span></div> <div class="line"><a name="l00062"></a><span class="lineno"> 62</span> <span class="comment"> * @return An unsigned integer in the mathematical range [low, high]</span></div> <div class="line"><a name="l00063"></a><span class="lineno"> 63</span> <span class="comment"> */</span></div> <div class="line"><a name="l00064"></a><span class="lineno"> 64</span> <span class="keyword">static</span> <span class="keyword">inline</span> <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> ranged_urand(<span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> low, <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> high)</div> <div class="line"><a name="l00065"></a><span class="lineno"> 65</span> {</div> <div class="line"><a name="l00066"></a><span class="lineno"> 66</span>  <span class="keywordflow">return</span> low + (rand() * (1.0 / (RAND_MAX + 1.0)) * (high - low));</div> <div class="line"><a name="l00067"></a><span class="lineno"> 67</span> }</div> <div class="line"><a name="l00068"></a><span class="lineno"> 68</span> <span class="comment"></span></div> <div class="line"><a name="l00069"></a><span class="lineno"> 69</span> <span class="comment">/**</span></div> <div class="line"><a name="l00070"></a><span class="lineno"> 70</span> <span class="comment"> * Get number of online cpus</span></div> <div class="line"><a name="l00071"></a><span class="lineno"> 71</span> <span class="comment"> * @return Active cpu cores detected on success. 0 on failure.</span></div> <div class="line"><a name="l00072"></a><span class="lineno"> 72</span> <span class="comment"> */</span></div> <div class="line"><a name="l00073"></a><span class="lineno"> 73</span> <span class="keyword">extern</span> <span class="keywordtype">int</span> <a class="code" href="nsutils_8h.html#a7674c6154264b62f100ad41863e64dee">real_online_cpus</a>(<span class="keywordtype">void</span>);</div> <div class="line"><a name="l00074"></a><span class="lineno"> 74</span> <span class="comment"></span></div> <div class="line"><a name="l00075"></a><span class="lineno"> 75</span> <span class="comment">/**</span></div> <div class="line"><a name="l00076"></a><span class="lineno"> 76</span> <span class="comment"> * Wrapper for real_online_cpus(), returning 1 in case we can't</span></div> <div class="line"><a name="l00077"></a><span class="lineno"> 77</span> <span class="comment"> * detect any active cpus.</span></div> <div class="line"><a name="l00078"></a><span class="lineno"> 78</span> <span class="comment"> * @return Number of active cpu cores on success. 1 on failure.</span></div> <div class="line"><a name="l00079"></a><span class="lineno"> 79</span> <span class="comment"> */</span></div> <div class="line"><a name="l00080"></a><span class="lineno"> 80</span> <span class="keyword">extern</span> <span class="keywordtype">int</span> <a class="code" href="nsutils_8h.html#a60a5912bf88ddfa4c6cbf1faa0b2ef9a">online_cpus</a>(<span class="keywordtype">void</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">/**</span></div> <div class="line"><a name="l00083"></a><span class="lineno"> 83</span> <span class="comment"> * Create a short-lived string in stack-allocated memory</span></div> <div class="line"><a name="l00084"></a><span class="lineno"> 84</span> <span class="comment"> * The number and size of strings is limited (currently to 256 strings of</span></div> <div class="line"><a name="l00085"></a><span class="lineno"> 85</span> <span class="comment"> * 32 bytes each), so beware and use this sensibly. Intended for</span></div> <div class="line"><a name="l00086"></a><span class="lineno"> 86</span> <span class="comment"> * number-to-string conversion and other short strings.</span></div> <div class="line"><a name="l00087"></a><span class="lineno"> 87</span> <span class="comment"> * @note The returned string must *not* be free()'d!</span></div> <div class="line"><a name="l00088"></a><span class="lineno"> 88</span> <span class="comment"> * @param[in] fmt The format string</span></div> <div class="line"><a name="l00089"></a><span class="lineno"> 89</span> <span class="comment"> * @return A pointer to the formatted string on success. Undefined on errors</span></div> <div class="line"><a name="l00090"></a><span class="lineno"> 90</span> <span class="comment"> */</span></div> <div class="line"><a name="l00091"></a><span class="lineno"> 91</span> <span class="keyword">extern</span> <span class="keyword">const</span> <span class="keywordtype">char</span> *<a class="code" href="nsutils_8h.html#a48c79bbb0b4bb978a529835c3b17d6a2">mkstr</a>(<span class="keyword">const</span> <span class="keywordtype">char</span> *fmt, ...)</div> <div class="line"><a name="l00092"></a><span class="lineno"> 92</span>  __attribute__((__format__(__printf__, 1, 2)));</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">/**</span></div> <div class="line"><a name="l00095"></a><span class="lineno"> 95</span> <span class="comment"> * Calculate the millisecond delta between two timeval structs</span></div> <div class="line"><a name="l00096"></a><span class="lineno"> 96</span> <span class="comment"> * @param[in] start The start time</span></div> <div class="line"><a name="l00097"></a><span class="lineno"> 97</span> <span class="comment"> * @param[in] stop The stop time</span></div> <div class="line"><a name="l00098"></a><span class="lineno"> 98</span> <span class="comment"> * @return The millisecond delta between the two structs</span></div> <div class="line"><a name="l00099"></a><span class="lineno"> 99</span> <span class="comment"> */</span></div> <div class="line"><a name="l00100"></a><span class="lineno"> 100</span> extern <span class="keywordtype">int</span> <a class="code" href="nsutils_8h.html#a89bdd94baabcc0743a916ef7fcf75532">tv_delta_msec</a>(const struct timeval *start, const struct timeval *stop);</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"> * Get timeval delta as seconds</span></div> <div class="line"><a name="l00105"></a><span class="lineno"> 105</span> <span class="comment"> * @param start The start time</span></div> <div class="line"><a name="l00106"></a><span class="lineno"> 106</span> <span class="comment"> * @param stop The stop time</span></div> <div class="line"><a name="l00107"></a><span class="lineno"> 107</span> <span class="comment"> * @return time difference in fractions of seconds</span></div> <div class="line"><a name="l00108"></a><span class="lineno"> 108</span> <span class="comment"> */</span></div> <div class="line"><a name="l00109"></a><span class="lineno"> 109</span> extern <span class="keywordtype">float</span> <a class="code" href="nsutils_8h.html#a231490982ef814eed7b04ba16edc5520">tv_delta_f</a>(const struct timeval *start, const struct timeval *stop);</div> <div class="line"><a name="l00110"></a><span class="lineno"> 110</span> <span class="comment"></span></div> <div class="line"><a name="l00111"></a><span class="lineno"> 111</span> <span class="comment">/** @} */</span></div> <div class="line"><a name="l00112"></a><span class="lineno"> 112</span> <span class="preprocessor">#endif </span><span class="comment">/* LIBNAGIOS_NSUTILS_H_INCLUDED */</span><span class="preprocessor"></span></div> <div class="ttc" id="nsutils_8h_html_a48c79bbb0b4bb978a529835c3b17d6a2"><div class="ttname"><a href="nsutils_8h.html#a48c79bbb0b4bb978a529835c3b17d6a2">mkstr</a></div><div class="ttdeci">const char * mkstr(const char *fmt,...) __attribute__((__format__(__printf__</div><div class="ttdoc">Create a short-lived string in stack-allocated memory The number and size of strings is limited (curr...</div></div> <div class="ttc" id="nsutils_8h_html_a231490982ef814eed7b04ba16edc5520"><div class="ttname"><a href="nsutils_8h.html#a231490982ef814eed7b04ba16edc5520">tv_delta_f</a></div><div class="ttdeci">float tv_delta_f(const struct timeval *start, const struct timeval *stop)</div><div class="ttdoc">Get timeval delta as seconds. </div></div> <div class="ttc" id="nsutils_8h_html_a89bdd94baabcc0743a916ef7fcf75532"><div class="ttname"><a href="nsutils_8h.html#a89bdd94baabcc0743a916ef7fcf75532">tv_delta_msec</a></div><div class="ttdeci">const char int tv_delta_msec(const struct timeval *start, const struct timeval *stop)</div><div class="ttdoc">Calculate the millisecond delta between two timeval structs. </div></div> <div class="ttc" id="nsutils_8h_html_a7674c6154264b62f100ad41863e64dee"><div class="ttname"><a href="nsutils_8h.html#a7674c6154264b62f100ad41863e64dee">real_online_cpus</a></div><div class="ttdeci">int real_online_cpus(void)</div><div class="ttdoc">Get number of online cpus. </div></div> <div class="ttc" id="nsutils_8h_html_a60a5912bf88ddfa4c6cbf1faa0b2ef9a"><div class="ttname"><a href="nsutils_8h.html#a60a5912bf88ddfa4c6cbf1faa0b2ef9a">online_cpus</a></div><div class="ttdeci">int online_cpus(void)</div><div class="ttdoc">Wrapper for real_online_cpus(), returning 1 in case we can&#39;t detect any active cpus. </div></div> </div><!-- fragment --></div><!-- contents --> <!-- start footer part --> <hr class="footer"/><address class="footer"><small> Generated by  <a href="http://www.doxygen.org/index.html"> <img class="footer" src="doxygen.png" alt="doxygen"/> </a> 1.8.5 </small></address> </body> </html>