Factories that support OS programs

The OS binder factory is the starting point for OS programs that are loaded using the binder. It is available in SYS.OSBF .

Code called GNOBIBMx is available in three versions to be included in a .program. They are in SYS.TEXTS.GNOBIBMx where "x" is "A", "B", or "C". (These correspond closely and respectively to the three ranges of ordinals used by GNOFIBM.) GNOBIBMx is responsible for making the transition from the factory environment to the OS environment. See (gnobibmx) for the differences.

The .program component of the factory must be an l-segment factory that was produced from the OS binder factory. Along with the OS program, it must include one of the versions of GNOBIBMx (and use the starting address thereof).

Free Storage

The l-segment factory must also include a block of free storage, with the symbols #@FRBEG and #@FREND defining the beginning and ending addresses.

The factory must also have the OSSIMFB factory (ossimfb) as component 4. GNOBIBMx uses it. It is available from SYS.OSSIMFB .

Let OSFACT be a requestor's key to such a factory. Here is what the versions of GNOBIBMx do.

GNOBIBMA
The model of OS programs. They may be reused or single shot depending on the calling sequence.

Calling sequence for reusable program

In this case, a call on the requestor's key returns an entry key without the OS program having run.

Programs loaded with GNOBIBMA are suitable to interface with the command system. The OSFLOAD command calls these factories and puts the entry key into the directory. The EXECUTE or FORK commands will call these entry keys with terminal keys and run them as follows:

OSFACT(kt+5;PSB,M,SB ==> kt+5;,,,OSFACTCO)

OSFACTCO(akt;FILEDEFQUERY,CLOCK,ARG ==>c ;OSENTRY,OSFD)

Builds the OS domain and returns an entry key to it. OSFD is the key that can be used to simulate the filedef function (osfd).

Akt becomes the alleged type of the program. If specified as zero (0) the alleged type will be x'FF14'. 0 < akt < kt.

Return code c

c = 0 success

c = 1 The first space bank is not prompt and official

c = 2 The first spacebank doesn't have sufficient space

c = 3 calling sequence error

c = 4 OSSIMFB factory failure

c = 5 SNODE factory failure

OSENTRY(oc,osparms;SIK,SOK,PARM ==> c;,PARM,SIK,SOK)
Runs the OS program using the OS parameters osparms. When the program terminates, its return code is returned in c. This operation was invented for the "EXECUTE" or "FORK" commands which send this message.

oc is currently unavailable to the OS program, but is included for consistency.

SIK, SOK, PARM will be returned to the caller in the same fashion as is currently done, that is the return keys are DK(0),PARM,SIK,SOK.

NOTE that the OS environment closes SYSOUT and SYSPRINT when it terminates and thus the SOK key may not be available (It will be signalled EOF at the CLOSE).

PARM is often a NODE with slot 0 containing CCK. This is the convention of the current command system when using EXECUTE and FORK commands.

OSENTRY(kt+4 ==> 0) destroys the OS program domain and its OS simulator domain. Any space allocated by the program itself will not be destroyed. It is the responsibility of the OS program to destroy anything it creates before returning.

OSENTRY(kt ==> akt) or if akt was specified as 0, x'FF14'.

Calling sequence for single shot execution
OSFACT(kt+5;PSB,M,SB ==> kt+5;,,,OSFACTCO)

OSFACTCO(kt+5;FILEDEFQUERY,CLOCK,ARG ==> kt+5;,,,OSFACTCO)

OSFACTCO(oc,osparms;SIK,SOK,PARM ==> c;,PARM,SIK,SOK)

Run the OS program using the OS parameters passed on the third part of the extended jump. Destroy the domain when the program terminates. C is the return code from the OS program.

It is the responsibility of the OS program to destroy anything it creates before returning.

oc is currently unavailable to the OS program, but is included for consistency.

NOTE that the os environment CLOSEs SYSOUT and SYSPRINT when the program terminates so that SOK may not be available (having been signalled EOF)./

Initial contents of the c-slots
Slot 0 The components node

Slot 1 OSCOM

Slot 2 Exit to caller. GNOBIBMA is responsible for returning to it.

Slot 3 Parameter zero {(osen)} (nominally SIK)

Slot 4 Parameter one (nominally SOK)

Slot 5 Parameter two

Slot 6 The domain creator

Slot 7 The synthetic domain key

Slot 8 PSB

Slot 9 The meter key M

Slot 10 ARG

Slot 11 SB

Slot 15 The key returned by the binder for reporting ref key blocks

GNOBIBMB
A not so useful model of the traditional Gnosis creator. The calling sequence is much like the traditional creator sequence.

OSFACT(akt;PSB,M,SB ==> c;OSENT)

OSENT(oc,params;key0,key1,key2 ==> c;)

Calls the OS program.

The order code is not available to the program.

Initial contents of the c-slots
Slot 0 The components node

Slot 1 OSCOM

Slot 2 Exit to caller

Slot 3 key0

Slot 4 key1

Slot 5 key2

Slot 6 The domain creator

Slot 7 The synthetic domain key

Slot 8 PSB

Slot 9 The meter key M

Slot 10 OSFD

Slot 11 SB

Slot 15 The key returned by the binder for reporting ref key blocks

GNOBIBMC
The model of the Gnosis creator.

If PSB is an official prompt space bank and has enough space then OSFACT(oc;PSB,M,SB,EXIT) starts the OS program.

The OS program may do what it wants with the resume key to the caller.

The order code is passed to the OS program as a 4 byte parameter that is the binary order code.

When the OS program returns, the domain will be destroyed and the caller (the key in c-slot 2) returned to with the return code (in R15) from the OS program. It is the responsibility of the OS program to destroy anything it creates before returning.

Otherwise OSFACT(oc;PSB,M,SB ==> c;) returns 1 or 2 in c as in (p3,fact-ret-codes).

Initial contents of the c-slots

Slot 0 The components node

Slot 1 OSCOM

Slot 2 EXIT

Slot 3 the synthetic domain key

Slot 4 PSB

Slot 5 the meter key M

Slot 6 The domain creator

Slot 10 OSFD

Slot 11 SB

Slot 15 The key returned by the binder for reporting ref key blocks

OSSIMFB is used to build an OS simulator environment around a domain. GNOBIBMx calls it.

OSSIMFB initializes itself, installs itself as the domain keeper (databyte 0), builds a new meter and installs itself as the meter keeper (databyte 3), makes a virtual domain key (databyte 1), windows the user memory, and returns the communication key (databyte 2) and OSFD (databyte 4) which is used to establish local filedefs.

The Domain Keeper key understands one explicit order code other than kt.

DK(1; ==> 0;SYNDOM) returns the synthetic domain key.

DK(kt; ==> x'214')

OSSIMFB(kt+5;PSB,M,SB ==> kt+5;SNC,RETR,,OSSIMFBCO)
SNC is the supernode creator. RETR is the returner. These are returned for the convenience of the OS domain.
CESSEK2 is the node key representing the ref key block CESSEK2 used by module CESSE for mapping segments.

OSSIMFBCO(kt+5;CESSEK2 ==> kt+5;,,,OSSIMFBCO2)

OSSIMFBCO2(0,(4,#@FRBEG),(4,#@FREND);FILEDEFQUERY,CLOCK,DOMKEY ==> c;OSCOM,OSFD)

FILEDEFQUERY is a key that will resolve DDNAMES into keys.

CLOCK is a time of day server.

DOMKEY is the domain key of the program domain that is to be kept by the OSSIM domain.

#@FRBEG and #@FREND are addresses which mark the beginning and end of free storage.

If PSB is an official prompt space bank and has enough space, the return code c will be 0. Otherwise it may be 1 or 2 according to (p3,fact-ret-codes).

OSLOAD will load OS style programs. It is available in SYS.OSLOAD . Its specifications are the same as SLOAD {(sload)} with the following exceptions.

The binder used has the necessary OS facilities built in. There are 14 megabytes left for the user program and data. GNOBIBMx {(gnobibm)} should be the first TEXT deck delivered to OSLOAD.

Remember GNOBIBMx requires OSSIMFB as component 4.
Shouldn't this be OSSIMF?

If you do not supply a section of free storage (named "#@FRBEG"), OSLOAD will create one to fill the remaining memory (up to 16 megabytes).

The locator for CESSEK2 is called CESSEJ2. GNOBIBMx uses it.

OSLOAD(kt; ==> X'70F0D';)

{arcane}The layout of memory of the segments produced with OSLOAD is as follows. Addresses are in hexadecimal.

0000 PSA etc.

2000 unused

E000 IBMBEEFA and IBMBEERA, GNOCPIRA

F000 unused because OSSIM uses this address for CESOS2

10000 unused because OSSIM uses this address for CESOS1

15000 CESTERM1 (shared)

19000 unused (shared)

20000 PL/I library (shared)

60000 unused

100000 ref key block CESSEK2, used for OS segment I/O

200000 User read-only segment (shared)

after that, the user read/write segment, including free storage

1000000 end of memory