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
|
;; Fibers: cooperative, event-driven user-space threads.
;;;; Copyright (C) 2016-2022 Free Software Foundation, Inc.
;;;;
;;;; This library is free software; you can redistribute it and/or
;;;; modify it under the terms of the GNU Lesser General Public
;;;; License as published by the Free Software Foundation; either
;;;; version 3 of the License, or (at your option) any later version.
;;;;
;;;; This library is distributed in the hope that it will be useful,
;;;; but WITHOUT ANY WARRANTY; without even the implied warranty of
;;;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
;;;; Lesser General Public License for more details.
;;;;
;;;; You should have received a copy of the GNU Lesser General Public License
;;;; along with this program. If not, see <http://www.gnu.org/licenses/>.
;;;;
(define-module (fibers)
#:use-module (ice-9 match)
#:use-module (ice-9 atomic)
#:use-module (ice-9 threads)
#:use-module ((ice-9 ports internal)
#:select (port-read-wait-fd port-write-wait-fd))
#:use-module (ice-9 suspendable-ports)
#:use-module (fibers config)
#:use-module (fibers scheduler)
#:use-module (fibers repl)
#:use-module ((fibers timers) #:select ((sleep . timers-sleep) timer-operation sleep-operation))
#:use-module (fibers interrupts)
#:use-module (fibers affinity)
#:use-module (fibers posix-clocks)
#:export (run-fibers spawn-fiber)
#:re-export (%fibers-version
dynamic-wind*)
;; use replace instead of #:re-export-and-replace for Guile 2.2 and <3.0.8 support
#:replace (sleep))
;; defined only for replacing in case timers is not imported
(define sleep timers-sleep)
;; Guile 2 and 3 compatibility. Some bit vector related procedures were
;; deprecated in Guile 3.0.3 and new ones were defined.
(define bitvector-count*
(or (and=> (module-variable the-scm-module 'bitvector-count)
variable-ref)
(lambda (v)
(bit-count #t v))))
(define bitvector-position*
(or (and=> (module-variable the-scm-module 'bitvector-position)
variable-ref)
(lambda (v b i)
(bit-position b v i))))
(define bitvector-set-bit!*
(or (and=> (module-variable the-scm-module 'bitvector-set-bit!)
variable-ref)
(lambda (v i)
(bitvector-set! v i #t))))
;; End of Guile 2 and 3 compatibility.
(define (wait-for-readable port)
(suspend-current-task
(lambda (sched k)
(schedule-task-when-fd-readable sched (port-read-wait-fd port) k))))
(define (wait-for-writable port)
(suspend-current-task
(lambda (sched k)
(schedule-task-when-fd-writable sched (port-write-wait-fd port) k))))
(define-syntax-rule (with-affinity affinity exp ...)
(let ((saved #f))
(dynamic-wind
(lambda ()
(set! saved (getaffinity* 0))
(setaffinity* 0 affinity))
(lambda () exp ...)
(lambda ()
(setaffinity* 0 saved)))))
(define (%run-fibers scheduler hz finished? affinity)
(with-affinity
affinity
(with-interrupts
hz
(let ((last-runcount 0))
(lambda ()
(let* ((runcount (scheduler-runcount scheduler))
(res (eqv? runcount last-runcount)))
(set! last-runcount runcount)
res)))
yield-current-task
(lambda ()
(run-scheduler scheduler finished?)))))
(define (start-auxiliary-threads scheduler hz finished? affinities)
(for-each (lambda (sched affinity)
(call-with-new-thread
(lambda ()
(%run-fibers sched hz finished? affinity))))
(scheduler-remote-peers scheduler) affinities))
(define (stop-auxiliary-threads scheduler)
(for-each
(lambda (scheduler)
(let ((thread (scheduler-kernel-thread scheduler)))
(when thread
(cancel-thread thread)
(join-thread thread))))
(scheduler-remote-peers scheduler)))
(define (compute-affinities group-affinity parallelism)
(define (each-thread-has-group-affinity)
(make-list parallelism group-affinity))
(define (one-thread-per-cpu)
(let lp ((cpu 0))
(match (bitvector-position* group-affinity #t cpu)
(#f '())
(cpu (let ((affinity
(make-bitvector (bitvector-length group-affinity) #f)))
(bitvector-set-bit!* affinity cpu)
(cons affinity (lp (1+ cpu))))))))
(let ((cpu-count (bitvector-count* group-affinity)))
(if (eq? parallelism cpu-count)
(one-thread-per-cpu)
(each-thread-has-group-affinity))))
(define* (run-fibers #:optional (init #f)
#:key (hz 100) (scheduler #f)
(parallelism (current-processor-count))
(cpus (getaffinity* 0))
(install-suspendable-ports? #t)
(drain? #f))
(when install-suspendable-ports? (install-suspendable-ports!))
(cond
(scheduler
(let ((finished? (lambda () #f)))
(when init (spawn-fiber init scheduler))
(%run-fibers scheduler hz finished? cpus)))
(else
(let* ((scheduler (make-scheduler #:parallelism parallelism))
(ret (make-atomic-box #f))
(finished? (lambda ()
(and (atomic-box-ref ret)
(or (not drain?)
(not (scheduler-work-pending? scheduler))))))
(affinities (compute-affinities cpus parallelism)))
(unless init
(error "run-fibers requires initial fiber thunk when creating sched"))
(spawn-fiber (lambda ()
(call-with-values init
(lambda vals (atomic-box-set! ret vals)))
;; Could be that this fiber was migrated away.
;; Make sure to wake up the main scheduler.
(spawn-fiber (lambda () #t) scheduler))
scheduler)
(match affinities
((affinity . affinities)
(dynamic-wind
(lambda ()
(start-auxiliary-threads scheduler hz finished? affinities))
(lambda ()
(%run-fibers scheduler hz finished? affinity))
(lambda ()
(stop-auxiliary-threads scheduler)))))
(for-each destroy-scheduler (scheduler-remote-peers scheduler))
(destroy-scheduler scheduler)
(apply values (atomic-box-ref ret))))))
(define* (spawn-fiber thunk #:optional scheduler #:key parallel?)
"Spawn a new fiber which will start by invoking @var{thunk}.
The fiber will be scheduled on the next turn. @var{thunk} will run
with a copy of the current dynamic state, isolating fluid and
parameter mutations to the fiber."
(define (capture-dynamic-state thunk)
(let ((dynamic-state (current-dynamic-state)))
(lambda ()
(with-dynamic-state dynamic-state thunk))))
(define (create-fiber sched thunk)
(schedule-task sched
(capture-dynamic-state thunk)))
(cond
(scheduler
;; When a scheduler is passed explicitly, it could be there is no
;; current fiber; in that case the dynamic state probably doesn't
;; have the right right current-read-waiter /
;; current-write-waiter, so wrap the thunk.
(create-fiber scheduler
(lambda ()
(current-read-waiter wait-for-readable)
(current-write-waiter wait-for-writable)
(thunk))))
((current-scheduler)
=> (lambda (sched)
(create-fiber (if parallel?
(choose-parallel-scheduler sched)
sched)
thunk)))
(else
(error "No scheduler current; call within run-fibers instead"))))
|
