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$
  26 .\"
  27 .Dd February 15, 2012
  28 .Dt KQUEUE 2
  29 .Os
  30 .Sh NAME
  31 .Nm kqueue ,
  32 .Nm kevent
  33 .Nd kernel event notification mechanism
  34 .Sh LIBRARY
  35 .Lb libc
  36 .Sh SYNOPSIS
  37 .In sys/types.h
  38 .In sys/event.h
  39 .In sys/time.h
  40 .Ft int
  41 .Fn kqueue "void"
  42 .Ft int
  43 .Fn kevent "int kq" "const struct kevent *changelist" "int nchanges" "struct kevent *eventlist" "int nevents" "const struct timespec *timeout"
  44 .Fn EV_SET "&kev" ident filter flags fflags data udata
  45 .Sh DESCRIPTION
  46 The
  47 .Fn kqueue
  48 system call
  49 provides a generic method of notifying the user when an event
  50 happens or a condition holds, based on the results of small
  51 pieces of kernel code termed filters.
  52 A kevent is identified by the (ident, filter) pair; there may only
  53 be one unique kevent per kqueue.
  54 .Pp
  55 The filter is executed upon the initial registration of a kevent
  56 in order to detect whether a preexisting condition is present, and is also
  57 executed whenever an event is passed to the filter for evaluation.
  58 If the filter determines that the condition should be reported,
  59 then the kevent is placed on the kqueue for the user to retrieve.
  60 .Pp
  61 The filter is also run when the user attempts to retrieve the kevent
  62 from the kqueue.
  63 If the filter indicates that the condition that triggered
  64 the event no longer holds, the kevent is removed from the kqueue and
  65 is not returned.
  66 .Pp
  67 Multiple events which trigger the filter do not result in multiple
  68 kevents being placed on the kqueue; instead, the filter will aggregate
  69 the events into a single struct kevent.
  70 Calling
  71 .Fn close
  72 on a file descriptor will remove any kevents that reference the descriptor.
  73 .Pp
  74 The
  75 .Fn kqueue
  76 system call
  77 creates a new kernel event queue and returns a descriptor.
  78 The queue is not inherited by a child created with
  79 .Xr fork 2 .
  80 However, if
  81 .Xr rfork 2
  82 is called without the
  83 .Dv RFFDG
  84 flag, then the descriptor table is shared,
  85 which will allow sharing of the kqueue between two processes.
  86 .Pp
  87 The
  88 .Fn kevent
  89 system call
  90 is used to register events with the queue, and return any pending
  91 events to the user.
  92 The
  93 .Fa changelist
  94 argument
  95 is a pointer to an array of
  96 .Va kevent
  97 structures, as defined in
  98 .In sys/event.h .
  99 All changes contained in the
 100 .Fa changelist
 101 are applied before any pending events are read from the queue.
 102 The
 103 .Fa nchanges
 104 argument
 105 gives the size of
 106 .Fa changelist .
 107 The
 108 .Fa eventlist
 109 argument
 110 is a pointer to an array of kevent structures.
 111 The
 112 .Fa nevents
 113 argument
 114 determines the size of
 115 .Fa eventlist .
 116 When
 117 .Fa nevents
 118 is zero,
 119 .Fn kevent
 120 will return immediately even if there is a
 121 .Fa timeout
 122 specified unlike
 123 .Xr select 2 .
 124 If
 125 .Fa timeout
 126 is a non-NULL pointer, it specifies a maximum interval to wait
 127 for an event, which will be interpreted as a struct timespec.
 128 If
 129 .Fa timeout
 130 is a NULL pointer,
 131 .Fn kevent
 132 waits indefinitely.
 133 To effect a poll, the
 134 .Fa timeout
 135 argument should be non-NULL, pointing to a zero-valued
 136 .Va timespec
 137 structure.
 138 The same array may be used for the
 139 .Fa changelist
 140 and
 141 .Fa eventlist .
 142 .Pp
 143 The
 144 .Fn EV_SET
 145 macro is provided for ease of initializing a
 146 kevent structure.
 147 .Pp
 148 The
 149 .Va kevent
 150 structure is defined as:
 151 .Bd -literal
 152 struct kevent {
 153         uintptr_t ident;        /* identifier for this event */
 154         short     filter;       /* filter for event */
 155         u_short   flags;        /* action flags for kqueue */
 156         u_int     fflags;       /* filter flag value */
 157         intptr_t  data;         /* filter data value */
 158         void      *udata;       /* opaque user data identifier */
 159 };
 160 .Ed
 161 .Pp
 162 The fields of
 163 .Fa struct kevent
 164 are:
 165 .Bl -tag -width XXXfilter
 166 .It ident
 167 Value used to identify this event.
 168 The exact interpretation is determined by the attached filter,
 169 but often is a file descriptor.
 170 .It filter
 171 Identifies the kernel filter used to process this event.
 172 The pre-defined
 173 system filters are described below.
 174 .It flags
 175 Actions to perform on the event.
 176 .It fflags
 177 Filter-specific flags.
 178 .It data
 179 Filter-specific data value.
 180 .It udata
 181 Opaque user-defined value passed through the kernel unchanged.
 182 .El
 183 .Pp
 184 The
 185 .Va flags
 186 field can contain the following values:
 187 .Bl -tag -width XXXEV_ONESHOT
 188 .It EV_ADD
 189 Adds the event to the kqueue.
 190 Re-adding an existing event
 191 will modify the parameters of the original event, and not result
 192 in a duplicate entry.
 193 Adding an event automatically enables it,
 194 unless overridden by the EV_DISABLE flag.
 195 .It EV_ENABLE
 196 Permit
 197 .Fn kevent
 198 to return the event if it is triggered.
 199 .It EV_DISABLE
 200 Disable the event so
 201 .Fn kevent
 202 will not return it.
 203 The filter itself is not disabled.
 204 .It EV_DISPATCH
 205 Disable the event source immediately after delivery of an event.
 206 See
 207 .Dv EV_DISABLE
 208 above.
 209 .It EV_DELETE
 210 Removes the event from the kqueue.
 211 Events which are attached to
 212 file descriptors are automatically deleted on the last close of
 213 the descriptor.
 214 .It EV_RECEIPT
 215 This flag is useful for making bulk changes to a kqueue without draining
 216 any pending events.
 217 When passed as input, it forces
 218 .Dv EV_ERROR
 219 to always be returned.
 220 When a filter is successfully added the
 221 .Va data
 222 field will be zero.
 223 .It EV_ONESHOT
 224 Causes the event to return only the first occurrence of the filter
 225 being triggered.
 226 After the user retrieves the event from the kqueue,
 227 it is deleted.
 228 .It EV_CLEAR
 229 After the event is retrieved by the user, its state is reset.
 230 This is useful for filters which report state transitions
 231 instead of the current state.
 232 Note that some filters may automatically
 233 set this flag internally.
 234 .It EV_EOF
 235 Filters may set this flag to indicate filter-specific EOF condition.
 236 .It EV_ERROR
 237 See
 238 .Sx RETURN VALUES
 239 below.
 240 .El
 241 .Pp
 242 The predefined system filters are listed below.
 243 Arguments may be passed to and from the filter via the
 244 .Va fflags
 245 and
 246 .Va data
 247 fields in the kevent structure.
 248 .Bl -tag -width EVFILT_SIGNAL
 249 .It EVFILT_READ
 250 Takes a descriptor as the identifier, and returns whenever
 251 there is data available to read.
 252 The behavior of the filter is slightly different depending
 253 on the descriptor type.
 254 .Bl -tag -width 2n
 255 .It Sockets
 256 Sockets which have previously been passed to
 257 .Fn listen
 258 return when there is an incoming connection pending.
 259 .Va data
 260 contains the size of the listen backlog.
 261 .Pp
 262 Other socket descriptors return when there is data to be read,
 263 subject to the
 264 .Dv SO_RCVLOWAT
 265 value of the socket buffer.
 266 This may be overridden with a per-filter low water mark at the
 267 time the filter is added by setting the
 268 NOTE_LOWAT
 269 flag in
 270 .Va fflags ,
 271 and specifying the new low water mark in
 272 .Va data .
 273 On return,
 274 .Va data
 275 contains the number of bytes of protocol data available to read.
 276 .Pp
 277 If the read direction of the socket has shutdown, then the filter
 278 also sets EV_EOF in
 279 .Va flags ,
 280 and returns the socket error (if any) in
 281 .Va fflags .
 282 It is possible for EOF to be returned (indicating the connection is gone)
 283 while there is still data pending in the socket buffer.
 284 .It Vnodes
 285 Returns when the file pointer is not at the end of file.
 286 .Va data
 287 contains the offset from current position to end of file,
 288 and may be negative.
 289 .It "Fifos, Pipes"
 290 Returns when the there is data to read;
 291 .Va data
 292 contains the number of bytes available.
 293 .Pp
 294 When the last writer disconnects, the filter will set EV_EOF in
 295 .Va flags .
 296 This may be cleared by passing in EV_CLEAR, at which point the
 297 filter will resume waiting for data to become available before
 298 returning.
 299 .It "BPF devices"
 300 Returns when the BPF buffer is full, the BPF timeout has expired, or
 301 when the BPF has
 302 .Dq immediate mode
 303 enabled and there is any data to read;
 304 .Va data
 305 contains the number of bytes available.
 306 .El
 307 .It EVFILT_WRITE
 308 Takes a descriptor as the identifier, and returns whenever
 309 it is possible to write to the descriptor.
 310 For sockets, pipes
 311 and fifos,
 312 .Va data
 313 will contain the amount of space remaining in the write buffer.
 314 The filter will set EV_EOF when the reader disconnects, and for
 315 the fifo case, this may be cleared by use of EV_CLEAR.
 316 Note that this filter is not supported for vnodes or BPF devices.
 317 .Pp
 318 For sockets, the low water mark and socket error handling is
 319 identical to the EVFILT_READ case.
 320 .It EVFILT_AIO
 321 The sigevent portion of the AIO request is filled in, with
 322 .Va sigev_notify_kqueue
 323 containing the descriptor of the kqueue that the event should
 324 be attached to,
 325 .Va sigev_notify_kevent_flags
 326 containing the kevent flags which should be EV_ONESHOT, EV_CLEAR or
 327 EV_DISPATCH,
 328 .Va sigev_value
 329 containing the udata value, and
 330 .Va sigev_notify
 331 set to SIGEV_KEVENT.
 332 When the
 333 .Fn aio_*
 334 system call is made, the event will be registered
 335 with the specified kqueue, and the
 336 .Va ident
 337 argument set to the
 338 .Fa struct aiocb
 339 returned by the
 340 .Fn aio_*
 341 system call.
 342 The filter returns under the same conditions as aio_error.
 343 .It EVFILT_VNODE
 344 Takes a file descriptor as the identifier and the events to watch for in
 345 .Va fflags ,
 346 and returns when one or more of the requested events occurs on the descriptor.
 347 The events to monitor are:
 348 .Bl -tag -width XXNOTE_RENAME
 349 .It NOTE_DELETE
 350 The
 351 .Fn unlink
 352 system call
 353 was called on the file referenced by the descriptor.
 354 .It NOTE_WRITE
 355 A write occurred on the file referenced by the descriptor.
 356 .It NOTE_EXTEND
 357 The file referenced by the descriptor was extended.
 358 .It NOTE_ATTRIB
 359 The file referenced by the descriptor had its attributes changed.
 360 .It NOTE_LINK
 361 The link count on the file changed.
 362 .It NOTE_RENAME
 363 The file referenced by the descriptor was renamed.
 364 .It NOTE_REVOKE
 365 Access to the file was revoked via
 366 .Xr revoke 2
 367 or the underlying file system was unmounted.
 368 .El
 369 .Pp
 370 On return,
 371 .Va fflags
 372 contains the events which triggered the filter.
 373 .It EVFILT_PROC
 374 Takes the process ID to monitor as the identifier and the events to watch for
 375 in
 376 .Va fflags ,
 377 and returns when the process performs one or more of the requested events.
 378 If a process can normally see another process, it can attach an event to it.
 379 The events to monitor are:
 380 .Bl -tag -width XXNOTE_TRACKERR
 381 .It NOTE_EXIT
 382 The process has exited.
 383 The exit status will be stored in
 384 .Va data .
 385 .It NOTE_FORK
 386 The process has called
 387 .Fn fork .
 388 .It NOTE_EXEC
 389 The process has executed a new process via
 390 .Xr execve 2
 391 or similar call.
 392 .It NOTE_TRACK
 393 Follow a process across
 394 .Fn fork
 395 calls.
 396 The parent process will return with NOTE_TRACK set in the
 397 .Va fflags
 398 field, while the child process will return with NOTE_CHILD set in
 399 .Va fflags
 400 and the parent PID in
 401 .Va data .
 402 .It NOTE_TRACKERR
 403 This flag is returned if the system was unable to attach an event to
 404 the child process, usually due to resource limitations.
 405 .El
 406 .Pp
 407 On return,
 408 .Va fflags
 409 contains the events which triggered the filter.
 410 .It EVFILT_SIGNAL
 411 Takes the signal number to monitor as the identifier and returns
 412 when the given signal is delivered to the process.
 413 This coexists with the
 414 .Fn signal
 415 and
 416 .Fn sigaction
 417 facilities, and has a lower precedence.
 418 The filter will record
 419 all attempts to deliver a signal to a process, even if the signal has
 420 been marked as SIG_IGN.
 421 Event notification happens after normal
 422 signal delivery processing.
 423 .Va data
 424 returns the number of times the signal has occurred since the last call to
 425 .Fn kevent .
 426 This filter automatically sets the EV_CLEAR flag internally.
 427 .It EVFILT_TIMER
 428 Establishes an arbitrary timer identified by
 429 .Va ident .
 430 When adding a timer,
 431 .Va data
 432 specifies the timeout period in milliseconds.
 433 The timer will be periodic unless EV_ONESHOT is specified.
 434 On return,
 435 .Va data
 436 contains the number of times the timeout has expired since the last call to
 437 .Fn kevent .
 438 This filter automatically sets the EV_CLEAR flag internally.
 439 There is a system wide limit on the number of timers
 440 which is controlled by the
 441 .Va kern.kq_calloutmax
 442 sysctl.
 443 .Pp
 444 On return,
 445 .Va fflags
 446 contains the events which triggered the filter.
 447 .It Dv EVFILT_USER
 448 Establishes a user event identified by
 449 .Va ident
 450 which is not associated with any kernel mechanism but is triggered by
 451 user level code.
 452 The lower 24 bits of the
 453 .Va fflags
 454 may be used for user defined flags and manipulated using the following:
 455 .Bl -tag -width XXNOTE_FFLAGSMASK
 456 .It Dv NOTE_FFNOP
 457 Ignore the input
 458 .Va fflags .
 459 .It Dv NOTE_FFAND
 460 Bitwise AND
 461 .Va fflags .
 462 .It Dv NOTE_FFOR
 463 Bitwise OR
 464 .Va fflags .
 465 .It Dv NOTE_COPY
 466 Copy
 467 .Va fflags .
 468 .It Dv NOTE_FFCTRLMASK
 469 Control mask for
 470 .Va fflags .
 471 .It Dv NOTE_FFLAGSMASK
 472 User defined flag mask for
 473 .Va fflags .
 474 .El
 475 .Pp
 476 A user event is triggered for output with the following:
 477 .Bl -tag -width XXNOTE_FFLAGSMASK
 478 .It Dv NOTE_TRIGGER
 479 Cause the event to be triggered.
 480 .El
 481 .Pp
 482 On return,
 483 .Va fflags
 484 contains the users defined flags in the lower 24 bits.
 485 .El
 486 .Sh RETURN VALUES
 487 The
 488 .Fn kqueue
 489 system call
 490 creates a new kernel event queue and returns a file descriptor.
 491 If there was an error creating the kernel event queue, a value of -1 is
 492 returned and errno set.
 493 .Pp
 494 The
 495 .Fn kevent
 496 system call
 497 returns the number of events placed in the
 498 .Fa eventlist ,
 499 up to the value given by
 500 .Fa nevents .
 501 If an error occurs while processing an element of the
 502 .Fa changelist
 503 and there is enough room in the
 504 .Fa eventlist ,
 505 then the event will be placed in the
 506 .Fa eventlist
 507 with
 508 .Dv EV_ERROR
 509 set in
 510 .Va flags
 511 and the system error in
 512 .Va data .
 513 Otherwise,
 514 .Dv -1
 515 will be returned, and
 516 .Dv errno
 517 will be set to indicate the error condition.
 518 If the time limit expires, then
 519 .Fn kevent
 520 returns 0.
 521 .Sh ERRORS
 522 The
 523 .Fn kqueue
 524 system call fails if:
 525 .Bl -tag -width Er
 526 .It Bq Er ENOMEM
 527 The kernel failed to allocate enough memory for the kernel queue.
 528 .It Bq Er EMFILE
 529 The per-process descriptor table is full.
 530 .It Bq Er ENFILE
 531 The system file table is full.
 532 .El
 533 .Pp
 534 The
 535 .Fn kevent
 536 system call fails if:
 537 .Bl -tag -width Er
 538 .It Bq Er EACCES
 539 The process does not have permission to register a filter.
 540 .It Bq Er EFAULT
 541 There was an error reading or writing the
 542 .Va kevent
 543 structure.
 544 .It Bq Er EBADF
 545 The specified descriptor is invalid.
 546 .It Bq Er EINTR
 547 A signal was delivered before the timeout expired and before any
 548 events were placed on the kqueue for return.
 549 .It Bq Er EINVAL
 550 The specified time limit or filter is invalid.
 551 .It Bq Er ENOENT
 552 The event could not be found to be modified or deleted.
 553 .It Bq Er ENOMEM
 554 No memory was available to register the event
 555 or, in the special case of a timer, the maximum number of
 556 timers has been exceeded.
 557 This maximum is configurable via the
 558 .Va kern.kq_calloutmax
 559 sysctl.
 560 .It Bq Er ESRCH
 561 The specified process to attach to does not exist.
 562 .El
 563 .Sh SEE ALSO
 564 .Xr aio_error 2 ,
 565 .Xr aio_read 2 ,
 566 .Xr aio_return 2 ,
 567 .Xr poll 2 ,
 568 .Xr read 2 ,
 569 .Xr select 2 ,
 570 .Xr sigaction 2 ,
 571 .Xr write 2 ,
 572 .Xr signal 3
 573 .Sh HISTORY
 574 The
 575 .Fn kqueue
 576 and
 577 .Fn kevent
 578 system calls first appeared in
 579 .Fx 4.1 .
 580 .Sh AUTHORS
 581 The
 582 .Fn kqueue
 583 system and this manual page were written by
 584 .An Jonathan Lemon Aq jlemon@FreeBSD.org .
 585 .Sh BUGS
 586 The
 587 .Fa timeout
 588 value is limited to 24 hours; longer timeouts will be silently
 589 reinterpreted as 24 hours.