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
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
|
/*
* libexplain - Explain errno values returned by libc functions
* Copyright (C) 2009-2011 Peter Miller
*
* This program is free software; you can redistribute it and/or modify it
* under the terms of the GNU Lesser General Public License as published by
* the Free Software Foundation; either version 3 of the License, or (at your
* option) any later version.
*
* This program is distributed in the hope that it will be useful, but WITHOUT
* ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
* FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public
* License for more details.
*
* You should have received a copy of the GNU Lesser General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
#ifndef LIBEXPLAIN_IOCONTROL_GENERIC_H
#define LIBEXPLAIN_IOCONTROL_GENERIC_H
#include <libexplain/iocontrol.h>
/**
* The explain_iocontrol_generic global variable is
* used to store information ablut the GENERIC
* I/O control.
*
* @note
* This information is not kept in a single table for all values,
* like every other set of constants, because (a) some values
* are ambiguous, and (b) the includes files have bugs making it
* impossible to include all of them in the same combilation unit.
*/
extern const explain_iocontrol_t explain_iocontrol_generic;
/**
* The explain_iocontrol_generic_print_explanation function is used to
* print a generic (non-specific) explanation of an error return by an
* ioctl system call.
*
* @param p
* ioctl descriptor
* @param sb
* where to print the explanation
* @param errnum
* the errno value to be explained
* @param fildes
* original fildes, exactly as passed to the ioctl system call
* @param request
* original request, exactly as passed to the ioctl system call
* @param data
* original data, exactly as passed to the ioctl system call
*/
void explain_iocontrol_generic_print_explanation(const explain_iocontrol_t *p,
struct explain_string_buffer_t *sb, int errnum, int fildes, int request,
const void *data);
/**
* The explain_iocontrol_fake_syscall_name function is used to
* synthesize a "sycall name" for use in error messages that take same.
*
* @param output
* where to write the name
* @param output_size
* the available output size, in bytes
* @param p
* ioctl descriptor
* @param request
* original request, exactly as passed to the ioctl system call
*/
void explain_iocontrol_fake_syscall_name(char *output, int output_size,
const explain_iocontrol_t *p, int request);
/**
* The explain_iocontrol_generic_print_data_int function is used to
* print a generic (non-specific) intger value arg (as opposed to some
* kind of pointer).
*
* For use in iocontrol definitions, as code common to <i>many</i>
* ioctl requests... hence the weird looking argument list.
*
* @param p
* ioctl descriptor
* @param sb
* where to print the explanation
* @param errnum
* the errno value to be explained
* @param fildes
* original fildes, exactly as passed to the ioctl system call
* @param request
* original request, exactly as passed to the ioctl system call
* @param data
* original data, exactly as passed to the ioctl system call
*/
void explain_iocontrol_generic_print_data_int(const explain_iocontrol_t *p,
struct explain_string_buffer_t *sb, int errnum, int fildes, int request,
const void *data);
/**
* The explain_iocontrol_generic_print_data_uint function is used to
* print a generic (non-specific) unsigned intger value arg (as opposed
* to some kind of pointer).
*
* For use in iocontrol definitions, as code common to <i>many</i>
* ioctl requests... hence the weird looking argument list.
*
* @param p
* ioctl descriptor
* @param sb
* where to print the explanation
* @param errnum
* the errno value to be explained
* @param fildes
* original fildes, exactly as passed to the ioctl system call
* @param request
* original request, exactly as passed to the ioctl system call
* @param data
* original data, exactly as passed to the ioctl system call
*/
void explain_iocontrol_generic_print_data_uint(const explain_iocontrol_t *p,
struct explain_string_buffer_t *sb, int errnum, int fildes, int request,
const void *data);
/**
* The explain_iocontrol_generic_print_data_int_star function is used to
* print a generic (non-specific) intger pointer arg (as opposed to any
* other kind of pointer).
*
* For use in iocontrol definitions, as code common to <i>many</i>
* ioctl requests... hence the weird looking argument list.
*
* @param p
* ioctl descriptor
* @param sb
* where to print the explanation
* @param errnum
* the errno value to be explained
* @param fildes
* original fildes, exactly as passed to the ioctl system call
* @param request
* original request, exactly as passed to the ioctl system call
* @param data
* original data, exactly as passed to the ioctl system call
*/
void explain_iocontrol_generic_print_data_int_star(const explain_iocontrol_t *p,
struct explain_string_buffer_t *sb, int errnum, int fildes, int request,
const void *data);
/**
* The explain_iocontrol_generic_print_data_uint_star function is used
* to print a generic (non-specific) unsigned intger pointer arg (as
* opposed to any other kind of pointer).
*
* For use in iocontrol definitions, as code common to <i>many</i>
* ioctl requests... hence the weird looking argument list.
*
* @param p
* ioctl descriptor
* @param sb
* where to print the explanation
* @param errnum
* the errno value to be explained
* @param fildes
* original fildes, exactly as passed to the ioctl system call
* @param request
* original request, exactly as passed to the ioctl system call
* @param data
* original data, exactly as passed to the ioctl system call
*/
void explain_iocontrol_generic_print_data_uint_star(
const explain_iocontrol_t *p, struct explain_string_buffer_t *sb,
int errnum, int fildes, int request, const void *data);
/**
* The explain_iocontrol_generic_print_data_long function is used to
* print a generic (non-specific) long int value arg (as opposed to some
* kind of pointer).
*
* For use in iocontrol definitions, as code common to <i>many</i>
* ioctl requests... hence the weird looking argument list.
*
* @param p
* ioctl descriptor
* @param sb
* where to print the explanation
* @param errnum
* the errno value to be explained
* @param fildes
* original fildes, exactly as passed to the ioctl system call
* @param request
* original request, exactly as passed to the ioctl system call
* @param data
* original data, exactly as passed to the ioctl system call
*/
void explain_iocontrol_generic_print_data_long(const explain_iocontrol_t *p,
struct explain_string_buffer_t *sb, int errnum, int fildes, int request,
const void *data);
/**
* The explain_iocontrol_generic_print_data_ulong function is used
* to print a generic (non-specific) unsigned long int value arg (as
* opposed to some kind of pointer).
*
* For use in iocontrol definitions, as code common to <i>many</i>
* ioctl requests... hence the weird looking argument list.
*
* @param p
* ioctl descriptor
* @param sb
* where to print the explanation
* @param errnum
* the errno value to be explained
* @param fildes
* original fildes, exactly as passed to the ioctl system call
* @param request
* original request, exactly as passed to the ioctl system call
* @param data
* original data, exactly as passed to the ioctl system call
*/
void explain_iocontrol_generic_print_data_ulong(const explain_iocontrol_t *p,
struct explain_string_buffer_t *sb, int errnum, int fildes, int request,
const void *data);
/**
* The explain_iocontrol_generic_print_data_long_star function is used
* to print a generic (non-specific) intger pointer arg (as opposed to
* any other kind of pointer).
*
* For use in iocontrol definitions, as code common to <i>many</i>
* ioctl requests... hence the weird looking argument list.
*
* @param p
* ioctl descriptor
* @param sb
* where to print the explanation
* @param errnum
* the errno value to be explained
* @param fildes
* original fildes, exactly as passed to the ioctl system call
* @param request
* original request, exactly as passed to the ioctl system call
* @param data
* original data, exactly as passed to the ioctl system call
*/
void explain_iocontrol_generic_print_data_long_star(
const explain_iocontrol_t *p, struct explain_string_buffer_t *sb,
int errnum, int fildes, int request, const void *data);
/**
* The explain_iocontrol_generic_print_data_ulong_star function is used
* to print a generic (non-specific) unsigned intger pointer arg (as
* opposed to any other kind of pointer).
*
* For use in iocontrol definitions, as code common to <i>many</i>
* ioctl requests... hence the weird looking argument list.
*
* @param p
* ioctl descriptor
* @param sb
* where to print the explanation
* @param errnum
* the errno value to be explained
* @param fildes
* original fildes, exactly as passed to the ioctl system call
* @param request
* original request, exactly as passed to the ioctl system call
* @param data
* original data, exactly as passed to the ioctl system call
*/
void explain_iocontrol_generic_print_data_ulong_star(
const explain_iocontrol_t *p, struct explain_string_buffer_t *sb,
int errnum, int fildes, int request, const void *data);
/**
* The explain_iocontrol_generic_print_data_pointer function is used
* to print a generic pointer arg.
*
* For use in iocontrol definitions, as code common to <i>many</i>
* ioctl requests... hence the weird looking argument list.
*
* @param p
* ioctl descriptor
* @param sb
* where to print the explanation
* @param errnum
* the errno value to be explained
* @param fildes
* original fildes, exactly as passed to the ioctl system call
* @param request
* original request, exactly as passed to the ioctl system call
* @param data
* original data, exactly as passed to the ioctl system call
*/
void explain_iocontrol_generic_print_data_pointer(
const explain_iocontrol_t *p, struct explain_string_buffer_t *sb,
int errnum, int fildes, int request, const void *data);
/**
* The explain_iocontrol_generic_print_data_int64_star function is used
* to print a the signed 64-bit value pointer to data.
*
* For use in iocontrol definitions, as code common to <i>many</i>
* ioctl requests... hence the weird looking argument list.
*
* @param p
* ioctl descriptor
* @param sb
* where to print the explanation
* @param errnum
* the errno value to be explained
* @param fildes
* original fildes, exactly as passed to the ioctl system call
* @param request
* original request, exactly as passed to the ioctl system call
* @param data
* original data, exactly as passed to the ioctl system call
*/
void explain_iocontrol_generic_print_data_int64_star(
const explain_iocontrol_t *p, struct explain_string_buffer_t *sb,
int errnum, int fildes, int request, const void *data);
/**
* The explain_iocontrol_generic_print_data_int64_star function is used
* to print a the unsigned 64-bit value pointer to data.
*
* For use in iocontrol definitions, as code common to <i>many</i>
* ioctl requests... hence the weird looking argument list.
*
* @param p
* ioctl descriptor
* @param sb
* where to print the explanation
* @param errnum
* the errno value to be explained
* @param fildes
* original fildes, exactly as passed to the ioctl system call
* @param request
* original request, exactly as passed to the ioctl system call
* @param data
* original data, exactly as passed to the ioctl system call
*/
void explain_iocontrol_generic_print_data_uint64_star(
const explain_iocontrol_t *p, struct explain_string_buffer_t *sb,
int errnum, int fildes, int request, const void *data);
/**
* The explain_iocontrol_generic_print_data_ignored function is used
* to print a ioctl::data argument in the case where it is ignored (by
* convention, should be zero).
*
* For use in iocontrol definitions, as code common to <i>many</i>
* ioctl requests... hence the weird looking argument list.
*
* @param p
* ioctl descriptor
* @param sb
* where to print the explanation
* @param errnum
* the errno value to be explained
* @param fildes
* original fildes, exactly as passed to the ioctl system call
* @param request
* original request, exactly as passed to the ioctl system call
* @param data
* original data, exactly as passed to the ioctl system call
*/
void explain_iocontrol_generic_print_data_ignored(
const explain_iocontrol_t *p, struct explain_string_buffer_t *sb,
int errnum, int fildes, int request, const void *data);
/**
* The explain_iocontrol_generic_print_data_short_star function is used
* to print a the signed short value pointer to data.
*
* For use in iocontrol definitions, as code common to <i>many</i>
* ioctl requests... hence the weird looking argument list.
*
* @param p
* ioctl descriptor
* @param sb
* where to print the explanation
* @param errnum
* the errno value to be explained
* @param fildes
* original fildes, exactly as passed to the ioctl system call
* @param request
* original request, exactly as passed to the ioctl system call
* @param data
* original data, exactly as passed to the ioctl system call
*/
void explain_iocontrol_generic_print_data_short_star(
const explain_iocontrol_t *p, struct explain_string_buffer_t *sb,
int errnum, int fildes, int request, const void *data);
/**
* The explain_iocontrol_generic_print_data_short_star function is used
* to print a the unsigned short value pointer to data.
*
* For use in iocontrol definitions, as code common to <i>many</i>
* ioctl requests... hence the weird looking argument list.
*
* @param p
* ioctl descriptor
* @param sb
* where to print the explanation
* @param errnum
* the errno value to be explained
* @param fildes
* original fildes, exactly as passed to the ioctl system call
* @param request
* original request, exactly as passed to the ioctl system call
* @param data
* original data, exactly as passed to the ioctl system call
*/
void explain_iocontrol_generic_print_data_ushort_star(
const explain_iocontrol_t *p, struct explain_string_buffer_t *sb,
int errnum, int fildes, int request, const void *data);
/**
* The explain_iocontrol_generic_print_data_int8_star function is used
* to print a the signed int8 value pointer to data.
*
* For use in iocontrol definitions, as code common to <i>many</i>
* ioctl requests... hence the weird looking argument list.
*
* @param p
* ioctl descriptor
* @param sb
* where to print the explanation
* @param errnum
* the errno value to be explained
* @param fildes
* original fildes, exactly as passed to the ioctl system call
* @param request
* original request, exactly as passed to the ioctl system call
* @param data
* original data, exactly as passed to the ioctl system call
*/
void explain_iocontrol_generic_print_data_int8_star(
const explain_iocontrol_t *p, struct explain_string_buffer_t *sb,
int errnum, int fildes, int request, const void *data);
/**
* The explain_iocontrol_generic_print_data_int8_star function is used
* to print a the unsigned int8 value pointer to data.
*
* For use in iocontrol definitions, as code common to <i>many</i>
* ioctl requests... hence the weird looking argument list.
*
* @param p
* ioctl descriptor
* @param sb
* where to print the explanation
* @param errnum
* the errno value to be explained
* @param fildes
* original fildes, exactly as passed to the ioctl system call
* @param request
* original request, exactly as passed to the ioctl system call
* @param data
* original data, exactly as passed to the ioctl system call
*/
void explain_iocontrol_generic_print_data_uint8_star(
const explain_iocontrol_t *p, struct explain_string_buffer_t *sb,
int errnum, int fildes, int request, const void *data);
/**
* The explain_iocontrol_generic_print_hash_define function is used to
* turn an ioctl request number into the corresponding hash define, or what
* it could have looked like had a hash define been used.
*
* @param sb
* The string buffer to print into.
* @param request
* The ioctl request number to be printed.
*/
void explain_iocontrol_generic_print_hash_define(
struct explain_string_buffer_t *sb, int request);
#endif /* LIBEXPLAIN_IOCONTROL_GENERIC_H */
|
