SoOSiM

Basic API

createComponent

Arguments

:: (ComponentInterface iface, Typeable (Receive iface))

=> iface

Component Interface

-> Sim ComponentId

ComponentId of the created component

Create a new component

invoke

Arguments

:: (ComponentInterface iface, Typeable (Receive iface), Typeable (Send iface))

=> iface

Interface type

-> ComponentId

ComponentId of callee

-> Receive iface

Argument

-> Sim (Send iface)

Response from callee

Synchronously invoke another component

invokeAsync

Arguments

:: (ComponentInterface iface, Typeable (Receive iface), Typeable (Send iface))

=> iface

Interface type

-> ComponentId

ComponentId of callee

-> Receive iface

Argument

-> (Send iface -> Sim ())

Response Handler

-> Sim ()

Call returns immediately

Invoke another component, handle response asynchronously

respond

Arguments

:: (ComponentInterface iface, Typeable (Send iface))

=> iface

Interface type

-> ReturnAddress

Return address to send response to

-> Send iface

Value to send as response

-> Sim ()

Call returns immediately

Respond to an invocation

yield :: a -> Sim a

Yield internal state to the simulator scheduler

readMemory

Arguments

:: Int

Address to read

-> Sim Dynamic

Read memory of local node

writeMemory

Arguments

:: Typeable a

=> Int

Address to write

-> a

Value to write

-> Sim ()

Write memory of local node

componentLookup

Arguments

:: ComponentInterface iface

=> iface

Interface type of the component you are looking for

-> Sim (Maybe ComponentId)

Just ComponentID if a component is found, Nothing otherwise

Get the unique ComponentId of a component implementing an interface

traceMsg :: String -> Sim ()

createNode

Arguments

:: Sim NodeId

NodeId of the created node

Create a new node

Advanced API

runSTM :: STM a -> Sim a

getComponentId :: Sim ComponentId

Get the component id of your component

getNodeId :: Sim NodeId

Get the node id of of the node your component is currently running on

componentCreator :: Sim ComponentId

Return the ComponentId of the component that created the current component

Specialized API

createComponentN

Arguments

:: (ComponentInterface iface, Typeable (Receive iface))

=> iface

Component Interface

-> NodeId

-> Sim ComponentId

Create a new component

createComponentNP

Arguments

:: (ComponentInterface iface, Typeable (Receive iface))

=> NodeId

Node to create component on, leave to Nothing to create on current node

-> ComponentId

ComponentId to set as parent, set to Nothing to use own ComponentId

-> iface

Component Interface

-> Sim ComponentId

ComponentId of the created component

Create a new component

invokeS

Arguments

:: forall iface . (ComponentInterface iface, Typeable (Receive iface), Typeable (Send iface))

=> iface

Interface type

-> Maybe ComponentId

Caller, leave Nothing to set to current module

-> ComponentId

Callee

-> Receive iface

Argument

-> Sim (Send iface)

Response from recipient

Synchronously invoke another component

invokeAsyncS

Arguments

:: forall iface . (ComponentInterface iface, Typeable (Receive iface), Typeable (Send iface))

=> iface

Interface type

-> Maybe ComponentId

Parent of handler, leave Nothing to set to the current module

-> ComponentId

Callee

-> Receive iface

Argument

-> (Send iface -> Sim ())

Handler

-> Sim ()

Call returns immediately

Invoke another component, handle response asynchronously

respondS

Arguments

:: forall iface . (ComponentInterface iface, Typeable (Send iface))

=> iface

Interface type

-> Maybe ComponentId

Callee Id, leave Nothing to set to current module

-> ReturnAddress

Return address

-> Send iface

Value to send as response

-> Sim ()

Call returns immediately

Respond to an invocation

readMemoryN

Arguments

:: Maybe NodeId

Node you want to look on, leave Nothing to set to current node

-> Int

Address to read

-> Sim Dynamic

Read memory of local node

writeMemoryN

Arguments

:: Typeable a

=> Maybe NodeId

Node you want to write on, leave Nothing to set to current node

-> Int

Address to write

-> a

Value to write

-> Sim ()

Write memory of local node

SoOSiM API Types

class ComponentInterface s where

Type class that defines an OS component

Associated Types

type Send s

Type of messages send by the component

type Receive s

Type of messages received by the component

type State s

Type of internal state of the component

Methods

initState :: s -> State s

The minimal internal state of your component

componentName :: s -> ComponentName

A function returning the unique global name of your component

componentBehaviour :: s -> State s -> Input (Receive s) -> Sim (State s)

The function defining the behaviour of your component

Instances

ComponentInterface HandlerStub

data Input a

Events send to components by the simulator

Constructors

Message a ReturnAddress

A message send another component: the field argument is the ComponentId of the sender, the second field the message content

Tick

Event send every simulation round

Instances

Show (Input a)

data Sim a

The simulator monad used by the OS components offers resumable computations in the form of coroutines. These resumable computations expect a value of type Dynamic, and return a value of type a.

We need resumable computations to simulate synchronous messaging between two components. When a component synchronously sends a message to another component, we store the rest of the computation as part of the execution context in the simulator state. When a message is send back, the stored computation will continue with the message content (of type Dynamic).

To suspend a computation you simply do: 'request componentId'

Where the componentId is the ID of the OS component you are expecting a message from. The execute a resumeable computation you simply do: 'resume comp'

Instances

Monad Sim

Functor Sim

MonadUnique Sim

MonadState SimState Sim

type ComponentId = Unique

type ComponentName = String

type NodeId = Unique

Imported Types

class Typeable a

The class Typeable allows a concrete representation of a type to be calculated.

Instances

Typeable Bool

Typeable Char

Typeable Double

Typeable Float

Typeable Int

Typeable Int8

Typeable Int16

Typeable Int32

Typeable Int64

Typeable Integer

Typeable Ordering

Typeable RealWorld

Typeable Word

Typeable Word8

Typeable Word16

Typeable Word32

Typeable Word64

Typeable ()

Typeable ThreadId

Typeable Dynamic

Typeable TypeRep

Typeable TyCon

(Typeable1 s, Typeable a) => Typeable (s a)

One Typeable instance for all Typeable1 instances

data Dynamic

A value of type Dynamic is an object encapsulated together with its type.

A Dynamic may only represent a monomorphic value; an attempt to create a value of type Dynamic from a polymorphically-typed expression will result in an ambiguity error (see toDyn).

Showing a value of type Dynamic returns a pretty-printed representation of the object's type; useful for debugging.

Instances

Show Dynamic

Typeable Dynamic

Exception Dynamic

Progress The Simulator

tick :: SimState -> IO SimState

Utility Functions

ignore :: a -> Sim ()

unmarshall :: forall a. Typeable a => String -> Dynamic -> a

returnAddress :: ReturnAddress -> ComponentId