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
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
| KQUEUE(2) BSD System Calls Manual KQUEUE(2)
NNAAMMEE
kkqquueeuuee, kkeevveenntt, kkeevveenntt6644 and kkeevveenntt__qqooss -- kernel event notification
mechanism
LLIIBBRRAARRYY
Standard C Library (libc, -lc)
SSYYNNOOPPSSIISS
##iinncclluuddee <<ssyyss//ttyyppeess..hh>>
##iinncclluuddee <<ssyyss//eevveenntt..hh>>
##iinncclluuddee <<ssyyss//ttiimmee..hh>>
_i_n_t
kkqquueeuuee(_v_o_i_d);
_i_n_t
kkeevveenntt(_i_n_t _k_q, _c_o_n_s_t _s_t_r_u_c_t _k_e_v_e_n_t _*_c_h_a_n_g_e_l_i_s_t, _i_n_t _n_c_h_a_n_g_e_s,
_s_t_r_u_c_t _k_e_v_e_n_t _*_e_v_e_n_t_l_i_s_t, _i_n_t _n_e_v_e_n_t_s,
_c_o_n_s_t _s_t_r_u_c_t _t_i_m_e_s_p_e_c _*_t_i_m_e_o_u_t);
_i_n_t
kkeevveenntt6644(_i_n_t _k_q, _c_o_n_s_t _s_t_r_u_c_t _k_e_v_e_n_t_6_4___s _*_c_h_a_n_g_e_l_i_s_t, _i_n_t _n_c_h_a_n_g_e_s,
_s_t_r_u_c_t _k_e_v_e_n_t_6_4___s _*_e_v_e_n_t_l_i_s_t, _i_n_t _n_e_v_e_n_t_s, _u_n_s_i_g_n_e_d _i_n_t _f_l_a_g_s,
_c_o_n_s_t _s_t_r_u_c_t _t_i_m_e_s_p_e_c _*_t_i_m_e_o_u_t);
_i_n_t
kkeevveenntt__qqooss(_i_n_t _k_q, _c_o_n_s_t _s_t_r_u_c_t _k_e_v_e_n_t___q_o_s___s _*_c_h_a_n_g_e_l_i_s_t, _i_n_t _n_c_h_a_n_g_e_s,
_s_t_r_u_c_t _k_e_v_e_n_t___q_o_s___s _*_e_v_e_n_t_l_i_s_t, _i_n_t _n_e_v_e_n_t_s, _v_o_i_d _*_d_a_t_a___o_u_t,
_s_i_z_e___t _*_d_a_t_a___a_v_a_i_l_a_b_l_e, _u_n_s_i_g_n_e_d _i_n_t _f_l_a_g_s);
EEVV__SSEETT(_&_k_e_v, _i_d_e_n_t, _f_i_l_t_e_r, _f_l_a_g_s, _f_f_l_a_g_s, _d_a_t_a, _u_d_a_t_a);
EEVV__SSEETT6644(_&_k_e_v, _i_d_e_n_t, _f_i_l_t_e_r, _f_l_a_g_s, _f_f_l_a_g_s, _d_a_t_a, _u_d_a_t_a, _e_x_t_[_0_],
_e_x_t_[_1_]);
EEVV__SSEETT__QQOOSS(_&_k_e_v, _i_d_e_n_t, _f_i_l_t_e_r, _f_l_a_g_s, _q_o_s, _u_d_a_t_a, _f_f_l_a_g_s, _x_f_l_a_g_s, _d_a_t_a,
_e_x_t_[_0_], _e_x_t_[_1_], _e_x_t_[_2_], _e_x_t_[_3_]);
DDEESSCCRRIIPPTTIIOONN
The kkqquueeuuee() system call allocates a kqueue file descriptor. This file
descriptor provides a generic method of notifying the user when a kernel
event (kevent) happens or a condition holds, based on the results of
small pieces of kernel code termed filters.
A kevent is identified by an (ident, filter, and optional udata value)
tuple. It specifies the interesting conditions to be notified about for
that tuple. An (ident, filter, and optional udata value) tuple can only
appear once in a given kqueue. Subsequent attempts to register the same
tuple for a given kqueue will result in the replacement of the conditions
being watched, not an addition. Whether the udata value is considered as
part of the tuple is controlled by the EV_UDATA_SPECIFIC flag on the
kevent.
The filter identified in a kevent is executed upon the initial registra-
tion of that event in order to detect whether a preexisting condition is
present, and is also executed whenever an event is passed to the filter
for evaluation. If the filter determines that the condition should be
reported, then the kevent is placed on the kqueue for the user to
retrieve.
The filter is also run when the user attempts to retrieve the kevent from
the kqueue. If the filter indicates that the condition that triggered
the event no longer holds, the kevent is removed from the kqueue and is
not returned.
Multiple events which trigger the filter do not result in multiple
kevents being placed on the kqueue; instead, the filter will aggregate
the events into a single struct kevent. Calling cclloossee() on a file
descriptor will remove any kevents that reference the descriptor.
The kkqquueeuuee() system call creates a new kernel event queue and returns a
descriptor. The queue is not inherited by a child created with fork(2).
The kkeevveenntt,,() kkeevveenntt6644() and kkeevveenntt__qqooss() system calls are used to regis-
ter events with the queue, and return any pending events to the user.
The _c_h_a_n_g_e_l_i_s_t argument is a pointer to an array of _k_e_v_e_n_t_, _k_e_v_e_n_t_6_4___s or
_k_e_v_e_n_t___q_o_s___s structures, as defined in <_s_y_s_/_e_v_e_n_t_._h>. All changes con-
tained in the _c_h_a_n_g_e_l_i_s_t are applied before any pending events are read
from the queue. The _n_c_h_a_n_g_e_s argument gives the size of _c_h_a_n_g_e_l_i_s_t.
The _e_v_e_n_t_l_i_s_t argument is a pointer to an array of out _k_e_v_e_n_t_, _k_e_v_e_n_t_6_4___s
or _k_e_v_e_n_t___q_o_s___s structures. The _n_e_v_e_n_t_s argument determines the size of
_e_v_e_n_t_l_i_s_t.
The _d_a_t_a___o_u_t argument provides space for extra out data provided by spe-
cific filters. The _d_a_t_a___a_v_a_i_l_a_b_l_e argument's contents specified the
space available in the data pool on input, and contains the amount still
remaining on output. If the KEVENT_FLAG_STACK_DATA flag is specified on
the system call, the data is allocated from the pool in stack order
instead of typical heap order.
If _t_i_m_e_o_u_t is a non-NULL pointer, it specifies a maximum interval to wait
for an event, which will be interpreted as a struct timespec. If _t_i_m_e_o_u_t
is a NULL pointer, both kkeevveenntt() and kkeevveenntt6644() wait indefinitely. To
effect a poll, the _f_l_a_g_s argument to kkeevveenntt6644() or kkeevveenntt__qqooss() can
include the KEVENT_FLAG_IMMEDIATE value to indicate an immediate timeout.
Alternatively, the _t_i_m_e_o_u_t argument should be non-NULL, pointing to a
zero-valued _t_i_m_e_s_p_e_c structure. The same array may be used for the
_c_h_a_n_g_e_l_i_s_t and _e_v_e_n_t_l_i_s_t.
The EEVV__SSEETT() macro is provided for ease of initializing a _k_e_v_e_n_t struc-
ture. Similarly, EEVV__SSEETT6644() initializes a _k_e_v_e_n_t_6_4___s structure and
EEVV__SSEETT__QQOOSS() initializes a _k_e_v_e_n_t___q_o_s___s structure.
The _k_e_v_e_n_t_, _k_e_v_e_n_t_6_4___s and _k_e_v_e_n_t___q_o_s___s structures are defined as:
struct kevent {
uintptr_t ident;
int16_t filter;
uint16_t flags;
uint32_t fflags;
intptr_t data;
void *udata;
};
struct kevent64_s {
uint64_t ident;
int16_t filter;
uint16_t flags;
uint32_t fflags;
int64_t data;
uint64_t udata;
uint64_t ext[2];
};
struct kevent_qos_s {
uint64_t ident;
int16_t filter;
uint16_t flags;
uint32_t qos;
uint64_t udata;
uint32_t fflags;
uint32_t xflags;
int64_t data;
uint64_t ext[4];
};
----
The fields of _s_t_r_u_c_t _k_e_v_e_n_t_, _s_t_r_u_c_t _k_e_v_e_n_t_6_4___s and _s_t_r_u_c_t _k_e_v_e_n_t___q_o_s___s
are:
ident Value used to identify the source of the event. The exact
interpretation is determined by the attached filter, but often
is a file descriptor.
filter Identifies the kernel filter used to process this event. The
pre-defined system filters are described below.
flags Actions to perform on the event.
fflags Filter-specific flags.
data Filter-specific data value.
udata Opaque user-defined value passed through the kernel unchanged.
It can optionally be part of the uniquing decision of the
kevent system
In addition, _s_t_r_u_c_t _k_e_v_e_n_t_6_4___s contains:
ext[2] This field stores extensions for the event's filter. What type
of extension depends on what type of filter is being used.
In addition, _s_t_r_u_c_t _k_e_v_e_n_t___q_o_s___s contains:
xflags Extra filter-specific flags.
ext[4] The QoS variant provides twice as many extension values for
filter-specific uses.
----
The _f_l_a_g_s field can contain the following values:
EV_ADD Adds the event to the kqueue. Re-adding an existing event
will modify the parameters of the original event, and not
result in a duplicate entry. Adding an event automati-
cally enables it, unless overridden by the EV_DISABLE
flag.
EV_ENABLE Permit kkeevveenntt,,() kkeevveenntt6644() and kkeevveenntt__qqooss() to return the
event if it is triggered.
EV_DISABLE Disable the event so kkeevveenntt,,() kkeevveenntt6644() and kkeevveenntt__qqooss()
will not return it. The filter itself is not disabled.
EV_DELETE Removes the event from the kqueue. Events which are
attached to file descriptors are automatically deleted on
the last close of the descriptor.
EV_RECEIPT This flag is useful for making bulk changes to a kqueue
without draining any pending events. When passed as input,
it forces EV_ERROR to always be returned. When a filter
is successfully added, the _d_a_t_a field will be zero.
EV_ONESHOT Causes the event to return only the first occurrence of
the filter being triggered. After the user retrieves the
event from the kqueue, it is deleted.
EV_CLEAR After the event is retrieved by the user, its state is
reset. This is useful for filters which report state
transitions instead of the current state. Note that some
filters may automatically set this flag internally.
EV_EOF Filters may set this flag to indicate filter-specific EOF
condition.
EV_OOBAND Read filter on socket may set this flag to indicate the
presence of out of band data on the descriptor.
EV_ERROR See _R_E_T_U_R_N _V_A_L_U_E_S below.
----
The predefined system filters are listed below. Arguments may be passed
to and from the filter via the _d_a_t_a_, _f_f_l_a_g_s and optionally _x_f_l_a_g_s fields
in the _k_e_v_e_n_t_, _k_e_v_e_n_t_6_4___s or _k_e_v_e_n_t___q_o_s___s structure.
EVFILT_READ Takes a file descriptor as the identifier, and returns
whenever there is data available to read. The behavior
of the filter is slightly different depending on the
descriptor type.
Sockets
Sockets which have previously been passed to
lliisstteenn() return when there is an incoming connection
pending. _d_a_t_a contains the size of the listen back-
log.
Other socket descriptors return when there is data
to be read, subject to the SO_RCVLOWAT value of the
socket buffer. This may be overridden with a per-
filter low water mark at the time the filter is
added by setting the NOTE_LOWAT flag in _f_f_l_a_g_s, and
specifying the new low water mark in _d_a_t_a. The
derived per filter low water mark value is, however,
bounded by socket receive buffer's high and low
water mark values. On return, _d_a_t_a contains the
number of bytes of protocol data available to read.
The presence of EV_OOBAND in _f_l_a_g_s, indicates the
presence of out of band data on the socket _d_a_t_a
equal to the potential number of OOB bytes availble
to read.
If the read direction of the socket has shutdown,
then the filter also sets EV_EOF in _f_l_a_g_s, and
returns the socket error (if any) in _f_f_l_a_g_s. It is
possible for EOF to be returned (indicating the con-
nection is gone) while there is still data pending
in the socket buffer.
Vnodes
Returns when the file pointer is not at the end of
file. _d_a_t_a contains the offset from current posi-
tion to end of file, and may be negative.
Fifos, Pipes
Returns when there is data to read; _d_a_t_a contains
the number of bytes available.
When the last writer disconnects, the filter will
set EV_EOF in _f_l_a_g_s. This may be cleared by passing
in EV_CLEAR, at which point the filter will resume
waiting for data to become available before return-
ing.
Device nodes
Returns when there is data to read from the device;
_d_a_t_a contains the number of bytes available. If the
device does not support returning number of bytes,
it will not allow the filter to be attached. How-
ever, if the NOTE_LOWAT flag is specified and the
_d_a_t_a field contains 1 on input, those devices will
attach - but cannot be relied upon to provide an
accurate count of bytes to be read on output.
EVFILT_EXCEPT Takes a descriptor as the identifier, and returns when-
ever one of the specified exceptional conditions has
occurred on the descriptor. Conditions are specified in
_f_f_l_a_g_s. Currently, this filter can be used to monitor
the arrival of out-of-band data on a socket descriptor
using the filter flag NOTE_OOB.
If the read direction of the socket has shutdown, then
the filter also sets EV_EOF in _f_l_a_g_s, and returns the
socket error (if any) in _f_f_l_a_g_s.
EVFILT_WRITE Takes a file descriptor as the identifier, and returns
whenever it is possible to write to the descriptor. For
sockets, pipes and fifos, _d_a_t_a will contain the amount
of space remaining in the write buffer. The filter will
set EV_EOF when the reader disconnects, and for the fifo
case, this may be cleared by use of EV_CLEAR. Note that
this filter is not supported for vnodes.
For sockets, the low water mark and socket error han-
dling is identical to the EVFILT_READ case.
EVFILT_AIO This filter is currently unsupported.
EVFILT_VNODE Takes a file descriptor as the identifier and the events
to watch for in _f_f_l_a_g_s, and returns when one or more of
the requested events occurs on the descriptor. The
events to monitor are:
NOTE_DELETE The uunnlliinnkk() system call was called on
the file referenced by the descriptor.
NOTE_WRITE A write occurred on the file referenced
by the descriptor.
NOTE_EXTEND The file referenced by the descriptor was
extended.
NOTE_ATTRIB The file referenced by the descriptor had
its attributes changed.
NOTE_LINK The link count on the file changed.
NOTE_RENAME The file referenced by the descriptor was
renamed.
NOTE_REVOKE Access to the file was revoked via
revoke(2) or the underlying fileystem was
unmounted.
NOTE_FUNLOCK The file was unlocked by calling flock(2)
or close(2)
On return, _f_f_l_a_g_s contains the filter-specific flags
which are associated with the triggered events seen by
this filter.
EVFILT_PROC Takes the process ID to monitor as the identifier and
the events to watch for in _f_f_l_a_g_s, and returns when the
process performs one or more of the requested events.
If a process can normally see another process, it can
attach an event to it. The events to monitor are:
NOTE_EXIT The process has exited.
NOTE_EXITSTATUS
The process has exited and its exit status
is in filter specific data. Valid only on
child processes and to be used along with
NOTE_EXIT.
NOTE_FORK The process created a child process via
fork(2) or similar call.
NOTE_EXEC The process executed a new process via
execve(2) or similar call.
NOTE_SIGNAL The process was sent a signal. Status can
be checked via waitpid(2) or similar call.
NOTE_REAP The process was reaped by the parent via
wait(2) or similar call. Deprecated, use
NOTE_EXIT.
On return, _f_f_l_a_g_s contains the events which triggered
the filter.
EVFILT_SIGNAL Takes the signal number to monitor as the identifier and
returns when the given signal is generated for the
process. This coexists with the ssiiggnnaall() and
ssiiggaaccttiioonn() facilities, and has a lower precedence.
Only signals sent to the process, not to a particular
thread, will trigger the filter. The filter will record
all attempts to deliver a signal to a process, even if
the signal has been marked as SIG_IGN. Event notifica-
tion happens before normal signal delivery processing.
_d_a_t_a returns the number of times the signal has been
generated since the last call to kkeevveenntt(). This filter
automatically sets the EV_CLEAR flag internally.
EVFILT_MACHPORT Takes the name of a mach port, or port set, in _i_d_e_n_t and
waits until a message is enqueued on the port or port
set. When a message is detected, but not directly
received by the kevent call, the name of the specific
port where the message is enqueued is returned in _d_a_t_a.
If _f_f_l_a_g_s contains MACH_RCV_MSG, the ext[0] and ext[1]
flags are assumed to contain a pointer to the buffer
where the message is to be received and the size of the
receive buffer, respectively. If MACH_RCV_MSG is
specifed, yet the buffer size in ext[1] is zero, The
space for the buffer may be carved out of the data_out
area provided to kkeevveenntt__qqooss() if there is enough space
remaining there.
EVFILT_TIMER Establishes an interval timer identified by _i_d_e_n_t where
_d_a_t_a specifies the timeout period (in milliseconds).
_f_f_l_a_g_s can include one of the following flags to specify
a different unit:
NOTE_SECONDS _d_a_t_a is in seconds
NOTE_USECONDS _d_a_t_a is in microseconds
NOTE_NSECONDS _d_a_t_a is in nanoseconds
NOTE_MACHTIME _d_a_t_a is in Mach absolute time units
_f_f_l_a_g_s can also include NOTE_ABSOLUTE, which establishes
an EV_ONESHOT timer with an absolute deadline instead of
an interval. The absolute deadline is expressed in
terms of gettimeofday(2). With NOTE_MACHTIME, the dead-
line is expressed in terms of mmaacchh__aabbssoolluuttee__ttiimmee().
The timer can be coalesced with other timers to save
power. The following flags can be set in _f_f_l_a_g_s to mod-
ify this behavior:
NOTE_CRITICAL override default power-saving tech-
niques to more strictly respect the
leeway value
NOTE_BACKGROUND apply more power-saving techniques to
coalesce this timer with other timers
NOTE_LEEWAY _e_x_t_[_1_] holds user-supplied slop in
deadline for timer coalescing.
The timer will be periodic unless EV_ONESHOT is speci-
fied. On return, _d_a_t_a contains the number of times the
timeout has expired since the last arming or last deliv-
ery of the timer event.
This filter automatically sets the EV_CLEAR flag.
----
In the _e_x_t_[_2_] field of the _k_e_v_e_n_t_6_4___s struture, _e_x_t_[_0_] is only used with
the EVFILT_MACHPORT filter. With other filters, _e_x_t_[_0_] is passed through
kkeevveenntt6644() much like _u_d_a_t_a. _e_x_t_[_1_] can always be used like _u_d_a_t_a. For
the use of ext[0], see the EVFILT_MACHPORT filter above.
RREETTUURRNN VVAALLUUEESS
The kkqquueeuuee() system call creates a new kernel event queue and returns a
file descriptor. If there was an error creating the kernel event queue,
a value of -1 is returned and errno set.
The kkeevveenntt(), kkeevveenntt6644() and kkeevveenntt__qqooss() system calls return the number
of events placed in the _e_v_e_n_t_l_i_s_t, up to the value given by _n_e_v_e_n_t_s. If
an error occurs while processing an element of the _c_h_a_n_g_e_l_i_s_t and there
is enough room in the _e_v_e_n_t_l_i_s_t, then the event will be placed in the
_e_v_e_n_t_l_i_s_t with EV_ERROR set in _f_l_a_g_s and the system error in _d_a_t_a. Oth-
erwise, -1 will be returned, and errno will be set to indicate the error
condition. If the time limit expires, then kkeevveenntt(), kkeevveenntt6644() and
kkeevveenntt__qqooss() return 0.
EERRRROORRSS
The kkqquueeuuee() system call fails if:
[ENOMEM] The kernel failed to allocate enough memory for the
kernel queue.
[EMFILE] The per-process descriptor table is full.
[ENFILE] The system file table is full.
The kkeevveenntt() and kkeevveenntt6644() system calls fail if:
[EACCES] The process does not have permission to register a
filter.
[EFAULT] There was an error reading or writing the _k_e_v_e_n_t or
_k_e_v_e_n_t_6_4___s structure.
[EBADF] The specified descriptor is invalid.
[EINTR] A signal was delivered before the timeout expired and
before any events were placed on the kqueue for
return.
[EINVAL] The specified time limit or filter is invalid.
[ENOENT] The event could not be found to be modified or
deleted.
[ENOMEM] No memory was available to register the event.
[ESRCH] The specified process to attach to does not exist.
SSEEEE AALLSSOO
aio_error(2), aio_read(2), aio_return(2), read(2), select(2),
sigaction(2), write(2), signal(3)
HHIISSTTOORRYY
The kkqquueeuuee() and kkeevveenntt() system calls first appeared in FreeBSD 4.1.
AAUUTTHHOORRSS
The kkqquueeuuee() system and this manual page were written by Jonathan Lemon
<jlemon@FreeBSD.org>.
BBUUGGSS
Not all filesystem types support kqueue-style notifications. And even
some that do, like some remote filesystems, may only support a subset of
the notification semantics described here.
BSD October 21, 2008 BSD
|