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 March 29, 2015
  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 "Fa filter"
 166 .It Fa 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 Fa filter
 171 Identifies the kernel filter used to process this event.
 172 The pre-defined
 173 system filters are described below.
 174 .It Fa flags
 175 Actions to perform on the event.
 176 .It Fa fflags
 177 Filter-specific flags.
 178 .It Fa data
 179 Filter-specific data value.
 180 .It Fa 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 EV_DISPATCH
 188 .It Dv 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 Dv EV_ENABLE
 196 Permit
 197 .Fn kevent
 198 to return the event if it is triggered.
 199 .It Dv EV_DISABLE
 200 Disable the event so
 201 .Fn kevent
 202 will not return it.
 203 The filter itself is not disabled.
 204 .It Dv EV_DISPATCH
 205 Disable the event source immediately after delivery of an event.
 206 See
 207 .Dv EV_DISABLE
 208 above.
 209 .It Dv 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 Dv 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 Dv 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 Dv 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 Dv EV_EOF
 235 Filters may set this flag to indicate filter-specific EOF condition.
 236 .It Dv 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 "Dv EVFILT_PROCDESC"
 249 .It Dv 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 .Dv 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
 279 .Dv EV_EOF
 280 in
 281 .Va flags ,
 282 and returns the socket error (if any) in
 283 .Va fflags .
 284 It is possible for EOF to be returned (indicating the connection is gone)
 285 while there is still data pending in the socket buffer.
 286 .It Vnodes
 287 Returns when the file pointer is not at the end of file.
 288 .Va data
 289 contains the offset from current position to end of file,
 290 and may be negative.
 291 .It "Fifos, Pipes"
 292 Returns when the there is data to read;
 293 .Va data
 294 contains the number of bytes available.
 295 .Pp
 296 When the last writer disconnects, the filter will set
 297 .Dv EV_EOF
 298 in
 299 .Va flags .
 300 This may be cleared by passing in
 301 .Dv EV_CLEAR ,
 302 at which point the
 303 filter will resume waiting for data to become available before
 304 returning.
 305 .It "BPF devices"
 306 Returns when the BPF buffer is full, the BPF timeout has expired, or
 307 when the BPF has
 308 .Dq immediate mode
 309 enabled and there is any data to read;
 310 .Va data
 311 contains the number of bytes available.
 312 .El
 313 .It Dv EVFILT_WRITE
 314 Takes a descriptor as the identifier, and returns whenever
 315 it is possible to write to the descriptor.
 316 For sockets, pipes
 317 and fifos,
 318 .Va data
 319 will contain the amount of space remaining in the write buffer.
 320 The filter will set EV_EOF when the reader disconnects, and for
 321 the fifo case, this may be cleared by use of
 322 .Dv EV_CLEAR .
 323 Note that this filter is not supported for vnodes or BPF devices.
 324 .Pp
 325 For sockets, the low water mark and socket error handling is
 326 identical to the
 327 .Dv EVFILT_READ
 328 case.
 329 .It Dv EVFILT_AIO
 330 The sigevent portion of the AIO request is filled in, with
 331 .Va sigev_notify_kqueue
 332 containing the descriptor of the kqueue that the event should
 333 be attached to,
 334 .Va sigev_notify_kevent_flags
 335 containing the kevent flags which should be
 336 .Dv EV_ONESHOT ,
 337 .Dv EV_CLEAR
 338 or
 339 .Dv EV_DISPATCH ,
 340 .Va sigev_value
 341 containing the udata value, and
 342 .Va sigev_notify
 343 set to
 344 .Dv SIGEV_KEVENT .
 345 When the
 346 .Fn aio_*
 347 system call is made, the event will be registered
 348 with the specified kqueue, and the
 349 .Va ident
 350 argument set to the
 351 .Fa struct aiocb
 352 returned by the
 353 .Fn aio_*
 354 system call.
 355 The filter returns under the same conditions as
 356 .Fn aio_error .
 357 .It Dv EVFILT_VNODE
 358 Takes a file descriptor as the identifier and the events to watch for in
 359 .Va fflags ,
 360 and returns when one or more of the requested events occurs on the descriptor.
 361 The events to monitor are:
 362 .Bl -tag -width "Dv NOTE_RENAME"
 363 .It Dv NOTE_DELETE
 364 The
 365 .Fn unlink
 366 system call
 367 was called on the file referenced by the descriptor.
 368 .It Dv NOTE_WRITE
 369 A write occurred on the file referenced by the descriptor.
 370 .It Dv NOTE_EXTEND
 371 The file referenced by the descriptor was extended.
 372 .It Dv NOTE_ATTRIB
 373 The file referenced by the descriptor had its attributes changed.
 374 .It Dv NOTE_LINK
 375 The link count on the file changed.
 376 .It Dv NOTE_RENAME
 377 The file referenced by the descriptor was renamed.
 378 .It Dv NOTE_REVOKE
 379 Access to the file was revoked via
 380 .Xr revoke 2
 381 or the underlying file system was unmounted.
 382 .El
 383 .Pp
 384 On return,
 385 .Va fflags
 386 contains the events which triggered the filter.
 387 .It Dv EVFILT_PROC
 388 Takes the process ID to monitor as the identifier and the events to watch for
 389 in
 390 .Va fflags ,
 391 and returns when the process performs one or more of the requested events.
 392 If a process can normally see another process, it can attach an event to it.
 393 The events to monitor are:
 394 .Bl -tag -width "Dv NOTE_TRACKERR"
 395 .It Dv NOTE_EXIT
 396 The process has exited.
 397 The exit status will be stored in
 398 .Va data .
 399 .It Dv NOTE_FORK
 400 The process has called
 401 .Fn fork .
 402 .It Dv NOTE_EXEC
 403 The process has executed a new process via
 404 .Xr execve 2
 405 or a similar call.
 406 .It Dv NOTE_TRACK
 407 Follow a process across
 408 .Fn fork
 409 calls.
 410 The parent process registers a new kevent to monitor the child process
 411 using the same
 412 .Va fflags
 413 as the original event.
 414 The child process will signal an event with
 415 .Dv NOTE_CHILD
 416 set in
 417 .Va fflags
 418 and the parent PID in
 419 .Va data .
 420 .Pp
 421 If the parent process fails to register a new kevent
 422 .Pq usually due to resource limitations ,
 423 it will signal an event with
 424 .Dv NOTE_TRACKERR
 425 set in
 426 .Va fflags ,
 427 and the child process will not signal a
 428 .Dv NOTE_CHILD
 429 event.
 430 .El
 431 .Pp
 432 On return,
 433 .Va fflags
 434 contains the events which triggered the filter.
 435 .It Dv EVFILT_SIGNAL
 436 Takes the signal number to monitor as the identifier and returns
 437 when the given signal is delivered to the process.
 438 This coexists with the
 439 .Fn signal
 440 and
 441 .Fn sigaction
 442 facilities, and has a lower precedence.
 443 The filter will record
 444 all attempts to deliver a signal to a process, even if the signal has
 445 been marked as
 446 .Dv SIG_IGN ,
 447 except for the
 448 .Dv SIGCHLD
 449 signal, which, if ignored, won't be recorded by the filter.
 450 Event notification happens after normal
 451 signal delivery processing.
 452 .Va data
 453 returns the number of times the signal has occurred since the last call to
 454 .Fn kevent .
 455 This filter automatically sets the
 456 .Dv EV_CLEAR
 457 flag internally.
 458 .It Dv EVFILT_TIMER
 459 Establishes an arbitrary timer identified by
 460 .Va ident .
 461 When adding a timer,
 462 .Va data
 463 specifies the timeout period.
 464 The timer will be periodic unless
 465 .Dv EV_ONESHOT
 466 is specified.
 467 On return,
 468 .Va data
 469 contains the number of times the timeout has expired since the last call to
 470 .Fn kevent .
 471 This filter automatically sets the EV_CLEAR flag internally.
 472 There is a system wide limit on the number of timers
 473 which is controlled by the
 474 .Va kern.kq_calloutmax
 475 sysctl.
 476 .Bl -tag -width "Dv NOTE_USECONDS"
 477 .It Dv NOTE_SECONDS
 478 .Va data
 479 is in seconds.
 480 .It Dv NOTE_MSECONDS
 481 .Va data
 482 is in milliseconds.
 483 .It Dv NOTE_USECONDS
 484 .Va data
 485 is in microseconds.
 486 .It Dv NOTE_NSECONDS
 487 .Va data
 488 is in nanoseconds.
 489 .El
 490 .Pp
 491 If
 492 .Va fflags
 493 is not set, the default is milliseconds. On return,
 494 .Va fflags
 495 contains the events which triggered the filter.
 496 .It Dv EVFILT_USER
 497 Establishes a user event identified by
 498 .Va ident
 499 which is not associated with any kernel mechanism but is triggered by
 500 user level code.
 501 The lower 24 bits of the
 502 .Va fflags
 503 may be used for user defined flags and manipulated using the following:
 504 .Bl -tag -width "Dv NOTE_FFLAGSMASK"
 505 .It Dv NOTE_FFNOP
 506 Ignore the input
 507 .Va fflags .
 508 .It Dv NOTE_FFAND
 509 Bitwise AND
 510 .Va fflags .
 511 .It Dv NOTE_FFOR
 512 Bitwise OR
 513 .Va fflags .
 514 .It Dv NOTE_FFCOPY
 515 Copy
 516 .Va fflags .
 517 .It Dv NOTE_FFCTRLMASK
 518 Control mask for
 519 .Va fflags .
 520 .It Dv NOTE_FFLAGSMASK
 521 User defined flag mask for
 522 .Va fflags .
 523 .El
 524 .Pp
 525 A user event is triggered for output with the following:
 526 .Bl -tag -width "Dv NOTE_FFLAGSMASK"
 527 .It Dv NOTE_TRIGGER
 528 Cause the event to be triggered.
 529 .El
 530 .Pp
 531 On return,
 532 .Va fflags
 533 contains the users defined flags in the lower 24 bits.
 534 .El
 535 .Sh CANCELLATION BEHAVIOUR
 536 If
 537 .Fa nevents
 538 is non-zero, i.e. the function is potentially blocking, the call
 539 is a cancellation point.
 540 Otherwise, i.e. if
 541 .Fa nevents
 542 is zero, the call is not cancellable.
 543 Cancellation can only occur before any changes are made to the kqueue,
 544 or when the call was blocked and no changes to the queue were requested.
 545 .Sh RETURN VALUES
 546 The
 547 .Fn kqueue
 548 system call
 549 creates a new kernel event queue and returns a file descriptor.
 550 If there was an error creating the kernel event queue, a value of -1 is
 551 returned and errno set.
 552 .Pp
 553 The
 554 .Fn kevent
 555 system call
 556 returns the number of events placed in the
 557 .Fa eventlist ,
 558 up to the value given by
 559 .Fa nevents .
 560 If an error occurs while processing an element of the
 561 .Fa changelist
 562 and there is enough room in the
 563 .Fa eventlist ,
 564 then the event will be placed in the
 565 .Fa eventlist
 566 with
 567 .Dv EV_ERROR
 568 set in
 569 .Va flags
 570 and the system error in
 571 .Va data .
 572 Otherwise,
 573 .Dv -1
 574 will be returned, and
 575 .Dv errno
 576 will be set to indicate the error condition.
 577 If the time limit expires, then
 578 .Fn kevent
 579 returns 0.
 580 .Sh ERRORS
 581 The
 582 .Fn kqueue
 583 system call fails if:
 584 .Bl -tag -width Er
 585 .It Bq Er ENOMEM
 586 The kernel failed to allocate enough memory for the kernel queue.
 587 .It Bq Er EMFILE
 588 The per-process descriptor table is full.
 589 .It Bq Er ENFILE
 590 The system file table is full.
 591 .El
 592 .Pp
 593 The
 594 .Fn kevent
 595 system call fails if:
 596 .Bl -tag -width Er
 597 .It Bq Er EACCES
 598 The process does not have permission to register a filter.
 599 .It Bq Er EFAULT
 600 There was an error reading or writing the
 601 .Va kevent
 602 structure.
 603 .It Bq Er EBADF
 604 The specified descriptor is invalid.
 605 .It Bq Er EINTR
 606 A signal was delivered before the timeout expired and before any
 607 events were placed on the kqueue for return.
 608 .It Bq Er EINTR
 609 A cancellation request was delivered to the thread, but not yet handled.
 610 .It Bq Er EINVAL
 611 The specified time limit or filter is invalid.
 612 .It Bq Er ENOENT
 613 The event could not be found to be modified or deleted.
 614 .It Bq Er ENOMEM
 615 No memory was available to register the event
 616 or, in the special case of a timer, the maximum number of
 617 timers has been exceeded.
 618 This maximum is configurable via the
 619 .Va kern.kq_calloutmax
 620 sysctl.
 621 .It Bq Er ESRCH
 622 The specified process to attach to does not exist.
 623 .El
 624 .Pp
 625 When
 626 .Fn kevent
 627 call fails with
 628 .Er EINTR
 629 error, all changes in the
 630 .Fa changelist
 631 have been applied.
 632 .Sh SEE ALSO
 633 .Xr aio_error 2 ,
 634 .Xr aio_read 2 ,
 635 .Xr aio_return 2 ,
 636 .Xr poll 2 ,
 637 .Xr read 2 ,
 638 .Xr select 2 ,
 639 .Xr sigaction 2 ,
 640 .Xr write 2 ,
 641 .Xr pthread_setcancelstate 3 ,
 642 .Xr signal 3
 643 .Sh HISTORY
 644 The
 645 .Fn kqueue
 646 and
 647 .Fn kevent
 648 system calls first appeared in
 649 .Fx 4.1 .
 650 .Sh AUTHORS
 651 The
 652 .Fn kqueue
 653 system and this manual page were written by
 654 .An Jonathan Lemon Aq jlemon@FreeBSD.org .
 655 .Sh BUGS
 656 The
 657 .Fa timeout
 658 value is limited to 24 hours; longer timeouts will be silently
 659 reinterpreted as 24 hours.