lib/libc/sys/kqueue.2

   1 .\" Copyright (c) 2000 Jonathan Lemon
   2 .\" All rights reserved.
   3 .\"
   4 .\" Redistribution and use in source and binary forms, with or without
   5 .\" modification, are permitted provided that the following conditions
   6 .\" are met:
   7 .\" 1. Redistributions of source code must retain the above copyright
   8 .\"    notice, this list of conditions and the following disclaimer.
   9 .\" 2. Redistributions in binary form must reproduce the above copyright
  10 .\"    notice, this list of conditions and the following disclaimer in the
  11 .\"    documentation and/or other materials provided with the distribution.
  12 .\"
  13 .\" THIS SOFTWARE IS PROVIDED ``AS IS'' AND
  14 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  15 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  16 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
  17 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  18 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  19 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  20 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  21 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  22 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  23 .\" SUCH DAMAGE.
  24 .\"
  25 .\" $FreeBSD: src/lib/libc/sys/kqueue.2,v 1.1.2.16 2002/07/02 21:05:08 mp Exp $
  26 .\" $DragonFly: src/lib/libc/sys/kqueue.2,v 1.6 2007/09/07 08:14:57 swildner Exp $
  27 .\"
  28 .Dd April 14, 2000
  29 .Dt KQUEUE 2
  30 .Os
  31 .Sh NAME
  32 .Nm kqueue ,
  33 .Nm kevent
  34 .Nd kernel event notification mechanism
  35 .Sh LIBRARY
  36 .Lb libc
  37 .Sh SYNOPSIS
  38 .In sys/types.h
  39 .In sys/event.h
  40 .In sys/time.h
  41 .Ft int
  42 .Fn kqueue "void"
  43 .Ft int
  44 .Fn kevent "int kq" "const struct kevent *changelist" "int nchanges" "struct kevent *eventlist" "int nevents" "const struct timespec *timeout"
  45 .Fn EV_SET "&kev" ident filter flags fflags data udata
  46 .Sh DESCRIPTION
  47 .Fn kqueue
  48 provides a generic method of notifying the user when an event
  49 happens or a condition holds, based on the results of small
  50 pieces of kernel code termed filters.
  51 A kevent is identified by the (ident, filter) pair; there may only
  52 be one unique kevent per kqueue.
  53 .Pp
  54 The filter is executed upon the initial registration of a kevent
  55 in order to detect whether a preexisting condition is present, and is also
  56 executed whenever an event is passed to the filter for evaluation.
  57 If the filter determines that the condition should be reported,
  58 then the kevent is placed on the kqueue for the user to retrieve.
  59 .Pp
  60 The filter is also run when the user attempts to retrieve the kevent
  61 from the kqueue.
  62 If the filter indicates that the condition that triggered
  63 the event no longer holds, the kevent is removed from the kqueue and
  64 is not returned.
  65 .Pp
  66 Multiple events which trigger the filter do not result in multiple
  67 kevents being placed on the kqueue; instead, the filter will aggregate
  68 the events into a single struct kevent.
  69 Calling
  70 .Fn close
  71 on a file descriptor will remove any kevents that reference the descriptor.
  72 .Pp
  73 .Fn kqueue
  74 creates a new kernel event queue and returns a descriptor.
  75 The queue is not inherited by a child created with
  76 .Xr fork 2 .
  77 However, if
  78 .Xr rfork 2
  79 is called without the
  80 .Dv RFFDG
  81 flag, then the descriptor table is shared,
  82 which will allow sharing of the kqueue between two processes.
  83 .Pp
  84 .Fn kevent
  85 is used to register events with the queue, and return any pending
  86 events to the user.
  87 .Fa changelist
  88 is a pointer to an array of
  89 .Va kevent
  90 structures, as defined in
  91 .In sys/event.h .
  92 All changes contained in the
  93 .Fa changelist
  94 are applied before any pending events are read from the queue.
  95 .Fa nchanges
  96 gives the size of
  97 .Fa changelist .
  98 .Fa eventlist
  99 is a pointer to an array of kevent structures.
 100 .Fa nevents
 101 determines the size of
 102 .Fa eventlist .
 103 If
 104 .Fa timeout
 105 is a non-NULL pointer, it specifies a maximum interval to wait
 106 for an event, which will be interpreted as a struct timespec.
 107 If
 108 .Fa timeout
 109 is a NULL pointer,
 110 .Fn kevent
 111 waits indefinitely.
 112 To effect a poll, the
 113 .Fa timeout
 114 argument should be non-NULL, pointing to a zero-valued
 115 .Va timespec
 116 structure.
 117 The same array may be used for the
 118 .Fa changelist
 119 and
 120 .Fa eventlist .
 121 .Pp
 122 .Fn EV_SET
 123 is a macro which is provided for ease of initializing a
 124 kevent structure.
 125 .Pp
 126 The
 127 .Va kevent
 128 structure is defined as:
 129 .Bd -literal
 130 struct kevent {
 131         uintptr_t ident;        /* identifier for this event */
 132         short     filter;       /* filter for event */
 133         u_short   flags;        /* action flags for kqueue */
 134         u_int     fflags;       /* filter flag value */
 135         intptr_t  data;         /* filter data value */
 136         void      *udata;       /* opaque user data identifier */
 137 };
 138 .Ed
 139 .Pp
 140 The fields of
 141 .Fa struct kevent
 142 are:
 143 .Bl -tag -width XXXfilter
 144 .It ident
 145 Value used to identify this event.
 146 The exact interpretation is determined by the attached filter,
 147 but often is a file descriptor.
 148 .It filter
 149 Identifies the kernel filter used to process this event.
 150 The pre-defined system filters are described below.
 151 .It flags
 152 Actions to perform on the event.
 153 .It fflags
 154 Filter-specific flags.
 155 .It data
 156 Filter-specific data value.
 157 .It udata
 158 Opaque user-defined value passed through the kernel unchanged.
 159 .El
 160 .Pp
 161 The
 162 .Va flags
 163 field can contain the following values:
 164 .Bl -tag -width ".Dv EV_ONESHOT"
 165 .It Dv EV_ADD
 166 Adds the event to the kqueue.
 167 Re-adding an existing event will modify the parameters of the original
 168 event, and not result in a duplicate entry.
 169 Adding an event automatically enables it, unless overridden by the
 170 .Dv EV_DISABLE
 171 flag.
 172 .It Dv EV_ENABLE
 173 Permit
 174 .Fn kevent
 175 to return the event if it is triggered.
 176 .It Dv EV_DISABLE
 177 Disable the event so
 178 .Fn kevent
 179 will not return it.
 180 The filter itself is not disabled.
 181 .It Dv EV_DELETE
 182 Removes the event from the kqueue.
 183 Events which are attached to file descriptors are automatically
 184 deleted on the last close of the descriptor.
 185 .It Dv EV_ONESHOT
 186 Causes the event to return only the first occurrence of the filter
 187 being triggered.
 188 After the user retrieves the event from the kqueue, it is deleted.
 189 .It Dv EV_CLEAR
 190 After the event is retrieved by the user, its state is reset.
 191 This is useful for filters which report state transitions
 192 instead of the current state.
 193 Note that some filters may automatically set this flag internally.
 194 .It Dv EV_EOF
 195 Filters may set this flag to indicate filter-specific EOF condition.
 196 .It Dv EV_ERROR
 197 See
 198 .Sx RETURN VALUES
 199 below.
 200 .El
 201 .Pp
 202 The predefined system filters are listed below.
 203 Arguments may be passed to and from the filter via the
 204 .Va fflags
 205 and
 206 .Va data
 207 fields in the kevent structure.
 208 .Bl -tag -width ".Dv EVFILT_SIGNAL"
 209 .It Dv EVFILT_READ
 210 Takes a descriptor as the identifier, and returns whenever
 211 there is data available to read.
 212 The behavior of the filter is slightly different depending
 213 on the descriptor type.
 214 .Pp
 215 .Bl -tag -width 2n
 216 .It Sockets
 217 Sockets which have previously been passed to
 218 .Fn listen
 219 return when there is an incoming connection pending.
 220 .Va data
 221 contains the size of the listen backlog.
 222 .Pp
 223 Other socket descriptors return when there is data to be read,
 224 subject to the
 225 .Dv SO_RCVLOWAT
 226 value of the socket buffer.
 227 This may be overridden with a per-filter low water mark at the
 228 time the filter is added by setting the
 229 .Dv NOTE_LOWAT
 230 flag in
 231 .Va fflags ,
 232 and specifying the new low water mark in
 233 .Va data .
 234 On return,
 235 .Va data
 236 contains the number of bytes in the socket buffer.
 237 .Pp
 238 If the read direction of the socket has shutdown, then the filter also sets
 239 .Dv EV_EOF
 240 in
 241 .Va flags ,
 242 and returns the socket error (if any) in
 243 .Va fflags .
 244 It is possible for EOF to be returned (indicating the connection is gone)
 245 while there is still data pending in the socket buffer.
 246 .It Vnodes
 247 Returns when the file pointer is not at the end of file.
 248 .Va data
 249 contains the offset from current position to end of file,
 250 and may be negative.
 251 .It "Fifos, Pipes"
 252 Returns when the there is data to read;
 253 .Va data
 254 contains the number of bytes available.
 255 .Pp
 256 When the last writer disconnects, the filter will set
 257 .Dv EV_EOF
 258 in
 259 .Va flags .
 260 This may be cleared by passing in
 261 .Dv EV_CLEAR ,
 262 at which point the filter will resume waiting for data to become
 263 available before returning.
 264 .El
 265 .It Dv EVFILT_WRITE
 266 Takes a descriptor as the identifier, and returns whenever
 267 it is possible to write to the descriptor.
 268 For sockets, pipes and fifos,
 269 .Va data
 270 will contain the amount of space remaining in the write buffer.
 271 The filter will set
 272 .Dv EV_EOF
 273 when the reader disconnects, and for the fifo case, this may be cleared
 274 by use of
 275 .Dv EV_CLEAR .
 276 Note that this filter is not supported for vnodes.
 277 .Pp
 278 For sockets, the low water mark and socket error handling is
 279 identical to the
 280 .Dv EVFILT_READ
 281 case.
 282 .It Dv EVFILT_AIO
 283 The sigevent portion of the AIO request is filled in, with
 284 .Va sigev_notify_kqueue
 285 containing the descriptor of the kqueue that the event should
 286 be attached to,
 287 .Va sigev_value
 288 containing the udata value, and
 289 .Va sigev_notify
 290 set to
 291 .Dv SIGEV_KEVENT .
 292 When the aio_* function is called, the event will be registered
 293 with the specified kqueue, and the
 294 .Va ident
 295 argument set to the
 296 .Fa struct aiocb
 297 returned by the aio_* function.
 298 The filter returns under the same conditions as aio_error.
 299 .Pp
 300 Alternatively, a kevent structure may be initialized, with
 301 .Va ident
 302 containing the descriptor of the kqueue, and the
 303 address of the kevent structure placed in the
 304 .Va aio_lio_opcode
 305 field of the AIO request.
 306 However, this approach will not work on architectures with 64-bit
 307 pointers, and should be considered deprecated.
 308 .It Dv EVFILT_VNODE
 309 Takes a file descriptor as the identifier and the events to watch for in
 310 .Va fflags ,
 311 and returns when one or more of the requested events occurs on the descriptor.
 312 The events to monitor are:
 313 .Bl -tag -width ".Dv NOTE_RENAME"
 314 .It Dv NOTE_DELETE
 315 .Fn unlink
 316 was called on the file referenced by the descriptor.
 317 .It Dv NOTE_WRITE
 318 A write occurred on the file referenced by the descriptor.
 319 .It Dv NOTE_EXTEND
 320 The file referenced by the descriptor was extended.
 321 .It Dv NOTE_ATTRIB
 322 The file referenced by the descriptor had its attributes changed.
 323 .It Dv NOTE_LINK
 324 The link count on the file changed.
 325 .It Dv NOTE_RENAME
 326 The file referenced by the descriptor was renamed.
 327 .It Dv NOTE_REVOKE
 328 Access to the file was revoked via
 329 .Xr revoke 2
 330 or the underlying fileystem was unmounted.
 331 .El
 332 .Pp
 333 On return,
 334 .Va fflags
 335 contains the events which triggered the filter.
 336 .It Dv EVFILT_PROC
 337 Takes the process ID to monitor as the identifier and the events to watch for
 338 in
 339 .Va fflags ,
 340 and returns when the process performs one or more of the requested events.
 341 If a process can normally see another process, it can attach an event to it.
 342 The events to monitor are:
 343 .Bl -tag -width ".Dv NOTE_TRACKERR"
 344 .It Dv NOTE_EXIT
 345 The process has exited.
 346 .It Dv NOTE_FORK
 347 The process has called
 348 .Fn fork .
 349 .It Dv NOTE_EXEC
 350 The process has executed a new process via
 351 .Xr execve 2
 352 or similar call.
 353 .It Dv NOTE_TRACK
 354 Follow a process across
 355 .Fn fork
 356 calls.
 357 The parent process will return with
 358 .Dv NOTE_TRACK
 359 set in the
 360 .Va fflags
 361 field, while the child process will return with
 362 .Dv NOTE_CHILD
 363 set in
 364 .Va fflags
 365 and the parent PID in
 366 .Va data .
 367 .It Dv NOTE_TRACKERR
 368 This flag is returned if the system was unable to attach an event to
 369 the child process, usually due to resource limitations.
 370 .El
 371 .Pp
 372 On return,
 373 .Va fflags
 374 contains the events which triggered the filter.
 375 .It Dv EVFILT_SIGNAL
 376 Takes the signal number to monitor as the identifier and returns
 377 when the given signal is delivered to the process.
 378 This coexists with the
 379 .Fn signal
 380 and
 381 .Fn sigaction
 382 facilities, and has a lower precedence.
 383 The filter will record all attempts to deliver a signal to a process,
 384 even if the signal has been marked as
 385 .Dv SIG_IGN .
 386 Event notification happens after normal signal delivery processing.
 387 .Va data
 388 returns the number of times the signal has occurred since the last call to
 389 .Fn kevent .
 390 This filter automatically sets the
 391 .Dv EV_CLEAR
 392 flag internally.
 393 .It Dv EVFILT_TIMER
 394 Establishes an arbitrary timer identified by
 395 .Va ident .
 396 When adding a timer,
 397 .Va data
 398 specifies the timeout period in milliseconds.
 399 The timer will be periodic unless
 400 .Dv EV_ONESHOT
 401 is specified.
 402 On return,
 403 .Va data
 404 contains the number of times the timeout has expired since the last call to
 405 .Fn kevent .
 406 This filter automatically sets the
 407 .Dv EV_CLEAR
 408 flag internally.
 409 .El
 410 .Sh RETURN VALUES
 411 .Fn kqueue
 412 creates a new kernel event queue and returns a file descriptor.
 413 If there was an error creating the kernel event queue, a value of -1 is
 414 returned and
 415 .Va errno
 416 set.
 417 .Pp
 418 .Fn kevent
 419 returns the number of events placed in the
 420 .Fa eventlist ,
 421 up to the value given by
 422 .Fa nevents .
 423 If an error occurs while processing an element of the
 424 .Fa changelist
 425 and there is enough room in the
 426 .Fa eventlist ,
 427 then the event will be placed in the
 428 .Fa eventlist
 429 with
 430 .Dv EV_ERROR
 431 set in
 432 .Va flags
 433 and the system error in
 434 .Va data .
 435 Otherwise,
 436 .Dv -1
 437 will be returned, and
 438 .Va errno
 439 will be set to indicate the error condition.
 440 If the time limit expires, then
 441 .Fn kevent
 442 returns 0.
 443 .Sh ERRORS
 444 The
 445 .Fn kqueue
 446 function fails if:
 447 .Bl -tag -width Er
 448 .It Bq Er ENOMEM
 449 The kernel failed to allocate enough memory for the kernel queue.
 450 .It Bq Er EMFILE
 451 The per-process descriptor table is full.
 452 .It Bq Er ENFILE
 453 The system file table is full.
 454 .El
 455 .Pp
 456 The
 457 .Fn kevent
 458 function fails if:
 459 .Bl -tag -width Er
 460 .It Bq Er EACCES
 461 The process does not have permission to register a filter.
 462 .It Bq Er EFAULT
 463 There was an error reading or writing the
 464 .Va kevent
 465 structure.
 466 .It Bq Er EBADF
 467 The specified descriptor is invalid.
 468 .It Bq Er EINTR
 469 A signal was delivered before the timeout expired and before any
 470 events were placed on the kqueue for return.
 471 .It Bq Er EINVAL
 472 The specified time limit or filter is invalid.
 473 .It Bq Er ENOENT
 474 The event could not be found to be modified or deleted.
 475 .It Bq Er ENOMEM
 476 No memory was available to register the event.
 477 .It Bq Er ESRCH
 478 The specified process to attach to does not exist.
 479 .El
 480 .Sh SEE ALSO
 481 .Xr aio_error 2 ,
 482 .Xr aio_read 2 ,
 483 .Xr aio_return 2 ,
 484 .Xr poll 2 ,
 485 .Xr read 2 ,
 486 .Xr select 2 ,
 487 .Xr sigaction 2 ,
 488 .Xr write 2 ,
 489 .Xr signal 3
 490 .Sh HISTORY
 491 The
 492 .Fn kqueue
 493 and
 494 .Fn kevent
 495 functions first appeared in
 496 .Fx 4.1 .
 497 .Sh AUTHORS
 498 The
 499 .Fn kqueue
 500 system and this manual page were written by
 501 .An Jonathan Lemon Aq jlemon@FreeBSD.org .
 502 .Sh BUGS
 503 It is currently not possible to watch a
 504 .Xr vnode 9
 505 that resides on anything but
 506 a UFS file system.