-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathKernel.py
More file actions
1709 lines (1446 loc) · 48.5 KB
/
Copy pathKernel.py
File metadata and controls
1709 lines (1446 loc) · 48.5 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
"""
Platform kernels for smallOS.
The scheduler is intentionally written against a tiny interface so the runtime
can stay portable across desktop Python and MicroPython boards. This module
keeps the shared surface in one place, then layers a few practical profiles on
top:
- ``Unix`` for desktop development and testing
- ``MicroPythonKernel`` for the generic portable subset of MicroPython
- thin board profiles like ``ESP32`` and ``PicoW`` for board-flavored defaults
The important design choice is that board profiles do not own scheduling logic.
They only provide capability hints and convenience configuration around the
shared MicroPython transport/time API.
"""
from __future__ import annotations
try:
from typing import TYPE_CHECKING
except ImportError: # pragma: no cover - exercised on constrained runtimes
TYPE_CHECKING = False
if TYPE_CHECKING:
from collections.abc import Iterable, Mapping, Sequence
from typing import Any, cast
from ._types import WakeupChannelLike
from ._types import SocketBuffer, SocketOperation, SocketRetryMode
_UNSET = object()
_MAX_WAKEUP_IO_ATTEMPTS = 8
_SOCKET_OPERATIONS = ('accept', 'recv', 'send', 'handshake')
def _validate_socket_operation(operation):
"""Reject retry classifications that do not name a supported operation."""
if operation not in _SOCKET_OPERATIONS:
raise ValueError(
'Unknown socket operation {!r}; expected one of: {}.'.format(
operation, ', '.join(_SOCKET_OPERATIONS)
)
)
class _PassiveAddressInfo:
"""Kernel-owned address record for a passive TCP endpoint."""
def __init__(self, owner, address_info):
self.owner = owner
self.address_info = address_info
def _unwrap_passive_address(owner, address_info):
"""Return backend address data only for a record created by ``owner``."""
if not isinstance(address_info, _PassiveAddressInfo) or address_info.owner is not owner:
raise ValueError('Passive address record belongs to a different kernel.')
return address_info.address_info
def _import_first(*module_names: str) -> Any | None:
"""
Import the first available module name from a list.
This keeps the rest of the kernel code readable when we want CPython and
MicroPython fallbacks like ``time``/``utime`` or ``socket``/``usocket``.
"""
for module_name in module_names:
if not module_name:
continue
try:
return __import__(module_name)
except ImportError:
continue
return None
def _portable_shell_split(line: str) -> list[str]:
"""
Tokenize one shell command line without relying on desktop-only helpers.
This parser is intentionally small but still handles the common cases a
MicroPython-facing shell needs:
- whitespace-separated tokens
- single or double quoted strings
- backslash escaping for the next character
"""
tokens = []
current = []
quote = None
escape = False
for char in line:
if escape:
current.append(char)
escape = False
continue
if char == "\\":
escape = True
continue
if quote is not None:
if char == quote:
quote = None
else:
current.append(char)
continue
if char in ("'", '"'):
quote = char
continue
if char.isspace():
if current:
tokens.append("".join(current))
current = []
continue
current.append(char)
if escape:
current.append("\\")
if quote is not None:
raise ValueError("unterminated quoted string")
if current:
tokens.append("".join(current))
return tokens
def _io_wait_lookup_key(obj):
"""Return the stable descriptor/key used by poll-style backends."""
if hasattr(obj, 'fileno'):
try:
return obj.fileno()
except Exception:
pass
return obj
class _SelectorIOWaitSet:
"""Persistent CPython selector with delta-updated registrations."""
def __init__(self, selector, read_mask, write_mask):
self._selector = selector
self._read_mask = read_mask
self._write_mask = write_mask
self._entries = {}
self._objects_by_key = {}
self._closed = False
def _event_mask(self, readable, writable):
mask = 0
if readable:
mask |= self._read_mask
if writable:
mask |= self._write_mask
return mask
def _remove(self, obj):
entry = self._entries.pop(obj, None)
if entry is None:
return
_, key = entry
if self._objects_by_key.get(key) is obj:
del self._objects_by_key[key]
try:
self._selector.unregister(key)
except (KeyError, OSError, ValueError):
# The descriptor may already have been closed and removed by the OS.
pass
def _discard_stale_key_owner(self, obj, key):
existing_obj = self._objects_by_key.get(key)
if existing_obj is None or existing_obj is obj:
return
if _io_wait_lookup_key(existing_obj) == key:
raise ValueError(
'I/O descriptor {} is already registered by another object.'.format(key)
)
self._remove(existing_obj)
def set_interest(self, obj, readable, writable):
"""Apply one object's combined read/write interest when it changes."""
if self._closed:
raise RuntimeError('I/O wait set is closed.')
mask = self._event_mask(readable, writable)
entry = self._entries.get(obj)
if entry is None:
if mask == 0:
return
lookup_key = _io_wait_lookup_key(obj)
self._discard_stale_key_owner(obj, lookup_key)
selector_key = self._selector.register(obj, mask, obj)
key = selector_key.fd
self._entries[obj] = (mask, key)
self._objects_by_key[key] = obj
return
old_mask, key = entry
if mask == 0:
self._remove(obj)
return
if mask == old_mask:
return
current_key = _io_wait_lookup_key(obj)
if current_key != key:
self._remove(obj)
self.set_interest(obj, readable, writable)
return
self._selector.modify(key, mask, obj)
self._entries[obj] = (mask, key)
def wait(self, timeout_ms=None):
"""Wait for readiness without rebuilding the registered descriptor set."""
if self._closed:
raise RuntimeError('I/O wait set is closed.')
timeout = None if timeout_ms is None else max(0, timeout_ms) / 1000
events = self._selector.select(timeout)
ready_read = []
ready_write = []
for selector_key, mask in events:
obj = selector_key.data
entry = self._entries.get(obj)
if entry is None or entry[1] != selector_key.fd:
raise RuntimeError('I/O selector returned a stale readiness event.')
if mask & self._read_mask:
ready_read.append(obj)
if mask & self._write_mask:
ready_write.append(obj)
return ready_read, ready_write
def close(self):
"""Release selector resources without closing registered user objects."""
if self._closed:
return
for obj in list(self._entries):
self._remove(obj)
self._selector.close()
self._closed = True
class _PollIOWaitSet:
"""Portable persistent poll set used by MicroPython kernels."""
def __init__(self, select_mod, poller):
self._poller = poller
self._read_mask = getattr(select_mod, 'POLLIN', 0x001)
self._write_mask = getattr(select_mod, 'POLLOUT', 0x004)
self._invalid_mask = getattr(select_mod, 'POLLNVAL', 0x020)
self._error_mask = (
getattr(select_mod, 'POLLERR', 0x008)
| getattr(select_mod, 'POLLHUP', 0x010)
| getattr(select_mod, 'POLLRDHUP', 0)
| self._invalid_mask
)
self._entries = {}
self._objects_by_key = {}
self._closed = False
def _event_mask(self, readable, writable):
mask = 0
if readable:
mask |= self._read_mask
if writable:
mask |= self._write_mask
return mask
def _remove(self, obj):
entry = self._entries.pop(obj, None)
if entry is None:
return
_, key = entry
if self._objects_by_key.get(key) is obj:
del self._objects_by_key[key]
try:
self._poller.unregister(obj)
return
except Exception:
pass
try:
self._poller.unregister(key)
except Exception:
# Some MicroPython ports discard closed streams automatically.
pass
def _discard_stale_key_owner(self, obj, key):
existing_obj = self._objects_by_key.get(key)
if existing_obj is None or existing_obj is obj:
return
if _io_wait_lookup_key(existing_obj) == key:
raise ValueError(
'I/O descriptor {} is already registered by another object.'.format(key)
)
self._remove(existing_obj)
def set_interest(self, obj, readable, writable):
"""Apply one poll registration delta."""
if self._closed:
raise RuntimeError('I/O wait set is closed.')
mask = self._event_mask(readable, writable)
entry = self._entries.get(obj)
if entry is None:
if mask == 0:
return
key = _io_wait_lookup_key(obj)
self._discard_stale_key_owner(obj, key)
self._poller.register(obj, mask)
self._entries[obj] = (mask, key)
self._objects_by_key[key] = obj
return
old_mask, key = entry
if mask == 0:
self._remove(obj)
return
if mask == old_mask:
return
current_key = _io_wait_lookup_key(obj)
if current_key != key:
self._remove(obj)
self.set_interest(obj, readable, writable)
return
modifier = getattr(self._poller, 'modify', None)
if modifier is not None:
modifier(obj, mask)
else:
# MicroPython permits repeated register() calls to update the mask.
self._poller.register(obj, mask)
self._entries[obj] = (mask, key)
def _ready_object(self, event_obj):
try:
if event_obj in self._entries:
return event_obj
except (KeyError, TypeError):
pass
try:
return self._objects_by_key[event_obj]
except (KeyError, TypeError):
raise RuntimeError('poll returned an unknown I/O object.')
def wait(self, timeout_ms=None):
"""Consume poll/ipoll events immediately and return original objects."""
if self._closed:
raise RuntimeError('I/O wait set is closed.')
timeout = -1 if timeout_ms is None else max(0, int(timeout_ms))
ipoll = getattr(self._poller, 'ipoll', None)
events = ipoll(timeout) if callable(ipoll) else self._poller.poll(timeout)
if TYPE_CHECKING:
# MicroPython pollers return iterable (object, mask) event records,
# but their dynamic API cannot express that to Pyright.
events = cast("Iterable[Sequence[Any]]", events)
ready_read = []
ready_write = []
for event in events:
event_obj = event[0]
mask = event[1]
obj = self._ready_object(event_obj)
entry = self._entries.get(obj)
if entry is None:
raise RuntimeError('poll returned a stale readiness event.')
requested_mask = entry[0]
ready_mask = mask
if mask & self._error_mask:
# HUP/ERR apply to the requested directions even though callers do
# not include those unsolicited bits in the registration mask.
ready_mask |= requested_mask
if ready_mask & self._read_mask:
ready_read.append(obj)
if ready_mask & self._write_mask:
ready_write.append(obj)
if mask & self._invalid_mask:
self._remove(obj)
return ready_read, ready_write
def close(self):
"""Unregister streams and clear constrained-runtime references."""
if self._closed:
return
for obj in list(self._entries):
self._remove(obj)
closer = getattr(self._poller, 'close', None)
if closer is not None:
closer()
self._objects_by_key.clear()
self._closed = True
class _SocketWakeupChannel:
"""Coalescing cross-thread wakeup backed by a non-blocking socket pair."""
def __init__(self, reader, writer, lock):
self._reader = reader
self._writer = writer
self._lock = lock
self._pending = False
self._terminal = False
self._closed = False
self._reader_released = False
self._writer_released = False
@property
def wait_object(self):
"""Return the opaque object registered for readable readiness."""
return self._reader
def _make_terminal(self):
"""Close the writer so EOF wakes the reader, without false latching."""
try:
self._writer.close()
except BaseException:
# A later notify must retry when neither send nor close established a
# visible wakeup.
return False
self._writer_released = True
self._terminal = True
self._pending = True
return True
def notify(self):
"""Publish one coalescing notification without blocking indefinitely."""
with self._lock:
if self._closed or self._pending or self._terminal:
return
for _attempt in range(_MAX_WAKEUP_IO_ATTEMPTS):
try:
sent = self._writer.send(b'\x00')
except InterruptedError:
continue
except BlockingIOError:
# A full non-blocking channel is already readable.
self._pending = True
return
except Exception:
self._make_terminal()
return
try:
made_progress = sent > 0
except Exception:
self._make_terminal()
return
if made_progress:
self._pending = True
return
self._make_terminal()
return
# Repeated interruption is terminal only if closing the writer really
# succeeds and therefore makes EOF observable on the reader.
self._make_terminal()
def drain(self):
"""Clear a normal pending byte while bounding interrupted receive retries."""
with self._lock:
if self._closed:
return
for _attempt in range(_MAX_WAKEUP_IO_ATTEMPTS):
try:
data = self._reader.recv(4096)
except InterruptedError:
continue
except BlockingIOError:
if not self._terminal:
self._pending = False
return
except Exception:
# Preserve pending state because the notification may remain unread.
return
if not data:
self._terminal = True
self._pending = True
return
# The bounded loop intentionally preserves pending state. A caller may
# retry drain, but notify cannot race in and create a lost wakeup.
def close(self):
"""Idempotently release both endpoints, retrying prior close failures."""
with self._lock:
self._closed = True
self._pending = False
self._terminal = True
for endpoint, released_name in (
(self._reader, '_reader_released'),
(self._writer, '_writer_released'),
):
if getattr(self, released_name):
continue
try:
endpoint.close()
except BaseException:
continue
setattr(self, released_name, True)
def detect_micropython_machine_name(sys_mod: Any = None, os_mod: Any = None) -> str:
"""
Best-effort lookup of the active board/firmware machine name.
MicroPython commonly exposes a descriptive string through
``sys.implementation._machine``. When that is unavailable we fall back to
``os.uname().machine``.
"""
if sys_mod is None:
sys_mod = _import_first('sys')
if sys_mod is not None:
implementation = getattr(sys_mod, 'implementation', None)
machine_name = getattr(implementation, '_machine', None)
if machine_name:
return machine_name
if os_mod is None:
os_mod = _import_first('os')
if os_mod is not None and hasattr(os_mod, 'uname'):
try:
uname_result = os_mod.uname()
except TypeError:
uname_result = os_mod.uname
machine_name = getattr(uname_result, 'machine', None)
if machine_name:
return machine_name
return ''
def build_micropython_kernel(
machine_name: str | None = None, **kwargs: Any
) -> MicroPythonKernel:
"""
Return the best built-in MicroPython kernel profile for the current board.
This helper is intentionally conservative: it only selects a board-specific
profile when the firmware string clearly identifies one of the built-in board
targets. Everything else falls back to the generic ``MicroPythonKernel``.
"""
name = (machine_name or detect_micropython_machine_name() or '').lower()
if 'pico w' in name or 'pico 2 w' in name:
return PicoW(**kwargs)
if 'esp32' in name:
return ESP32(**kwargs)
if 'esp8266' in name:
return ESP8266(**kwargs)
return MicroPythonKernel(**kwargs)
class Kernel:
'''
@class Kernel - Soft interface for the platform layer.
The runtime keeps this surface intentionally small:
- text output
- wall-clock time when available
- scheduler timing built on ticks-style APIs
- sleeping and I/O readiness waiting
- generic TCP/TLS stream primitives
Higher-level protocols such as HTTPS, Redis, MQTT, RabbitMQ/AMQP, and Kafka
should be built in userland on top of these generic facilities instead of
requiring protocol-specific kernel methods.
'''
def __init__(self) -> None:
self._scheduler_anchor_tick = None
self._scheduler_elapsed_ms = 0
def write(self, msg: str) -> None:
pass
def shell_split(self, line: str) -> list[str]:
"""
Tokenize one shell command line.
The base implementation uses a small portable parser so shells can work on
platforms where ``shlex`` is unavailable. Desktop kernels may override
this with richer parsing behavior.
"""
return _portable_shell_split(line)
def time_epoch(self) -> float:
raise NotImplementedError
def ticks_ms(self) -> int:
raise NotImplementedError
def ticks_add(self, base: int, delta_ms: int) -> int:
return base + delta_ms
def ticks_diff(self, end: int, start: int) -> int:
return end - start
def time_monotonic(self) -> float:
return self.scheduler_now_ms() / 1000
def scheduler_now_ms(self) -> int:
'''
Returns a non-decreasing scheduler clock in milliseconds.
On MicroPython this is derived from ticks_ms/ticks_diff so wrap-around is
hidden from the scheduler and queue code.
'''
current = self.ticks_ms()
if self._scheduler_anchor_tick is None:
self._scheduler_anchor_tick = current
return self._scheduler_elapsed_ms
delta = self.ticks_diff(current, self._scheduler_anchor_tick)
if delta < 0:
delta = 0
self._scheduler_elapsed_ms += delta
self._scheduler_anchor_tick = current
return self._scheduler_elapsed_ms
def sleep(self, secs: float) -> None:
self.sleep_ms(int(max(0, secs) * 1000))
return
def sleep_ms(self, delay_ms: int) -> None:
pass
def io_wait(
self,
readables: Iterable[Any],
writables: Iterable[Any],
timeout_ms: int | None = None,
) -> tuple[list[Any], list[Any]]:
return [], []
def create_io_wait_set(self):
"""Return an optional persistent readiness set for one scheduler run."""
return None
def supports_external_wait_objects(self) -> bool:
"""Whether ``io_wait`` can wake on adapter-owned readiness objects."""
return False
def supports_wakeup_channel(self) -> bool:
"""Whether this kernel can wake a blocked scheduler from another thread."""
return False
def create_wakeup_channel(self) -> WakeupChannelLike:
"""Create an opaque cross-thread scheduler wakeup channel."""
raise NotImplementedError('Cross-thread wakeup channels are not supported.')
def supports_tcp_server(self) -> bool:
"""Whether this kernel implements the complete passive TCP contract."""
return False
def supports_reuse_address(self) -> bool:
"""Whether this kernel can configure address reuse on a listener."""
return False
def validate_io_wait_object(
self, obj: Any
) -> tuple[bool, BaseException | None]:
"""
Return whether ``obj`` still looks safe to hand to poll/select.
Closed sockets on CPython typically report ``fileno() == -1`` after close.
Letting those reach ``select.poll().register(...)`` crashes the runtime
with ``ValueError`` before the waiting task can be resumed or cleaned up.
"""
if obj is None:
return False, ValueError('I/O wait object cannot be None.')
if isinstance(obj, int):
if obj < 0:
return False, ValueError(
'I/O wait object has invalid file descriptor ({}).'.format(obj)
)
return True, None
if hasattr(obj, 'fileno'):
try:
fd = obj.fileno()
except Exception as exc:
return False, exc
if isinstance(fd, int) and fd < 0:
return False, ValueError(
'I/O wait object has invalid file descriptor ({}).'.format(fd)
)
return True, None
def resolve_address(self, host: str, port: int) -> Any:
return None
def resolve_passive_address(self, host: str, port: int) -> Any:
raise NotImplementedError('Passive TCP address resolution is not supported.')
def socket_open(self, address_info: Any) -> Any:
raise NotImplementedError('TCP sockets are not supported.')
def socket_setblocking(self, sock: Any, flag: bool) -> None:
raise NotImplementedError('TCP sockets are not supported.')
def socket_set_reuse_address(self, sock: Any, enabled: bool) -> None:
raise NotImplementedError('TCP address reuse is not supported.')
def socket_bind(self, sock: Any, address_info: Any) -> None:
raise NotImplementedError('TCP listeners are not supported.')
def socket_listen(self, sock: Any, backlog: int) -> None:
raise NotImplementedError('TCP listeners are not supported.')
def socket_accept(self, listener: Any) -> tuple[Any, Any]:
raise NotImplementedError('TCP listeners are not supported.')
def socket_local_address(self, sock: Any) -> Any:
raise NotImplementedError('Socket address inspection is not supported.')
def socket_peer_address(self, sock: Any) -> Any | None:
raise NotImplementedError('Socket address inspection is not supported.')
def socket_connect(self, sock: Any, sockaddr: Any) -> bool:
return True
def socket_connection_error(self, sock: Any) -> int:
return 0
def socket_send(self, sock: Any, data: SocketBuffer) -> int:
"""Send a bytes-like buffer without requiring an intermediate copy."""
return 0
def socket_recv(self, sock: Any, buffer_size: int) -> bytes:
return b''
def socket_close(self, sock: Any) -> None:
raise NotImplementedError('TCP sockets are not supported.')
def socket_wrap_tls_client(
self,
sock,
server_hostname=None,
tls_ca_file=None,
tls_cert_file=None,
tls_key_file=None,
tls_verify=True,
):
return sock
def socket_do_handshake(self, sock: Any) -> None:
return
def _extract_errno(self, exc: BaseException) -> int | None:
errno_value = getattr(exc, 'errno', None)
if errno_value is not None:
return errno_value
if getattr(exc, 'args', None):
return exc.args[0]
return None
def socket_needs_read(self, exc: BaseException) -> bool:
return isinstance(exc, BlockingIOError)
def socket_needs_write(self, exc: BaseException) -> bool:
return False
def socket_retry_mode(
self, exc: BaseException, operation: SocketOperation
) -> SocketRetryMode:
"""Return the readiness direction needed to retry one socket operation."""
_validate_socket_operation(operation)
if self.socket_needs_write(exc):
return 'write'
if self.socket_needs_read(exc):
return 'write' if operation == 'send' else 'read'
return None
def _poll_lookup_key(self, obj: Any) -> Any:
"""
Return the identity key used to map poll events back to registered objects.
``select.poll()`` typically reports integer file descriptors instead of the
original socket object, so the kernel needs a stable way to translate poll
results back into the scheduler's waiter keys.
"""
return _io_wait_lookup_key(obj)
class Unix(Kernel):
'''
For Unix-like systems.
The imports used by this implementation are loaded here instead of at module
import time so alternate kernels can import ``Kernel.py`` without requiring
desktop-oriented modules such as ``select`` and ``socket`` to exist.
'''
def __init__(self):
super().__init__()
import errno
import os
import shlex
import select
import selectors
import socket
import ssl
import sys
import threading
import time
self._errno = errno
self._os = os
self._shlex = shlex
self._select = select
self._selector_factory = selectors.DefaultSelector
if sys.platform == 'darwin' and hasattr(selectors, 'PollSelector'):
# Kqueue has a comparatively high fixed cost for zero-time checks on
# macOS. Persistent poll avoids the small-wait-set scheduler regression
# while still removing registration rebuilds.
self._selector_factory = selectors.PollSelector
self._selector_read_mask = selectors.EVENT_READ
self._selector_write_mask = selectors.EVENT_WRITE
self._socket = socket
self._ssl = ssl
self._sys = sys
self._lock_factory = threading.Lock
self._time = time
self._poll_factory = getattr(select, 'poll', None)
return
def write(self, msg):
self._sys.stdout.write(msg)
self._sys.stdout.flush()
return
def shell_split(self, line):
"""Use ``shlex`` on Unix for richer desktop-style shell parsing."""
return self._shlex.split(line)
def time_epoch(self):
return self._time.time()
def ticks_ms(self):
return int(self._time.monotonic() * 1000)
def ticks_add(self, base, delta_ms):
return base + delta_ms
def ticks_diff(self, end, start):
return end - start
def time_monotonic(self):
return self._time.monotonic()
def sleep_ms(self, delay_ms):
self._time.sleep(max(0, delay_ms) / 1000)
return
def io_wait(self, readables, writables, timeout_ms=None):
if self._poll_factory:
poller = self._poll_factory()
mask_by_object = {}
object_by_key = {}
read_mask = getattr(self._select, 'POLLIN', 0x001)
write_mask = getattr(self._select, 'POLLOUT', 0x004)
for obj in readables:
mask_by_object[obj] = mask_by_object.get(obj, 0) | read_mask
for obj in writables:
mask_by_object[obj] = mask_by_object.get(obj, 0) | write_mask
for obj, mask in mask_by_object.items():
object_by_key[self._poll_lookup_key(obj)] = obj
poller.register(obj, mask)
timeout = -1 if timeout_ms is None else max(0, int(timeout_ms))
events = poller.poll(timeout)
ready_read = []
ready_write = []
for obj, mask in events:
ready_obj = object_by_key.get(obj, obj)
if mask & read_mask:
ready_read.append(ready_obj)
if mask & write_mask:
ready_write.append(ready_obj)
return ready_read, ready_write
timeout = None if timeout_ms is None else max(0, timeout_ms) / 1000
if not readables and not writables:
if timeout is not None and timeout > 0:
self._time.sleep(timeout)
return [], []
ready_read, ready_write, _ = self._select.select(readables, writables, [], timeout)
return ready_read, ready_write
def create_io_wait_set(self):
"""Create the runtime-owned selector used for persistent Unix waits."""
return _SelectorIOWaitSet(
self._selector_factory(),
self._selector_read_mask,
self._selector_write_mask,
)
def validate_io_wait_object(self, obj: Any) -> tuple[bool, BaseException | None]:
"""Reject Unix descriptors that were closed behind a persistent wait set."""
is_valid, exc = super().validate_io_wait_object(obj)
if not is_valid:
return is_valid, exc
fd = _io_wait_lookup_key(obj)
if not isinstance(fd, int):
return True, None
try:
self._os.fstat(fd)
except (OSError, OverflowError, ValueError) as exc:
return False, exc
return True, None
def supports_external_wait_objects(self) -> bool:
return True
def supports_wakeup_channel(self) -> bool:
"""Require a callable primitive rather than mere attribute presence."""
return callable(getattr(self._socket, 'socketpair', None))
def create_wakeup_channel(self) -> WakeupChannelLike:
"""Create a non-blocking socket-pair channel owned by this kernel."""
socket_pair = getattr(self._socket, 'socketpair', None)
if not callable(socket_pair):
raise NotImplementedError(
'This Unix platform does not provide a callable socketpair().'
)
acquired = []
try:
pair = socket_pair()
if TYPE_CHECKING:
pair = cast("Any", pair)
iterator = iter(pair)
reader = next(iterator)
acquired.append(reader)
writer = next(iterator)
acquired.append(writer)
try:
extra = next(iterator)
except StopIteration:
pass
else:
acquired.append(extra)
raise ValueError('socketpair() must return exactly two endpoints.')
if reader is writer:
raise ValueError('socketpair() endpoints must be distinct objects.')
for endpoint, required in (
(reader, ('setblocking', 'recv', 'close')),
(writer, ('setblocking', 'send', 'close')),
):
missing = [
name for name in required
if not callable(getattr(endpoint, name, None))
]
if missing:
raise TypeError(
'socketpair() endpoint is missing callable operations: {}.'.format(
', '.join(missing)
)
)
reader.setblocking(False)
writer.setblocking(False)
lock = self._lock_factory()
except BaseException:
released = []
for endpoint in reversed(acquired):
if any(endpoint is released_endpoint for released_endpoint in released):
continue
released.append(endpoint)
try:
closer = getattr(endpoint, 'close', None)
if callable(closer):
closer()
except BaseException:
pass
raise
return _SocketWakeupChannel(reader, writer, lock)
def supports_tcp_server(self) -> bool:
return True
def supports_reuse_address(self) -> bool:
return (
hasattr(self._socket, 'SOL_SOCKET')
and hasattr(self._socket, 'SO_REUSEADDR')
and callable(getattr(self._socket.socket, 'setsockopt', None))