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