[Indigo]<Voice>Thrush>LarkSmartsSupImpl.mesa!6

LarkSmartsSupImpl.mesa

Last modified by D. Swinehart, May 15, 1984 10:13:55 am PDT

DIRECTORY

IO,

Lark,

LarkSmartsMonitorImpl,

Nice,

Process USING [ Detach, SetTimeout, SecondsToTicks ],

Rope USING [ Concat ],

Log USING [ Problem, Report, SLOG ],

ThParty USING [ Advance, Alert, ReleaseTrunkParty ],

ThPartyPrivate USING [ DehandleSmarts, GetCurrentParty, SmartsBody, SmartsData ],

Thrush USING [
CallUrgency, ConvEvent, ConversationHandle, Disposition, H, IntervalSpec, PartyHandle, NB, nullConvHandle, nullHandle, pERROR, Reason, ROPE, SmartsHandle, StateID, StateInConv, ThHandle ],

ThSmartsPrivate USING [

ConvDesc, ConvDescBody, Deregister, EnterLarkState, LarkFailed, LarkState, OpenConversations, ParseState, SmartsInfo, SmartsInfoBody ],

Triples USING [ Select ],

;

LarkSmartsSupImpl: CEDAR MONITOR LOCKS root

IMPORTS IO,

Process,

root: LarkSmartsMonitorImpl,

Log,

Nice,

Rope,

ThParty,

ThPartyPrivate,

Thrush,

ThSmartsPrivate,

Triples,

EXPORTS ThSmartsPrivate

SHARES LarkSmartsMonitorImpl = {

OPEN IO;

Copies

CallUrgency: TYPE = Thrush.CallUrgency;

CommandEvents: TYPE = Lark.CommandEvents;

ConversationHandle: TYPE = Thrush.ConversationHandle;

nullConvHandle: ConversationHandle=Thrush.nullConvHandle;

ConvDesc: TYPE = ThSmartsPrivate.ConvDesc;

ConvEvent: TYPE = Thrush.ConvEvent;

disabled: Lark.Event = Lark.disabled;

enabled: Lark.Event = Lark.enabled;

endNum: Lark.Event = Lark.endNum;

H: PROC[r: REF] RETURNS[Thrush.ThHandle] = INLINE {RETURN[Thrush.H[r]]; };

IntervalSpec: TYPE = Thrush.IntervalSpec;

LarkState: TYPE = ThSmartsPrivate.LarkState;

NB: TYPE = Thrush.NB;

nullHandle: Thrush.ThHandle = Thrush.nullHandle;

OpenConversations: TYPE = ThSmartsPrivate.OpenConversations;

PartyHandle: TYPE = Thrush.PartyHandle;

Reason: TYPE = Thrush.Reason;

ROPE: TYPE = Thrush.ROPE;

SHHH: TYPE = Lark.SHHH; -- Encrypts conv. if first arg to RPC PROC

SmartsHandle: TYPE = Thrush.SmartsHandle;

SmartsInfo: TYPE = ThSmartsPrivate.SmartsInfo;

SmartsInfoBody: TYPE = ThSmartsPrivate.SmartsInfoBody;

StateInConv: TYPE = Thrush.StateInConv;

StatusEvents: TYPE = Lark.StatusEvents;

Ctr: TYPE = RECORD[

count: INT,

stop: INT

];

PD: TYPE = RECORD [

defaultRecordLength: INT ← -1,

timeoutNoAction: INTEGER ← 5,

cPr: REF Ctr←NEW[Ctr←[0,1000000]],

cSp: REF Ctr←NEW[Ctr←[0,1000000]],

cRs: REF Ctr←NEW[Ctr←[0,1000000]],

cZp: REF Ctr←NEW[Ctr←[0,1000000]],

cNw: REF Ctr←NEW[Ctr←[0,1000000]],

doReports: BOOL←FALSE,

doNice: BOOL←FALSE

];

pd: REF PD ← NEW[PD←[]];

Report: PROC[what: ROPE, info: SmartsInfo, ctr: REF Ctr] = {

IF NOT pd.doReports THEN RETURN;

Log.Report[what, $Lark, info.larkInfo];

ctr.count𡤌tr.count+1;

IF ctr.count>ctr.stop THEN { Log.Problem["Report overflow", $Lark, info.larkInfo]; };

};

BeNice: PROC[r: REF, d: INT, info: SmartsInfo] = {

IF NOT pd.doNice THEN RETURN;

Nice.BeNice[r, d, $Lark, info.larkInfo];

};

Party-invoked actions

LarkProgress: PUBLIC ENTRY PROC[

shh: SHHH,

smartsID: Thrush.SmartsHandle,

event: Thrush.ConvEvent,

yourParty: BOOL,

latestEvent: BOOL,

informationOnly: BOOL

] RETURNS [ d: Thrush.Disposition ] = {

info: SmartsInfo ← GetSmartsInfo[smartsID: smartsID];

cDesc: ThSmartsPrivate.ConvDesc;

IF info=NIL THEN RETURN[pass];

d�tedAndStop;

Update local state information

Log.SLOG[];

IF pd.doReports THEN Report[

Rope.Concat[

IO.PutFR["---- LkProg: %t(%d) %g %g yr=%g ",

time[event.credentials.convID], int[event.credentials.stateID],

refAny[NEW[StateInConv𡤎vent.state]], TU.RefAddr[info], bool[yourParty]],

IO.PutFR["lt=%g in=%g, ky=%g\n",

bool[latestEvent], bool[event.intervalSpec#NIL], bool[event.keyTable#NIL]]],

info, pd.cPr];

cDesc ← GetConv[info, event.credentials.convID, FALSE];

IF event.credentials.stateID <= cDesc.cState.credentials.stateID THEN RETURN[pass]; -- Old news!

Fields always extracted

cDesc.cState.credentials.smartsID ← smartsID;

cDesc.cState.credentials.stateID ← event.credentials.stateID;

<<Need to check for increasing stateID here, and reject old ones? If so, enable

test in alrt case below.>>

Extracted if present

IF event.keyTable#NIL THEN {

cDesc.cState.keyTable ← event.keyTable; cDesc.newKeys←TRUE; };

IF event.intervalSpec#NIL AND event.intervalSpec.type=finished THEN

May accept more later.

EnqueueInterval[cDesc, event.intervalSpec];

IF event.address#NIL THEN { cDesc.cState.address𡤎vent.address; cDesc.newAddress←TRUE; };

Extracted if the event changes our state.

IF yourParty THEN {

cDesc.descValid ← TRUE;

cDesc.cState.credentials.partyID ← event.credentials.partyID;

cDesc.cState.state ← event.state;

cDesc.cState.comment ← event.comment;

cDesc.cState.reason ← event.reason;

<< When Conferencing is added, put this back in.>>

cDesc.cState.conferenceHost ← event.conferenceHost;

IF event.spec#NIL THEN { cDesc.cState.spec ← event.spec; cDesc.newSpec←TRUE; };

Extracted if non-standard?

IF event.comment#NIL THEN cDesc.cState.comment ← event.comment;

IF event.urgency#normal THEN cDesc.cState.urgency ← event.urgency;

IF event.alertKind#standard THEN cDesc.cState.alertKind ← event.alertKind;

SELECT event.state FROM

reserved, parsing, initiating, maybe => cDesc.originator ← us;

pending, ringing => cDesc.originator ← them;

ENDCASE;

};

BeNice[event, 4, info];

BeNice[cDesc, 6, info];

cDesc.newEvent ← TRUE;

IF latestEvent THEN Apprise[info]; -- Wait for the last report to wake process.

};

Th(e) Process

LarkSupervise: PUBLIC ENTRY PROC[info: SmartsInfo ] = {

TRUSTED {

Process.SetTimeout[@info.thAction, Process.SecondsToTicks[pd.timeoutNoAction]]; };

IF info.apprise THEN DO

ENABLE {

UNWIND => NULL;

ThSmartsPrivate.LarkFailed => GOTO Failing;

ANY => { Log.Problem[NIL, $Smarts, info]; GOTO Failing; };

};

prevL: OpenConversations ← NIL;

nb: NB←success;

convL: OpenConversations;

trans: Transition;

info.apprise ← FALSE;

FOR convL ← info.conversations,

convL.rest WHILE convL#NIL DO

cDesc: ConvDesc = convL.first;

stateNow: StateInConv = cDesc.cState.state;

ours: BOOL ← ( cDesc.cState.credentials.convID = info.currentConvID );

Log.SLOG[];

IF pd.doReports THEN Report[

Rope.Concat[

IO.PutFR["**** LkSup: %t(%d) %g %g->%g",

time[cDesc.cState.credentials.convID], int[cDesc.cState.credentials.stateID],

TU.RefAddr[info], refAny[NEW[StateInConv←stateNow]], refAny[NEW[StateInConv�sc.desiredState]]],

IO.PutFR[" %g%g\n",

refAny[NEW[Transition←transForStates[stateNow][cDesc.desiredState]]],

rope[IF ours THEN " (ours)" ELSE ""]]],

info, pd.cSp];

BeNice[cDesc, 6, info];

IF NOT cDesc.descValid THEN LOOP;

IF info.currentConvID = nullConvHandle AND stateNow#idle THEN {

<<This stuff feels like it's in the wrong place. Will feel more so when multi-calls
are dealt with. >>

ours←TRUE; info.currentConvID ← cDesc.cState.credentials.convID;

};

IF stateNow=idle THEN {

Conv. is now idle: forget about it or re-use it, sort of.

Remove dead conversation from list.

IF pd.doReports THEN

Report[IO.PutFR[" ** Zap %t\n", time[cDesc.cState.credentials.convID]], info, pd.cZp];

IF prevL#NIL THEN {

prevL.rest ← convL.rest; convL ← prevL; }

ELSE info.conversations𡤌onvL.rest;

IF ours THEN {

reason: Reason = cDesc.cState.reason;

newConvID: ConversationHandle�sc.cState.credentials.convID;

newDesc: ConvDesc;

info.currentConvID ← nullConvHandle;

SELECT info.larkInfo.hookState FROM

onhook, spkr =>

SELECT reason FROM

terminating, wontSay => GOTO Exit;

ENDCASE => IF cDesc.originator#us THEN GOTO Exit;

ENDCASE =>

SELECT TRUE FROM

reason=terminating, reason=wontSay, cDesc.originator#us => {

Set to look like reserving brand new conversation

newConvID ← nullConvHandle;

info.currentConvID ← nullConvHandle;

};

ENDCASE;

ours←FALSE; -- avoid LarkState transition this time.

newDesc ← GetConv[info, newConvID, TRUE];

ChangeState[info, newDesc, reserved, cDesc.cState.reason, cDesc.cState.comment];

EXITS Exit => NULL;

};

}

ELSE IF NOT ours THEN

Conv isn't the one we're interested in, and doesn't look like it's going idle: idle it.

Should probably consult transForStates for validity.

nb ← ThParty.Advance[

credentials: cDesc.cState.credentials,

state: idle,

reason: busy,

comment: "One conversation at a time, please."

]

ELSE {

State and substate (below) and desired state indicate there's something to do. Do it:

SELECT (trans←transForStates[stateNow][cDesc.desiredState]) FROM

noop => NULL;

elim => Thrush.pERROR; -- handled in stateNow=idle case above.

rsrv, rers, prsg, alrt => { -- placing call, or reserving conversation

convID: ConversationHandle;

calledPartyID: PartyHandle =

IF trans#alrt THEN nullHandle ELSE cDesc.desiredPartyID;

nb ← IF trans=alrt AND calledPartyID=nullHandle

THEN noSuchParty2 ELSE success;

IF NOT ours THEN Log.Problem["What to do in a race?", $Smarts, info];

IF nb=success THEN [nb, convID] ← ThParty.Alert [

credentials: cDesc.cState.credentials,

calledPartyID: calledPartyID,

state: IF trans = alrt THEN initiating ELSE cDesc.desiredState,

reason: cDesc.desiredReason,

newConv: trans=rsrv,

comment: cDesc.desiredComment

];

IF trans=alrt AND nb#stateMismatch AND calledPartyID#nullHandle THEN

ThParty.ReleaseTrunkParty[partyID: cDesc.desiredPartyID];

Will release iff attempt to alert failed to get into conversation.

IF nb=success THEN {

cDesc.cState.credentials.convID ← info.currentConvID ← convID;

ours←TRUE;

};

idle, actv => -- Simple transitions

nb ← ThParty.Advance [

credentials: cDesc.cState.credentials,

state: cDesc.desiredState,

reason: cDesc.desiredReason,

comment: cDesc.desiredComment

];

spvs => { -- Supervision while active.

cDesc.desiredState�tive; -- Reflect reality

IF cDesc.newIntervals#NIL THEN

May do more later

SELECT info.larkInfo.hookState FROM

spkr, spKr => ChangeState[info, cDesc, idle]; ENDCASE;

cDesc.newIntervals ← NIL;

};

EnterLarkState, below, may cause new keys to be distributed.

When voice messages again supported, will need to initiate intervals here.

ring => -- This is how you say you'll ring an incoming call

IF info.larkInfo.hotLine THEN {

info.apprise←TRUE;

cDesc.desiredState ← active;

}

ELSE nb ← ThParty.Advance [

credentials: cDesc.cState.credentials,

state: ringing

];

invl => {

comment: ROPE="Invalid state transition";

Log.Problem[comment, $Smarts, info];

ChangeState[info, cDesc, idle, error, comment];

};

ntiy => {

comment: ROPE= "Unimplemented state transition";

Log.Problem[comment, $Smarts, info];

ChangeState[info, cDesc, idle, error, comment];

};

ENDCASE => Thrush.pERROR;

};

Analyze any results of trying to reach a different state.

IF nb#success THEN

Report[IO.PutFR[" ** Results: nb=%g\n", refAny[NEW[Thrush.NB←nb]]], info, pd.cRs];

SELECT nb FROM

success, stateMismatch => NULL;

noSuchParty2, narcissism => -- Have to get to error tone here. No such party.

ChangeState[info, cDesc, idle, notFound, "Called party not found, or calling self"];

partyNotEnabled => ours←FALSE;

invalidTransition, convNotActive, convStillActive => {

Complain and transition to idle

comment: ROPE="Party-level detected invalid state transition request";

Log.Problem[comment, $Smarts, info];

ChangeState[info, cDesc, idle, error, comment];

};

notInConv, noSuchConv => { -- Complain, zap, go idle and repeat.

comment: ROPE="NotInConv or NoSuchConv";

Log.Problem[comment, $Smarts, info];

IF ours THEN info.currentConvID ← nullConvHandle;

cDesc.cState.credentials.convID ← nullConvHandle;

cDesc.cState.credentials.stateID ← 0;

ChangeState[info, cDesc, idle, error, comment];

};

noSuchParty, noSuchSmarts => { -- Complain, deregister, we gone! Needs tuning.

Log.Problem[

"NoSuchParty or NoSuchSmarts reported, must try to go away", $Smarts, info];

GOTO Failing;

};

ENDCASE => Thrush.pERROR;

Set up switching and tones to match state.

IF ours THEN ThSmartsPrivate.EnterLarkState[

info.larkInfo, LarkStateForState[cDesc, stateNow], info];

prevL ← convL;

ENDLOOP;

IF NOT info.apprise THEN WAIT info.thAction;

IF info.conversations = NIL THEN EXIT;

REPEAT Failing => ThSmartsPrivate.Deregister[info]; -- now Failed

ENDLOOP;

info.thProcess ← NIL;

};

Connection Management Utilities

GetConv: PUBLIC INTERNAL PROC[info: SmartsInfo, convID: ConversationHandle, validIfNew: BOOL

] RETURNS [ cDesc: ConvDesc←NIL ] = --INLINE-- {

FOR convs: OpenConversations ← info.conversations, convs.rest WHILE convs#NIL DO

IF convs.first.cState.credentials.convID = convID THEN RETURN[convs.first];

ENDLOOP;

cDesc ← NEW[ThSmartsPrivate.ConvDescBody←[]];

cDesc.descValid ← validIfNew;

cDesc.cState.state ← any;

cDesc.cState.credentials ← [ convID: convID, smartsID: H[info.smarts],

partyID: ThPartyPrivate.GetCurrentParty[smartsID: H[info.smarts]], stateID: 0 ];

info.conversations ← CONS[cDesc, info.conversations];

IF pd.doReports THEN

Report[IO.PutFR[" ** NewConv %t %g, vl=%g\n", time[convID], TU.RefAddr[info], bool[validIfNew]], info, pd.cNw];

};

ChangeState: PUBLIC INTERNAL PROC[

info: SmartsInfo,

cDesc: ConvDesc,

state: StateInConv ← idle,

reason: Reason ← wontSay,

comment: ROPE←NIL

] = {

IF info=NIL OR cDesc=NIL THEN RETURN;

cDesc.desiredState ← state;

cDesc.desiredReason ← reason;

cDesc.desiredComment ← comment;

Apprise[info];

};

Apprise: PUBLIC INTERNAL PROC[info: SmartsInfo] = TRUSTED --INLINE-- {

IF info.thProcess=NIL THEN

Process.Detach[info.thProcess ← FORK info.Supervise[info]];

info.apprise ← TRUE;

NOTIFY info.thAction;

};

EnqueueInterval: INTERNAL PROC[cDesc: ConvDesc, int: IntervalSpec] = INLINE {

iL: LIST OF IntervalSpec = LIST[int];

IF cDesc.newIntervals#NIL THEN cDesc.iTail.rest ← iL ELSE cDesc.newIntervals ← iL;

cDesc.iTail ← iL;

};

Other Utilities

GetSmartsInfo: PUBLIC PROC[smartsID: SmartsHandle←nullHandle,

smarts: ThPartyPrivate.SmartsData←NIL]

RETURNS [info: SmartsInfo←NIL] = {

r: REF←smarts;

IF smartsID#nullHandle THEN

r←ThPartyPrivate.DehandleSmarts[smartsID];

IF r#NIL THEN RETURN[NARROW[Triples.Select[$SmartsData, r, --info--]]];

};

State Transition Tables

larkStateForState: ARRAY StateInConv OF LarkState ← [

idle, reserved, parsing, initiating, pending, maybe, ringing, canActivate, active,

idle, dialTone, silence, silence, silence, ringBack, ringing, silence, talking,

inActive, any

silence, silence

];

LarkStateForState: INTERNAL PROC[cDesc: ConvDesc, state: StateInConv]

RETURNS [larkState: LarkState] = -- INLINE -- {

SELECT (larkState←larkStateForState[state]) FROM

talking => {

spec: Lark.ConnectionSpec = cDesc.cState.spec;

IF spec=NIL THEN Thrush.pERROR;

IF spec.localSocket.net = spec.remoteSocket.net

AND spec.localSocket.host = spec.remoteSocket.host THEN larkState ← trunkTalking;

};

dialTone => larkState ← SELECT cDesc.cState.reason FROM

busy, notImportantEnough => busyTone,

absent, noCircuits, noParticular, notFound, error => errorTone,

ENDCASE => dialTone;

ENDCASE;

};

Transition: TYPE = {

Just codes to dispatch on in Supervisor; explained there

noop, elim, idle, rsrv, rers, prsg, alrt, ring, actv, spvs, invl, ntiy

};

transForStates: ARRAY StateInConv OF ARRAY StateInConv OF Transition ← [

idle resrv pars init pend mayb ring canAc activ inact any -- desired

[ elim, invl, prsg, invl, invl, invl, invl, invl, elim, elim, elim ], -- idle (current)

[ idle, noop, prsg, invl, invl, invl, invl, invl, alrt, ntiy, invl ], -- reserved

[ idle, rers, noop, invl, invl, invl, invl, invl, alrt, ntiy, invl ], -- parsing

[ idle, noop, invl, invl, invl, invl, invl, invl, noop, ntiy, noop ], -- initiating

[ idle, invl, invl, invl, invl, invl, invl, invl, actv, ntiy, ring ], -- pending

[ idle, noop, invl, invl, invl, invl, invl, invl, noop, ntiy, noop ], -- maybe

[ idle, invl, invl, invl, invl, invl, invl, invl, actv, ntiy, noop ], -- ringing

[ idle, invl, invl, invl, invl, invl, invl, invl, ntiy, ntiy, ntiy ], -- canActivate

[ idle, spvs, invl, invl, invl, invl, invl, invl, spvs, ntiy, spvs ], -- active

[ idle, invl, invl, invl, invl, invl, invl, invl, ntiy, noop, ntiy ], -- inactive

[ noop, rsrv, prsg, invl, invl, invl, invl, invl, alrt, ntiy, invl ] -- any (nonex)

];

NB: examine relationship to validity table in PartyOpsImpl someday.

Debugging nonsense

Nice.View[pd, "Lark PD"];