%PDF- %PDF-
Direktori : /proc/self/root/usr/share/nagios/html/docs/ |
Current File : //proc/self/root/usr/share/nagios/html/docs/lnag-utils_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: lnag-utils.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">lnag-utils.h</div> </div> </div><!--header--> <div class="contents"> <a href="lnag-utils_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_LNAG_UTILS_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_LNAG_UTILS_H_INCLUDED</span></div> <div class="line"><a name="l00003"></a><span class="lineno"> 3</span> <span class="preprocessor"></span></div> <div class="line"><a name="l00004"></a><span class="lineno"> 4</span> <span class="preprocessor">#include <unistd.h></span> <span class="comment">/* for sysconf() */</span></div> <div class="line"><a name="l00005"></a><span class="lineno"> 5</span> <span class="preprocessor">#include <stdlib.h></span> <span class="comment">/* for rand() */</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">/**</span></div> <div class="line"><a name="l00008"></a><span class="lineno"> 8</span> <span class="comment"> * @file lnag-utils.h</span></div> <div class="line"><a name="l00009"></a><span class="lineno"> 9</span> <span class="comment"> * @brief libnagios helper and compatibility macros that lack a "real" home.</span></div> <div class="line"><a name="l00010"></a><span class="lineno"> 10</span> <span class="comment"> *</span></div> <div class="line"><a name="l00011"></a><span class="lineno"> 11</span> <span class="comment"> * This is the home of random macros that must be present for compilation</span></div> <div class="line"><a name="l00012"></a><span class="lineno"> 12</span> <span class="comment"> * to succeed but are missing on some platforms.</span></div> <div class="line"><a name="l00013"></a><span class="lineno"> 13</span> <span class="comment"> *</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"> */</span></div> <div class="line"><a name="l00016"></a><span class="lineno"> 16</span> </div> <div class="line"><a name="l00017"></a><span class="lineno"> 17</span> <span class="preprocessor">#define NAGIOS_MKVERSION(a, b, c) \</span></div> <div class="line"><a name="l00018"></a><span class="lineno"> 18</span> <span class="preprocessor"> (((a) * 10000) + ((b) * 100) + (c))</span></div> <div class="line"><a name="l00019"></a><span class="lineno"> 19</span> <span class="preprocessor"></span></div> <div class="line"><a name="l00020"></a><span class="lineno"> 20</span> <span class="preprocessor">#ifdef __cplusplus</span></div> <div class="line"><a name="l00021"></a><span class="lineno"> 21</span> <span class="preprocessor"></span><span class="comment">/** C++ compatibility macro that avoids confusing indentation programs */</span></div> <div class="line"><a name="l00022"></a><span class="lineno"> 22</span> <span class="preprocessor"># define NAGIOS_BEGIN_DECL extern "C" {</span></div> <div class="line"><a name="l00023"></a><span class="lineno"> 23</span> <span class="preprocessor"></span><span class="comment">/**</span></div> <div class="line"><a name="l00024"></a><span class="lineno"> 24</span> <span class="comment"> * Use at end of header file declarations to obtain C++ compatibility</span></div> <div class="line"><a name="l00025"></a><span class="lineno"> 25</span> <span class="comment"> * ... without confusing indentation programs</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="preprocessor"># define NAGIOS_END_DECL }</span></div> <div class="line"><a name="l00028"></a><span class="lineno"> 28</span> <span class="preprocessor"></span><span class="preprocessor">#else</span></div> <div class="line"><a name="l00029"></a><span class="lineno"> 29</span> <span class="preprocessor"></span><span class="comment">/** C++ compatibility macro that avoids confusing indentation programs */</span></div> <div class="line"><a name="l00030"></a><span class="lineno"><a class="line" href="lnag-utils_8h.html#aa15a8af3588df950f89ef7dc6eda43a8"> 30</a></span> <span class="preprocessor"># define NAGIOS_BEGIN_DECL </span><span class="comment">/* nothing */</span><span class="preprocessor"></span></div> <div class="line"><a name="l00031"></a><span class="lineno"> 31</span> <span class="preprocessor"></span><span class="comment">/** C++ compatibility macro that avoid confusing indentation programs */</span></div> <div class="line"><a name="l00032"></a><span class="lineno"><a class="line" href="lnag-utils_8h.html#a153dc411eb3334b8f7da41668144ce82"> 32</a></span> <span class="preprocessor"># define NAGIOS_END_DECL </span><span class="comment">/* more of nothing */</span><span class="preprocessor"></span></div> <div class="line"><a name="l00033"></a><span class="lineno"> 33</span> <span class="preprocessor"></span><span class="preprocessor">#endif</span></div> <div class="line"><a name="l00034"></a><span class="lineno"> 34</span> <span class="preprocessor"></span></div> <div class="line"><a name="l00035"></a><span class="lineno"> 35</span> <span class="preprocessor">#ifndef NODOXY </span><span class="comment">/* doxy comments are useless here */</span><span class="preprocessor"></span></div> <div class="line"><a name="l00036"></a><span class="lineno"> 36</span> <span class="preprocessor"></span><span class="preprocessor"># ifndef __GNUC__</span></div> <div class="line"><a name="l00037"></a><span class="lineno"> 37</span> <span class="preprocessor"></span><span class="preprocessor"># define GCC_VERSION 0</span></div> <div class="line"><a name="l00038"></a><span class="lineno"> 38</span> <span class="preprocessor"></span><span class="preprocessor"># define __attribute__(x) </span><span class="comment">/* nothing */</span><span class="preprocessor"></span></div> <div class="line"><a name="l00039"></a><span class="lineno"> 39</span> <span class="preprocessor"></span><span class="preprocessor"># else</span></div> <div class="line"><a name="l00040"></a><span class="lineno"> 40</span> <span class="preprocessor"></span><span class="preprocessor"># ifdef __GNUC_PATCHLEVEL__</span></div> <div class="line"><a name="l00041"></a><span class="lineno"> 41</span> <span class="preprocessor"></span><span class="preprocessor"># define GCC_VERSION NAGIOS_MKVERSION(__GNUC__, __GNUC_MINOR__, __GNUC_PATCHLEVEL__)</span></div> <div class="line"><a name="l00042"></a><span class="lineno"> 42</span> <span class="preprocessor"></span><span class="preprocessor"># else</span></div> <div class="line"><a name="l00043"></a><span class="lineno"> 43</span> <span class="preprocessor"></span><span class="preprocessor"># define GCC_VERSION NAGIOS_MKVERSION(__GNUC__, __GNUC_MINOR__, 0)</span></div> <div class="line"><a name="l00044"></a><span class="lineno"> 44</span> <span class="preprocessor"></span><span class="preprocessor"># endif </span><span class="comment">/* __GNUC_PATCHLEVEL__ */</span><span class="preprocessor"></span></div> <div class="line"><a name="l00045"></a><span class="lineno"> 45</span> <span class="preprocessor"></span><span class="preprocessor"># endif </span><span class="comment">/* __GNUC__ */</span><span class="preprocessor"></span></div> <div class="line"><a name="l00046"></a><span class="lineno"> 46</span> <span class="preprocessor"></span><span class="preprocessor">#endif </span><span class="comment">/* NODOXY */</span><span class="preprocessor"></span></div> <div class="line"><a name="l00047"></a><span class="lineno"> 47</span> <span class="preprocessor"></span></div> <div class="line"><a name="l00048"></a><span class="lineno"> 48</span> <span class="preprocessor">#if GCC_VERSION >= NAGIOS_MKVERSION(4, 5, 0)</span></div> <div class="line"><a name="l00049"></a><span class="lineno"> 49</span> <span class="preprocessor"></span><span class="preprocessor"># define NAGIOS_DEPRECATED(version, hint) \</span></div> <div class="line"><a name="l00050"></a><span class="lineno"> 50</span> <span class="preprocessor"> __attribute__((deprecated("This function will be removed in Nagios v" #version ". Please use " #hint " instead")))</span></div> <div class="line"><a name="l00051"></a><span class="lineno"> 51</span> <span class="preprocessor"></span><span class="preprocessor">#else</span></div> <div class="line"><a name="l00052"></a><span class="lineno"> 52</span> <span class="preprocessor"></span><span class="comment">/** Macro for alerting module authors to function deprecation */</span></div> <div class="line"><a name="l00053"></a><span class="lineno"><a class="line" href="lnag-utils_8h.html#ab1c122883af9d26c0acf5f6ca8f5ce8c"> 53</a></span> <span class="preprocessor"># define NAGIOS_DEPRECATED(version, hint) \</span></div> <div class="line"><a name="l00054"></a><span class="lineno"> 54</span> <span class="preprocessor"> __attribute__((deprecated))</span></div> <div class="line"><a name="l00055"></a><span class="lineno"> 55</span> <span class="preprocessor"></span><span class="preprocessor">#endif</span></div> <div class="line"><a name="l00056"></a><span class="lineno"> 56</span> <span class="preprocessor"></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"> * These macros are widely used throughout Nagios</span></div> <div class="line"><a name="l00059"></a><span class="lineno"> 59</span> <span class="comment"> */</span></div> <div class="line"><a name="l00060"></a><span class="lineno"><a class="line" href="lnag-utils_8h.html#aba51915c87d64af47fb1cc59348961c9"> 60</a></span> <span class="preprocessor">#define OK 0 </span><span class="comment">/**< Indicates successful function call in Nagios */</span><span class="preprocessor"></span></div> <div class="line"><a name="l00061"></a><span class="lineno"><a class="line" href="lnag-utils_8h.html#a8fe83ac76edc595f6b98cd4a4127aed5"> 61</a></span> <span class="preprocessor"></span><span class="preprocessor">#define ERROR -2 </span><span class="comment">/**< Non-successful function call in Nagios */</span><span class="preprocessor"></span></div> <div class="line"><a name="l00062"></a><span class="lineno"> 62</span> <span class="preprocessor"></span></div> <div class="line"><a name="l00063"></a><span class="lineno"> 63</span> <span class="preprocessor">#ifdef FALSE</span></div> <div class="line"><a name="l00064"></a><span class="lineno"> 64</span> <span class="preprocessor"></span><span class="preprocessor">#undef FALSE</span></div> <div class="line"><a name="l00065"></a><span class="lineno"> 65</span> <span class="preprocessor"></span><span class="preprocessor">#endif</span></div> <div class="line"><a name="l00066"></a><span class="lineno"><a class="line" href="lnag-utils_8h.html#aa93f0eb578d23995850d61f7d61c55c1"> 66</a></span> <span class="preprocessor"></span><span class="preprocessor">#define FALSE 0 </span><span class="comment">/**< Not true */</span><span class="preprocessor"></span></div> <div class="line"><a name="l00067"></a><span class="lineno"> 67</span> <span class="preprocessor"></span></div> <div class="line"><a name="l00068"></a><span class="lineno"> 68</span> <span class="preprocessor">#ifdef TRUE</span></div> <div class="line"><a name="l00069"></a><span class="lineno"> 69</span> <span class="preprocessor"></span><span class="preprocessor">#undef TRUE</span></div> <div class="line"><a name="l00070"></a><span class="lineno"> 70</span> <span class="preprocessor"></span><span class="preprocessor">#endif</span></div> <div class="line"><a name="l00071"></a><span class="lineno"><a class="line" href="lnag-utils_8h.html#aa8cecfc5c5c054d2875c03e77b7be15d"> 71</a></span> <span class="preprocessor"></span><span class="preprocessor">#define TRUE (!FALSE) </span><span class="comment">/**< Not false */</span><span class="preprocessor"></span></div> <div class="line"><a name="l00072"></a><span class="lineno"> 72</span> <span class="preprocessor"></span><span class="comment"></span></div> <div class="line"><a name="l00073"></a><span class="lineno"> 73</span> <span class="comment">/** Useful macro to safely avoid double-free memory corruption */</span></div> <div class="line"><a name="l00074"></a><span class="lineno"><a class="line" href="lnag-utils_8h.html#a9b12a99aae3efc49af9be50afc17b526"> 74</a></span> <span class="preprocessor">#define my_free(ptr) do { if(ptr) { free(ptr); ptr = NULL; } } while(0)</span></div> <div class="line"><a name="l00075"></a><span class="lineno"> 75</span> <span class="preprocessor"></span></div> <div class="line"><a name="l00076"></a><span class="lineno"> 76</span> <span class="preprocessor">#ifndef ARRAY_SIZE</span></div> <div class="line"><a name="l00077"></a><span class="lineno"> 77</span> <span class="preprocessor"></span><span class="comment">/** Useful for iterating over all elements in a static array */</span></div> <div class="line"><a name="l00078"></a><span class="lineno"><a class="line" href="lnag-utils_8h.html#a6242a25f9d996f0cc4f4cdb911218b75"> 78</a></span> <span class="preprocessor"># define ARRAY_SIZE(x) (sizeof(x) / sizeof(x[0]))</span></div> <div class="line"><a name="l00079"></a><span class="lineno"> 79</span> <span class="preprocessor"></span><span class="preprocessor">#endif</span></div> <div class="line"><a name="l00080"></a><span class="lineno"> 80</span> <span class="preprocessor"></span><span class="preprocessor">#ifndef veclen</span></div> <div class="line"><a name="l00081"></a><span class="lineno"> 81</span> <span class="preprocessor"></span><span class="comment">/** useful for iterating over all elements in a static array */</span></div> <div class="line"><a name="l00082"></a><span class="lineno"><a class="line" href="lnag-utils_8h.html#a1e5e4a113a5db9f1557e8831384dcccb"> 82</a></span> <span class="preprocessor"># define veclen ARRAY_SIZE</span></div> <div class="line"><a name="l00083"></a><span class="lineno"> 83</span> <span class="preprocessor"></span><span class="preprocessor">#endif</span></div> <div class="line"><a name="l00084"></a><span class="lineno"> 84</span> <span class="preprocessor"></span></div> <div class="line"><a name="l00085"></a><span class="lineno"> 85</span> <span class="preprocessor">#ifndef offsetof</span></div> <div class="line"><a name="l00086"></a><span class="lineno"> 86</span> <span class="preprocessor"></span><span class="comment">/** standard offsetof macro */</span></div> <div class="line"><a name="l00087"></a><span class="lineno"><a class="line" href="lnag-utils_8h.html#a653b84fc771db76754d386863feba6d5"> 87</a></span> <span class="preprocessor"># define offsetof(t, f) ((unsigned long)&((t *)0)->f)</span></div> <div class="line"><a name="l00088"></a><span class="lineno"> 88</span> <span class="preprocessor"></span><span class="preprocessor">#endif</span></div> <div class="line"><a name="l00089"></a><span class="lineno"> 89</span> <span class="preprocessor"></span><span class="comment"></span></div> <div class="line"><a name="l00090"></a><span class="lineno"> 90</span> <span class="comment">/** character map initialization for .bss-allocated char maps */</span></div> <div class="line"><a name="l00091"></a><span class="lineno"><a class="line" href="lnag-utils_8h.html#a4e824af16bab56a1c8a21e7352aff5cd"> 91</a></span> <span class="preprocessor">#define CHAR_MAP_INIT(k) { \</span></div> <div class="line"><a name="l00092"></a><span class="lineno"> 92</span> <span class="preprocessor"> k, k, k, k, k, k, k, k, k, k, k, k, k, k, k, k, \</span></div> <div class="line"><a name="l00093"></a><span class="lineno"> 93</span> <span class="preprocessor"> k, k, k, k, k, k, k, k, k, k, k, k, k, k, k, k, \</span></div> <div class="line"><a name="l00094"></a><span class="lineno"> 94</span> <span class="preprocessor"> k, k, k, k, k, k, k, k, k, k, k, k, k, k, k, k, \</span></div> <div class="line"><a name="l00095"></a><span class="lineno"> 95</span> <span class="preprocessor"> k, k, k, k, k, k, k, k, k, k, k, k, k, k, k, k, \</span></div> <div class="line"><a name="l00096"></a><span class="lineno"> 96</span> <span class="preprocessor"> k, k, k, k, k, k, k, k, k, k, k, k, k, k, k, k, \</span></div> <div class="line"><a name="l00097"></a><span class="lineno"> 97</span> <span class="preprocessor"> k, k, k, k, k, k, k, k, k, k, k, k, k, k, k, k, \</span></div> <div class="line"><a name="l00098"></a><span class="lineno"> 98</span> <span class="preprocessor"> k, k, k, k, k, k, k, k, k, k, k, k, k, k, k, k, \</span></div> <div class="line"><a name="l00099"></a><span class="lineno"> 99</span> <span class="preprocessor"> k, k, k, k, k, k, k, k, k, k, k, k, k, k, k, k, \</span></div> <div class="line"><a name="l00100"></a><span class="lineno"> 100</span> <span class="preprocessor"> k, k, k, k, k, k, k, k, k, k, k, k, k, k, k, k, \</span></div> <div class="line"><a name="l00101"></a><span class="lineno"> 101</span> <span class="preprocessor"> k, k, k, k, k, k, k, k, k, k, k, k, k, k, k, k, \</span></div> <div class="line"><a name="l00102"></a><span class="lineno"> 102</span> <span class="preprocessor"> k, k, k, k, k, k, k, k, k, k, k, k, k, k, k, k, \</span></div> <div class="line"><a name="l00103"></a><span class="lineno"> 103</span> <span class="preprocessor"> k, k, k, k, k, k, k, k, k, k, k, k, k, k, k, k, \</span></div> <div class="line"><a name="l00104"></a><span class="lineno"> 104</span> <span class="preprocessor"> k, k, k, k, k, k, k, k, k, k, k, k, k, k, k, k, \</span></div> <div class="line"><a name="l00105"></a><span class="lineno"> 105</span> <span class="preprocessor"> k, k, k, k, k, k, k, k, k, k, k, k, k, k, k, k, \</span></div> <div class="line"><a name="l00106"></a><span class="lineno"> 106</span> <span class="preprocessor"> k, k, k, k, k, k, k, k, k, k, k, k, k, k, k, k, \</span></div> <div class="line"><a name="l00107"></a><span class="lineno"> 107</span> <span class="preprocessor"> k, k, k, k, k, k, k, k, k, k, k, k, k, k, k, k, \</span></div> <div class="line"><a name="l00108"></a><span class="lineno"> 108</span> <span class="preprocessor"> }</span></div> <div class="line"><a name="l00109"></a><span class="lineno"> 109</span> <span class="preprocessor"></span><span class="comment"></span></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="preprocessor">#endif</span></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>