summaryrefslogtreecommitdiffstats
path: root/runtime/docs/html/structmap__root.html
blob: 2a4eb81949064da10c59ccf0d7a4eed286724f0a (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
<title>SystemTap: map_root Struct Reference</title>
<link href="doxygen.css" rel="stylesheet" type="text/css">
</head><body>
<!-- Generated by Doxygen 1.4.1 -->
<div class="qindex"><a class="qindex" href="index.html">Main&nbsp;Page</a> | <a class="qindex" href="modules.html">Modules</a> | <a class="qindex" href="annotated.html">Data&nbsp;Structures</a> | <a class="qindex" href="dirs.html">Directories</a> | <a class="qindex" href="files.html">File&nbsp;List</a> | <a class="qindex" href="functions.html">Data&nbsp;Fields</a> | <a class="qindex" href="globals.html">Globals</a> | <a class="qindex" href="pages.html">Related&nbsp;Pages</a></div>
<h1>map_root Struct Reference<br>
<small>
[<a class="el" href="group__maps.html">Maps</a>]</small>
</h1>This structure contains all information about a map.  
<a href="#_details">More...</a>
<p>
<code>#include &lt;<a class="el" href="map_8h-source.html">map.h</a>&gt;</code>
<p>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td></td></tr>
<tr><td colspan="2"><br><h2>Data Fields</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="o0" doxytag="map_root::type"></a>
enum <a class="el" href="group__maps.html#ga33">valtype</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structmap__root.html#o0">type</a></td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">type of the values stored in the array <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="o1" doxytag="map_root::maxnum"></a>
int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structmap__root.html#o1">maxnum</a></td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">maximum number of elements allowed in the array. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="o2" doxytag="map_root::num"></a>
int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structmap__root.html#o2">num</a></td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">current number of used elements <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="o3" doxytag="map_root::no_wrap"></a>
int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structmap__root.html#o3">no_wrap</a></td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">when more than maxnum elements, wrap or discard? <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="o4" doxytag="map_root::head"></a>
list_head&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structmap__root.html#o4">head</a></td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">linked list of current entries <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">list_head&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structmap__root.html#o5">pool</a></td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">pool of unused entries.  <a href="#o5"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="o6" doxytag="map_root::key"></a>
<a class="el" href="structmap__node.html">map_node</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structmap__root.html#o6">key</a></td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">saved key entry for lookups <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">u_int8_t&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structmap__root.html#o7">create</a></td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">this is the creation data saved between the key functions and the set/get functions  <a href="#o7"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="o8" doxytag="map_root::c_key1type"></a>
enum <a class="el" href="group__maps.html#ga32">keytype</a>&nbsp;</td><td class="memItemRight" valign="bottom"><b>c_key1type</b></td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="o9" doxytag="map_root::c_key2type"></a>
enum <a class="el" href="group__maps.html#ga32">keytype</a>&nbsp;</td><td class="memItemRight" valign="bottom"><b>c_key2type</b></td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="o10" doxytag="map_root::c_keyhead"></a>
hlist_head *&nbsp;</td><td class="memItemRight" valign="bottom"><b>c_keyhead</b></td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="o11" doxytag="map_root::c_key1"></a>
<a class="el" href="unionkey__data.html">key_data</a>&nbsp;</td><td class="memItemRight" valign="bottom"><b>c_key1</b></td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="o12" doxytag="map_root::c_key2"></a>
<a class="el" href="unionkey__data.html">key_data</a>&nbsp;</td><td class="memItemRight" valign="bottom"><b>c_key2</b></td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="o13" doxytag="map_root::hashes"></a>
hlist_head&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structmap__root.html#o13">hashes</a> [HASH_TABLE_SIZE]</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">the hash table for this array <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structmap__root.html#o14">membuf</a></td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">pointer to allocated memory space.  <a href="#o14"></a><br></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
This structure contains all information about a map. 
<p>
It is allocated once when <a class="el" href="group__maps.html#ga2">_stp_map_new()</a> is called. 
<p>

<p>
Definition at line <a class="el" href="map_8h-source.html#l00067">67</a> of file <a class="el" href="map_8h-source.html">map.h</a>.<hr><h2>Field Documentation</h2>
<a class="anchor" name="o7" doxytag="map_root::create"></a><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
  <tr>
    <td class="mdRow">
      <table cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td class="md" nowrap valign="top">u_int8_t <a class="el" href="structmap__root.html#o7">map_root::create</a>          </td>
        </tr>
      </table>
    </td>
  </tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
this is the creation data saved between the key functions and the set/get functions 
<p>
<dl compact><dt><b><a class="el" href="todo.html#_todo000009">Todo:</a></b></dt><dd>Needs to be per-cpu data for SMP support</dd></dl>

<p>
Definition at line <a class="el" href="map_8h-source.html#l00093">93</a> of file <a class="el" href="map_8h-source.html">map.h</a>.
<p>
Referenced by <a class="el" href="map_8c-source.html#l00568">_stp_map_get_int64()</a>, <a class="el" href="map_8c-source.html#l00732">_stp_map_get_stat()</a>, <a class="el" href="map_8c-source.html#l00649">_stp_map_get_str()</a>, <a class="el" href="map_8c-source.html#l00233">_stp_map_key_long_long()</a>, <a class="el" href="map_8c-source.html#l00373">_stp_map_key_long_str()</a>, <a class="el" href="map_8c-source.html#l00325">_stp_map_key_str_long()</a>, <a class="el" href="map_8c-source.html#l00276">_stp_map_key_str_str()</a>, <a class="el" href="map_8c-source.html#l00673">_stp_map_set_stat()</a>, <a class="el" href="map_8c-source.html#l00588">_stp_map_set_str()</a>, and <a class="el" href="map_8c-source.html#l00753">_stp_map_stat_add()</a>.    </td>
  </tr>
</table>
<a class="anchor" name="o14" doxytag="map_root::membuf"></a><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
  <tr>
    <td class="mdRow">
      <table cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td class="md" nowrap valign="top">void* <a class="el" href="structmap__root.html#o14">map_root::membuf</a>          </td>
        </tr>
      </table>
    </td>
  </tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
pointer to allocated memory space. 
<p>
Used for freeing memory. 
<p>
Definition at line <a class="el" href="map_8h-source.html#l00104">104</a> of file <a class="el" href="map_8h-source.html">map.h</a>.
<p>
Referenced by <a class="el" href="map_8c-source.html#l00205">_stp_map_del()</a>, and <a class="el" href="map_8c-source.html#l00057">_stp_map_new()</a>.    </td>
  </tr>
</table>
<a class="anchor" name="o5" doxytag="map_root::pool"></a><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
  <tr>
    <td class="mdRow">
      <table cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td class="md" nowrap valign="top">struct list_head <a class="el" href="structmap__root.html#o5">map_root::pool</a>          </td>
        </tr>
      </table>
    </td>
  </tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
pool of unused entries. 
<p>
Used only when entries are statically allocated at startup. 
<p>
Definition at line <a class="el" href="map_8h-source.html#l00085">85</a> of file <a class="el" href="map_8h-source.html">map.h</a>.
<p>
Referenced by <a class="el" href="map_8c-source.html#l00813">_stp_list_clear()</a>, <a class="el" href="map_8c-source.html#l00057">_stp_map_new()</a>, <a class="el" href="map_8c-source.html#l00673">_stp_map_set_stat()</a>, and <a class="el" href="map_8c-source.html#l00588">_stp_map_set_str()</a>.    </td>
  </tr>
</table>
<hr>The documentation for this struct was generated from the following file:<ul>
<li><a class="el" href="map_8h-source.html">map.h</a></ul>
</body></html>