1 ;;; 8sync --- Asynchronous programming for Guile
2 ;;; Copyright (C) 2016 Christopher Allan Webber <cwebber@dustycloud.org>
4 ;;; This file is part of 8sync.
6 ;;; 8sync is free software: you can redistribute it and/or modify it
7 ;;; under the terms of the GNU Lesser General Public License as
8 ;;; published by the Free Software Foundation, either version 3 of the
9 ;;; License, or (at your option) any later version.
11 ;;; 8sync is distributed in the hope that it will be useful,
12 ;;; but WITHOUT ANY WARRANTY; without even the implied warranty of
13 ;;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 ;;; GNU Lesser General Public License for more details.
16 ;;; You should have received a copy of the GNU Lesser General Public
17 ;;; License along with 8sync. If not, see <http://www.gnu.org/licenses/>.
19 ;; XUDD inspired actor system
21 (define-module (8sync systems actors)
22 #:use-module (oop goops)
23 #:use-module (srfi srfi-9)
24 #:use-module (srfi srfi-9 gnu)
25 #:use-module (ice-9 format)
26 #:use-module (ice-9 match)
27 #:use-module (ice-9 pretty-print)
28 #:use-module (8sync agenda)
29 #:use-module (8sync repl)
30 #:export (;; utilities... ought to go in their own module
32 big-random-number-string
33 simple-message-id-generator
41 ;;; Commenting out the <address> type for now;
42 ;;; it may be back when we have better serializers
45 address-actor-id address-hive-id
57 ;; There are more methods for the hive, but there's
58 ;; no reason for the outside world to look at them maybe?
60 hive-create-actor hive-create-actor*
64 message-to message-action message-from
65 message-id message-body message-in-reply-to
69 send-message send-message-wait
70 reply-message reply-message-wait
73 hive-bootstrap-message
75 serialize-message write-message
76 serialize-message-pretty pprint-message
77 read-message read-message-from-string))
81 (make-parameter (random-state-from-platform)))
83 ;; Probably bigger than necessary
84 (define random-number-size (expt 10 50))
86 (define (big-random-number)
87 (random random-number-size (%random-state)))
89 ;; Would be great to get this base64 encoded instead.
90 (define (big-random-number-string)
91 ;; @@: This is slow. Using format here is wasteful.
92 (format #f "~x" (big-random-number)))
94 ;; @@: This is slow. A mere ~275k / second on my (old) machine.
95 ;; The main cost seems to be in number->string.
96 (define (simple-message-id-generator)
97 ;; Prepending this cookie makes message ids unique per hive
98 (let ((prefix (format #f "~x:" (big-random-number)))
101 (set! counter (1+ counter))
102 (string-append prefix (number->string counter)))))
104 (define (require-slot slot-name)
105 "Generate something for #:init-thunk to complain about unfilled slot"
107 (throw 'required-slot
108 (format #f "Slot ~s not filled" slot-name)
117 (define-record-type <message>
118 (make-message-intern id to from action
119 body in-reply-to wants-reply ; do we need hive-proxy?
120 ;; Are these still needed?
121 replied deferred-reply)
126 (action message-action)
128 (in-reply-to message-in-reply-to)
129 (wants-reply message-wants-reply)
131 ;; See XUDD source for these. Not use yet, maybe eventually will be?
132 ;; XUDD uses them for autoreply.
133 ;; Requiring mutation on message objects is clearly not great,
134 ;; but it may be worth it...? Investigate!
135 (replied message-replied set-message-replied!)
136 (deferred-reply message-deferred-reply set-message-deferred-reply!))
139 (define* (make-message id to from action body
140 #:key in-reply-to wants-reply
141 replied deferred-reply)
142 (make-message-intern id to from action body
143 in-reply-to wants-reply replied
146 ;; Note: the body of messages is currently an alist, but it's created
147 ;; from a keyword based property list (see the following two functions).
148 ;; But, that's an extra conversion step, and maybe totally unnecessary:
149 ;; we already have message-ref, and this could just pull a keyword
150 ;; from a property list.
151 ;; The main ways this might be useful are error checking,
152 ;; serialization across the wire (but even that might require some
153 ;; change), and using existing tooling (though adding new tooling
154 ;; would be negligible in implementation effort.)
156 ;; This cons cell is immutable and unique (for eq? tests)
157 (define %nothing-provided (cons 'nothing 'provided))
159 (define* (message-ref message key #:optional (dflt %nothing-provided))
160 "Extract KEY from body of MESSAGE.
162 Optionally set default with [DFLT]
163 If key not found and DFLT not provided, throw an error."
164 (let ((result (assoc key (message-body message))))
165 (if result (cdr result)
166 (if (eq? dflt %nothing-provided)
167 (throw 'message-missing-key
168 "Message body does not contain key and no default provided"
174 (define (message-needs-reply message)
175 "See if this message needs a reply still"
176 (and (message-wants-reply message)
177 (not (or (message-replied message)
178 (message-deferred-reply message)))))
181 (define (kwarg-list-to-alist args)
182 (let loop ((remaining args)
185 (((? keyword? key) val rest ...)
187 (cons (cons (keyword->symbol key) val)
190 (_ (throw 'invalid-kwarg-list
191 "Invalid keyword argument list"
195 (define (send-message from-actor to-id action . message-body-args)
196 "Send a message from an actor to another actor"
197 (let* ((hive (actor-hive from-actor))
198 (message (make-message (hive-gen-message-id hive) to-id
199 (actor-id from-actor) action
200 (kwarg-list-to-alist message-body-args))))
201 (8sync (hive-process-message hive message))))
203 (define (send-message-wait from-actor to-id action . message-body-args)
204 "Send a message from an actor to another, but wait until we get a response"
205 (let* ((hive (actor-hive from-actor))
206 (agenda-prompt (hive-prompt (actor-hive from-actor)))
207 (message (make-message (hive-gen-message-id hive) to-id
208 (actor-id from-actor) action
209 (kwarg-list-to-alist message-body-args)
211 (abort-to-prompt agenda-prompt from-actor message)))
213 ;; TODO: Intelligently ~propagate(ish) errors on -wait functions.
214 ;; We might have `send-message-wait-brazen' to allow callers to
215 ;; not have an exception thrown and instead just have a message with
216 ;; the appropriate '*error* message returned.
218 (define (reply-message from-actor original-message
221 (set-message-replied! original-message #t)
222 (let* ((hive (actor-hive from-actor))
223 (new-message (make-message (hive-gen-message-id hive)
224 (message-from original-message)
225 (actor-id from-actor) '*reply*
226 (kwarg-list-to-alist message-body-args)
227 #:in-reply-to (message-id original-message))))
228 (8sync (hive-process-message hive new-message))))
230 (define (reply-message-wait from-actor original-message
232 "Reply to a messsage, but wait until we get a response"
233 (set-message-replied! original-message #t)
234 (let* ((hive (actor-hive from-actor))
235 (agenda-prompt (hive-prompt (actor-hive from-actor)))
236 (new-message (make-message (hive-gen-message-id hive)
237 (message-from original-message)
238 (actor-id from-actor) '*reply*
239 (kwarg-list-to-alist message-body-args)
241 #:in-reply-to (message-id original-message))))
242 (abort-to-prompt agenda-prompt from-actor new-message)))
246 ;;; Main actor implementation
247 ;;; =========================
249 (define-class <actor> ()
251 (id #:init-thunk (require-slot "id")
254 ;; The hive we're connected to.
255 ;; We need this to be able to send messages.
256 (hive #:init-thunk (require-slot "hive")
257 #:init-keyword #:hive
258 #:accessor actor-hive)
259 ;; How we receive and process new messages
260 (message-handler #:init-thunk (require-slot "message-handler")
261 #:allocation #:each-subclass))
263 (define-method (actor-message-handler (actor <actor>))
264 (slot-ref actor 'message-handler))
266 ;;; So these are the nicer representations of addresses.
267 ;;; However, they don't serialize so easily with scheme read/write, so we're
268 ;;; using the simpler cons cell version below for now.
270 ;; (define-record-type <address>
271 ;; (make-address actor-id hive-id) ; @@: Do we want the trailing -id?
273 ;; (actor-id address-actor-id)
274 ;; (hive-id address-hive-id))
276 ;; (set-record-type-printer!
278 ;; (lambda (record port)
279 ;; (format port "<address: ~s@~s>"
280 ;; (address-actor-id record) (address-hive-id record))))
283 (define (make-address actor-id hive-id)
284 (cons actor-id hive-id))
286 (define (address-actor-id address)
289 (define (address-hive-id address)
292 (define (address->string address)
293 (string-append (address-actor-id address) "@"
294 (address-hive-id address)))
296 (define-method (actor-id-actor (actor <actor>))
297 "Get the actor id component of the actor-id"
298 (address-actor-id (actor-id actor)))
300 (define-method (actor-id-hive (actor <actor>))
301 "Get the hive id component of the actor-id"
302 (address-hive-id (actor-id actor)))
304 (define-method (actor-id-string (actor <actor>))
305 "Render the full actor id as a human-readable string"
306 (address->string (actor-id actor)))
313 (define (simple-dispatcher action-map)
314 (lambda (actor message)
315 (let* ((action (message-action message))
316 (method (assoc-ref action-map action)))
318 (throw 'action-not-found
319 "No appropriate action handler found for actor"
323 #:available-actions (map car action-map)))
324 (method actor message))))
326 (define-syntax %expand-action-item
328 ((_ ((action-name action-args ...) body ...))
329 (cons (quote action-name)
330 (lambda (action-args ...)
332 ((_ (action-name handler))
333 (cons (quote action-name) handler))))
335 (define-syntax make-action-dispatch
337 "Expand a list of action names and actions into an alist
339 You can use this like the following:
340 (make-action-dispatch
342 (lambda (actor message)
343 (display \"I love cookies!\n\")))
345 (lambda (actor message)
346 (display \"Life of the party!\"))))
348 Alternately, if you'd like to skip the lambda, you could use the slightly
349 more compact following syntax:
350 (make-action-dispatch
351 ((cookies actor message)
352 (display \"I love cookies!\n\"))
353 ((party actor message)
354 (display \"Life of the party!\")))"
355 ((make-action-dispatch action-item ...)
357 (list (%expand-action-item action-item) ...)))))
359 (define-syntax-rule (define-simple-actor class actions ...)
360 (define-class class (<actor>)
362 #:init-value (make-action-dispatch actions ...)
363 #:allocation #:each-subclass)))
368 ;;; Every actor has a hive. The hive is a kind of "meta-actor"
369 ;;; which routes all the rest of the actors in a system.
371 (define-generic hive-handle-failed-forward)
373 (define-class <hive> (<actor>)
374 ;; This gets set to itself immediately after being created
375 (hive #:init-value #f)
376 (actor-registry #:init-thunk make-hash-table
377 #:getter hive-actor-registry)
378 (msg-id-generator #:init-thunk simple-message-id-generator
379 #:getter hive-msg-id-generator)
380 ;; Ambassadors are used (or will be) for inter-hive communication.
381 ;; These are special actors that know how to route messages to other hives.
382 (ambassadors #:init-thunk make-weak-key-hash-table
383 #:getter hive-ambassadors)
384 ;; Waiting coroutines
385 ;; This is a map from cons cell of message-id
386 ;; to a cons cell of (actor-id . coroutine)
387 ;; @@: Should we have a <waiting-coroutine> record type?
388 ;; @@: Should there be any way to clear out "old" coroutines?
389 (waiting-coroutines #:init-thunk make-hash-table
390 #:getter hive-waiting-coroutines)
392 ;; When actors send messages to each other they abort to this prompt
393 ;; to send the message, then carry on their way
394 (prompt #:init-thunk make-prompt-tag
395 #:getter hive-prompt)
398 (make-action-dispatch
399 ;; This is in the case of an ambassador failing to forward a message...
400 ;; it reports it back to the hive
401 (*failed-forward* hive-handle-failed-forward))))
403 (define-method (hive-handle-failed-forward (hive <hive>) message)
404 "Handle an ambassador failing to forward a message"
407 (define* (make-hive #:key hive-id)
408 (let ((hive (make <hive>
411 (big-random-number-string))))))
412 ;; Set the hive's actor reference to itself
413 (set! (actor-hive hive) hive)
416 (define-method (hive-id (hive <hive>))
417 (actor-id-hive hive))
419 (define-method (hive-gen-actor-id (hive <hive>) cookie)
420 (make-address (if cookie
421 (string-append cookie "-" (big-random-number-string))
422 (big-random-number-string))
425 (define-method (hive-gen-message-id (hive <hive>))
426 "Generate a message id using HIVE's message id generator"
427 ((hive-msg-id-generator hive)))
429 (define-method (hive-resolve-local-actor (hive <hive>) actor-address)
430 (hash-ref (hive-actor-registry hive) actor-address))
432 (define-method (hive-resolve-ambassador (hive <hive>) ambassador-address)
433 (hash-ref (hive-ambassadors hive) ambassador-address))
435 (define-method (make-forward-request (hive <hive>) (ambassador <actor>) message)
436 (make-message (hive-gen-message-id hive) (actor-id ambassador)
437 ;; If we make the hive not an actor, we could either switch this
438 ;; to #f or to the original actor...?
439 ;; Maybe some more thinking should be done on what should
440 ;; happen in case of failure to forward? Handling ambassador failures
441 ;; seems like the primary motivation for the hive remaining an actor.
444 `((original . ,message))))
446 (define-method (hive-process-message (hive <hive>) message)
447 "Handle one message, or forward it via an ambassador"
448 (define (process-local-message)
449 (let ((actor (hive-resolve-local-actor hive (message-to message))))
451 (throw 'actor-not-found
452 (format #f "Message ~a from ~a directed to nonexistant actor ~a"
454 (address->string (message-from message))
455 (address->string (message-to message)))
457 (call-with-prompt (hive-prompt hive)
459 (define message-handler (actor-message-handler actor))
460 ;; @@: Should a more general error handling happen here?
462 (message-handler actor message)))
463 ;; Possibly autoreply
464 (if (message-needs-reply message)
465 ;; @@: Should we give *autoreply* as the action instead of *reply*?
466 (reply-message actor message
468 ;; Returning result allows actors to possibly make a run-request
469 ;; at the end of handling a message.
470 ;; ... We do want that, right?
473 (lambda (kont actor message)
474 (let ((hive (actor-hive actor)))
475 ;; Register the coroutine
476 (hash-set! (hive-waiting-coroutines hive)
478 (cons (actor-id actor) kont))
479 ;; Send off the message
480 (8sync (hive-process-message hive message)))))))
482 (define (resume-waiting-coroutine)
483 (match (hash-remove! (hive-waiting-coroutines hive)
484 (message-in-reply-to message))
485 ((_ . (resume-actor-id . kont))
486 (if (not (equal? (message-to message)
488 (throw 'resuming-to-wrong-actor
489 "Attempted to resume a coroutine to the wrong actor!"
490 #:expected-actor-id (message-to message)
491 #:got-actor-id resume-actor-id
494 (#f (throw 'no-waiting-coroutine
495 "message in-reply-to tries to resume nonexistent coroutine"
498 (define (process-remote-message)
499 ;; Find the ambassador
500 (let* ((remote-hive-id (hive-id (message-to message)))
501 (ambassador (hive-resolve-ambassador remote-hive-id))
502 (message-handler (actor-message-handler ambassador))
503 (forward-request (make-forward-request hive ambassador message)))
504 (message-handler ambassador forward-request)))
506 (let ((to (message-to message)))
507 ;; This seems to be an easy mistake to make, so check that addressing
510 (throw 'missing-addressee
511 "`to' field is missing on message"
513 (if (hive-actor-local? hive to)
514 (if (message-in-reply-to message)
515 (resume-waiting-coroutine)
516 (process-local-message))
517 (process-remote-message))))
519 (define-method (hive-actor-local? (hive <hive>) address)
520 (hash-ref (hive-actor-registry hive) address))
522 (define-method (hive-register-actor! (hive <hive>) (actor <actor>))
523 (hash-set! (hive-actor-registry hive) (actor-id actor) actor))
525 (define-method (%hive-create-actor (hive <hive>) actor-class
527 "Actual method called by hive-create-actor.
529 Since this is a define-method it can't accept fancy define* arguments,
530 so this gets called from the nicer hive-create-actor interface. See
531 that method for documentation."
532 (let* ((actor-id (hive-gen-actor-id hive id-cookie))
533 (actor (apply make actor-class
534 ;; @@: If we switch to a hive-proxy, do it here
538 (hive-register-actor! hive actor)
539 ;; return the actor id
542 (define* (hive-create-actor hive actor-class
546 (%hive-create-actor hive actor-class
549 (define-syntax hive-create-actor*
551 "Create an instance of actor-class attached to this hive.
552 Return the new actor's id.
554 Used internally, and used for bootstrapping a fresh hive.
556 Note that actors should generally not call this method directly.
557 Instead, actors should call create-actor."
558 ((_ args ... (init-args ...))
559 (hive-create-actor args ...
560 #:init (list init-args ...)))))
563 ;; TODO: Give actors this instead of the actual hive reference
564 (define-class <hive-proxy> ()
565 (send-message #:getter proxy-send-message
566 #:init-keyword #:send-message)
567 (create-actor #:getter proxy-create-actor
568 #:init-keyword #:create-actor))
570 ;; Live the hive proxy, but has access to the hive itself...
571 (define-class <debug-hive-proxy> (<hive-proxy>)
572 (hive #:init-keyword #:hive))
576 ;;; 8sync bootstrap utilities
577 ;;; =========================
579 (define* (ez-run-hive hive initial-tasks #:key repl-server)
580 "Start up an agenda and run HIVE in it with INITIAL-TASKS.
582 Should we start up a cooperative REPL for live hacking? REPL-SERVER
583 wants to know! You can pass it #t or #f, or if you want to specify a port,
585 (let* ((queue (list->q initial-tasks))
586 (agenda (make-agenda #:pre-unwind-handler print-error-and-continue
589 ;; If repl-server is an integer, we'll use that as the port
590 ((integer? repl-server)
591 (spawn-and-queue-repl-server! agenda repl-server))
593 (spawn-and-queue-repl-server! agenda)))
594 (start-agenda agenda)))
596 (define (hive-bootstrap-message hive to-id action . message-body-args)
598 (apply send-message hive to-id action message-body-args)))
602 ;;; Basic readers / writers
603 ;;; =======================
605 (define (serialize-message message)
606 "Serialize a message for read/write"
610 (message-from message)
611 (message-action message)
612 (message-body message)
613 (message-in-reply-to message)
614 (message-wants-reply message)
615 (message-replied message)
616 (message-deferred-reply message)))
618 (define* (write-message message #:optional (port (current-output-port)))
619 "Write out a message to a port for easy reading later.
621 Note that if a sub-value can't be easily written to something
622 Guile's `read' procedure knows how to read, this doesn't do anything
623 to improve that. You'll need a better serializer for that.."
624 (write (serialize-message message) port))
626 (define (serialize-message-pretty message)
627 "Serialize a message in a way that's easy for humans to read."
629 (id ,(message-id message))
630 (to ,(message-to message))
631 (from ,(message-from message))
632 (action ,(message-action message))
633 (body ,(message-body message))
634 (in-reply-to ,(message-in-reply-to message))
635 (wants-reply ,(message-wants-reply message))
636 (replied ,(message-replied message))
637 (deferred-reply ,(message-deferred-reply message))))
639 (define (pprint-message message)
640 "Pretty print a message."
641 (pretty-print (serialize-message-pretty message)))
643 (define* (read-message #:optional (port (current-input-port)))
644 "Read a message serialized via serialize-message from PORT"
646 ((id to from action body in-reply-to wants-reply replied deferred-reply)
648 id to from action body
649 in-reply-to wants-reply replied deferred-reply))
651 (throw 'message-read-bad-structure
652 "Could not read message from structure"
655 (define (read-message-from-string message-str)
656 "Read message from MESSAGE-STR"
657 (with-input-from-string message-str
659 (read-message (current-input-port)))))