path: root/stdlib/source/lux/concurrency/actor.lux

(;module: {#;doc "The actor model of concurrency."}
  lux
  (lux (control monad
                ["p" parser]
                ["ex" exception #+ exception:])
       [io #- run "io/" Monad<IO>]
       (data text/format
             (coll [list "L/" Monoid<List> Monad<List>])
             [product])
       [macro #+ with-gensyms Monad<Lux>]
       (macro [code]
              ["s" syntax #+ syntax: Syntax]
              (syntax ["cs" common]
                      (common ["csr" reader]
                              ["csw" writer])))
       [type])
  (.. ["A" atom]
      ["P" promise "P/" Monad<Promise>]
      ["T" task]
      [stm #+ Monad<STM>]
      [frp]))

(exception: #export Poisoned)
(exception: #export Killed)

## [Types]
(with-expansions
  [<Message> (as-is (-> s (Actor s) (T;Task s)))
   <Obituary> (as-is [Text s (List <Message>)])]
  (type: #export (Actor s)
    {#;doc "An actor, defined as all the necessities it requires."}
    {#mailbox (stm;Var <Message>)
     #kill-switch (P;Promise Unit)
     #obituary (P;Promise <Obituary>)})

  (type: #export (Message s)
    <Message>)

  (type: #export (Obituary s)
    <Obituary>))

(type: #export (Behavior s)
  {#;doc "An actor's behavior when messages are received."}
  {#handle (-> (Message s) s (Actor s) (T;Task s))
   #end (-> Text s (P;Promise Unit))})

## [Values]
(def: #export (default-handle message state self)
  (All [s] (-> (Message s) s (Actor s) (T;Task s)))
  (message state self))

(def: #export (default-end cause state)
  (All [s] (-> Text s (P;Promise Unit)))
  (P/wrap []))

(def: #export (spawn behavior init)
  {#;doc "Given a behavior and initial state, spawns an actor and returns it."}
  (All [s] (-> (Behavior s) s (IO (Actor s))))
  (io (let [[handle end] behavior
            self (: (Actor ($ +0))
                    {#mailbox (stm;var (:! (Message ($ +0)) []))
                     #kill-switch (P;promise Unit)
                     #obituary (P;promise (Obituary ($ +0)))})
            mailbox-chan (io;run (stm;follow (get@ #mailbox self)))
            |mailbox| (stm;var mailbox-chan)
            _ (P/map (function [_]
                       (io;run (do Monad<IO>
                                 [mb (stm;read! |mailbox|)]
                                 (frp;close mb))))
                     (get@ #kill-switch self))
            process (loop [state init
                           messages mailbox-chan]
                      (do P;Monad<Promise>
                        [?messages+ messages]
                        (case ?messages+
                          ## No kill-switch so far, so I may proceed...
                          (#;Some [message messages'])
                          (do P;Monad<Promise>
                            [#let [_ (io;run (stm;write! messages' |mailbox|))]
                             ?state' (handle message state self)]
                            (case ?state'
                              (#;Left error)
                              (do @
                                [#let [_ (io;run (P;resolve [] (get@ #kill-switch self)))
                                       _ (io;run (frp;close messages'))]
                                 _ (end error state)
                                 remaining-messages (frp;consume messages')]
                                (wrap [error state (#;Cons message remaining-messages)]))

                              (#;Right state')
                              (recur state' messages')))

                          ## Otherwise, clean-up and return current state.
                          #;None
                          (do P;Monad<Promise>
                            [#let [_ (io;run (frp;close messages))
                                   death-message (Killed "")]
                             _ (end death-message state)]
                            (wrap [death-message state (list)])))))]
        self)))

(def: #export (alive? actor)
  (All [s] (-> (Actor s) Bool))
  (case [(P;poll (get@ #kill-switch actor))
         (P;poll (get@ #obituary actor))]
    [#;None #;None]
    true

    _
    false))

(def: #export (send message actor)
  {#;doc "Communicate with an actor through message passing."}
  (All [s] (-> (Message s) (Actor s) (IO Bool)))
  (if (alive? actor)
    (exec (io;run (stm;write! message (get@ #mailbox actor)))
      (io/wrap true))
    (io/wrap false)))

(def: #export (kill actor)
  {#;doc "Immediately kills the given actor (if it is not already dead)."}
  (All [s] (-> (Actor s) (io;IO Bool)))
  (if (alive? actor)
    (|> actor (get@ #kill-switch) (P;resolve []))
    (io/wrap false)))

(def: #export (poison actor)
  {#;doc "Kills the actor by sending a message that will kill it upon processing,
          but allows the actor to handle previous messages."}
  (All [s] (-> (Actor s) (IO Bool)))
  (send (function [state self]
          (T;throw Poisoned ""))
        actor))

## [Syntax]
(do-template [<with> <resolve> <tag> <desc>]
  [(def: (<with> name)
     (-> Ident cs;Annotations cs;Annotations)
     (|>. (#;Cons [(ident-for <tag>)
                   (code;tag name)])))
   
   (def: (<resolve> name)
     (-> Ident (Lux Ident))
     (do Monad<Lux>
       [name (macro;normalize name)
        [_ annotations _] (macro;find-def name)]
       (case (macro;get-ident-ann (ident-for <tag>) annotations)
         (#;Some actor-name)
         (wrap actor-name)

         _
         (macro;fail (format "Definition is not " <desc> ".")))))]

  [with-actor   resolve-actor   #;;actor   "an actor"]
  [with-message resolve-message #;;message "a message"]
  )

(def: actor-decl^
  (Syntax [Text (List Text)])
  (p;either (s;form (p;seq s;local-symbol (p;some s;local-symbol)))
            (p;seq s;local-symbol (:: p;Monad<Parser> wrap (list)))))

(do-template [<name> <desc>]
  [(def: <name>
     (-> Text Text)
     (|>. (format <desc> "@")))]

  [state-name    "State"]
  [behavior-name "Behavior"]
  [new-name      "new"]
  )

(type: HandleC
  [[Text Text Text] Code])

(type: StopC
  [[Text Text] Code])

(type: BehaviorC
  [(Maybe HandleC) (Maybe StopC)])

(def: behavior^
  (s;Syntax BehaviorC)
  (let [handle-args ($_ p;seq s;local-symbol s;local-symbol s;local-symbol)
        stop-args ($_ p;seq s;local-symbol s;local-symbol)]
    (p;seq (p;opt (s;form (p;seq (s;form (p;after (s;this (' handle)) handle-args))
                                 s;any)))
           (p;opt (s;form (p;seq (s;form (p;after (s;this (' stop)) stop-args))
                                 s;any))))))

(syntax: #export (actor: [export csr;export]
                   [[_name _vars] actor-decl^]
                   [annotations (p;default cs;empty-annotations csr;annotations)]
                   state-type
                   [[?handle ?stop] behavior^])
  {#;doc (doc "Defines an actor, with its behavior and internal state."
              (actor: #export Counter
                Nat
                
                ((stop cause state)
                 (:: P;Monad<Promise> wrap
                     (log! (if (ex;match? ;;Killed cause)
                             (format "Counter was killed: " (%n state))
                             cause)))))

              (actor: #export (Stack a)
                (List a)
                
                ((handle message state self)
                 (do T;Monad<Task>
                   [#let [_ (log! "BEFORE")]
                    output (message state self)
                    #let [_ (log! "AFTER")]]
                   (wrap output)))))}
  (with-gensyms [g!message g!self g!state g!init g!error g!return g!output]
    (do @
      [module macro;current-module-name
       #let [g!type (code;local-symbol (state-name _name))
             g!behavior (code;local-symbol (behavior-name _name))
             g!actor (code;local-symbol _name)
             g!new (code;local-symbol (new-name _name))
             g!vars (L/map code;local-symbol _vars)]]
      (wrap (list (` (type: (~@ (csw;export export)) ((~ g!type) (~@ g!vars))
                       (~ state-type)))
                  (` (type: (~@ (csw;export export)) ((~ g!actor) (~@ g!vars))
                       (~ (|> annotations
                              (with-actor [module _name])
                              csw;annotations))
                       (;;Actor ((~ g!type) (~@ g!vars)))))
                  (` (def: (~@ (csw;export export)) (~ g!behavior)
                       (All [(~@ g!vars)]
                         (;;Behavior ((~ g!type) (~@ g!vars))))
                       {#;;handle (~ (case ?handle
                                       #;None
                                       (` ;;default-handle)

                                       (#;Some [[messageN stateN selfN] bodyC])
                                       (` (function [(~ (code;local-symbol messageN))
                                                     (~ (code;local-symbol stateN))
                                                     (~ (code;local-symbol selfN))]
                                            (do T;Monad<Task>
                                              []
                                              (~ bodyC))))))
                        #;;end (~ (case ?stop
                                    #;None
                                    (` ;;default-handle)

                                    (#;Some [[causeN stateN] bodyC])
                                    (` (function [(~ (code;local-symbol causeN))
                                                  (~ (code;local-symbol stateN))]
                                         (do P;Monad<Promise>
                                           []
                                           (~ bodyC))))))}))
                  (` (def: (~@ (csw;export export)) ((~ g!new) (~ g!init))
                       (All [(~@ g!vars)]
                         (-> ((~ g!type) (~@ g!vars)) (io;IO ((~ g!actor) (~@ g!vars)))))
                       (;;spawn (~ g!behavior) (~ g!init))))))
      )))

(type: Signature
  {#vars (List Text)
   #name Text
   #inputs (List [Text Code])
   #state Text
   #self Text
   #output Code})

(def: signature^
  (s;Syntax Signature)
  (s;form ($_ p;seq
              (p;default (list) (s;tuple (p;some s;local-symbol)))
              s;local-symbol
              (p;some csr;typed-input)
              s;local-symbol
              s;local-symbol
              s;any)))

(def: reference^
  (s;Syntax [Ident (List Text)])
  (p;either (s;form (p;seq s;symbol (p;some s;local-symbol)))
            (p;seq s;symbol (:: p;Monad<Parser> wrap (list)))))

(syntax: #export (message: [export csr;export] [[actor-name actor-vars] reference^]
                   [signature signature^]
                   [annotations (p;default cs;empty-annotations csr;annotations)]
                   body)
  {#;doc (doc "A message can access the actor's state through the state parameter."
              "A message can also access the actor itself through the self parameter."
              "A message's output must be a task containing a 2-tuple with the updated state and a return value."
              "A message may succeed or fail (in case of failure, the actor dies)."

              (message: #export Counter
                (count! [increment Nat] state self Nat)
                (let [state' (n.+ increment state)]
                  (T;return [state' state'])))

              (message: #export (Stack a)
                (push [value a] state self (List a))
                (let [state' (#;Cons value state)]
                  (T;return [state' state']))))}
  (with-gensyms [g!return g!error g!task]
    (do @
      [actor-name (resolve-actor actor-name)
       #let [g!type (code;symbol (product;both id state-name actor-name))
             g!message (code;local-symbol (get@ #name signature))
             g!refs (: (List Code)
                       (if (list;empty? actor-vars)
                         (list)
                         (|> actor-vars list;size n.dec
                             (list;n.range +0) (L/map (|>. code;nat (~) ($) (`))))))
             g!actor (code;symbol actor-name)
             g!tvars (|> (get@ #vars signature) (L/append actor-vars) (L/map code;local-symbol))
             g!inputsC (|> (get@ #inputs signature) (L/map (|>. product;left code;local-symbol)))
             g!inputsT (|> (get@ #inputs signature) (L/map product;right))
             g!outputT (get@ #output signature)
             g!state (|> signature (get@ #state) code;local-symbol)
             g!self (|> signature (get@ #self) code;local-symbol)]]
      (wrap (list (` (def: (~@ (csw;export export)) ((~ g!message) (~@ g!inputsC) (~ g!self))
                       (~ (|> annotations
                              (with-message actor-name)
                              csw;annotations))
                       (All [(~@ g!tvars)] (-> (~@ g!inputsT) (~ g!actor) (T;Task (~ g!outputT))))
                       (let [(~ g!task) (T;task (~ g!outputT))]
                         (exec (;;send (function [(~ g!state) (~ g!self)]
                                         (do P;Monad<Promise>
                                           [(~ g!return) (: (T;Task [((~ g!type) (~@ g!refs))
                                                                     (~ g!outputT)])
                                                            (~ body))]
                                           (case (~ g!return)
                                             (#;Right [(~ g!state) (~ g!return)])
                                             (exec (io;run (P;resolve (#;Right (~ g!return)) (~ g!task)))
                                               (T;return (~ g!state)))
                                             
                                             (#;Left (~ g!error))
                                             (exec (io;run (P;resolve (#;Left (~ g!error)) (~ g!task)))
                                               (T;fail (~ g!error))))
                                           ))
                                       (~ g!self))
                           (~ g!task)))))
                  ))
      )))