Print this page
12743 man page spelling mistakes
Split |
Close |
Expand all |
Collapse all |
--- old/usr/src/man/man5/epoll.5
+++ new/usr/src/man/man5/epoll.5
1 1 '\" te
2 2 .\" Copyright (c) 2014, Joyent, Inc. All Rights Reserved.
3 3 .\" This file and its contents are supplied under the terms of the
4 4 .\" Common Development and Distribution License ("CDDL"), version 1.0.
5 5 .\" You may only use this file in accordance with the terms of version
6 6 .\" 1.0 of the CDDL.
7 7 .\"
8 8 .\" A full copy of the text of the CDDL should have accompanied this
9 9 .\" source. A copy of the CDDL is also available via the Internet at
10 10 .\" http://www.illumos.org/license/CDDL.
11 -.TH EPOLL 5 "Apr 17, 2014"
11 +.TH EPOLL 5 "May 16, 2020"
12 12 .SH NAME
13 13 epoll \- Linux-compatible I/O event notification facility
14 14 .SH SYNOPSIS
15 15 .nf
16 16 #include <sys/epoll.h>
17 17 .fi
18 18
19 19 .SH DESCRIPTION
20 20 \fBepoll\fR is a facility for efficient event-oriented I/O that has a
21 21 similar model to \fBpoll\fR(2), but does not necessitate rescanning a
22 22 set of file descriptors to wait for an event. \fBepoll\fR is of Linux
23 23 origins, and this facility is designed to be binary-compatible with
24 24 the Linux facility, including the following interfaces:
25 25
26 26 .RS +4
27 27 .TP
28 28 .ie t \(bu
29 29 .el o
30 30 \fBepoll_create\fR(3C) creates an \fBepoll\fR instance, returning a file
31 -descriptor. It contains a size arugment which is meaningful only in as
31 +descriptor. It contains a size argument which is meaningful only in as
32 32 much as it cannot be 0.
33 33 .RE
34 34 .RS +4
35 35 .TP
36 36 .ie t \(bu
37 37 .el o
38 38 \fBepoll_create1\fR(3C) also creates an \fBepoll\fR instance, but eliminates
39 39 the meaningless size argument -- replacing it instead with a flags
40 40 argument.
41 41 .RE
42 42 .RS +4
43 43 .TP
44 44 .ie t \(bu
45 45 .el o
46 46 \fBepoll_ctl\fR(3C) allows file descriptors to be added
47 47 (via \fBEPOLL_CTL_ADD\fR), deleted (via \fBEPOLL_CTL_DEL\fR) or
48 48 modified (via \fBEPOLL_CTL_MOD\fR) with respect to the \fBepoll\fR'd set
49 49 of file descriptors.
50 50 .RE
51 51 .RS +4
↓ open down ↓ |
10 lines elided |
↑ open up ↑ |
52 52 .TP
53 53 .ie t \(bu
54 54 .el o
55 55 \fBepoll_wait\fR(3C) fetches pending events for file descriptors added
56 56 via \fBepoll_ctl\fR(3C), blocking the caller if no such events are pending.
57 57 .RE
58 58 .RS +4
59 59 .TP
60 60 .ie t \(bu
61 61 .el o
62 -\fBepoll_pwait\fR(3C) opeates in a similar manner to \fBepoll_wait\fR(3C), but
62 +\fBepoll_pwait\fR(3C) operates in a similar manner to \fBepoll_wait\fR(3C), but
63 63 allows the caller to specify a signal mask to be set atomically with respect
64 64 to waiting for events.
65 65 .RE
66 66
67 67 .sp
68 68 .SH NOTES
69 69 The \fBepoll\fR facility is implemented
70 70 for purposes of offering compatibility to and portability of Linux-borne
71 71 applications; native applications should continue to prefer using event ports
72 72 via the \fBport_create\fR(3C),
73 73 \fBport_associate\fR(3C) and \fBport_getn\fR(3C) interfaces.
74 74 In particular, use of \fBepoll\fR in a multithreaded environment is fraught
75 75 with peril; even when using \fBEPOLLONESHOT\fR for one-shot events,
76 76 there are race conditions with respect to \fBclose\fR(2) that are unresolvable.
77 77 (For more details, see the aborted effort in Linux to resolve this via the
78 78 proposed
79 79 \fBEPOLL_CTL_DISABLE\fR operation.)
80 80 The event port facility -- like the BSD kqueue facility that inspired it --
81 81 is designed to deal with such issues via explicit event source dissociation.
82 82
83 83 While a best effort has been made to mimic the Linux semantics, there
84 84 are some semantics that are too peculiar or ill-conceived to merit
85 85 accommodation. In particular, the Linux \fBepoll\fR facility will -- by
86 86 design -- continue to generate events for closed file descriptors where/when
87 87 the underlying file description remains open. For example, if one were
88 88 to \fBfork\fR(2) and subsequently close an actively \fBepoll\fR'd file
89 89 descriptor in the parent,
90 90 any events generated in the child on the implicitly duplicated file descriptor
91 91 will continue to be delivered to the parent -- despite the fact that the
92 92 parent itself no longer has any notion of the file description!
93 93 This \fBepoll\fR facility refuses to honor
94 94 these semantics; closing the \fBEPOLL_CTL_ADD\fR'd file descriptor
95 95 will always result in no further
96 96 events being generated for that event description.
97 97
98 98 .SH SEE ALSO
99 99 \fBepoll_create\fR(3C), \fBepoll_create1\fR(3C), \fBepoll_ctl\fR(3C),
100 100 \fBepoll_wait\fR(3C), \fBepoll_pwait\fR(3C),
101 101 \fBport_create\fR(3C), \fBport_associate\fR(3C), \fBport_dissociate\fR(3C),
102 102 \fBport_get\fR(3C),
103 103 \fBpselect\fR(3C)
↓ open down ↓ |
31 lines elided |
↑ open up ↑ |
XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX