DIRECTORY
Basics USING [LongNumber],
BufferDefs USING [OisBuffer],
Checksums USING [SetChecksum, TestChecksum],
CommunicationInternal USING [],
CommFlags USING [doDebug, doStats, doStorms],
CommUtilDefs USING [CopyLong],
DriverDefs USING [ChangeNumberOfInputBuffers, DriverXmitStatus, GetDeviceChain, Glitch, MaybeGetFreeOisBuffer, Network, PutOnGlobalDoneQueue, RouterObject, SetOisRouter],
OISCP USING [allHostIDs, CreditReceiveOisBuffer, EnqueueOis, MaybeGetFreeReceiveOisBufferFromPool, unknownNetID, unknownSocketID],
OISCPConstants USING [routingInformationSocket],
OISCPTypes USING [
bytesPerPktHeader, bytesPerPktText, maxBytesPerPkt, OISErrorCode, TransPortControl],
Process USING [Yield],
ProcessorFace USING [GetClockPulses],
Router USING [AddNetwork, FindNetworkAndTransmit, FindDestinationRelativeNetID, ForwardPacket, RemoveNetwork, RoutingInformationPacket, RoutingTableOn, RoutingTableOff, SocketTable, StateChanged, XmitStatus],
SocketInternal USING [SocketHandle],
SpecialCommunication USING [RoutersFunction],
NSAddress USING [broadcastHostNumber, GetProcessorID, HostNumber, NetworkAddress, nullNetworkNumber, NetworkNumber, SocketNumber],
StatsDefs USING [StatIncr];

RouterImpl: MONITOR LOCKS socketRouterLock
IMPORTS BufferDefs, Checksums, CommUtilDefs, DriverDefs, OISCP, Process, ProcessorFace, Router, NSAddress, StatsDefs
EXPORTS BufferDefs, CommunicationInternal, OISCP, Router
SHARES BufferDefs =
BEGIN OPEN DriverDefs, OISCP, OISCPTypes, SocketInternal, StatsDefs;



Network: PUBLIC TYPE = DriverDefs.Network;

primaryMDS: PUBLIC BOOLEAN _ TRUE; -- we are in the primary MDS.
checkIt: PUBLIC BOOLEAN _ TRUE; -- checksums on for everybody
driverLoopback: BOOLEAN _ FALSE; -- loopback in router
stormy: BOOLEAN _ FALSE; -- storms for debugging are not on
routersFunction: PUBLIC SpecialCommunication.RoutersFunction _ vanillaRouting;
myHostID: NSAddress.HostNumber; -- processor ID of this system element

initialSpareSocketID: NSAddress.SocketNumber = [1001];
initialTransportControl: OISCPTypes.TransPortControl =
[trace: FALSE, filler: 0, hopCount: 0];

oiscpRouter: DriverDefs.RouterObject _
[input: LOOPHOLE[ReceivePacket], broadcast: LOOPHOLE[SendBroadcastPacketToCorrectNet],
addNetwork: Router.AddNetwork, removeNetwork: Router.RemoveNetwork,
stateChanged: Router.StateChanged];

lightning: INTEGER _ 30;
bolt: INTEGER _ 10;
socketRouterLock: PUBLIC MONITORLOCK;
spareSocketID: NSAddress.SocketNumber;
socketTable: Router.SocketTable;

IllegalOisPktLength: ERROR = CODE;


AssignOisAddress: PUBLIC ENTRY PROCEDURE
RETURNS [localAddr: NSAddress.NetworkAddress] =
BEGIN
localAddr _ [net: Router.FindDestinationRelativeNetID[NSAddress.nullNetworkNumber],
host: myHostID, socket: spareSocketID];
IF (spareSocketID _ [spareSocketID + 1]) = NSAddress.SocketNumber[0] THEN
spareSocketID _ initialSpareSocketID;
END; -- AssignOisAddress

AssignDestinationRelativeOisAddress: PUBLIC ENTRY PROCEDURE [destNet: NSAddress.NetworkNumber]
RETURNS [localAddr: NSAddress.NetworkAddress] =
BEGIN
localAddr _
[net: Router.FindDestinationRelativeNetID[destNet], host: myHostID,
socket: spareSocketID];
IF (spareSocketID _ [spareSocketID + 1]) = NSAddress.SocketNumber[0] THEN
spareSocketID _ initialSpareSocketID;
END; -- AssignDestinationRelativeOisAddress

AddSocket: PUBLIC ENTRY PROCEDURE [sH: SocketHandle] =
BEGIN

MaybeIncreaseDriversBuffers: PROCEDURE = INLINE
BEGIN
previousSH: SocketHandle _ socketTable.first;
UNTIL previousSH = NIL DO
IF previousSH.pool.total > 0 THEN RETURN;
previousSH _ previousSH.next;
ENDLOOP;
DriverDefs.ChangeNumberOfInputBuffers[TRUE]; -- TRUE => increase
END;

IF sH.pool.total > 0 THEN MaybeIncreaseDriversBuffers[];
sH.next _ socketTable.first;
socketTable.first _ sH;
socketTable.length _ socketTable.length + 1;
END; -- AddSocket

RemoveSocket: PUBLIC ENTRY PROCEDURE [sH: SocketHandle] =
BEGIN

MaybeDecreaseDriversBuffers: PROCEDURE = INLINE
BEGIN
previousSH _ socketTable.first;
UNTIL previousSH = NIL DO
IF previousSH.pool.total > 0 THEN RETURN;
previousSH _ previousSH.next;
ENDLOOP;
DriverDefs.ChangeNumberOfInputBuffers[FALSE]; -- FALSE => decrease
END;

previousSH: SocketHandle;
IF socketTable.first = sH THEN socketTable.first _ sH.next
ELSE
BEGIN
previousSH _ socketTable.first;
UNTIL previousSH = NIL DO
IF previousSH.next = sH THEN BEGIN previousSH.next _ sH.next; EXIT; END;
previousSH _ previousSH.next;
ENDLOOP;
END;
socketTable.length _ socketTable.length - 1;
IF sH.pool.total > 0 THEN MaybeDecreaseDriversBuffers[];
END; -- RemoveSocket

SetOisStormy: PUBLIC PROCEDURE [new: BOOLEAN] = BEGIN stormy _ new; END;

SetOisCheckit: PUBLIC PROCEDURE [new: BOOLEAN] = BEGIN checkIt _ new; END;

SetOisDriverLoopback: PUBLIC PROCEDURE [new: BOOLEAN] =
BEGIN driverLoopback _ new; END; -- SetOisDriverLoopback

FindMyHostID: PUBLIC PROCEDURE RETURNS [NSAddress.HostNumber] =
BEGIN RETURN[myHostID]; END; -- FindMyHostID

GetOisPacketTextLength: PUBLIC PROCEDURE [b: BufferDefs.OisBuffer] RETURNS [CARDINAL] =
BEGIN RETURN[b.ois.pktLength - bytesPerPktHeader]; END;

SetOisPacketTextLength: PUBLIC PROCEDURE [b: BufferDefs.OisBuffer, len: CARDINAL] =
BEGIN
IF len IN [0..bytesPerPktText] THEN
b.ois.pktLength _ len + bytesPerPktHeader
ELSE IF CommFlags.doDebug THEN Glitch[IllegalOisPktLength];
END; -- SetOisPacketTextLength

SetOisPacketLength: PUBLIC PROCEDURE [b: BufferDefs.OisBuffer, len: CARDINAL] =
BEGIN
IF len IN [bytesPerPktHeader..maxBytesPerPkt] THEN b.ois.pktLength _ len
ELSE IF CommFlags.doDebug THEN Glitch[IllegalOisPktLength];
END; -- SetOisPacketLength


SendPacket: PUBLIC PROCEDURE [b: BufferDefs.OisBuffer] =
BEGIN
IF CommFlags.doStorms AND stormy AND PacketHit[] THEN 
BEGIN
DriverDefs.PutOnGlobalDoneQueue[b];
RETURN; -- for debugging only
END;

IF b.ois.destination.host = myHostID AND
NOT driverLoopback THEN
BEGIN
IF NOT DeliveredToLocalSocket[b, TRUE] THEN -- TRUE -> copy this buffer
BEGIN
nullNetwork: Network = NIL; -- because of EXPORTed TYPEs bug
IF CommFlags.doStats THEN StatIncr[statJunkOisForUsNoLocalSocket];
b.network _ nullNetwork; SendErrorPacket[b, noSocketOisErrorCode, 0];
END;
DriverDefs.PutOnGlobalDoneQueue[b];
Process.Yield[];
END
ELSE
BEGIN
b.ois.transCntlAndPktTp.transportControl _ initialTransportControl;
IF checkIt THEN Checksums.SetChecksum[b] ELSE b.ois.checksum _ 177777B;
[] _ Router.FindNetworkAndTransmit[b];
END;
END; -- SendPacket

ReceivePacket: PUBLIC PROCEDURE [b: BufferDefs.OisBuffer] =
BEGIN
badChecksum: BOOLEAN;
incomingNet: Network;
destHost: NSAddress.HostNumber _ b.ois.destination.host;
broadcastPacket: BOOLEAN  _ FALSE;

IF b.ois.pktLength < OISCPTypes.bytesPerPktHeader THEN
BEGIN
IF CommFlags.doStats THEN StatIncr[statOisDiscarded];
DriverDefs.PutOnGlobalDoneQueue[b]; -- done with this packet
RETURN;
END;

IF (badChecksum _ IF checkIt THEN NOT Checksums.TestChecksum[b] ELSE FALSE)
THEN
BEGIN
IF CommFlags.doStats THEN
BEGIN
StatIncr[statReceivedBadOisChecksum];
StatIncr[statOisDiscarded];
END;
DriverDefs.PutOnGlobalDoneQueue[b]; -- done with this packet
RETURN;
END;


IF CommFlags.doStorms AND stormy AND PacketHit[] THEN
BEGIN DriverDefs.PutOnGlobalDoneQueue[b]; RETURN; END; -- for debugging only

incomingNet _ b.network;
IF destHost = myHostID
OR ((broadcastPacket_(destHost = allHostIDs))
AND (incomingNet.netNumber = b.ois.destination.net)
OR (b.ois.destination.net = NSAddress.nullNetworkNumber)) THEN
BEGIN -- incomming packet for us (we may have broadcast it)
IF NOT DeliveredToLocalSocket[b, FALSE] THEN
BEGIN
IF b.ois.destination.socket = OISCPConstants.routingInformationSocket THEN
Router.RoutingInformationPacket[b] -- we still own this packet!

ELSE
BEGIN -- packet for unknown socket
IF NOT broadcastPacket THEN
BEGIN
SendErrorPacket[b, noSocketOisErrorCode, 0];
IF CommFlags.doStats THEN StatIncr[statJunkOisForUsNoLocalSocket];
END
ELSE IF CommFlags.doStats THEN StatIncr[statJunkBroadcastOis]
END;
DriverDefs.PutOnGlobalDoneQueue[b]; -- done with this packet

END;
END
ELSE SELECT TRUE FROM
routersFunction=interNetworkRouting =>
BEGIN
Router.ForwardPacket[b]; -- dispatcher returns to system pool
END;
b.ois.destination.socket=OISCPConstants.routingInformationSocket =>
BEGIN
Router.RoutingInformationPacket[b]; -- we still own this packet!
DriverDefs.PutOnGlobalDoneQueue[b];
END;
ENDCASE =>
BEGIN
IF CommFlags.doStats THEN StatIncr[statOisDiscarded];
DriverDefs.PutOnGlobalDoneQueue[b]; -- we got the packet when we shouldn't have!
END;
END; -- ReceivePacket

PacketHit: ENTRY PROCEDURE RETURNS [BOOLEAN] =
BEGIN
IF (lightning _ lightning + 1) > bolt OR lightning < 0 THEN
BEGIN
IF lightning > bolt THEN
BEGIN
IF bolt > 100 THEN
BEGIN
randLong: LONG CARDINAL _ ProcessorFace.GetClockPulses[];
rand: CARDINAL _ LOOPHOLE[randLong, Basics.LongNumber].lowbits;
lightning _ -INTEGER[rand MOD 20B];
bolt _ 10;
END
ELSE BEGIN lightning _ 0; bolt _ bolt + 1; END;
END;
IF CommFlags.doStats THEN StatIncr[statZappedP];
RETURN[TRUE];
END
ELSE RETURN[FALSE];
END; -- PacketHit


DeliveredToLocalSocket: ENTRY PROCEDURE [b: BufferDefs.OisBuffer, useCopy: BOOLEAN]
RETURNS [BOOLEAN] =
BEGIN
ENABLE UNWIND => NULL;
destSocket: NSAddress.SocketNumber _ b.ois.destination.socket;
sH, prevSH: SocketHandle;
FOR sH _ (prevSH _ socketTable.first), sH.next UNTIL sH = NIL DO
IF sH.localAddr.socket = destSocket THEN
BEGIN
IF useCopy THEN EnqueueCopyOfNewInput[sH, b] ELSE EnqueueNewInput[sH, b];
IF prevSH # socketTable.first THEN
BEGIN
prevSH.next _ sH.next; -- this removes sH from the list
sH.next _ socketTable.first;
socketTable.first _ sH; -- this puts sH at head of list

END;
RETURN[TRUE];
END;
prevSH _ sH;
ENDLOOP;
RETURN[FALSE];
END; -- DeliveredToLocalSocket

EnqueueNewInput: INTERNAL PROCEDURE [sH: SocketHandle, b: BufferDefs.OisBuffer] =
INLINE
BEGIN
IF (sH.channelState = aborted) OR NOT
(OISCP.CreditReceiveOisBuffer[sH.pool, b]) THEN
BEGIN
IF CommFlags.doStats THEN StatsDefs.StatIncr[statOisInputQueueOverflow];
DriverDefs.PutOnGlobalDoneQueue[b];
RETURN;
END;
b.status _ LOOPHOLE[Router.XmitStatus[goodCompletion]];
EnqueueOis[sH.completedUserGetQueue, b];
BROADCAST sH.newUserInput;
END; -- EnqueueNewInput

EnqueueCopyOfNewInput: INTERNAL PROCEDURE [
sH: SocketHandle, b: BufferDefs.OisBuffer] = INLINE
BEGIN
getBuffer: BufferDefs.OisBuffer _
IF sH.channelState = aborted THEN NIL
ELSE MaybeGetFreeReceiveOisBufferFromPool[sH.pool];
IF (getBuffer # NIL) THEN
BEGIN
getBuffer.status _ LOOPHOLE[Router.XmitStatus[goodCompletion]];
CommUtilDefs.CopyLong[
from: @b.ois.checksum, nwords: (b.ois.pktLength + 1)/2,
to: @getBuffer.ois.checksum];
EnqueueOis[sH.completedUserGetQueue, getBuffer];
BROADCAST sH.newUserInput;
END
ELSE IF CommFlags.doStats THEN StatsDefs.StatIncr[statOisInputQueueOverflow];
END; -- EnqueueNewLocalInput

BroadcastThisPacket: PUBLIC PROCEDURE [b: BufferDefs.OisBuffer] =
BEGIN
network: Network;
IF CommFlags.doStats THEN StatIncr[statOisBroadcast];
b.allNets _ TRUE; -- this is where it gets turned on
b.ois.destination.host _ NSAddress.broadcastHostNumber;
b.network _ network _ DriverDefs.GetDeviceChain[];
IF network = NIL THEN 
BEGIN
DriverDefs.PutOnGlobalDoneQueue[b];
IF CommFlags.doStats THEN StatsDefs.StatIncr[statOisSentNowhere];
RETURN; 
END;
SendBroadcastPacketToCorrectNet[b];
END;  -- BroadcastThisPacket

SendBroadcastPacketToCorrectNet: PUBLIC PROCEDURE [b: BufferDefs.OisBuffer] =
BEGIN
network: Network _ b.network;
IF ~network.alive OR (b.bypassZeroNet AND network.netNumber = [0, 0]) THEN
BEGIN DriverDefs.PutOnGlobalDoneQueue[b]; RETURN; END;
b.ois.destination.net _ b.ois.source.net _ network.netNumber;
b.ois.source.host _ myHostID;
IF checkIt THEN Checksums.SetChecksum[b] ELSE b.ois.checksum _ 177777B;
LOOPHOLE[b.status, DriverDefs.DriverXmitStatus] _ goodCompletion;
network.encapsulateOis[b, NSAddress.broadcastHostNumber];
network.sendBuffer[b];
END;  -- SendBroadcastPacketToCorrectNet

SendErrorPacket: PUBLIC PROCEDURE [offendingPkt: BufferDefs.OisBuffer, errCode: OISCPTypes.OISErrorCode, errParm: CARDINAL] =
BEGIN
net: Network = offendingPkt.network;
b: BufferDefs.OisBuffer;
offenseLen: CARDINAL;
IF offendingPkt.ois.transCntlAndPktTp.packetType=error THEN RETURN;  -- don't send errors about errors
IF (b _ DriverDefs.MaybeGetFreeOisBuffer[])=NIL THEN RETURN;  -- give up!
b.ois.destination _ offendingPkt.ois.source;
b.ois.source _ [ IF net=NIL THEN OISCP.unknownNetID ELSE net.netNumber,
myHostID, OISCP.unknownSocketID];
b.ois.transCntlAndPktTp _ [initialTransportControl, error];
b.ois.errorType _ errCode;
b.ois.errorParameter _ errParm;
offenseLen _ MIN[offendingPkt.ois.pktLength, OISCPTypes.bytesPerPktText-4];  -- four is for errorType and errorParameter.
CommUtilDefs.CopyLong[@offendingPkt.ois, (offenseLen+1)/2, @b.ois.errorBody];
SetOisPacketTextLength[b, offenseLen+4];
SendPacket[b];
END;  -- SendErrorPacket


OisRouterOn: PUBLIC PROCEDURE =
BEGIN
OisRouterActivate[];
Router.RoutingTableOn[];
DriverDefs.SetOisRouter[@oiscpRouter];
END; -- OisRouterOn

OisRouterActivate: ENTRY PROCEDURE = INLINE
BEGIN
myHostID _ NSAddress.GetProcessorID[];
IF primaryMDS THEN socketTable _ [length: 0, first: NIL];
END; -- OisRouterActivate

OisRouterOff: PUBLIC PROCEDURE =
BEGIN
DriverDefs.SetOisRouter[NIL];
OisRouterDeactivate[];
Router.RoutingTableOff[];
END; -- OisRouterOff

OisRouterDeactivate: ENTRY PROCEDURE = INLINE
BEGIN

END; -- OisRouterDeactivate


IF primaryMDS THEN spareSocketID _ initialSpareSocketID;

END.  -- RouterImpl module.

LOG

Time: January 19, 1980  4:05 PM By: Dalal  Action: Split OISCPRouter into two.
Time: January 21, 1980  6:07 PM By: Dalal  Action: one lock for SocketImpl and RouterImpl.
Time: March 13, 1980  4:55 PM  By: BLyon  Action: modified SendPacket.
Time: March 18, 1980  4:09 PM  By: BLyon  Action: Modified EnqueueNewInput where it gets an input buffer.
Time: May 12, 1980  6:38 PM  By: BLyon  Action: Put checksum into microcode (switched order parameters too).
Time: May 16, 1980  10:07 AM PM  By: BLyon  Action: Removed all ShortenPointer to allow multiple MDS. 
Time: June 30, 1980  1:02 PM  By: BLyon  Action: Checkit init to FALSE instead of TRUE.. 
Time: July 22, 1980  11:03 AM  By: BLyon  Action: Checkit changed back to TRUE; checksums stuff put in seperate modules; we now receive out own broadcasts. 
Time: August 1, 1980  1:29 PM  By: BLyon  Action: replaced internetRouter by routersFunction. 
Time: September 13, 1980  6:15 PM  By: HGM  Action: Add StateChanged. 
Time: September 18, 1980  3:34 PM  By: BLyon  Action: AssignOisAddress puts unknownNetID in network field rather than primaryNetID. 
Time: February 24, 1981  3:25 PM  By: BLyon  Action: put extra clause in ReceivePacket so that an INR would forward a broadcast instead of eating it with a local socket. 

RouterImpl.mesa - implementation module for the Pilot OISCP Router switch
Copyright c 1985 by Xerox Corporation.  All rights reserved.
BLyon on: March 21, 1981  11:53 AM)
Levin, August 9, 1983 9:22 am
Many of these variables must eventually live in outerspace so that multiple MDSs
access the same router variables.  The modules in the primary MDS will have the
proceses and will perform the initialization of the "globals", while the others will not.
The lock covers both SocketImpl and RouterImpl, specifically the socket objects,
the socket table, and spare socket ID counter.  These will all live in outerspace.
The monitor locks some variables on the global frame too.  They can be MDS specific.
EXPORTed TYPEs
switches and variables that don't change during execution unless for diagnostics
oiscp router object for the dispatcher.  There will only be one for all MDSs, but it
can live on all global frame instances or we can put it in hyperspace and have the
dispatcher access it via a long pointer.  The former is preferable.
monitor protected data.
parameters for killing packets for debugging
I think only the following need be in outerspace, accesible via a pointer since these
will be touched by multiple MDS processes via their copy of RouterImpl and SocketImpl.
lock for the router and all the sockets.
Some day the socketIDs in use will be remembered across wrap around, and maybe
the rebooting of Pilot.
socket table
various Glitches generated by the router
Cool Procedures 
This procedure assigns a temporary socket number in an NSAddress.NetworkAddress.
Some day the active socket numbers in use will be kept around, so that on wrap
around an unused number will be assigned.  When the system element is connected to
more than one network, this procedure must return a list of NSAddress.NetworkAddress.
This procedure is just like the previous one except that the network number is relative
to the destination network.  That is, we pick that one of our locally connected
networks that is the best way to get to destNet, with the hope that it is the best
way to get from destNet to us.
This procedure tells the OISCP Router about a new socket.
add new socket to the head of the table
This procedure removes a socket from the OISCP Router's tables.
This is not an entry procedure because we change it only for debugging and can
live with a race condition.
SetOisStormy
This is not an entry procedure because we change it only for debugging and can
live with a race condition.
SetOisCheckIt
This is not an entry procedure because we change it only for debugging and can
live with a race condition.
This procedure returns the processor ID of this machine.
GetOisPacketTextLength
Hot Procedures
This procedure transmits a packet over a locally connected network.
The procedure assumes that all fields of the buffer have been filled in appropriately,
except the encapsulation and buffer length which depend on the network.  If the
packet is destined for a local socket and we do NOT want to do loopback at the
driver or at the network,  then it gets looped back here.  Broadcast
packets are NOT delivered to the source socket.
Packets are no longer copied into system buffers.
The caller owns the buffer.  The buffer is asynchronously sent and retruned to the 
caller process by the dispatcher using b.requeueProcedure.
packet is for a local socket; broadcast packets are not delivered locally
no socket
we requeue here because we shorted the drivers and dispatcher.
we Yield here to prevent local communication from using all of the cycles.
packet is for a remote machine
If the destination net is inaccessible then we will have suffered the overhead of 
computing a checksum, but we don't expect inaccessible nets that often.
set the checksum if appropriate
This procedure is called by the Dispatcher when it sees a valid ois packet in a system
buffer.  The procedure checks the checksum field and then routes the packet to a
local socket.  If this is an internetwork router, then the packets are forwarded over
a suitable network.  We now own this packet.
hardware says ok, but bad end-to-end software checksum.
packet is in good shape, route it.
FALSE -> do not copy this buffer, but deliver it
routing information socket is part of router in another module
Hot, except should really not exist; therefor cold?
This procedure attempts to hit a packet with a bolt of lightening, and if it succeeds,
then it returns true else false.  The caller dispenses with the buffer.
This procedure finds a local socket object to deliver the packet to, and if it succeeds,
then it returns true else false.  Caller  retains ownership of buffer if useCopy is true
or return is false;  caller loses buffer ownership if NOT useCopy and return is true.
find the correct socket for this packet
do some dynamic socket ordering before returning; rearange the list only if 
sH was not in the first two entries of the list.
This procedure enqueues a new input packet at the socket object.
The incoming buffer is from a  network driver and NOT a local socket.
The caller of this routine relinquishes ownership of this buffer.
This procedure enqueues a new input packet at the socket object.
The incoming buffer is only from a  local socket.
The caller of this routine retains ownership of this buffer.
Copy b into the first OisBuffer on the pendingGetQueue, if there is one.
assume always good
getBuffer is full sized OisBuffer, therefore no need to check length
funny name
This procedure causes a broadcast packet to be sent over all networks.
This procedure causes a broadcast packet to be sent out over the right network.
goes (slowly) around in circles
This procedure generates and sends an error packet.  All or most of the 
offending packet is copied into the the error packet.  The caller of this 
Procedure still owns offendingPkt.
Cold Procedures
This procedure turns the router on.  The Communication software is written with the
idea of eventually turning the code on and off during execution, and so we should
get the latest values of netID and hostID when being turned back on.
cleanup the socket table.
IF primaryMDS THEN 
Cold
initialization
Κ~˜
codeš
œI™IKšœ
Οm
œ1™<Kš
œ#™#Kš
œ™—K˜š
Οk	˜	Kšœžœ˜Kšœžœ
˜Kšœ
žœ˜,Kšœžœ˜Kšœ
žœ˜-Kšœ
žœ˜Kšœžœš
˜ͺ
Kšžœ
žœw˜‚
Kšœžœ˜0šœžœ˜K˜T—Kšœžœ	˜Kšœžœ˜%KšœžœΔ
˜Π
Kšœžœ˜$Kšœžœ˜-Kšœ
žœs˜‚
Kšœ
žœ˜K˜—šœžœ
žœ˜*Kšžœ2žœ6˜tKšžœ$žœ˜8Kšžœ
˜Kšžœ
žœ
žœ(˜DK˜Kš
œP™PKš
œO™OKš
œY™YK˜Kš
œP™PKš
œR™RKš
œT™TK˜Kš
œ™Kšœ	žœ
žœ˜*K˜Kš
œP™PKšœžœ
žœžœΟc˜@Kšœ	žœ
žœžœŸ˜=KšœžœžœŸ˜6KšœžœžœŸ"˜;Kšœžœ7˜NKšœ Ÿ&˜FK˜K˜6˜6Kšœžœ˜'K˜—Kš
œT™TKš
œR™RKš
œC™C˜&šœžœžœ"˜VK˜CK˜#K˜——Kš
œ™Kš
œ,™,Kšœžœ˜Kšœžœ˜Kš
œU™UKš
œV™VKšœžœ
žœ
˜%Kš
œ(™(Kš
œN™NKš
œ™K˜&Kš
œ™K˜ K˜Kš
œ(™(Kšœžœžœ
˜"K˜Kš
œ™K˜Kš
œP™PKš
œN™NKš
œR™RKš
œU™UšΟnœžœ
žœ
ž	˜(Kšžœ(˜/Kš
ž˜˜SK˜'—šžœCž˜IK˜%—KšžœŸ˜K˜—Kš
œW™WKš
œO™OKš
œR™RKš
œ™š #œžœ
žœ
ž	œ#˜^Kšžœ(˜/Kš
ž˜˜˜CK˜——šžœCž˜IK˜%—KšžœŸ&˜+K˜—Kš
œ9™9š 	œžœ
žœ
ž	œ˜6Kš
ž˜K˜š œž	œž˜/Kš
ž˜K˜-šžœžœ
ž˜Kšžœžœ
žœ
˜)K˜Kšžœ
˜—Kšœ&žœŸ˜@Kšžœ
˜K˜—Kš
œ'™'Kšžœžœ˜8K˜K˜K˜,KšžœŸ˜K˜—Kš
œ?™?š œžœ
žœ
ž	œ˜9Kš
ž˜K˜š œž	œž˜/Kš
ž˜K˜šžœžœ
ž˜Kšžœžœ
žœ
˜)K˜Kšžœ
˜—Kšœ&žœŸ˜BKšžœ
˜K˜—K˜Kšžœžœ˜:š
ž˜Kš
ž˜K˜šžœžœ
ž˜Kš
žœžœ
žœžœžœ
˜HK˜Kšžœ
˜—Kšžœ
˜—K˜,Kšžœžœ˜8KšžœŸ˜K˜—Kš
œN™NKš
œ™Kš œžœ
ž	œžœžœžœ
˜HKš
œ™K˜Kš
œN™NKš
œ™Kš 
œžœ
ž	œžœžœžœ
˜JKš
œ
™
K˜Kš
œN™NKš
œ™š œžœ
ž	œžœ˜7KšžœžœŸ˜8K˜—Kš
œ8™8š œžœ
ž	œ
žœ˜?Kšžœ
žœžœŸ˜,K˜—š
 œžœ
ž	œžœžœ˜WKšžœ
žœ'žœ
˜7—Kš
œ™K˜š œžœ
ž	œ žœ˜SKš
ž˜šžœžœž˜#K˜)—Kšžœ
žœžœ˜;KšžœŸ˜K˜—š œžœ
ž	œ žœ˜OKš
ž˜Kšžœžœ%žœ˜HKšžœ
žœžœ˜;KšžœŸ˜K˜—Kš
œ™K˜Kš
œC™CKš
œV™VKš
œO™OKš
œN™NKš
œD™DKš
œ/™/Kš
œ1™1Kš
œS™SKš
œ:™:š 
œžœ
ž	œ˜8Kš
ž˜šžœžœžœ
žœ
˜6Kš
ž˜K˜#KšžœŸ˜Kšžœ
˜K˜Kšžœ#ž˜(Kšžœž˜Kš
œI™IKš
ž˜š	žœ
žœžœžœ
Ÿ˜GKš
ž˜KšœžœŸ ˜<Kš
œ	™	Kšžœžœ)˜BK˜EKšžœ
˜—Kš
œ>™>Kš
œJ™JK˜#K˜Kš
ž˜—š
ž˜Kš
œ™Kš
ž˜Kš
œR™RKš
œG™GKš
œ™K˜CKšžœ	žœžœ˜GK˜&Kšžœ
˜—KšžœŸ
˜K˜—Kš
œV™VKš
œP™PKš
œU™UKš
œ,™,š 
œžœ
ž	œ˜;Kš
ž˜Kšœ
žœ
˜K˜K˜8Kšœžœžœ
˜"K˜šžœ0ž˜6Kš
ž˜Kšžœžœ˜5Kšœ$Ÿ˜<Kšžœ
˜Kšžœ
˜K˜—šžœžœ	žœ
žœžœ
žœ
˜KKš
ž˜Kš
œ7™7Kš
ž˜šžœž˜Kš
ž˜K˜%K˜Kšžœ
˜—Kšœ$Ÿ˜<Kšžœ
˜Kšžœ
˜K˜—Kš
œ"™"˜Kšžœžœžœ
ž˜5Kšžœ%žœžœŸ˜LK˜K˜Kšžœ˜šžœ+˜-šžœ0˜3Kšžœ8ž˜>——Kšžœ
Ÿ5˜;šžœ
žœžœž˜,Kš
œ0™0Kš
ž˜Kš
œ>™>šžœDž˜JKšœ#Ÿ˜?K˜—š
ž˜Kšžœ
Ÿ˜"——šžœ
žœž˜Kš
ž˜K˜,Kšžœžœ)˜BKš
ž˜—šžœ
žœžœ˜=Kšžœ
˜Kšœ$Ÿ˜<K˜Kšžœ
˜Kš
ž˜——šžœ
žœ
žœ
ž˜˜&Kš
ž˜KšœŸ$˜=Kšžœ
˜—˜CKš
ž˜Kšœ$Ÿ˜@K˜#Kšžœ
˜—šžœ˜
Kš
ž˜Kšžœžœ˜5Kšœ$Ÿ,˜PKšžœ
˜——KšžœŸ˜K˜—Kš
œ3™3Kš
œV™VKš
œG™Gš
 	œžœ
ž	œ
žœžœ˜.Kš
ž˜šžœ$žœž˜;Kš
ž˜šžœž˜Kš
ž˜šžœž˜Kš
ž˜Kšœ
žœ
žœ"˜9Kšœžœžœ&˜?Kšœ
žœžœ˜#K˜
Kš
ž˜—Kšžœ
žœ!žœ
˜/Kšžœ
˜—Kšžœžœ˜0Kšžœ
žœ˜
Kš
ž˜—Kšžœ
žœ
žœ˜KšžœŸ˜K˜—Kš
œX™XKš
œX™XKš
œU™UK˜š œžœ
ž	œ$žœ
˜SKšžœžœ˜Kš
ž˜Kšžœ
žœžœ
˜K˜>K˜Kš
œ'™'šžœ,žœžœ
ž˜@šžœ"ž˜(Kš
ž˜Kšžœ	žœžœ˜IKš
œL™LKš
œ0™0šžœž˜"Kš
ž˜KšœŸ ˜7K˜KšœŸ˜7K˜Kšžœ
˜—Kšžœ
žœ˜
Kšžœ
˜—K˜Kšžœ
˜—Kšžœ
žœ˜KšžœŸ˜K˜—Kš
œ@™@Kš
œE™EKš
œA™Aš œžœ
ž	œ.˜QKš
ž˜Kš
ž˜šžœžœ
ž˜%Kšœ
žœ%ž˜/Kš
ž˜Kšžœžœ/˜HK˜#Kšžœ
˜Kšžœ
˜—Kšœžœ$˜7K˜(Kšž	œ˜KšžœŸ˜K˜—Kš
œ@™@Kš
œ1™1Kš
œ<™<š œžœ
ž	œ˜+Kšœ-ž˜3Kš
ž˜˜!Kšžœžœ
ž˜%Kšžœ/˜3—Kš
œH™Hšžœžœž˜Kš
ž˜Kšœžœ$˜?Kš
œ™Kš
œD™D˜K˜7K˜—K˜0Kšž	œ˜Kš
ž˜—Kšžœ
žœžœ/˜MKš
œ
™
KšžœŸ˜K˜—Kš
œF™Fš œžœ
ž	œ˜AKš
ž˜K˜Kšžœžœ˜5KšœžœŸ"˜4K˜7K˜2šžœžœ
žœ
˜Kš
ž˜K˜#Kšžœžœ(˜AKšžœ˜Kšžœ
˜—K˜#KšžœŸ˜K˜—Kš
œO™Oš œžœ
ž	œ˜MKš
ž˜K˜šžœžœžœž˜JKšžœ%žœžœ
˜6—Kš
œ™K˜=K˜Kšžœ	žœžœ˜GKšžœ9˜AK˜9K˜KšžœŸ"˜(K˜—Kš
œH™HKš
œJ™JKš
œ"™"š œžœ
ž	œQžœ˜}Kš
ž˜K˜$K˜Kšœžœ
˜Kšžœ5žœ
žœŸ!˜fKš	žœ*žœ
žœ
žœŸ˜IK˜,šœžœžœ
žœ
žœžœ˜GKšœ
žœ˜!—K˜;K˜K˜Kšœ
žœ=Ÿ,˜yK˜MK˜(K˜KšžœŸ˜K˜—Kš
œ™K˜Kš
œS™SKš
œQ™QKš
œD™Dš œžœ
ž	œ˜Kš
ž˜K˜K˜K˜&KšžœŸ˜K˜—š œžœ
ž	œž˜+Kš
ž˜K˜&Kšžœžœ"žœ˜9KšžœŸ˜K˜—š œžœ
ž	œ˜ Kš
ž˜Kšœžœ˜K˜K˜KšžœŸ˜K˜—š œžœ
ž	œž˜-Kš
ž˜Kš
œ™Kš
œ™K˜KšžœŸ˜K˜—Kš
œ™Kš
œ™K˜Kšžœžœ&˜8K˜KšžœŸ˜K˜—Kš
ž˜K˜Kšœžœ/˜NKšœžœ;˜ZKšœžœ)˜FKšœžœL˜iKšœžœQ˜lKšœžœ
žœBžœ˜fKšœžœ%žœžœ˜YKšœžœ-žœN˜œ
KšœžœA˜^Kšœžœžœ˜FKšœžœc˜„
KšœžœBžœE˜ͺ
K˜—…—9TcΪ