Safe Haskell	Safe-Inferred
Language	GHC2021

Butler.Core

Contents

Boot
Memory api
Processor api
Log api
Clock api
IPC api
Helpers
Re-exports

Synopsis

data OS = OS {
- processor :: Processor
- storage :: Storage
- clock :: Clock
- logger :: Logger SystemEvent
- buzzer :: Buzzer
}
spawnInitProcess :: RawFilePath -> ProcessIO a -> IO ExitReason
withButlerOS :: ProcessIO a -> IO ExitReason
data ProcessEnv = ProcessEnv {
- os :: OS
- process :: Process
}
data ProcessIO a
runProcessIO :: OS -> Process -> ProcessIO a -> IO a
getSelfProcess :: ProcessIO Process
asProcess :: ProcessEnv -> ProcessIO a -> ProcessIO a
runExternalProcess :: Text -> ProcessConfig stdin stdout0 stderr0 -> ProcessIO ()
getPath :: StorageAddress -> ProcessIO RawFilePath
newProcessMemory :: Serialise a => StorageAddress -> ProcessIO a -> ProcessIO (a, MemoryVar a)
chroot :: StorageAddress -> ProcessIO a -> ProcessIO a
spawnProcess :: ProgramName -> ProcessIO () -> ProcessIO Process
superviseProcess :: ProgramName -> ProcessIO Void -> ProcessIO Process
stopProcess :: Process -> STM Bool
killProcess :: Pid -> ProcessIO Bool
spawnThread_ :: ProcessIO Void -> ProcessIO ()
spawnThread :: ProcessIO a -> ProcessIO (Thread a)
logSystem :: EventSeverity -> SystemEvent -> ProcessIO ()
logDebug :: HasCallStack => Text -> [Pair] -> ProcessIO ()
logInfo :: HasCallStack => Text -> [Pair] -> ProcessIO ()
logError :: HasCallStack => Text -> [Pair] -> ProcessIO ()
getTime :: ProcessIO Time
writePipe :: HasCallStack => Pipe a -> a -> ProcessIO ()
waitProcess :: MonadIO m => Process -> m ExitReason
newtype ProgramName = ProgramName Text
data Process = Process {
- pid :: Pid
- childs :: TVar [Process]
- scope :: Scope
- threadId :: ThreadId
- thread :: Thread ExitReason
- doneVar :: TMVar ()
- status :: TVar ProcessStatus
- program :: ProgramName
- createdAt :: Time
}
newtype ProcessAction = ProcessAction (Process -> IO ())
data SystemEvent
- = ProcessCreated Process
- | ProcessStopped Process ExitReason
- | ProcessMessage ByteString Process Text
- | StorageSync Int
- | SystemReady
- | SystemCompleted
- | DaemonCrashed Process Int

Boot

data OS #

Constructors

OS
Fields processor :: Processor storage :: Storage clock :: Clock logger :: Logger SystemEvent buzzer :: Buzzer

Instances

Instances details

Generic OS #
Instance details Defined in Butler.Core Associated Types type Rep OS :: Type -> Type # Methods from :: OS -> Rep OS x # to :: Rep OS x -> OS #
type Rep OS #
Instance details Defined in Butler.Core type Rep OS = D1 ('MetaData "OS" "Butler.Core" "butler-0.0.1.0-inplace" 'False) (C1 ('MetaCons "OS" 'PrefixI 'True) ((S1 ('MetaSel ('Just "processor") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Processor) :: S1 ('MetaSel ('Just "storage") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Storage)) :: (S1 ('MetaSel ('Just "clock") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Clock) :: (S1 ('MetaSel ('Just "logger") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Logger SystemEvent)) :: S1 ('MetaSel ('Just "buzzer") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Buzzer)))))

spawnInitProcess :: RawFilePath -> ProcessIO a -> IO ExitReason #

Run the initial process with a given storage root directory.

withButlerOS :: ProcessIO a -> IO ExitReason #

data ProcessEnv #

Constructors

ProcessEnv
Fields os :: OS process :: Process

Instances

Instances details

Generic ProcessEnv #
Instance details Defined in Butler.Core Associated Types type Rep ProcessEnv :: Type -> Type # Methods from :: ProcessEnv -> Rep ProcessEnv x # to :: Rep ProcessEnv x -> ProcessEnv #
MonadReader ProcessEnv ProcessIO #
Instance details Defined in Butler.Core Methods ask :: ProcessIO ProcessEnv # local :: (ProcessEnv -> ProcessEnv) -> ProcessIO a -> ProcessIO a # reader :: (ProcessEnv -> a) -> ProcessIO a #
type Rep ProcessEnv #
Instance details Defined in Butler.Core type Rep ProcessEnv = D1 ('MetaData "ProcessEnv" "Butler.Core" "butler-0.0.1.0-inplace" 'False) (C1 ('MetaCons "ProcessEnv" 'PrefixI 'True) (S1 ('MetaSel ('Just "os") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 OS) :*: S1 ('MetaSel ('Just "process") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Process)))

data ProcessIO a #

Instances

Instances details

MonadFail ProcessIO #
Instance details Defined in Butler.Core Methods fail :: String -> ProcessIO a #
MonadIO ProcessIO #
Instance details Defined in Butler.Core Methods liftIO :: IO a -> ProcessIO a #
Applicative ProcessIO #
Instance details Defined in Butler.Core Methods pure :: a -> ProcessIO a # (<>) :: ProcessIO (a -> b) -> ProcessIO a -> ProcessIO b # liftA2 :: (a -> b -> c) -> ProcessIO a -> ProcessIO b -> ProcessIO c # (>) :: ProcessIO a -> ProcessIO b -> ProcessIO b # (<*) :: ProcessIO a -> ProcessIO b -> ProcessIO a #
Functor ProcessIO #
Instance details Defined in Butler.Core Methods fmap :: (a -> b) -> ProcessIO a -> ProcessIO b # (<$) :: a -> ProcessIO b -> ProcessIO a #
Monad ProcessIO #
Instance details Defined in Butler.Core Methods (>>=) :: ProcessIO a -> (a -> ProcessIO b) -> ProcessIO b # (>>) :: ProcessIO a -> ProcessIO b -> ProcessIO b # return :: a -> ProcessIO a #
MonadUnliftIO ProcessIO #
Instance details Defined in Butler.Core Methods withRunInIO :: ((forall a. ProcessIO a -> IO a) -> IO b) -> ProcessIO b #
MonadReader ProcessEnv ProcessIO #
Instance details Defined in Butler.Core Methods ask :: ProcessIO ProcessEnv # local :: (ProcessEnv -> ProcessEnv) -> ProcessIO a -> ProcessIO a # reader :: (ProcessEnv -> a) -> ProcessIO a #

runProcessIO :: OS -> Process -> ProcessIO a -> IO a #

getSelfProcess :: ProcessIO Process #

asProcess :: ProcessEnv -> ProcessIO a -> ProcessIO a #

runExternalProcess :: Text -> ProcessConfig stdin stdout0 stderr0 -> ProcessIO () #

Memory api

getPath :: StorageAddress -> ProcessIO RawFilePath #

newProcessMemory :: Serialise a => StorageAddress -> ProcessIO a -> ProcessIO (a, MemoryVar a) #

chroot :: StorageAddress -> ProcessIO a -> ProcessIO a #

Change the root storage directory of a process.

Processor api

spawnProcess :: ProgramName -> ProcessIO () -> ProcessIO Process #

Create a process.

superviseProcess :: ProgramName -> ProcessIO Void -> ProcessIO Process #

stopProcess :: Process -> STM Bool #

Stop a process, returns False if the process did not received the message.

killProcess :: Pid -> ProcessIO Bool #

Lookup and kill the pid. Use stopProcess instead.

spawnThread_ :: ProcessIO Void -> ProcessIO () #

Create a child thread that never exit, for example to handle messages. If the thread crash, the whole process is terminated.

spawnThread :: ProcessIO a -> ProcessIO (Thread a) #

Create a child thread.

Log api

logSystem :: EventSeverity -> SystemEvent -> ProcessIO () #

logDebug :: HasCallStack => Text -> [Pair] -> ProcessIO () #

Use logDebug for the rest.

logInfo :: HasCallStack => Text -> [Pair] -> ProcessIO () #

Use logInfo for nominal but important event.

logError :: HasCallStack => Text -> [Pair] -> ProcessIO () #

Use logError for unexpected mal-functions.

Clock api

getTime :: ProcessIO Time #

IPC api

writePipe :: HasCallStack => Pipe a -> a -> ProcessIO () #

Helpers

waitProcess :: MonadIO m => Process -> m ExitReason #

Re-exports

newtype ProgramName #

Constructors

ProgramName Text

Instances

Instances details

FromJSON ProgramName #
Instance details Defined in Butler.Core.Process Methods parseJSON :: Value -> Parser ProgramName # parseJSONList :: Value -> Parser [ProgramName] #
ToJSON ProgramName #
Instance details Defined in Butler.Core.Process Methods toJSON :: ProgramName -> Value # toEncoding :: ProgramName -> Encoding # toJSONList :: [ProgramName] -> Value # toEncodingList :: [ProgramName] -> Encoding #
IsString ProgramName #
Instance details Defined in Butler.Core.Process Methods fromString :: String -> ProgramName #
Semigroup ProgramName #
Instance details Defined in Butler.Core.Process Methods (<>) :: ProgramName -> ProgramName -> ProgramName # sconcat :: NonEmpty ProgramName -> ProgramName # stimes :: Integral b => b -> ProgramName -> ProgramName #
Generic ProgramName #
Instance details Defined in Butler.Core.Process Associated Types type Rep ProgramName :: Type -> Type # Methods from :: ProgramName -> Rep ProgramName x # to :: Rep ProgramName x -> ProgramName #
Show ProgramName #
Instance details Defined in Butler.Core.Process Methods showsPrec :: Int -> ProgramName -> ShowS # show :: ProgramName -> String # showList :: [ProgramName] -> ShowS #
Eq ProgramName #
Instance details Defined in Butler.Core.Process Methods (==) :: ProgramName -> ProgramName -> Bool # (/=) :: ProgramName -> ProgramName -> Bool #
Ord ProgramName #
Instance details Defined in Butler.Core.Process Methods compare :: ProgramName -> ProgramName -> Ordering # (<) :: ProgramName -> ProgramName -> Bool # (<=) :: ProgramName -> ProgramName -> Bool # (>) :: ProgramName -> ProgramName -> Bool # (>=) :: ProgramName -> ProgramName -> Bool # max :: ProgramName -> ProgramName -> ProgramName # min :: ProgramName -> ProgramName -> ProgramName #
ToHtml ProgramName #
Instance details Defined in Butler.Core.Process Methods toHtml :: forall (m :: Type -> Type). Monad m => ProgramName -> HtmlT m () # toHtmlRaw :: forall (m :: Type -> Type). Monad m => ProgramName -> HtmlT m () #
Serialise ProgramName #
Instance details Defined in Butler.Core.Process Methods encode :: ProgramName -> Encoding # decode :: Decoder s ProgramName # encodeList :: [ProgramName] -> Encoding # decodeList :: Decoder s [ProgramName] #
From ProgramName Text #
Instance details Defined in Butler.Core.Process Methods from :: ProgramName -> Text #
From Text ProgramName #
Instance details Defined in Butler.Core.Process Methods from :: Text -> ProgramName #
From Natural ProgramName #
Instance details Defined in Butler.Core.Process Methods from :: Natural -> ProgramName #
type Rep ProgramName #
Instance details Defined in Butler.Core.Process type Rep ProgramName = D1 ('MetaData "ProgramName" "Butler.Core.Process" "butler-0.0.1.0-inplace" 'True) (C1 ('MetaCons "ProgramName" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

data Process #

A process is a killable thread.

Constructors

Process
Fields pid :: Pid the process id childs :: TVar [Process] the list of sub process scope :: Scope the processor scope threadId :: ThreadId the haskell rts id thread :: Thread ExitReason the ki thread reference doneVar :: TMVar () a sync var to terminate the process ki scope status :: TVar ProcessStatus the process status program :: ProgramName createdAt :: Time

Instances

Instances details

ToJSON Process #
Instance details Defined in Butler.Core.Process Methods toJSON :: Process -> Value # toEncoding :: Process -> Encoding # toJSONList :: [Process] -> Value # toEncodingList :: [Process] -> Encoding #
Show Process #
Instance details Defined in Butler.Core.Process Methods showsPrec :: Int -> Process -> ShowS # show :: Process -> String # showList :: [Process] -> ShowS #

newtype ProcessAction #

Constructors

ProcessAction (Process -> IO ())

data SystemEvent #

Constructors

ProcessCreated Process
ProcessStopped Process ExitReason
ProcessMessage ByteString Process Text
StorageSync Int
SystemReady
SystemCompleted
DaemonCrashed Process Int

Instances

Instances details

Show SystemEvent #
Instance details Defined in Butler.Core.Events Methods showsPrec :: Int -> SystemEvent -> ShowS # show :: SystemEvent -> String # showList :: [SystemEvent] -> ShowS #
From SystemEvent Text #
Instance details Defined in Butler.Core.Events Methods from :: SystemEvent -> Text #