summaryrefslogtreecommitdiff
path: root/unmerged/debian/tmp/usr/share/man/man3/libnet-macros.h.3
blob: b6389a57326300074b9a1926785e722a2b57e6a3 (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
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
.TH "libnet-macros.h" 3 "9 Jun 2009" "Version 1.1.4" "libnet" \" -*- nroff -*-
.ad l
.nh
.SH NAME
libnet-macros.h \- libnet macros and symbolic constants 
.SH SYNOPSIS
.br
.PP
.SS "Defines"

.in +1c
.ti -1c
.RI "#define \fBLIBNET_DONT_RESOLVE\fP   0"
.br
.ti -1c
.RI "#define \fBLIBNET_RESOLVE\fP   1"
.br
.ti -1c
.RI "#define \fBLIBNET_ON\fP   0"
.br
.ti -1c
.RI "#define \fBLIBNET_OFF\fP   1"
.br
.ti -1c
.RI "#define \fBIN6ADDR_ERROR_INIT\fP"
.br
.ti -1c
.RI "#define \fBLIBNET_PR2\fP   0"
.br
.ti -1c
.RI "#define \fBLIBNET_PR8\fP   1"
.br
.ti -1c
.RI "#define \fBLIBNET_PR16\fP   2"
.br
.ti -1c
.RI "#define \fBLIBNET_PRu16\fP   3"
.br
.ti -1c
.RI "#define \fBLIBNET_PR32\fP   4"
.br
.ti -1c
.RI "#define \fBLIBNET_PRu32\fP   5"
.br
.ti -1c
.RI "#define \fBLIBNET_PRAND_MAX\fP   0xffffffff"
.br
.ti -1c
.RI "#define \fBLIBNET_MAX_PACKET\fP   0xffff"
.br
.ti -1c
.RI "#define \fBIP_MAXPACKET\fP   0xffff"
.br
.ti -1c
.RI "#define \fBETHER_ADDR_LEN\fP   0x6"
.br
.ti -1c
.RI "#define \fBFDDI_ADDR_LEN\fP   0x6"
.br
.ti -1c
.RI "#define \fBTOKEN_RING_ADDR_LEN\fP   0x6"
.br
.ti -1c
.RI "#define \fBLIBNET_ORG_CODE_SIZE\fP   0x3"
.br
.ti -1c
.RI "#define \fBLIBNET_ERRBUF_SIZE\fP   0x100"
.br
.ti -1c
.RI "#define \fBLIBNET_MAXOPTION_SIZE\fP   0x28"
.br
.ti -1c
.RI "#define \fBFIX\fP(n)   (n)"
.br
.ti -1c
.RI "#define \fBUNFIX\fP(n)   (n)"
.br
.ti -1c
.RI "#define \fBLIBNET_DO_PAYLOAD\fP(l, p)"
.br
.ti -1c
.RI "#define \fBLIBNET_CKSUM_CARRY\fP(x)   (x = (x >> 16) + (x & 0xffff), (~(x + (x >> 16)) & 0xffff))"
.br
.ti -1c
.RI "#define \fBLIBNET_OSPF_AUTHCPY\fP(x, y)   memcpy((u_int8_t *)x, (u_int8_t *)y, sizeof(y))"
.br
.ti -1c
.RI "#define \fBLIBNET_OSPF_CKSUMBUF\fP(x, y)   memcpy((u_int8_t *)x, (u_int8_t *)y, sizeof(y))"
.br
.ti -1c
.RI "#define \fBLIBNET_NTP_DO_LI_VN_MODE\fP(li, vn, md)   ((u_int8_t)((((li) << 6) & 0xc0) | (((vn) << 3) & 0x38) | ((md) & 0x7)))"
.br
.ti -1c
.RI "#define \fBLIBNET_ISLOOPBACK\fP(p)   (strcmp((p)->ifr_name, 'lo0') == 0)"
.br
.ti -1c
.RI "#define \fBLIBNET_ISADVMODE\fP(x)   (x & 0x08)"
.br
.ti -1c
.RI "#define \fBLIBNET_LABEL_SIZE\fP   64"
.br
.ti -1c
.RI "#define \fBLIBNET_LABEL_DEFAULT\fP   'cardshark'"
.br
.ti -1c
.RI "#define \fBCQ_LOCK_UNLOCKED\fP   (u_int)0x00000000"
.br
.ti -1c
.RI "#define \fBCQ_LOCK_READ\fP   (u_int)0x00000001"
.br
.ti -1c
.RI "#define \fBCQ_LOCK_WRITE\fP   (u_int)0x00000002"
.br
.ti -1c
.RI "#define \fBfor_each_context_in_cq\fP(l)   for (l = libnet_cq_head(); libnet_cq_last(); l = libnet_cq_next())"
.br
.ti -1c
.RI "#define \fBcq_is_wlocked\fP()   (l_cqd.cq_lock & CQ_LOCK_WRITE)"
.br
.ti -1c
.RI "#define \fBcq_is_rlocked\fP()   (l_cqd.cq_lock & CQ_LOCK_READ)"
.br
.ti -1c
.RI "#define \fBcq_is_locked\fP()   (l_cqd.cq_lock & (CQ_LOCK_READ | CQ_LOCK_WRITE))"
.br
.ti -1c
.RI "#define \fBcheck_cq_lock\fP(x)   (l_cqd.cq_lock & x)"
.br
.in -1c
.SH "Detailed Description"
.PP 
libnet macros and symbolic constants 


.SH "Define Documentation"
.PP 
.SS "#define for_each_context_in_cq(l)   for (l = libnet_cq_head(); libnet_cq_last(); l = libnet_cq_next())"
.PP
Provides an interface to iterate through the context queue of libnet contexts. Before calling this macro, be sure to set the queue using \fBlibnet_cq_head()\fP. 
.SS "#define IN6ADDR_ERROR_INIT"
.PP
\fBValue:\fP
.PP
.nf
{ { { 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, \
                                 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, \
                                 0xff, 0xff } } }
.fi
IPv6 error code 
.SS "#define LIBNET_DO_PAYLOAD(l, p)"
.PP
\fBValue:\fP
.PP
.nf
if ((payload && !payload_s) || (!payload && payload_s))                      \
{                                                                            \
    snprintf(l->err_buf, LIBNET_ERRBUF_SIZE,                                 \
            '%s(): payload inconsistency\n', __func__);                      \
    goto bad;                                                                \
}                                                                            \
if (payload && payload_s)                                                    \
{                                                                            \
    n = libnet_pblock_append(l, p, payload, payload_s);                      \
    if (n == (u_int32_t) - 1)                                                \
    {                                                                        \
        goto bad;                                                            \
    }                                                                        \
}                                                                            \
.fi
.SS "#define LIBNET_DONT_RESOLVE   0"
.PP
Used for libnet's name resolution functions, specifies that no DNS lookups should be performed and the IP address should be kept in numeric form. 
.SS "#define LIBNET_ERRBUF_SIZE   0x100"
.PP
The libnet error buffer is 256 bytes long. 
.SS "#define LIBNET_MAX_PACKET   0xffff"
.PP
The biggest an IP packet can be -- 65,535 bytes. 
.SS "#define LIBNET_MAXOPTION_SIZE   0x28"
.PP
IP and TCP options can be up to 40 bytes long. 
.SS "#define LIBNET_OFF   1"
.PP
Used several places, to specify 'on' or 'one' 
.SS "#define LIBNET_ON   0"
.PP
Used several places, to specify 'on' or 'one' 
.SS "#define LIBNET_PR2   0"
.PP
Used for \fBlibnet_get_prand()\fP to specify function disposition 
.SS "#define LIBNET_RESOLVE   1"
.PP
Used for libnet's name resolution functions, specifies that a DNS lookup can be performed if needed to resolve the IP address to a canonical form. 
.SH "Author"
.PP 
Generated automatically by Doxygen for libnet from the source code.