author | alanb |
Sat, 16 Jun 2018 10:10:54 +0100 | |
changeset 50602 | ed8de3d0cd28 |
parent 49527 | 5aa40f834b50 |
child 59146 | 455612b3161a |
permissions | -rw-r--r-- |
12047 | 1 |
/* |
49248
15a0e60c8b97
8199611: (se) Minor selector implementation clean-up
alanb
parents:
47216
diff
changeset
|
2 |
* Copyright (c) 2011, 2018, Oracle and/or its affiliates. All rights reserved. |
12047 | 3 |
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. |
4 |
* |
|
5 |
* This code is free software; you can redistribute it and/or modify it |
|
6 |
* under the terms of the GNU General Public License version 2 only, as |
|
12438
c1183d4a80d4
7143744: (se) Stabilize KQueue SelectorProvider and make default on MacOSX
alanb
parents:
12047
diff
changeset
|
7 |
* published by the Free Software Foundation. Oracle designates this |
c1183d4a80d4
7143744: (se) Stabilize KQueue SelectorProvider and make default on MacOSX
alanb
parents:
12047
diff
changeset
|
8 |
* particular file as subject to the "Classpath" exception as provided |
c1183d4a80d4
7143744: (se) Stabilize KQueue SelectorProvider and make default on MacOSX
alanb
parents:
12047
diff
changeset
|
9 |
* by Oracle in the LICENSE file that accompanied this code. |
12047 | 10 |
* |
11 |
* This code is distributed in the hope that it will be useful, but WITHOUT |
|
12 |
* ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or |
|
13 |
* FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License |
|
14 |
* version 2 for more details (a copy is included in the LICENSE file that |
|
15 |
* accompanied this code). |
|
16 |
* |
|
17 |
* You should have received a copy of the GNU General Public License version |
|
18 |
* 2 along with this work; if not, write to the Free Software Foundation, |
|
19 |
* Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. |
|
20 |
* |
|
21 |
* Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA |
|
22 |
* or visit www.oracle.com if you need additional information or have any |
|
23 |
* questions. |
|
24 |
*/ |
|
25 |
||
26 |
package sun.nio.ch; |
|
27 |
||
28 |
import java.io.IOException; |
|
49248
15a0e60c8b97
8199611: (se) Minor selector implementation clean-up
alanb
parents:
47216
diff
changeset
|
29 |
import java.nio.channels.ClosedSelectorException; |
50602
ed8de3d0cd28
8199433: (se) select(Consumer<SelectionKey> action) as alternative to selected-key set
alanb
parents:
49527
diff
changeset
|
30 |
import java.nio.channels.SelectionKey; |
49248
15a0e60c8b97
8199611: (se) Minor selector implementation clean-up
alanb
parents:
47216
diff
changeset
|
31 |
import java.nio.channels.Selector; |
15a0e60c8b97
8199611: (se) Minor selector implementation clean-up
alanb
parents:
47216
diff
changeset
|
32 |
import java.nio.channels.spi.SelectorProvider; |
49290 | 33 |
import java.util.ArrayDeque; |
34 |
import java.util.Deque; |
|
49248
15a0e60c8b97
8199611: (se) Minor selector implementation clean-up
alanb
parents:
47216
diff
changeset
|
35 |
import java.util.HashMap; |
49290 | 36 |
import java.util.Map; |
37 |
import java.util.concurrent.TimeUnit; |
|
50602
ed8de3d0cd28
8199433: (se) select(Consumer<SelectionKey> action) as alternative to selected-key set
alanb
parents:
49527
diff
changeset
|
38 |
import java.util.function.Consumer; |
12047 | 39 |
|
49290 | 40 |
import static sun.nio.ch.KQueue.EVFILT_READ; |
41 |
import static sun.nio.ch.KQueue.EVFILT_WRITE; |
|
42 |
import static sun.nio.ch.KQueue.EV_ADD; |
|
43 |
import static sun.nio.ch.KQueue.EV_DELETE; |
|
44 |
||
45 |
/** |
|
46 |
* KQueue based Selector implementation for macOS |
|
47 |
*/ |
|
48 |
||
49 |
class KQueueSelectorImpl extends SelectorImpl { |
|
50 |
||
51 |
// maximum number of events to poll in one call to kqueue |
|
52 |
private static final int MAX_KEVENTS = 256; |
|
53 |
||
54 |
// kqueue file descriptor |
|
55 |
private final int kqfd; |
|
56 |
||
57 |
// address of poll array (event list) when polling for pending events |
|
58 |
private final long pollArrayAddress; |
|
59 |
||
60 |
// file descriptors used for interrupt |
|
49248
15a0e60c8b97
8199611: (se) Minor selector implementation clean-up
alanb
parents:
47216
diff
changeset
|
61 |
private final int fd0; |
15a0e60c8b97
8199611: (se) Minor selector implementation clean-up
alanb
parents:
47216
diff
changeset
|
62 |
private final int fd1; |
12047 | 63 |
|
49290 | 64 |
// maps file descriptor to selection key, synchronize on selector |
65 |
private final Map<Integer, SelectionKeyImpl> fdToKey = new HashMap<>(); |
|
66 |
||
49526 | 67 |
// pending new registrations/updates, queued by setEventOps |
49290 | 68 |
private final Object updateLock = new Object(); |
69 |
private final Deque<SelectionKeyImpl> updateKeys = new ArrayDeque<>(); |
|
12047 | 70 |
|
49290 | 71 |
// interrupt triggering and clearing |
49248
15a0e60c8b97
8199611: (se) Minor selector implementation clean-up
alanb
parents:
47216
diff
changeset
|
72 |
private final Object interruptLock = new Object(); |
15a0e60c8b97
8199611: (se) Minor selector implementation clean-up
alanb
parents:
47216
diff
changeset
|
73 |
private boolean interruptTriggered; |
12047 | 74 |
|
12438
c1183d4a80d4
7143744: (se) Stabilize KQueue SelectorProvider and make default on MacOSX
alanb
parents:
12047
diff
changeset
|
75 |
// used by updateSelectedKeys to handle cases where the same file |
c1183d4a80d4
7143744: (se) Stabilize KQueue SelectorProvider and make default on MacOSX
alanb
parents:
12047
diff
changeset
|
76 |
// descriptor is polled by more than one filter |
49290 | 77 |
private int pollCount; |
12438
c1183d4a80d4
7143744: (se) Stabilize KQueue SelectorProvider and make default on MacOSX
alanb
parents:
12047
diff
changeset
|
78 |
|
49248
15a0e60c8b97
8199611: (se) Minor selector implementation clean-up
alanb
parents:
47216
diff
changeset
|
79 |
KQueueSelectorImpl(SelectorProvider sp) throws IOException { |
12047 | 80 |
super(sp); |
49290 | 81 |
|
82 |
this.kqfd = KQueue.create(); |
|
83 |
this.pollArrayAddress = KQueue.allocatePollArray(MAX_KEVENTS); |
|
84 |
||
32856
c654cdf1d685
8138819: (se) File descriptor leak when Selector.open fails
igerasim
parents:
25859
diff
changeset
|
85 |
try { |
49290 | 86 |
long fds = IOUtil.makePipe(false); |
87 |
this.fd0 = (int) (fds >>> 32); |
|
88 |
this.fd1 = (int) fds; |
|
89 |
} catch (IOException ioe) { |
|
90 |
KQueue.freePollArray(pollArrayAddress); |
|
91 |
FileDispatcherImpl.closeIntFD(kqfd); |
|
92 |
throw ioe; |
|
32856
c654cdf1d685
8138819: (se) File descriptor leak when Selector.open fails
igerasim
parents:
25859
diff
changeset
|
93 |
} |
49290 | 94 |
|
95 |
// register one end of the socket pair for wakeups |
|
96 |
KQueue.register(kqfd, fd0, EVFILT_READ, EV_ADD); |
|
12047 | 97 |
} |
98 |
||
49248
15a0e60c8b97
8199611: (se) Minor selector implementation clean-up
alanb
parents:
47216
diff
changeset
|
99 |
private void ensureOpen() { |
49290 | 100 |
if (!isOpen()) |
49248
15a0e60c8b97
8199611: (se) Minor selector implementation clean-up
alanb
parents:
47216
diff
changeset
|
101 |
throw new ClosedSelectorException(); |
15a0e60c8b97
8199611: (se) Minor selector implementation clean-up
alanb
parents:
47216
diff
changeset
|
102 |
} |
12047 | 103 |
|
49248
15a0e60c8b97
8199611: (se) Minor selector implementation clean-up
alanb
parents:
47216
diff
changeset
|
104 |
@Override |
50602
ed8de3d0cd28
8199433: (se) select(Consumer<SelectionKey> action) as alternative to selected-key set
alanb
parents:
49527
diff
changeset
|
105 |
protected int doSelect(Consumer<SelectionKey> action, long timeout) |
ed8de3d0cd28
8199433: (se) select(Consumer<SelectionKey> action) as alternative to selected-key set
alanb
parents:
49527
diff
changeset
|
106 |
throws IOException |
ed8de3d0cd28
8199433: (se) select(Consumer<SelectionKey> action) as alternative to selected-key set
alanb
parents:
49527
diff
changeset
|
107 |
{ |
49290 | 108 |
assert Thread.holdsLock(this); |
109 |
||
49493 | 110 |
long to = Math.min(timeout, Integer.MAX_VALUE); // max kqueue timeout |
111 |
boolean blocking = (to != 0); |
|
112 |
boolean timedPoll = (to > 0); |
|
113 |
||
49248
15a0e60c8b97
8199611: (se) Minor selector implementation clean-up
alanb
parents:
47216
diff
changeset
|
114 |
int numEntries; |
49290 | 115 |
processUpdateQueue(); |
12047 | 116 |
processDeregisterQueue(); |
117 |
try { |
|
49493 | 118 |
begin(blocking); |
49290 | 119 |
|
120 |
do { |
|
121 |
long startTime = timedPoll ? System.nanoTime() : 0; |
|
122 |
numEntries = KQueue.poll(kqfd, pollArrayAddress, MAX_KEVENTS, to); |
|
123 |
if (numEntries == IOStatus.INTERRUPTED && timedPoll) { |
|
124 |
// timed poll interrupted so need to adjust timeout |
|
125 |
long adjust = System.nanoTime() - startTime; |
|
126 |
to -= TimeUnit.MILLISECONDS.convert(adjust, TimeUnit.NANOSECONDS); |
|
127 |
if (to <= 0) { |
|
128 |
// timeout expired so no retry |
|
129 |
numEntries = 0; |
|
130 |
} |
|
131 |
} |
|
132 |
} while (numEntries == IOStatus.INTERRUPTED); |
|
133 |
assert IOStatus.check(numEntries); |
|
134 |
||
12047 | 135 |
} finally { |
49493 | 136 |
end(blocking); |
12047 | 137 |
} |
138 |
processDeregisterQueue(); |
|
50602
ed8de3d0cd28
8199433: (se) select(Consumer<SelectionKey> action) as alternative to selected-key set
alanb
parents:
49527
diff
changeset
|
139 |
return processEvents(numEntries, action); |
12047 | 140 |
} |
141 |
||
142 |
/** |
|
49526 | 143 |
* Process changes to the interest ops. |
49290 | 144 |
*/ |
145 |
private void processUpdateQueue() { |
|
146 |
assert Thread.holdsLock(this); |
|
147 |
||
148 |
synchronized (updateLock) { |
|
149 |
SelectionKeyImpl ski; |
|
49526 | 150 |
while ((ski = updateKeys.pollFirst()) != null) { |
49290 | 151 |
if (ski.isValid()) { |
49526 | 152 |
int fd = ski.getFDVal(); |
153 |
// add to fdToKey if needed |
|
154 |
SelectionKeyImpl previous = fdToKey.putIfAbsent(fd, ski); |
|
155 |
assert (previous == null) || (previous == ski); |
|
49290 | 156 |
|
49526 | 157 |
int newEvents = ski.translateInterestOps(); |
49493 | 158 |
int registeredEvents = ski.registeredEvents(); |
159 |
if (newEvents != registeredEvents) { |
|
160 |
||
161 |
// add or delete interest in read events |
|
162 |
if ((registeredEvents & Net.POLLIN) != 0) { |
|
163 |
if ((newEvents & Net.POLLIN) == 0) { |
|
164 |
KQueue.register(kqfd, fd, EVFILT_READ, EV_DELETE); |
|
165 |
} |
|
166 |
} else if ((newEvents & Net.POLLIN) != 0) { |
|
167 |
KQueue.register(kqfd, fd, EVFILT_READ, EV_ADD); |
|
49290 | 168 |
} |
169 |
||
49493 | 170 |
// add or delete interest in write events |
171 |
if ((registeredEvents & Net.POLLOUT) != 0) { |
|
172 |
if ((newEvents & Net.POLLOUT) == 0) { |
|
173 |
KQueue.register(kqfd, fd, EVFILT_WRITE, EV_DELETE); |
|
174 |
} |
|
175 |
} else if ((newEvents & Net.POLLOUT) != 0) { |
|
176 |
KQueue.register(kqfd, fd, EVFILT_WRITE, EV_ADD); |
|
49290 | 177 |
} |
49493 | 178 |
|
179 |
ski.registeredEvents(newEvents); |
|
49290 | 180 |
} |
181 |
} |
|
182 |
} |
|
183 |
} |
|
184 |
} |
|
185 |
||
186 |
/** |
|
50602
ed8de3d0cd28
8199433: (se) select(Consumer<SelectionKey> action) as alternative to selected-key set
alanb
parents:
49527
diff
changeset
|
187 |
* Process the polled events. |
12047 | 188 |
* If the interrupt fd has been selected, drain it and clear the interrupt. |
189 |
*/ |
|
50602
ed8de3d0cd28
8199433: (se) select(Consumer<SelectionKey> action) as alternative to selected-key set
alanb
parents:
49527
diff
changeset
|
190 |
private int processEvents(int numEntries, Consumer<SelectionKey> action) |
ed8de3d0cd28
8199433: (se) select(Consumer<SelectionKey> action) as alternative to selected-key set
alanb
parents:
49527
diff
changeset
|
191 |
throws IOException |
ed8de3d0cd28
8199433: (se) select(Consumer<SelectionKey> action) as alternative to selected-key set
alanb
parents:
49527
diff
changeset
|
192 |
{ |
49290 | 193 |
assert Thread.holdsLock(this); |
194 |
||
12047 | 195 |
int numKeysUpdated = 0; |
196 |
boolean interrupted = false; |
|
197 |
||
12438
c1183d4a80d4
7143744: (se) Stabilize KQueue SelectorProvider and make default on MacOSX
alanb
parents:
12047
diff
changeset
|
198 |
// A file descriptor may be registered with kqueue with more than one |
49290 | 199 |
// filter and so there may be more than one event for a fd. The poll |
200 |
// count is incremented here and compared against the SelectionKey's |
|
201 |
// "lastPolled" field. This ensures that the ready ops is updated rather |
|
202 |
// than replaced when a file descriptor is polled by both the read and |
|
203 |
// write filter. |
|
204 |
pollCount++; |
|
12438
c1183d4a80d4
7143744: (se) Stabilize KQueue SelectorProvider and make default on MacOSX
alanb
parents:
12047
diff
changeset
|
205 |
|
49248
15a0e60c8b97
8199611: (se) Minor selector implementation clean-up
alanb
parents:
47216
diff
changeset
|
206 |
for (int i = 0; i < numEntries; i++) { |
49290 | 207 |
long kevent = KQueue.getEvent(pollArrayAddress, i); |
208 |
int fd = KQueue.getDescriptor(kevent); |
|
209 |
if (fd == fd0) { |
|
12047 | 210 |
interrupted = true; |
211 |
} else { |
|
49290 | 212 |
SelectionKeyImpl ski = fdToKey.get(fd); |
213 |
if (ski != null) { |
|
214 |
int rOps = 0; |
|
215 |
short filter = KQueue.getFilter(kevent); |
|
216 |
if (filter == EVFILT_READ) { |
|
217 |
rOps |= Net.POLLIN; |
|
218 |
} else if (filter == EVFILT_WRITE) { |
|
219 |
rOps |= Net.POLLOUT; |
|
220 |
} |
|
50602
ed8de3d0cd28
8199433: (se) select(Consumer<SelectionKey> action) as alternative to selected-key set
alanb
parents:
49527
diff
changeset
|
221 |
int updated = processReadyEvents(rOps, ski, action); |
ed8de3d0cd28
8199433: (se) select(Consumer<SelectionKey> action) as alternative to selected-key set
alanb
parents:
49527
diff
changeset
|
222 |
if (updated > 0 && ski.lastPolled != pollCount) { |
ed8de3d0cd28
8199433: (se) select(Consumer<SelectionKey> action) as alternative to selected-key set
alanb
parents:
49527
diff
changeset
|
223 |
numKeysUpdated++; |
ed8de3d0cd28
8199433: (se) select(Consumer<SelectionKey> action) as alternative to selected-key set
alanb
parents:
49527
diff
changeset
|
224 |
ski.lastPolled = pollCount; |
12047 | 225 |
} |
226 |
} |
|
227 |
} |
|
228 |
} |
|
229 |
||
230 |
if (interrupted) { |
|
49248
15a0e60c8b97
8199611: (se) Minor selector implementation clean-up
alanb
parents:
47216
diff
changeset
|
231 |
clearInterrupt(); |
12047 | 232 |
} |
233 |
return numKeysUpdated; |
|
234 |
} |
|
235 |
||
49248
15a0e60c8b97
8199611: (se) Minor selector implementation clean-up
alanb
parents:
47216
diff
changeset
|
236 |
@Override |
12047 | 237 |
protected void implClose() throws IOException { |
49290 | 238 |
assert !isOpen(); |
239 |
assert Thread.holdsLock(this); |
|
12438
c1183d4a80d4
7143744: (se) Stabilize KQueue SelectorProvider and make default on MacOSX
alanb
parents:
12047
diff
changeset
|
240 |
|
49290 | 241 |
// prevent further wakeup |
242 |
synchronized (interruptLock) { |
|
243 |
interruptTriggered = true; |
|
244 |
} |
|
245 |
||
246 |
FileDispatcherImpl.closeIntFD(kqfd); |
|
247 |
KQueue.freePollArray(pollArrayAddress); |
|
12438
c1183d4a80d4
7143744: (se) Stabilize KQueue SelectorProvider and make default on MacOSX
alanb
parents:
12047
diff
changeset
|
248 |
|
49290 | 249 |
FileDispatcherImpl.closeIntFD(fd0); |
250 |
FileDispatcherImpl.closeIntFD(fd1); |
|
12047 | 251 |
} |
252 |
||
49248
15a0e60c8b97
8199611: (se) Minor selector implementation clean-up
alanb
parents:
47216
diff
changeset
|
253 |
@Override |
12047 | 254 |
protected void implDereg(SelectionKeyImpl ski) throws IOException { |
49290 | 255 |
assert !ski.isValid(); |
256 |
assert Thread.holdsLock(this); |
|
257 |
||
49526 | 258 |
int fd = ski.getFDVal(); |
49493 | 259 |
int registeredEvents = ski.registeredEvents(); |
260 |
if (fdToKey.remove(fd) != null) { |
|
261 |
if (registeredEvents != 0) { |
|
262 |
if ((registeredEvents & Net.POLLIN) != 0) |
|
263 |
KQueue.register(kqfd, fd, EVFILT_READ, EV_DELETE); |
|
264 |
if ((registeredEvents & Net.POLLOUT) != 0) |
|
265 |
KQueue.register(kqfd, fd, EVFILT_WRITE, EV_DELETE); |
|
266 |
ski.registeredEvents(0); |
|
267 |
} |
|
268 |
} else { |
|
269 |
assert registeredEvents == 0; |
|
49290 | 270 |
} |
12047 | 271 |
} |
272 |
||
49248
15a0e60c8b97
8199611: (se) Minor selector implementation clean-up
alanb
parents:
47216
diff
changeset
|
273 |
@Override |
49526 | 274 |
public void setEventOps(SelectionKeyImpl ski) { |
49248
15a0e60c8b97
8199611: (se) Minor selector implementation clean-up
alanb
parents:
47216
diff
changeset
|
275 |
ensureOpen(); |
49290 | 276 |
synchronized (updateLock) { |
277 |
updateKeys.addLast(ski); |
|
278 |
} |
|
12047 | 279 |
} |
280 |
||
49248
15a0e60c8b97
8199611: (se) Minor selector implementation clean-up
alanb
parents:
47216
diff
changeset
|
281 |
@Override |
12047 | 282 |
public Selector wakeup() { |
283 |
synchronized (interruptLock) { |
|
284 |
if (!interruptTriggered) { |
|
49290 | 285 |
try { |
286 |
IOUtil.write1(fd1, (byte)0); |
|
287 |
} catch (IOException ioe) { |
|
288 |
throw new InternalError(ioe); |
|
289 |
} |
|
12047 | 290 |
interruptTriggered = true; |
291 |
} |
|
292 |
} |
|
293 |
return this; |
|
294 |
} |
|
49248
15a0e60c8b97
8199611: (se) Minor selector implementation clean-up
alanb
parents:
47216
diff
changeset
|
295 |
|
15a0e60c8b97
8199611: (se) Minor selector implementation clean-up
alanb
parents:
47216
diff
changeset
|
296 |
private void clearInterrupt() throws IOException { |
15a0e60c8b97
8199611: (se) Minor selector implementation clean-up
alanb
parents:
47216
diff
changeset
|
297 |
synchronized (interruptLock) { |
15a0e60c8b97
8199611: (se) Minor selector implementation clean-up
alanb
parents:
47216
diff
changeset
|
298 |
IOUtil.drain(fd0); |
15a0e60c8b97
8199611: (se) Minor selector implementation clean-up
alanb
parents:
47216
diff
changeset
|
299 |
interruptTriggered = false; |
15a0e60c8b97
8199611: (se) Minor selector implementation clean-up
alanb
parents:
47216
diff
changeset
|
300 |
} |
15a0e60c8b97
8199611: (se) Minor selector implementation clean-up
alanb
parents:
47216
diff
changeset
|
301 |
} |
12047 | 302 |
} |