TSXLIB A Library Implementation of Programmed Requests for TSX-Plus V5.1 DECUS #11-490 N. A. Bourgeois, Jr. of NAB Software Services, Inc. PO Box 20009 Albuquerque, NM 87154 and Sandia National Laboratories P. O. Box 5800 Albuquerque, NM 87185 Abstract A library of FORTRAN callable routines that implement the EMTs provided by TSX-Plus is described. Complete descrip- tions, calling sequences, examples of use, and library building procedures are given. [84j18a] TSXLIB V5.1 PAGE 2 The information in this document is subject to change without notice and should not be construed as a commitment by NAB Software Services, Inc. NAB Software Services , Inc. assumes no responsibility for any errors that may appear in this document. This document was originally issued by Sandia National Laboratories, operated for the United States Department of Energy by Sandia Corporation. Notice This document was originally sponsored by the United States Government. Neither the United States Government nor the United States Department of Energy, nor any of their employ- ees, nor any of their contractors, subcontractors, or their employees makes any warranty, express or implied, or assumes any legal liability or responsibility for the accuracy, com- pleteness or usefulness of any information, apparatus, product or process disclosed, or represents that its use would not infringe privately owned rights. This work was originally funded by: Headquarters, ESD / OCB / Stop 36 Hanscom Air Force Base, MA 01731 TSXLIB V5.1 PAGE 3 The Reader's Comment form on the last page of this document requests the user's critical evaluation to assist NAB Software Services, Inc. in preparing future documentation. Acknowledgments The author wishes to thank S & H Computer Systems, Inc. for its permission to reprint parts of their "TSX-Plus Reference Manual" in this document. The author wishes also to thank W. L. Jacklin of Sandia National Laboratories for his assistance in reviewing this document and particularly for his help with the many FORTRAN examples in the third chapter. *********** * CAUTION * *********** Much of both the MACRO-11 source codes and the FORTRAN exam- ples described in this document are as yet untried. TSXLIB V5.1 PAGE 4 Table of Contents Table of Contents 1. Introduction . . . . . . . . . . . . . 6 2. General Description . . . . . . . . . 7 Communication Line Support . . . . . . 7 Detached Job Support . . . . . . . . . 7 Device Allocating and Deallocating . . 8 Device Mounting and Dismounting . . . 8 Interprogram Message Communication . . 8 Job Status Monitoring . . . . . . . . 8 Miscellaneous EMT Support . . . . . . 9 ODT Activation Mode Support . . . . . 9 Performance Analysis Support . . . . . 9 Real Time Program Support . . . . . . 9 Shared Run Time System Support . . . . 11 Shared File Support . . . . . . . . . 11 Special File Information . . . . . . . 12 Spooler Support . . . . . . . . . . . 12 System Status Information . . . . . . 12 Terminal Communication Support . . . . 12 Terminal Control Support . . . . . . . 13 User Name Support . . . . . . . . . . 13 3. Routine Descriptions . . . . . . . . . 14 BRKCTL . . . . . . . . . . . . . . . . 14 CNVAPA . . . . . . . . . . . . . . . . 14 DISMNT . . . . . . . . . . . . . . . . 15 GETREG . . . . . . . . . . . . . . . . 15 GTUNAM . . . . . . . . . . . . . . . . 16 HIEFOF . . . . . . . . . . . . . . . . 16 HIEFON . . . . . . . . . . . . . . . . 16 IACTCH . . . . . . . . . . . . . . . . 16 IALOC . . . . . . . . . . . . . . . . 17 IASRNT . . . . . . . . . . . . . . . . 17 IBICIO . . . . . . . . . . . . . . . . 18 IBISIO . . . . . . . . . . . . . . . . 18 IBSTCH . . . . . . . . . . . . . . . . 19 ICALOC . . . . . . . . . . . . . . . . 19 ICKWTS . . . . . . . . . . . . . . . . 19 ICNINT . . . . . . . . . . . . . . . . 20 ICNMCM . . . . . . . . . . . . . . . . 20 ICNRTN . . . . . . . . . . . . . . . . 21 ICNTSP . . . . . . . . . . . . . . . . 22 ICONTM . . . . . . . . . . . . . . . . 22 ICPUTM . . . . . . . . . . . . . . . . 23 IDALOC . . . . . . . . . . . . . . . . 23 IDCLSF . . . . . . . . . . . . . . . . 24 IESMCN . . . . . . . . . . . . . . . . 24 IEXSTS . . . . . . . . . . . . . . . . 25 IFLINF . . . . . . . . . . . . . . . . 26 IHERR . . . . . . . . . . . . . . . . 27 ILNSTS . . . . . . . . . . . . . . . . 27 INITPA . . . . . . . . . . . . . . . . 27 IPEKIO . . . . . . . . . . . . . . . . 28 IPGNAM . . . . . . . . . . . . . . . . 28 IPOKIO . . . . . . . . . . . . . . . . 28 IPPNUM . . . . . . . . . . . . . . . . 29 IRDRCL . . . . . . . . . . . . . . . . 29 IRLINT . . . . . . . . . . . . . . . . 30 ISERR . . . . . . . . . . . . . . . . 30 ISPBLK . . . . . . . . . . . . . . . . 31 ISPCTL . . . . . . . . . . . . . . . . 31 ISPPA . . . . . . . . . . . . . . . . 31 ISPY . . . . . . . . . . . . . . . . . 32 ISTDJ . . . . . . . . . . . . . . . . 33 ISTFTM . . . . . . . . . . . . . . . . 33 ISTPA . . . . . . . . . . . . . . . . 33 ISTPRV . . . . . . . . . . . . . . . . 34 ISVST . . . . . . . . . . . . . . . . 34 TSXLIB V5.1 PAGE 5 Table of Contents ITCRTN . . . . . . . . . . . . . . . . 34 ITRCTL . . . . . . . . . . . . . . . . 35 ITRERR . . . . . . . . . . . . . . . . 35 ITRTYP . . . . . . . . . . . . . . . . 35 ITSLIC . . . . . . . . . . . . . . . . 36 ITSLIN . . . . . . . . . . . . . . . . 36 IUALBK . . . . . . . . . . . . . . . . 36 IUNLKM . . . . . . . . . . . . . . . . 37 IUSPBK . . . . . . . . . . . . . . . . 37 KLDTJB . . . . . . . . . . . . . . . . 38 LKANMY . . . . . . . . . . . . . . . . 38 LKBLK . . . . . . . . . . . . . . . . 38 LKBLKW . . . . . . . . . . . . . . . . 39 LKLOMY . . . . . . . . . . . . . . . . 39 MAPRNT . . . . . . . . . . . . . . . . 40 MEMPOS . . . . . . . . . . . . . . . . 41 MEMSET . . . . . . . . . . . . . . . . 41 MEMUSE . . . . . . . . . . . . . . . . 41 MOUNT . . . . . . . . . . . . . . . . 42 MPIOPS . . . . . . . . . . . . . . . . 42 MPRGN . . . . . . . . . . . . . . . . 42 MPRMPS . . . . . . . . . . . . . . . . 43 MSGREQ . . . . . . . . . . . . . . . . 43 MSGSND . . . . . . . . . . . . . . . . 44 RCVMSG . . . . . . . . . . . . . . . . 44 RCVMSW . . . . . . . . . . . . . . . . 45 RLCTL . . . . . . . . . . . . . . . . 45 RSTODT . . . . . . . . . . . . . . . . 46 SETODT . . . . . . . . . . . . . . . . 46 STDTJB . . . . . . . . . . . . . . . . 46 STPRLV . . . . . . . . . . . . . . . . 46 STUNAM . . . . . . . . . . . . . . . . 47 TERMPA . . . . . . . . . . . . . . . . 47 TIMOUT . . . . . . . . . . . . . . . . 48 TKCTL . . . . . . . . . . . . . . . . 48 TRMIN . . . . . . . . . . . . . . . . 48 TRMMSG . . . . . . . . . . . . . . . . 49 TRMOUT . . . . . . . . . . . . . . . . 49 4. Building the Library . . . . . . . . . 50 References . . . . . . . . . . . . . . . . 52 Appendix A . . . . . . . . . . . . . . . . 53 Appendix B . . . . . . . . . . . . . . . . 57 TSXLIB V5.1 PAGE 6 Introduction 1. Introduction When application programs are executed under a time sharing executive such as TSX-Plus [1,2] certain capabilities become desirable if not absolute- ly essential. These capabilities relate to requirements for such things as hardware dependent I/O, shared files, interprogram communication, and others. TSX-Plus provides a number of programmed requests or EMTs for these purposes. This document describes a number of FORTRAN callable routines and their calling sequences that implement these EMTs. All of the routines are call- able as FORTRAN subroutines and some are also callable as FORTRAN functions. The routines are written in MACRO-11 [3]. The next section offers a general description of the several groups of routines. It describes the process for linking the routines to the FORTRAN application program. The general calling sequences are also described. The third section gives a detailed description of each of the individual routines. The descriptions include both the calling sequences and, in most cases, examples. Procedures for constructing the library from the several source modules are given in the fourth section. Appendix A contains a table of the routines listed in functional groups. A description of the distribution kit is contained in Appendix B. NOTE TSX-Plus is a registered trademark of S & H Computer Systems Inc., Nashville, TN. TSXLIB V5.1 PAGE 7 General Description 2. General Description These TSX-Plus library routines provide facilities to support communica- tion lines, detached jobs, device allocating and deallocating, file structured device mounting and dismounting, communication between running programs, job status monitoring, program performance analysis, real time pro- gram execution, shared run time systems, shared files, special files information, spooler control, communication between running programs and a terminal, program control of the terminal, ODT activation mode, user name control, and several miscellaneous EMTs. The standard FORTRAN subroutine calling sequence shown below may be used to access all of the routines in the TSX-Plus library. CALL RTNAM ( ARG1,...,ARGn ) Those routines that return only one value are also callable as FORTRAN functions. This is as follows: IRET = RTNAM ( ARG1,...,ARGn ) The application program is first compiled as follows: .RUN SY:FORTRAN *MYPROG=MYPROG *^C Then the routines are linked with the application program as shown below: .RUN SY:LINK *MYPROG=MYPROG,TSXLIB/F *^C or .RUN SY:LINK *MYPROG=MYPROG,TSXLIB,SYSLIB,FPULIB *^C The application program is now ready for execution. .RUN DK:MYPROG The "TSX-Plus Reference Manual" [1] describes how the EMTs implemented in this TSX-Plus library are accessed from a MACRO-11 program. However, the FORTRAN/MACRO interface described in the "RT-11 Programmer's Reference Manu- al" [5] may also be used to access the routines in the library. Communication Line Support Table 2-1 lists the TSXLIB routines that offer certain communication line support from within a running program. IRDRCL Redirect a communication or timesharing line. ICNTSP Control the speed of a communication or timesharing line. Communication line support. Table 2-1 Detached Job Support Table 2-2 lists the routines that provide detached job support from within an executing program. TSXLIB V5.1 PAGE 8 General Description ISTDJ Get the status of a detached job. KLDTJB Kill a detached job. STDTJB Start a detached job. Detached job support. Table 2-2. Device Allocating and Deallocating System services are available to allow a running program to control the allocation of a device for exclusive use. Table 2-3 lists these routines. Once a device has been allocated to a job, no other job is allowed to access the device. A device allocated to a primary line or associated virtual line may be accessed by any of the associated lines. IALOC Allocate a device. IDALOC Deallocate a device. ICALOC Check the allocation status of a device. Device allocating and deallocating. Table 2-3 Device Mounting and Dismounting It is possible to mount and dismount a file structured device for direc- tory caching from within a running program. The routines listed in Table 2-4 provide these capabilities. DISMNT Dismount a file structured device. MOUNT Mount a file structured device. Device mounting and dismounting. Table 2-4. Interprogram Message Communication TSX-Plus provides an optional facility that allows running programs to communicate with each other. Table 2-5 lists the routines that support this interprogram message communication. MSGREQ Post a read request for a message. MSGSND Send a message to another job. RCVMSG Try to receive a message from another job. RCVMSW Wait for a message from another job. Interprogram message ãommunication. Table 2-5. Messages are transferred between programs by using named message chan- nels. A message channel accepts a message from a sending program, stores the message in a queue associated with the channel, and delivers the message to a receiving program on its request for a message on the channel. Message chan- nels are separate from I/O channels. Each active message channel has associated with it an ASCII character name that is used by both the sending and receiving programs to identify the channel. The names associated with the channels are defined dynamically by the running programs. A message channel is active when messages are being held in the queue associated with the channel or if a program is waiting for a message from the channel. When message channels become inactive they are returned to a free pool and may then be reused. Once a message is queued on a channel, that message will remain in the queue until some program receives it. A program's exiting to the keyboard monitor does not remove any pending messages. This allows one program to leave a message for another program that will be run at a later time. Job Status Monitoring A facility is available for one job to monitor the status of one or more other jobs. Once a job has declared to monitor another job, a completion TSXLIB V5.1 PAGE 9 General Description routine is executed in the monitoring job whenever a change of status occurs in the job being monitored. The services provided for job monitoring are listed in Table 2-6. IESMCN Establish a job status monitoring connection. ICNMCM Cancell a job status monitoring connection. IBSTCH Broadcast a job status change. Job status monitoring. Table 2-6. Miscellaneous EMT Support Table 2-7 lists the routines that support the several miscellaneous EMTs provided by TSX-Plus. GETREG Get the word and byte values stored in a processor register. ISPY Return values from within the simulated RMON (SYSLIB routine). ITSLIC Determine the TSX-Plus license number. ITSLIN Determine the TSX-Plus line number. ISTPRV Set the current job's priority value. MEMSET Set the memory allocation. Miscellaneous EMT support. Table 2-7. ODT Activation Mode Support ODT activation mode may be turned on and off from within a running pro- gram. Table 2-8 lists the routines that support this feature. In this mode TSX-Plus considers all characters to be activation characters except the digits, the comma, the dollar sign and the semicolon. RSRODT Reset normal activation mode. SETODT Set ODT activation mode. ODT activation mode support. Table 2-8. Performance Analysis Support For many applications the keyboard monitor level performance analysis control provided by TSX-Plus is adequate. Specifically, in cases such as analyzing the performance of an overlayed program it is necessary to have control over the performance analysis feature from the running program. The routines listed in Table 2-9 provide just this capability. INITPA Initialize for a performance analysis. ISPPA Stop a performance analysis. ISTPA Start a performance analysis. TERMPA Terminate from a performance analysis. Performance analysis support. Table 2-9. Real Time Program Support The real time program support provided by TSX-Plus allows multiple real time programs to be run concurrently with normal time sharing operations. The basic functions provided by this facility are listed in Table 2-10. A program must have operator privilege to use any of the real time routines. The real time facilities are available to both normal jobs con- trolled by time sharing lines and to detached jobs. Detached jobs started by time sharing users have operator privilege only if the user starting them does. A basic facility required by many real time programs is the ability to access the I/O page which contains the peripheral device registers. A normal time sharing job does not have this access. It is instead mapped to a simu- TSXLIB V5.1 PAGE 10 General Description lated RMON. This allows programs that directly access offsets into RMON to run correctly. CNVAPA Convert a virtual address to a physical address. IBICIO Bit clear a value into the I/O page. IBISIO Bit set a value into the I/O page. ICNINT Connect an interrupt vector to a completion routine. ICNRTN Connect a service routine to an interrupt vector. IPEKIO Peek at a value in the I/O page. IPOKIO Poke a value into the I/O page. IRLINT Release an interrupt vector connection. ITCRTN Trigger a completion routine from an interrupt service routine. IUNLKM Unlock a job from memory. LKANMY Lock a job into any memory. LKLOMY Lock a job into low memory. MPIOPS Map the I/O page into the program space. MPRGN Map a region of virtual memory to a specified region of physical memory. MPRMPS Map the simulated RMON into the program space. RLCTL Relinquish exclusive control of the system. STPRLV Set the user mode processor priority level. TKCTL Take exclusive control of the system. Real time program support. Table 2-10. A real time program can access the I/O page in one of two ways. It can map the I/O page into the program's space, or it can leave the simulated RMON mapped into the program's space and perform peek, poke, bit set, and bit clear operations into the I/O page. It is much more efficient to directly access the device registers by mapping the I/O page into the program's space than to use the routines to perform each individual access. However, this technique will not work if the program must also directly access offsets into RMON. The correct way to access offsets into RMON is with the SYSLIB routine, ISPY, which will work even if the I/O page is mapped into the pro- gram's space. The TSX-Plus real time support facility provides two methods to connect real time interrupts to TSX-Plus jobs. The first of these methods uses the mechanism of completion routines to perform the connection. The second method provides a more direct connection between interrupts and service routines in TSX-Plus jobs. Once a connection is established the routine, completion or service, is executed each time the specified interrupt occurs. It is possible for several interrupt vectors to be connected to the same com- pletion routine in a job but it is illegal for more than one job to connect to the same interrupt vector. With the first method an interrupt causes a completion routine to be queued for the job that was connected to the interrupt vector. This method is very general and allows the completion routine to call for system services (execute EMTs). Also the job does not have to be locked in memory. On entry to the completion routine, R0 contains the address of the vector that caused the completion routine to be entered. The second method sets up conditions for the job being called and enters the interrupt service routine. This approach minimizes the overhead in entering the service routine. Hence, the service routine method can process interrupts at a greater rate than can be processed using the completion routine method. There are restrictions imposed on a program using the service routine method. Specifically, the following conditions must be met to directly con- nect to an interrupt: 1. The job must be locked in memory before connecting it to the interrupt vector and must remain locked in memory as long as the interrupt connection is in effect. 2. The processing done by the service routine should not be very lengthy since other interrupts may be queued up during execution of the ser- vice routine. 3. Only two system services may be legally called from within the service routine. They are the SYSLIB routine, RESUME, and the TSXLIB TSXLIB V5.1 PAGE 11 General Description routine, ITCRTN. The interrupt service routine runs in user mode and uses memory mapping that has been established for the job before the interrupt occurs. Access to the I/O page via the MPIOPS routine is possible provided this mapping has been set up in the mainline code before the interrupt occurs. If an interrupt service routine needs to perform a system service other than the RESUME call listed above, it should trigger a completion routine via a call to ITCRTN and have the completion routine call for the required system service(s). An execution priority may be specified for each completion routine. This is not the same as the hardware selected priority of the interrupt. All completion routines are synchronized with the job and run at hardware priori- ty level zero. The completion routine priority is used to schedule completion routines for execution. The available priority levels are 0 through 127. The execution of a real time completion routine for one job will be interrupted and suspended if an interrupt occurs that causes a higher priority completion routine for another job to be queued for execution. However, a completion routine for a given job will never be interrupted to run another completion routine for the same job even if a higher priority completion routine is pending. Completion routine priorities one and larger are real time priorities. They are higher than the priorities given to time sharing jobs and will always preempt the time sharing jobs. Completion routine priority zero is not a real time priority but rather a very high normal priority. Such zero priority completion routines are time sliced in the normal fashion. If a completion routine enters a wait state it relinquishes its real time priori- ty. Jobs that have real time, interrupt driven completion routines need not be locked in memory. In time critical, real time applications where a program must respond to an interrupt with minimum delay, it may be necessary for the job to lock itself in memory to avoid the time consumed in program swapping. This facil- ity should be used with caution since if a number of large programs are locked in memory there may not be enough space left to run other programs. A running program may gain exclusive access to the system to perform some time-critical task. The program may then relinquish this exclusive access when it is not needed. A running program may also set the user mode priority level and map a region of virtual memory to a specified region of physical memory. Shared Run Time System Support TSX-Plus provides a facility that allows shared run time systems or data areas to be mapped into the address spaces of multiple time sharing jobs. Table 2-11 lists the routines that support this feature. IASRNT Associate/disassociate a shared run time system with a job. MAPRNT Map a shared run time system into a job's region. Shared run time system support. Table 2-11. Memory space can be conserved by having several jobs access a common copy of a run time system rather than having to allocate space within each job. Shared run time systems are never swapped out of memory. When a job is associated with a run time system, a portion of the job's virtual memory is mapped so as to allow access to the run time system. Shared File Support Table 2-12 lists the routines that offer access to the shared file record locking facility provided by TSX-Plus. This is useful in situations where programs being run from several terminals wish to update a common file. Through the record locking facility a program may gain exclusive access to one or more blocks in a shared file by locking those blocks. Other users attempting to lock the same blocks will be denied access until the first user releases the locked blocks. TSXLIB V5.1 PAGE 12 General Description ICKWTS Check for writes to a shared file. IDCLSF Declare a file to be shared. ISVST Save the status of a shared file. IUALBK Unlock all locked blocks. IUSPBK Unlock a specific block. LKBLK Try to lock a block. LKBLKW Wait for a block to lock. Shared file support. Table 2-12. The recommended procedure for updating a shared file being accessed by several users is as follows: 1. Open the file. 2. Declare the file to be shared. 3. Lock all blocks which contain the desired record. 4. Read the locked blocks into memory. 5. Update the record. 6. Write the updated blocks to the file. 7. Unlock the blocks. 8. Repeat steps three through seven as required. 9. Close the file. Special File Information TSX-Plus allows a running program to obtain certain status information about a file and to set the creation time of a file. Table 2-13 lists the routines that support this facility. IFLINF Obtain some information about a file. ISTFTM Set the creation time of a file. Special file information. Table 2-13. Spooler Support Table 2-14 lists the routines that provide spooler support available to an executing program. ISPBLK Determine the number of free blocks in the spool file. ISPCTL Control the release time of a spooled file. Spooler Support. Table 2-14. System Status Information Information typical of that returned by the SYSTAT keyboard command is made available to a running program by the routines listed in Table 2-15. ICONTM Determine the connect time for a job. ICPUTM Get the CPU time used by a job. IEXSTS Get a job's execution status. ILNSTS Check the status of a line. IPGNAM Get the name of the program being run by a job. IPPNUM Get the project-programmer number for a job. MEMPOS Determine the position of a job in memory. MEMUSE Determine the amount of memory used by a job. System status information. Table 2-15. Terminal Communications Support The routines that allow a running program to communicate with a terminal are listed in Table 2-16. TSXLIB V5.1 PAGE 13 General Description TRMIN Accept a string of characters from the terminal. TRMMSG Send a message to another terminal. TRMOUT Send a string of characters to the terminal. Terminal ãommunications support. Table 2-16. Terminal Control Support The terminal control support routines are listed in Table 2-17. BRKCTL Establish break sentinal control. HIEFOF Turn off the high efficiency terminal mode. HIEFON Turn on the high efficiency terminal mode. IACTCH Check for pending activation characters. ITRCTL Perform lead-in character type terminal control functions. ITRERR Check for terminal input errors. ITRTYP Determine the terminal type. TIMOUT Set the terminal read time out value. Terminal control support. Table 2-17. User Name Support An executing program may set and change the user name for the connected job. The routines for this facility are listed in Table 2-18. GTUNAM Get the user name associated with the current job. STUNAM set the user name assiciated with the current job. User name support. Table 2-18 TSXLIB V5.1 PAGE 14 Routine Descriptions 3. Routine Descriptions This section presents all of the TSX-Plus routines in alphabetical order and provides a detailed description of each one. The FORTRAN calling sequence and where appropriate an example of each call in a FORTRAN program is given. The user should be thoroughly familiar with the general description of this TSX-Plus library given in the previous section of this document. Additional information is available in the "TSX-Plus Reference Manual" [1] and the "RT-11 Programmer's Reference Manual" [5]. Some of these TSXLIB routines require calls to various SYSLIB routines. In the following descriptions, arguments enclosed in square brackets, [], are optional. BRKCTL This routine is used to declare a completion routine that will be trig- gered when the BREAK key or a declared key on the terminal is pressed. The calling sequence is: CALL BRKCTL ( IBRKCH,CPLRTN ) where: IBRKCH is the value of the character that is to be used for the break control. CPLRTN is the name of the completion routine to be executed when the break character is pressed. The specified completion routine will be entered when either the BREAK key or the declared key is pressed. If no declared key is wanted specify a value of zero for IBRKCH. On some systems the console terminal BREAK key causes entry into console ODT and for this reason requires a declared key value. Only one break routine may be specified at a time for each user. If a break routine was previously specified, it is cancelled when a new break routine is declared. If a value of zero is specified for the name of the completion routine, CPLRTN, any previously specified break routine is can- celled. The following example first declares the completion routine as an external, then establishes break sentinel control using the letter H, and later cancells the control. EXTERNAL CPLRTN IBRKCH = 72 . . CALL BRKCTL ( IBRKCH,CPLRTN ) . . CALL BRKCTL ( 0,0 ) . . CNVAPA This routine is used to convert a virtual address into a physical address. This is necessary when controlling devices that do direct memory access transfers. The program should lock itself into memory before execut- ing this routine. The calling sequence is as follows: CALL CNVAPA ( IVADR,IPADR [ ,IERR ] ) where: IVADR is the virtual address that is to be converted. TSXLIB V5.1 PAGE 15 Routine Descriptions IPADR is the name of the two element buffer into which the physical address is to be returned. IERR is negative or the following: 0 real time support is not available or this job does not have operator privilege. The low order sixteen bits of the physical address are returned in the first element of the buffer, IPADR, and the high order bits of the physical address are returned in bit positions four through nine of the second element of the buffer. The following example first locks itself into memory then converts a virtual address to a physical address. The program is halted if the error condition is returned. DIMENSION IPADR ( 2 ) CALL LKANMY CALL CNVAPA ( "54720,IPADR,IERR ) IF ( IERR .EQ. 0 ) STOP . . DISMNT This routine is used to dismount a file structured device. This causes TSX-Plus to stop doing directory caching of the device. The effect of this routine is the same as the TSX-Plus DISMOUNT keyboard command. The calling sequence is as follows: CALL DISMNT ( IDVNAM ) where: IDVNAM is the RAD50 value of the file structured device name. The following example uses the SYSLIB routine, IRAD50, to convert the ASCII value of the device name, DL:, to its RAD50 value. It then mounts the device and later dismounts it. CALL IRAD50 ( 3,'DL ',IDVNAM ) CALL MOUNT ( IDVNAM ) . . CALL DISMNT ( IDVNAM ) . . GETREG This routine is used to get the word and byte values stored in the specified processor register. The calling sequence is as follows: CALL GETREG ( IREG,IRET,IERR ) where: IREG is the number of the processor register in the range of zero to three whose values are to be returned. IRET is a three-element integer array that is to receive the values returned. The first element receives the word value stored in the specified processor register. The second ele- ment receives the low byte value and the third element receives the high byte value. IERR is one of the following: 0 no error. 1 an invalid processor register number was specified. The following eaxmple returns the values stored in processor register one. DIMENSION IRET(3) TSXLIB V5.1 PAGE 16 Routine Descriptions . . CALL GETREG (1,IRET,IERR) . . GTUNAM This routine is used to get the user name associated with the current job. The calling sequence is as follows: CALL GTUNAM ( USRNAM ) where: USRNAM is the name of the twelve-character array that is to receive the user name ASCII string. The following example declares the byte array and then gets the user name. LOGICAL*1 USRNAM(18) CALL GTUNAM ( USRNAM ) . . HIEFOF This routine is used to turn the high efficiency terminal mode off. The calling sequence in as follows: CALL HIEFOF The following example first turns high efficiency terminal mode on and later turns it off. CALL HIEFON . . CALL HIEFOF . . HIEFON This routine is used to turn the high efficiency terminal mode on. The calling sequence is as follows: CALL HIEFON TSX-Plus offers a high efficiency mode of terminal operation that elimi- nates a substantial amount of system overhead for terminal character processing by reducing the amount of processing that is done on each character. When in high efficiency mode, characters are sent directly to the terminal with minimum handling by TSX-Plus. Operations such as expanding tabs to spaces and form feeds to line feeds are omitted as well as input pro- cessing such as echoing characters and recognizing control characters such as rubout, control-U and control-C. The only characters treated specially on input are user defined activation characters and the user specified break character. At least one user specified activation character must be declared if high efficiency mode is to be used. This form of terminal I/O is designed to facilitate high speed machine to machine communication. It can be used effectively with buffered mode terminals. IACTCH This routine is used to determine if any activation characters have been received by the line but not yet accepted by the program. The calling sequences are as follows: CALL IACTCH ( IRET ) or IRET = IACTCH () TSXLIB V5.1 PAGE 17 Routine Descriptions where: IRET is one of the following: 0 no activation character is pending. 1 at least one activation character is pending. IALOC This routine is used to allocate a device for the exclusive use of a job. The calling sequence is as follows: CALL IALOC ( DEVPTR,IRET,IERR ) where: DEVPTR is the name of the four element integer array which contains the device name in RAD50 form in the first element and zeros in the other three elements. IRET is undefined or the number of the job to which the device is currently allocated if IERR = 1. IERR is negative or one of the following: 1 the device is already allocated to another user. 2 an invalid device has been specified. 3 the device allocation table is full. 4 the device is currently being used by another user. The following example sets up for and allocates a device. If the device is already allocated or busy, the program loops back for another try. If any other error condition prevails, the program aborts. INTEGER DEVPTR(4) DATA DEVPTR /3RDY1,0,0,0/ . . 100 CONTINUE CALL IALOC ( DEVPTR,IRET,IERR ) IF ( IERR .LMT. 0 ) GO TO 110 IF ( IERR .EQ. 1 ) GO TO 100 IF ( IERR .EQ. 2 ) STOP IF ( IERR .EQ. 3 ) STOP IF ( IERR .EQ. 4 ) GO TO 100 110 CONTINUE . . IASRNT This routine is used to associate a shared run time system with a job. It is also used to disassociate all shared run time systems from a job. The calling sequences are as follows: CALL IASRNT ( IRNTIM [ ,IERR ] ) or IERR = IASRNT ( IRNTIM ) where: IRNTIM is the six character RAD50 value of the name of the shareable run time system. IERR is one of the following: 0 no error. 1 run time system name not recognized. The effect of this routine is to associate a particular shareable run time system with the job. However, this routine does not affect the memory mapping for the job or make the run time system visible to the job. That is done by the MAPRNT routine described later. If some other run time system has been previously mapped into the job's region, that mapping is unaffected TSXLIB V5.1 PAGE 18 Routine Descriptions by this routine. Thus it is possible to have multiple run time systems mapped into the job's region by associating and mapping them one at a time into different regions of the job's virtual memory space. If the name pointer, IRNTIM, is set to zero, this routine causes all run time systems to become disassociated from the job and reestablishes normal memory mapping for the job. The following example uses the SYSLIB routine, IRAD50, to declare the name of the run time system and then associates it with the job. If the error condition is returned the program is halted. DIMENSION IRNTIM ( 2 ) CALL IRAD50 ( 6,'TSXLIB',IRNTIM ) IERR = IASRNT ( IRNTIM ) IF ( IERR .EQ. 1 ) STOP . . IBICIO This routine is used to perform a bit clear operation into a word in the I/O page without requiring the job's virtual address region to be mapped to the I/O page. The calling sequences are as follows: CALL IBICIO ( IADR,IVAL [ ,IERR ] ) or IERR = IBICIO ( IADR,IVAL ) where: IADR is the address of the word in the I/O page to be accessed. IVAL is the value to be bit cleared into the I/O page. IERR is negative or the following: 0 real time support is not available or this job does not have operator privilege. The following example bit clears a value in the register at the octal address 176500 in the I/O page. The program is stopped if the error condi- tion is returned. IERR = IBICIO ( "176500,"100 ) IF ( IERR .EQ. 0 ) STOP . . IBISIO This routine is used to perform a bit set operation into a word in the I/O page without requiring the job's virtual address region to be mapped to the I/O page. The calling sequences are as follows: CALL IBISIO ( IADR,IVAL [ ,IERR ] ) or IERR = IBISIO ( IADR, IVAL ) where: IADR is the address of the word in the I/O page to be accessed. IVAL is the value to be bit set into the I/O page. IERR is negative or the following: 0 real time support is not available or this job does not have operator privilege. The following example bit sets a value into the register at the octal address 176500 in the I/O page. The program is stopped if the error condi- tion returns. IERR = IBISIO ( "176500,"100 ) IF ( IERR .EQ. 0 ) STOP . TSXLIB V5.1 PAGE 19 Routine Descriptions . IBSTCH This routine is used to broadcast a status change to all jobs that are monitoring the status of the broadcasting job. The calling sequences are as follows: CALL IBSTCH ( IVAL [ ,IERR ] ) or IERR = IBSTCH ( IVAL ) where: IVAL is the 16-bit status code value that is to be broadcast. IERR is negative or the following: 0 no jobs are monitoring the job making this call. On entry to the completion routine in the monitoring job(s), the status value is in processor register R1, the number of the job issuing this call is in the low-order byte of R0, and the high-order bit of R0 is set to one. The GETREG routine may be used to recover the values stored in R0 and R1. In the following example the job aborts if no other job is monitoring its status. IERR = IBSTCH ( IVAL ) IF ( IERR .EQ. 0 ) STOP . . ICALOC This routine is used to check the allocation status of a device. The calling sequence is as follows: CALL ICALOC ( DEVPTR,JBNUM,IRET ) where: DEVPTR is the name of the four element integer array which contains the device name in RAD50 form in the first element and zeros in the other three elements. JBNUM is undefined or the number of the job to which the device is currently allocated if IRET = 1. IRET is negative or one of the following: 1 the device is already allocated to another user. 2 an invalid device has been specified. 4 the device is currently being used by another user. In the following example, the program aborts if an invalid device has been specified. INTEGER DEVPTR(4) DATA INTEGER /3RMT3,0,0,0/ . . CALL ICALOC ( DEVPTR,JBNUM,IRET ) IF ( IRET .EQ. 2 ) STOP . . ICKWTS This routine is used to determine if any other user has written to a shared file. The calling sequences are as follows: TSXLIB V5.1 PAGE 20 Routine Descriptions CALL ICKWTS ( ICHAN [ ,IRET ] ) or IRET = ICKWTS ( ICHAN ) where: ICHAN is the I/O channel open to the shared file. IRET is one of the following: 0 no writes have been performed. 2 writes have been performed. This routine can be used to advantage in a situation where data from some block in the file is being held in a buffer and it is desired to deter- mine if the data is valid or if it may be invalid because some other user might have altered it by writing to the file. The following example opens a file, declares the file to be shared and then checks for writes to the shared file. If writes have been performed to the file the program is halted. CALL ASSIGN ( 33,'RK3:THIS.DAT' ) ICHAN = ( 33 ) CALL IDCLSF ( ICHAN,5 ) . . IERR = ICKWTS ( ICHAN ) IF ( IERR .EQ. 2 ) STOP . . ICNINT This routine is used to connect a completion routine to an interrupt vector. The calling sequences are as follows: CALL ICNINT ( IVEC,CPLRTN,IPRI [ ,IERR ] ) or IERR = ICNINT ( IVEC,CPLRTN,IPRI ) where: IVEC is the interrupt vector address. CPLRTN is the six ASCII character name of the completion routine. IPRI is the priority for the completion routine in the range of 0 to 127. IERR is negative or one of the following: 0 real time support is not available or this job does not have operator privilege. 1 the maximum number of interrupts are already in use. 2 some other job is already connected to this interrupt vector. The vector remains connected to the completion routine until the program terminates or until the routine, IRLINT, is executed. On entry to the com- pletion routine, R0 contains the address of the vector that caused the completion routine to be executed. The GETREG routine may be used to obtain the value stored in R0. The following example declares the completion routine as an external and connects an interrupt vector to the completion routine. The program is halt- ed if an error condition is returned. EXTERNAL CPLRTN IERR = ICNINT ( "320,CPLRTN,3 ) IF ( IERR .GE. 0 ) STOP . . TSXLIB V5.1 PAGE 21 Routine Descriptions ICNMCN This routine is used to cancel the job monitoring connection(s) for the calling job. The calling sequences are as follows: CALL ICNMCN ( JBNUM [ ,IERR ] ) or IERR = ICNMCN ( JBNUM ) where: JBNUM is the number of the job for which status monitoring is to be calcelled. If JBNUM = zero, all job status monitoring requests for the job making this call are cancelled. IERR is negative or the following: 1 an invalid job number was specified. All job monitoring requests issued by a job are cancelled by the system when the job terminates, chains, or issues either a hard or soft reset request. The following example program aborts if an invalid job number is specified. CALL ICNMCN ( JBNUM,IERR ) IF ( IERR .EQ. 1 ) STOP . . ICNRTN This routine is used to connect a service routine to an interrupt vec- tor. The calling sequences are as follows: CALL ICNRTN ( IVEC , SVCRTN , 0 [ , IERR ] ) or IERR = ICNRTN ( IVEC , SVCRTN, 0 ) where: IVEC is the interrupt vector address. SVCRTN is the six ASCII character name of the service routine. IERR is negative or one of the following: 0 real time support is not available or this job does not have operator privilege. 1 no interrupt control blocks are available 2 some other job is connected to the vector. 3 the job is not locked in memory. The vector remains connected to the service routine until the program terminates or until the routine, IRLINT, is executed. The only system ser- vices (EMTs) permissible from within the service routine are the SYSLIB routine, RESUME, and the TSXLIB routine, ITCRTN. If other system services are required, they must be called from a completion routine which has been triggered by ITCRTN. The "0" argument is required. The following example declares the service routine as an external, locks the job in memory, and then connects an interrupt vector to the service routine. The program is halted if an error condition is returned. EXTERNAL SVCRTN IERR = ICNRTN ( IVEC,SVCRTN,IZERO ) CALL LKANMY IF ( IERR .GE. 1 ) STOP . . TSXLIB V5.1 PAGE 22 Routine Descriptions ICNTSP This routine is used to set the transmit/receive speed or baud rate of a of a communication or timesharing line. The calling sequence is as follows: CALL ICNTSP ( LINUM,ISPCD ) where: LINUM is the number of the line for which the speed is to be con- trolled. If the line number is zero, the speed is set for the line on which the calling program is executing. ISPCD is one of the following: 0 50 baud. 1 75 baud. 2 110 baud. 3 134.5 baud. 4 150 baud. 5 300 baud. 6 600 baud. 7 1200 baud. 8 1800 baud. 9 2000 baud. 10 2400 baud. 11 3600 baud. 12 4800 baud. 13 7200 baud. 14 9600 baud. 15 19200 baud. Operator privilege is required to change the speed of a line other than the one on which the calling program is running. This routine is only func- tional for lines connected to hardware controllers that support programmable baud rates. The following example sets the speed of the line on which the program is running to 9600 baud. CALL ICNTSP ( 0,14 ) . . ICONTM This routine is used to return the connect time of a job to the calling program. The calling sequence is as follows: CALL ICONTM ( LINUM,IRET [ ,IERR ] ) where: LINUM is the TSX-Plus line for which connect time is to be returned. IRET is the returned connect time in minutes. IERR is negative or one of the following: 0 line is not currently logged on. 2 invalid line number. TSXLIB V5.1 PAGE 23 Routine Descriptions In the following example the connect times of the logged on lines are returned in the variable, IRET. LINUM = 0 10 CONTINUE LINUM = LINUM + 1 CALL ICONTM ( LINUM,IRET,IERR ) IF ( IERR .EQ. 0 ) GO TO 10 IF ( IERR .EQ. 2 ) GO TO 20 . . GO TO 10 20 CONTINUE ICPUTM This routine is used to return a job's CPU time to the calling program. The calling sequence is as follows: CALL ICPUTM ( LINUM,ITIME [ ,IERR ] ) where: LINUM is the TSX-Plus line for which CPU time is to be returned. ITIME is the CPU time returned in clock ticks. IERR is negative or one of the following: 0 line is not currently logged on. 2 invalid line number. The variable, ITIME, is a two element array where the first element will receive the high order 16 bits and the second element will receive the low order 16 bits of the CPU time returned. The CPU time of line five is returned in the following example. The program aborts if an error condition prevails. DIMENSION ITIME(2) . . CALL ICPUTM ( 5,ITIME,IERR ) IF ( IERR .GE. 0 ) STOP . . IDALOC This routine is used to deallocate a device. The calling sequence is as follows: CALL IDALOC ( DEVPTR,IRET,IERR ) where: DEVPTR is the name of the four element integer array which contains the device name in RAD50 form in the first element and zeros in the other three elements. IRET is undefined or the number of the job to which the device is currently allocated if IERR = 1. IERR is negative or one of the following: 1 the device is already allocated to another user. 2 an invalid device has been specified. The following example program aborts if the device is allocated to another user. INTEGER (4) DATA /3RDX0,0,0,0/ . . TSXLIB V5.1 PAGE 24 Routine Descriptions CALL IDALOC ( DEVPTR,IRET,IERR ) IF ( IERR .EQ. 1 ) STOP . . IDCLSF This routine is used to declare an open file to be shared. The calling sequences are as follows: CALL IDCLSF ( ICHAN,IACES [ ,IERR ] ) or IERR = IDCLSF ( ICHAN,IACES ) where: ICHAN is the I/O channel number open to the shared file. IACES is one of the following protection/access codes: 0 exclusive/input. 1 exclusive/update. 2 protected/input. 3 protected/update. 4 shared/input. 5 shared/update. IERR is one of the following: 0 no error. 1 the I/O channel has not been opened to a file. 2 attempted to open too many channels to shared files. 3 attempted to open too many shared files. 4 a file protection/access conflict exists. The protection/access code specifies two things, the type of protection (exclusive, protected, shared) that you are claiming on your use of the file and the type of access (input or update) that you intend to make to the file. Exclusive protection means that you require exclusive access to the file and will allow no other users to access the file in any fashion. Protected pro- tection means that you will allow other users to open the file for input but wish to prohibit any from opening the file for update. Shared protection means that you are willing to allow other users to open the file for both input and update. The following example opens a file and then declares exclusive/update protection/access. If an error condition is returned the program aborts. CALL ASSIGN ( 40,'DK:FILE.DAT' ) ICHAN = ILUN ( 40 ) IERR = IDCLSF ( ICHAN,2 ) IF ( IERR .NE. 0 ) STOP . . IESMCN This routine is used to establish a job monitoring connection between the calling job and another job. The calling sequences are as follows: CALL IESMCN ( JBNUM,CPLRTN [ ,IERR ] ) or IERR = IESMCN ( JBNUM,CPLRTN ) where: JBNUM is the number of the job to be monitored. TSXLIB V5.1 PAGE 25 Routine Descriptions CPLRTN is the name of the completion routine to be entered when the status of the monitored job changes. IERR is negative or one of the following: 1 an invalid job number was specified. 2 there are no free job monitoring control blocks avail- able. The specified completion routine will be entered each time the status of the monitored job changes or the monitored job broadcasts a status change. On entry to the completion routine, the low-order byte of processor register R0 contains the number of the job whose status change is being reported. The high-order bit of R0 is zero if the status report was generated by the system and is one if the status report was generated by a program broadcasting a status change. The status value is contained in processor register R1. The values stored in R0 and R1 may be recovered with the GETREG routine. The system generated status values are listed below: 1 The job has been initialized. 2 The job logged on using the LOGON program. 3 The job began running a program. 4 The job returned control to KMON. 5 The job has logged off. The following example program establishes a job status monitoring con- nection. If there are no control blocks available, it loops back for another try. The program aborts if an invalid job number has been specified. EXTERNAL CPLRTN . . 100 CONTINUE IERR = IESMCN ( JBNUM,CPLRTN ) IF ( IERR .EQ. 2 ) GO TO 100 IF ( IERR .EQ. 1 ) STOP . . IEXSTS This routine is used to return the execution state of a TSX-Plus line. The calling sequence is as follows: CALL IEXSTS ( LINUM,ISTAT [ ,IERR ] ) where: LINUM is the number of the line for which execution state is returned. ISTAT is the one of the following execution state values: 1 high priority run state. 2 normal priority run state. 3 low priority run state. 4 waiting for terminal input. 5 waiting to write terminal output. 6 doing a timed wait. 7 suspended by SUSPND or .SPND. 8 waiting to access a shared file. 9 waiting for a message. TSXLIB V5.1 PAGE 26 Routine Descriptions 10 waiting for access to the USR. 11 waiting for I/O to finish. 12 waiting to access spool file. IERR is negative or one of the following: 0 line is not currently logged on. 2 invalid line number. The program in the following example halts if line 2 is doing a timed wait. CALL IEXSTS ( LINUM,ISTAT ) IF ( ISTAT .EQ. 6 ) STOP . . IFLINF This routine obtains some information about a file. The calling sequence is as follows: CALL IFLINF ( ICHAN , IDEV , INFO [ , IERR ] ) where: ICHAN is a channel number in the range of zero through sixteen that is currently not in use. IDEV is the name of a four-word array that contains the file specification in RAD50. INFO is the name of the seven-word array that is to receive the following information about the file: Word 1 is the number of 512-byte blocks contained in the file. Word 2 is zero of the file is not protected, or one if the file is protedted. Word 3 is the creation date of the file in RT-11 internal format. Word 4 is the creation time of the file in three-second units. Word 5 is the starting block number of the file. Word 6 is reserved. Word 7 is reserved. IERR is negative or one of the following 0 The channel is currently in use. 1 Unable to locate the specified file. 2 The specified device is not file structured. The following example obtains the information about the file, DY1:STUFF.DAT. DIMENSION IDEV(4),INFO(7) ICHAN = IGETC () CALL IRAD50 ( 12,'DY1STUFF DAT',IDEV) 100 CONTINUE CALL IFLINF ( ICHAN,IDEV,INFO,IERR ) IF ( ICHAN .GT. 16 ) STOP 'No channels' IF ( IERR .GT. 0 ) STOP 'IFLINF error' . . TSXLIB V5.1 PAGE 27 Routine Descriptions IHERR This routine is used to restore monitor interception of certain soft error conditions. It must be called at some point following a call to ISERR. The calling sequence is as follows: CALL IHERR ILNSTS This routine is used to return information about the status of a line. The calling sequence is as follows: CALL ILNSTS ( LINUM,IRET [ ,IERR ] ) where: LINUM is the TSX-Plus line for which status information is returned. IRET is the value returned and contains bit-flags that indicate the status for the line. The following bit-flags are defined: 000000 physical line. 000001 virtual line. 000002 detached job line. 000100 job is locked in memory. 000200 job has operator privilege. IERR is negative or one of the following: 0 line is not currently logged on. 2 invalid line number. The program in the example below stops if the line number is invalid. CALL ILNSTS ( LINUM,IRET,IERR ) IF ( IERR .EQ. 2 ) STOP . . INITPA This routine is used to set up parameters that will control a perfor- mance analysis. It does not actually begin the analysis. The calling sequences are as follows: CALL INITPA ( IBSADR,ITPADR,ICLSZ,IFLAG [ ,IERR ] ) or IERR = INITPA ( IBSADR,ITPADR,ICLSZ,IFLAG ) where: IBSADR is the base address of the region to be monitored. ITPADR is the top address of the region to be monitored. ICLSZ is the number of bytes to group into each histogram cell. IFLAG is one of the following: 0 do not include I/O wait time. 1 include I/O wait time. IERR is negative or one of the following: 0 performance analysis is already in use. 1 performance analysis feature is not included in this version of TSX-Plus. TSXLIB V5.1 PAGE 28 Routine Descriptions The following example initializes for a performance analysis. The pro- gram aborts if an error condition is returned. IERR = INITPA ( "2000,"5400,"100,0 ) IF ( IERR .GE. 0 ) STOP . . IPEKIO This routine is used to access or peek at a word in the I/O page without requiring the job's virtual address region to be mapped to the I/O page. The calling sequence is as follows: CALL IPEKIO ( IADR,IRET [ ,IERR ] ) where: IADR is the address of the word in the I/O page that is to be accessed. IRET is the value returned from the I/O page. IERR is negative or the following: 0 real time support is not available or this job does not have operator privilege. The following example obtains the value from the register at octal address 176502 in the I/O page. The program is aborted if the error condi- tion is returned. CALL IPEKIO ( "176502,IRET,IERR ) IF ( IERR .EQ. 0 ) STOP . . IPGNAM This routine is used to return the name of the program being executed by a TSX-Plus line. The calling sequence is as follows: CALL IPGNAM ( LINUM,PGNAME [ ,IERR ] ) where: LINUM is the number of the line executing the returned program name. PGNAME is the two-word variable into which the RAD50 value of the program name is returned. IERR is negative or one of the following: 0 line is not currently logged on. 2 invalid line number. The SYSLIB routine R50ASC is used to convert the returned program name to an ASCII string in the following example. LOGICAL*1 STRING(8) . . CALL IPGNAM ( LINUM,PGNAM,IERR ) IF ( IERR .GE. 0 ) STOP CALL R50ASC ( 6,PGNAM,STRING ) IPOKIO This routine is used to deliver a value into a word in the I/O page without requiring the job's virtual address region to be mapped to the I/O page. The calling sequences are as follows: TSXLIB V5.1 PAGE 29 Routine Descriptions CALL IPOKIO ( IADR,IVAL [ ,IERR ] ) or IERR = IPOKIO ( IADR,IVAL ) where: IADR is the address of the word in the I/O page to be accessed. IVAL is the value to be deposited in the I/O page. IERR is negative or the following: 0 real time support is not available or this job does not have operator privilege. The following example pokes a value into the register at octal address 176506 in the I/O page. The program stops if the error condition is returned. IERR = IPOKIO ( "176506,"101 ) IF ( IERR .EQ. 0 ) STOP . . IPPNUM This routine is used to return the project and programmer numbers for a TSX-Plus line. The calling sequence is as follows: CALL IPPNUM ( LINUM,IBUF [ ,IERR ] ) where: LINUM is the number of the line for which the project and pro- grammer numbers are returned. IBUF is the two word array into which the project and programmer numbers are returned. The first word contains the project number and the second word contains the programmer number. IERR is negative or one of the following: 0 line is not currently logged on. 2 invalid line number. The program in the following example stops if an error condition is encountered. DIMENSION IBUF(2) . . CALL IPPNUM ( LINUM,IBUF,IERR ) IF ( IERR .GE. 0 ) STOP . . IRDRCL This routine is used to redirect a dedicated communication line, CL unit, or a timesharing line. The calling sequences are as follows: CALL IRDRCL ( ICLNO,LINUM [ ,IERR ] ) or IERR = IRDRCL ( LCLNO,LINUM ) where: ICLNO is the dedicated communication line number, CLn. LINUM is the number of the timesharing line or the dedicated com- munication line. IERR is negative or one of the following: 1 the user making this call does not have operator privilege. 2 an invalid CL unit number, ICLNO, was specified. TSXLIB V5.1 PAGE 30 Routine Descriptions 3 an invalid line number, LINUM, was specified. 4 the specified line number, LINUM, is already assigned to a CL unit. 5 a timesharing user is logged onto the specified line number, LINUM. 6 the specified CL unit, ICLNO, is currently in use. The following sample program aborts if an error is returned when it attempts to redirect CL3 to line number 9. CALL IRDRCL ( 3,9,IERR ) IF ( IERR .GT. 0 ) STOP . . IRLINT This routine releases the connection of an interrupt vector and a com- pletion routine or a service routine. The connection must have been made by previously executing the routine, ICNINT or ICNRTN. The calling sequences are as follows: CALL IRLINT ( IVEC [ ,IERR ] or IERR = IRLINT ( IVEC ) where: IVEC is the interrupt vector address. IERR is negative or the following: 0 real time support is not available or this job does not have operator privilege. The following example first declares the completion routine as an external, then connects it to a vector, and finally breaks the connection. EXTERNAL CPLRTN CALL ICNINT ( "320,CPLRTN,0 ) . . CALL IRLINT ( "320 ) . . ISERR This routine is used to permit a running program to intercept certain soft error conditions. These conditions may occur only on the execution of other TSXLIB and SYSLIB routines. Execution of ISERR must at some point be followed by execution of IHERR. The calling sequence is as follows: CALL ISERR The following soft error codes may be returned on execution of other TSXLIB and SYSLIB routines: -1 Called "USR" from a completion routine. -2 No device handler; this operation needs one. -3 Error doing directory I/O. -4 ".FETCH" error. Either an I/O error occurred while the handler was being used, or an attempt was made to load the handler over "USR" or "RMON". (RT-11 only) -5 Error reading an overlay. -6 No more room for files in the directory. TSXLIB V5.1 PAGE 31 Routine Descriptions -7 Illegal address ("FB" only); tried to perform a monitor opera- tion outside the job partition. (RT-11 only) -8 Illegal channel number. Number is greater than actual number of channels that exist. -9 Illegal "EMT"; an illegal function code has been decoded. The example below tests for the existance of a handler for the logical device named DEV. DIMENSION IDVBLK(4) DATA IDVBLK /0,0,0,0/ . . CALL ISERR I = LOOKUP( ICHAN,IDVBLK) IF ( IDVBLK .EQ -2 ) STOP 'NO HANDLER' . . CALL IHERR ISPBLK This routine is used to determine the number of free blocks in the spool file. The calling sequences are as follows: CALL ISPBLK ( IRET ) or IRET = ISPBLK () where: IRET is the number of free blocks in the spool file. ISPCTL This routine is used to control the release time of a spooled file. The calling sequence is as follows: CALL ISPCTL ( ICHAN , IFLAG ) where: ICHAN is the number of the channel that is open to the file. IFLAG is an integer value as follows: 0 release the file immediately. 1 hold the release until the file is closed. This routine must be called after the file has been opened and before any data is written to the file. If the channel is open to a non-spooled device, the call is treated as a no-operation. The following example causes the file to be written to the spooled line printer to be released immediately. OPEN ( UNIT=30,NAME=LP: ) ICHAN = ILUN ( 30 ) CALL ISPCTL ( ICHAN,1 ) . . ISPPA This routine is used to suspend the collection of data for a perfor- mance analysis. The data collection can be restarted by using the ISTPA routine described later. The calling sequences are as follows: CALL ISPPA [ IERR ] or IERR = ISPPA () where: IERR is negative or the following: TSXLIB V5.1 PAGE 32 Routine Descriptions 0 performance analysis has not been previously initialized. The following example initializes for a performance analysis, then starts and stops the collection of data for the analysis within a loop. CALL INITPA ( "2000,"5400,"100,0 ) DO 10 I = 1,53 CALL ISTPA . . CALL ISPPA . . 10 CONTINUE . . ISPY This is a SYSLIB routine that is used to return the value located at a specific offset into the simulated RMON. TSX-Plus has extended it to return several TSX-Plus values. Refer to the "RT-11 Programmer's Reference Manual" [5] for information on getting values from within the simulated RMON. The calling sequence is as follows: IRET = ISPY ( IOFFST ) where: IRET is the integer value returned. IOFFST is the integer offset into the simulated RMON or to return a TSX-Plus value is one of the following: -2 job number. -4 lead-in character used for terminal controlled options. -6 zero if job is nonprivileged or one if privileged. -8 zero if PAR 7 is mapped to the simulated RMON or one if PAR 7 is mapped to the I/O page. -10 project number job is logged on under. -12 programmer number job is logged on under. -14 TSX-Plus license number. -16 get the job's priority level. -18 get the job's maximum allowable priority level. -20 the number of blocks per job in the file UCL.TSX. -22 get the job number of the primary line (0 if this is the primary line). -24 get the name of the physical SY: device. -26 Value of the PRILOW sysgen parameter. -28 Value of the PRIHI sysgen parameter. The following example aborts if the job is not privileged. IRET = ISPY ( -6 ) IF ( IRET .EQ. 0 ) STOP . . TSXLIB V5.1 PAGE 33 Routine Descriptions ISTDJ This routine is used to check the status of a detached job. The cal- ling sequences are as follows: CALL ISTDJ ( JOBNUM,ISTAT ) or ISTAT = ISTDJ ( JOBNUM ) where: JOBNUM is the job number of the detached job. ISTAT is one of the following: 0 the job is not active. 1 the job is active. The following example starts a detached job then checks the detached job's status until the job becomes inactive. CALL STDTJB ( JOBNAM, JOBNUM ) 10 CONTINUE ISTAT = ISTDJ ( JOBNUM ) IF ( ISTAT .NE. 1 ) GO TO 10 . . ISTFTM This routine is used to set the creation time for a file. The calling sequences are as follows: CALL ISTFTM ( ICHAN , IDEV , ITIME [ , IERR ] ) or IERR = ISTFTM ( ICHAN , IDEV , ITIME ) where: ICHAN is a channel number in the range of zero through sixteen that is currently not in use. IDEV is the name of the four-word array containing the file specification in RAD50. ITIME is an integer time value in three-second units since mid- night. IERR is negative or one of the following. 0 the channel is currently in use. 1 unable to locate the specified file. 2 the specified device is not file structured. The following example sets the creation time for the file, NICKS.DAT, at 300 three-second units past midnight. DIMENSION IDEV(4) DATA ICHAN,ITIME /0,300/ CALL IRAD50 ( 12,DM4NICKS DAT,IDEV) 100 CONTINUE IERR = ISTFTM ( ICHAN,IDEV,ITIME ) IF ( ICHAN .GT 16 ) STOP 'No channels' IF ( IERR .EQ. 0 ) GO TO 100 IF ( IERR .GT. 0 ) STOP 'ISTFTM error' . . ISTPA This routine is used to begin the actual collection of performance analysis data. The INITPA routine must have been executed to set up parame- ters about the performance analysis before this routine is called. The calling sequences are as follows: TSXLIB V5.1 PAGE 34 Routine Descriptions CALL ISTPA [ IERR ] or IERR = ISTPA () where: IERR is negative or the following: 0 performance analysis has not been initialized. The following example initializes for and starts a performance analysis. The program is halted if the error condition is returned from the call to ISTPA. CALL INITPA ( "2000,"5400,"100,0 ) IERR = ISTPA () IF ( IERR .EQ. 0 ) STOP . . ISTPRV This routine is used to set the priority value for the current job. The calling sequence is as follows: CALL ISTPRV ( IPRVAL ) where: IPRVAL is an integer priority value in the range of 0 through 99. ISVST This routine is used to save the status of a shared file. The effect of this routine is to suspend the connection between the shared file table and the I/O channel. Any blocks that are locked in the file remain locked until the channel is reopened to the file by using the SYSLIB routine, IREOPN. After return from this routine the channel may be freed by using the SYSLIB routine, PURGE. The calling sequence is as follows: CALL ISVST ( ICHAN ) where: ICHAN is the I/O channel number open to the shared file. When using a single channel number to access several shared files it is for each file convenient to initially open the file, declare the file to be shared and to save the status of the file with the SYSLIB routine, ISAVES. The channel being used to access the set of files can then be switched from one file to another with the SYSLIB routines, PURGE and IREOPN. However, before doing the PURGE, TSX-Plus must be told that you wish to save the shared file status of the file (otherwise all locked blocks will be unlocked and the file will be removed from the shared file list). The following example opens a file, declares it to be shared and then saves the status of the file for TSX-Plus. CALL ASSIGN ( 30,'DK:SOME.FIL' ) ICHAN = ILUN ( 30 ) CALL IDCLSF ( ICHAN,4 ) . . CALL ISVST ( ICHAN ) . . ITCRTN This routine is used to trigger a completion routine from within an interrupt service routine. The calling sequence is as follows: CALL ITCRTN ( CPLRTN , IPRI , ID , 0 ) where: CPLRTN is the six ASCII character name of the completion routine. IPRI is the execution priority for the completion routine in the range of zero to seven. TSXLIB V5.1 PAGE 35 Routine Descriptions ID is an integer value passed to the completion routine. The service routine that calls this ITCRTN must have been connected to an interrupt vector by executing the ICNRTN routine. The "0" argument is required. The following example declares the completion routine as an external and then triggers its execution. EXTERNAL CPLRTN CALL ITCRTN ( CPLRTN,IPRI,ID,IZERO ) . . ITRCTL This routine is used to perform all of the terminal control functions that can be performed using the "lead-in" character method. The calling sequence is as follows: CALL ITRCTL ( IFUN , IARG ) where: IFUN is an integer value that corresponds to the ASCII code for the desired function in the ranges of 65 through 70 (A-F) and 72 through 90 (H-Z). IARG is zero or an integer value as required by some functions. The following example declares the slash character (/) to be an activa- tion character. DATA IFUN,IARG /"000104,"000057/ . . CALL ITRCTL ( IFUN,IARG ) . . ITRERR This routine is used to determine if any terminal input errors have occurred. The calling sequences are as follows: CALL ITRERR ( IERR ) or IERR = ITRERR () where: IERR is one of the following: 0 no errors have occurred. 1 an input error has occurred. The following example checks for terminal input errors and aborts the program if one has occurred. . . IERR = ITRERR () IF ( IERR .NE. 0 ) STOP . . ITRTYP This routine is used to determine the terminal type being used on the time sharing line. The calling sequences are as follows: CALL ITRTYP ( IRET ) or IRET = ITRTYP () TSXLIB V5.1 PAGE 36 Routine Descriptions where: IRET is one of the following: 0 terminal type unknown. 1 VT52. 2 VT100. 3 Hazeltine. 4 ADM3A. 5 LA36. 6 LA120. 7 Diablo. 8 Qume. ITSLIC This routine is used to determine the TSX-Plus license number. The calling sequences are as follows: CALL ITSLIC ( IRET ) or IRET = ITSLIC () where: IRET is the requested TSX-Plus license number. ITSLIN This routine is used to determine the TSX-Plus time sharing line number to which the job is attached. The calling sequences are as follows: CALL ITSLIN ( IRET ) or IRET = ITSLIN () where: IRET is zero if RT-11 is running or the requested line number if TSX-Plus is running. The following example aborts if RT-11 is running or continues if TSX-Plus is running. IRET = ITSLIN () IF ( IRET .EQ. 0 ) STOP . . IUALBK This routine is used to unlock all locked blocks in a shared file. The calling sequences are as follows: CALL IUALBK ( ICHAN [ ,IERR ] ) or IERR = IUALBK ( ICHAN ) where: ICHAN is the I/O channel number that is open to a shared file. IERR is one of the following: 0 no error. 1 this channel is not open to a shared file. When this routine is executed all blocks previously locked by the user on the shared file are unlocked. Blocks locked by the user on other files are not released nor are blocks of the same file that are locked by other users. TSXLIB V5.1 PAGE 37 Routine Descriptions The following example first opens a file, declares it to be shared, locks some blocks, and then unlocks the blocks. The program is stopped if the error condition is returned. CALL ASSIGN ( 40,'DK:FILE.DAT' ) ICHAN = ILUN ( 40 ) CALL IDCLSF ( ICHAN,1 ) DO 10 IBLK = 4,6 CALL LKBLKW ( ICHAN,IBLK ) 10 CONTINUE . . IERR = IUALBK ( ICHAN ) IF ( IERR .NE. 0 ) STOP . . IUNLKM This routine is used to unlock a job from memory. The calling sequences are as follows: CALL IUNLKM [ IERR ] or IERR = IUNLKM () where: IERR is negative or as follows: 0 real time support is not available or this job does not have operator privilege. The following example first locks itself into memory and then unlocks itself. CALL LKANMY . . CALL IUNLKM . . IUSPBK This routine is used to unlock a specific locked block in a shared file. The calling sequences are as follows: CALL IUSPBK ( ICHAN,IBLOCK [ ,IERR ] ) or IERR = IUSPBK ( ICHAN,IBLOCK ) where: ICHAN is the I/O channel number that is open to the shared file. IBLOCK is the number of the block to be unlocked. IERR is one of the following: 0 no error. 1 the channel is not open to a shared file. The following example opens a file, declares the file to be shared, locks all blocks in the file and then unlocks a specific block in the file. The program is stopped if an error condition is returned. CALL ASSIGN ( 30,'DL0:THAT.DAT' ) ICHAN = ILUN ( 30 ) CALL IDCLSF ( ICHAN,2 ) CALL LKBLKW ( ICHAN,-1 ) IERR = IUSPBK ( ICHAN,7 ) IF ( IERR .NE. 0 ) STOP . . TSXLIB V5.1 PAGE 38 Routine Descriptions KLDTJB This routine is used to abort a detached job. The calling sequences are as follows: CALL KLDTJB ( JOBNUM [ ,IERR ] ) or IERR = KLDTJB ( JOBNUM ) where: JOBNUM is the job number of the detached job. IERR is one of the following: 0 no error. 1 invalid job number. The following example first starts a detached job and then later kills the detached job. If an error condition is returned the program is halted. CALL STDTJB ( JOBNAM,JOBNUM ) . . CALL KLDTJB ( JOBNUM,IERR ) IF ( IERR .EQ. 1 ) STOP . . LKANMY This routine is used to lock a job into any memory. It causes the job to become locked into the memory space it is occupying when this routine is executed. This routine executes extremely fast as compared to the routine, LKLOMY, described later. The calling sequences are as follows: CALL LKANMY [ IERR ] or IERR = LKANMY () where: IERR is negative or the following: 0 real time support is not available or this job does not have operator privilege. The job remains locked until the program exits or the routine, IUNLKM, is executed. The following example locks the job into the memory space that it cur- rently occupies. The program terminates if the error condition is returned. IERR = LKANMY () IF ( IERR .EQ. 0 ) STOP . . LKBLK This routine is used to try to lock a specific block in a shared file. If the requested block is not available the routine returns immediately with an error code. If the block is available it is locked for the requesting user and no error is reported. The calling sequences are as follows: CALL LKBLK ( ICHAN,IBLOCK [ ,IERR ] ) or IERR = ( ICHAN,IBLOCK ) where: ICHAN is the I/O channel number open to the shared file. IBLOCK is the number of the block to be locked. IERR is one of the following: 0 no error. TSXLIB V5.1 PAGE 39 Routine Descriptions 1 this channel is not open to a shared file. 2 request is to lock too many blocks in the file. 3 the requested block is locked by another user. The following example opens a file, declares the file to be shared and tries to lock a block in the file. If the block is already locked the pro- gram loops back for another try and if an error condition is returned the program halts. CALL ASSIGN ( 40,'DY1:JUNK.DAT' ) ICHAN = ILUN ( 40 ) CALL IDCLSF ( ICHAN,2 ) 10 CONTINUE IERR = LKBLK ( ICHAN,3 ) IF ( IERR .EQ. 3 ) GO TO 10 IF ( IERR .NE. 0 ) STOP . . LKBLKW This routine is used to wait for a specific block to lock in a shared file. If the requested block is locked by another job, the requesting job will be suspended until the desired block becomes available. The calling sequences are as follows: CALL LKBLKW ( ICHAN,IBLOCK [ ,IERR ] ) or IERR = LKBLKW ( ICHAN,IBLOCK ) where: ICHAN is the I/O channel number open to the shared file. IBLOCK is the number of the block to be locked. IERR is one of the following: 0 no error. 1 this channel is not open to a shared file. 2 request is to lock too many blocks in the file. Other blocks in the file which were previously locked remain locked. A block number of minus one can be used to request that all blocks in the file be locked. If several users request the same block, access will be granted sequentially in the order that the requests are received. The following example opens a file, declares the file to be shared, and locks all of the blocks in the file. If an error condition is returned the program stops. CALL ASSIGN ( 40,'DK:FILE.DAT' ) ICHAN = ILUN ( 40 ) CALL IDCLSF = ( ICHAN,0 ) IERR = LKBLKW ( ICHAN,-1 ) IF ( IERR .NE. 0 ) STOP . . LKLOMY This routine is used to lock a job into low memory. It causes the job to be relocated into low memory and then to become locked there. This type of lock is relatively slow and should be done only if the job is to remain locked for a long period of time. The calling sequences are as follows: CALL LKLOMY [ IERR ] or IERR = LKLOMY () where: IERR is negative or the following: TSXLIB V5.1 PAGE 40 Routine Descriptions 0 real time support is not available or this job does not have operator privilege. The job remains locked in memory until the program terminates or until the routine, IUNLKM, is executed. The following example locks the job into low memory aborting if the error condition is returned. IERR = LKLOMY () IF ( IERR .EQ. 0 ) STOP . . MAPRNT This routine is used to map a shareable run time system into a job's region. The run time system must first be associated with the job by exe- cuting the IASRNT routine described earlier. The calling sequences are as follows: CALL MAPRNT ( IPAR,IOFFST,MAPSIZ [ ,IERR ] ) or IERR = MAPRNT ( IPAR,IOFFST,MAPSIZ ) where: IPAR is a number in the range of zero to seven that indicates the job's page address register (PAR) that is to be used to access the run time system. The PAR number selects the region of virtual memory in the job that will be mapped to the run time system. The following correspondence exists between PAR numbers and virtual octal address regions within the job: 0 000000 - 017777 1 020000 - 037777 2 040000 - 057777 3 060000 - 077777 4 100000 - 117777 5 120000 - 137777 6 140000 - 157777 7 160000 - 177777 IOFFST specifies which portion of the run time system is to be mapped into the PAR region. It specifies the number of the 64-byte block within the run time system where mapping is to begin. This makes it possible to access different sections of a run time system at different times or through different regions. MAPSIZ is the number of 64-byte blocks to be mapped. If this value is larger than can be contained within a single PAR region, multiple PAR regions are automatically mapped as necessary to contain the entire specified section of the run time sys- tem. IERR is one of the following: 0 no error. 1 there is no run time system associated with this job. This routine affects the mapping of only the PAR region specified in IPAR and following PARs if the size so requires. It does not affect the mapping of any other PAR regions that may previously have been mapped to a run time system. Thus, a job may have different PAR regions mapped to dif- ferent sections of the same run time system or to different run time systems. Real time programs may map PAR region number seven to the I/O page and map other PAR regions to shared run time systems. The memory size of a job is not affected by the use of the this routine. Mapping a portion of a job's virtual address space to a shared run time system neither increases nor decreases the size of memory occupied by the job. If a job's size is such that a portion of its normal memory is under a PAR region that is mapped to a run time system, that section of its TSXLIB V5.1 PAGE 41 Routine Descriptions normal memory becomes inaccessible to the job as long as the run time system mapping is in effect but the memory contents are not lost and may be reac- cessed by disassociating all run time systems from the job. Any of the PAR regions may be mapped to a run time system including PAR region number seven which is normally not accessible to a job. The following example first uses the SYSLIB routine, IRAD50, to name the run time system, associates the run time system with the job, then maps a PAR region to a section of the run time system, and finally disassociates the run time system from the job. DIMENSION IRNTIM ( 2 ) CALL IRAD50 ( 6,'TSXLIB',IRNTIM ) CALL IASRNT ( IRNTIM ) CALL MAPRNT ( 3,1,4 ) . . CALL IASRNT ( 0 ) . . MEMPOS This routine is used to determine the position of a job in memory for a TSX-Plus line. The calling sequence is as follows: CALL MEMPOS ( LINUM,IPOS [ ,IERR ] ) where: LINUM is the number of the line for which memory position informa- tion is returned. IPOS is the 512-word block number of the start of the memory area allocated to the job. This value will be zero if the job is swapped out of memory. IERR is negative or one of the following: 0 line is not currently logged on. 2 invalid line number. MEMSET This routine is used to set the amount of memory that will be allocated for the job. The calling sequences are as follows: CALL MEMSET ( IARG [ ,IRET ] ) or IRET = MEMSET ( IARG ) where: IARG is the top memory address requested. IRET is the top memory address allocated. The size allocated to a job reverts to the size specified by the most recent MEMORY keyboard command when the job exits or chains. The following example requests a top memory address of 120000 (octal). The program is halted if the allocation is less than the request. DATA IARG/"120000/ IRET = MEMSET ( IARG ) IF ( IRET .LMT. IARG ) STOP . . MEMUSE This routine is used to return the amount of memory allocated to a TSX-Plus line. The calling sequence is as follows: TSXLIB V5.1 PAGE 42 Routine Descriptions CALL MEMUSE ( LINUM,MEMSIZ [ ,IERR ] ) where: LINUM is the number of the line about which memory allocation information is returned. MEMSIZ is the amount of memory allocated to the line in 512-word blocks. IERR is negative or one of the following: 0 line is not currently logged on. 2 invalid line number. MOUNT This routine is used to mount a file structured device for directory caching. The effect of this routine is the same as the TSX-Plus MOUNT key- board command. The calling sequences are as follows: CALL MOUNT ( IDVNAM [ ,IERR ] ) or IERR = MOUNT ( IDVNAM ) where: IDVNAM is the RAD50 value of the device name. IERR is one of the following: 0 no error. 1 no room left in the table of mounted devices. The following example uses the SYSLIB routine, IRAD50, to convert the ASCII device name, DY3, to its RAD50 value. Then the file structured device is mounted. The program is halted if an error condition is returned. CALL IRAD50 ( 3,'DY3',IDVNAM ) IERR = MOUNT ( IDVNAM ) IF ( IERR .EQ. 1 ) STOP . . MPIOPS This routine is used to map the I/O page into the program space between the octal addresses of 160000 and 177777. The calling sequence is as fol- lows: CALL MPIOPS The mapping set up by this routine remains in effect until the routine, MPRMPS, is executed or the program terminates. Operator privilege is required to execute this routine. MPRGN This routine is used to map a region of virtual memory to a specified region of physical memory. The calling sequences are as follows: CALL MPRGN ( IPAR,IPAD,ISIZ,IACS [ ,IERR ] ) or IERR = MPRGN ( IPAR,IPAD,ISIZ,IACS ) where: IPAR is one of the following Page Address Register (PAR) numbers indicating the beginning of the virtual region to be mapped: PAR Virtual Region 0 000000-017777 1 020000-037777 2 040000-057777 3 060000-077777 4 100000-177777 TSXLIB V5.1 PAGE 43 Routine Descriptions 5 120000-137777 6 140000-157777 7 160000-177777 IPAD is the physical address devided by 100 (octal) to which the virtual address is to be mapped. ISIZ is the number of 100-byte (octal) pages to be mapped. If zero all PAR mapping is restored to normal. IACS indicates the read/write access of the mapped region as fol- lows: 0 Read only. 1 Read and write. IERR is negative or the following: 0 real time support is not available or this job does not have operator privilege. Operator privilege is required to execute this routine. MPRMPS This routine is used to map a simulated RMON into the program space between the octal addresses of 160000 and 177777. The calling sequence is as follows: CALL MPRMPS Operator privilege is required to execute this routine. MSGREQ This routine is used to post a read request for a TSX-Plus interjob message. The calling sequences are as follows: CALL MSGREQ ( CHNL,BUFR,ISIZ,CPLRTN [ ,IERR ] ) or IERR = MSGREQ ( CNLI,BUFR,ISIZ,CPLRTN ) where: CHNL is the name of the string array containing the six character name of the message channel. BUFR is the name of the string array that is to receive the mes- sage. ISIZ is the length of the message buffer. CPLRTN is the name of the completion routine to be entered when the message is received. IERR is as follows: 0 no error. 1 all message channels are busy. 5 the maximum allowed number of requests are active. On entry to the completion routine, processor register R0 contains the number of bytes in the message that was received, and R1 contains the number of the job that sent the message. The GETREG routine may be used to recover the values stored in R0 and R1. Another call to this routine may be made from within the completion routine if it is desired to receive additional messages. The SUSPND and RESUME SYSLIB calls may be used with this facility if the program reaches a point where it must suspend its execution until a mes- sage arrives. TSXLIB V5.1 PAGE 44 Routine Descriptions The following sample program aborts if an error condition is returned after attempting to post a read request for a message. It later issues a SUSPND call. The associated completion routine must issue a RESUME call after processing the message. LOGICAL*1 CHNL(6),BUFR(75) DATA ISIZ /75/ EXTERNAL CPLRTN CALL SCOPY ( 'CHNL04',CHNL,6 ) . . IERR = MSGREQ ( CHNL,BUFR,ISIZ,CPLRTN ) IF ( IERR .GT. 0 ) STOP . . CALL SUSPND . . MSGSND This routine is used to queue up a message to another job on a named channel. If other messages are already pending on the channel, the new mes- sage is added to the end of the list of waiting messages. The sending program continues execution and does not wait for the message to be accepted by a receiving program. During processing the message is copied to an internal buffer, and the sending program is free to destroy its message on return from this routine. The calling sequences are as follows: CALL MSGSND ( ICHNAM,MSGBUF,MSGSIZ [ ,IERR ] ) or IERR = MSGSND ( ICHNAM,MSGBUF,MSGSIZ ) where: ICHNAM is the six ASCII character name of the message channel. MSGBUF is the name of the string array containing the message. MSGSIZ is the length of the message in characters. IERR is one of the following: 0 no error. 1 all message channels are busy. 2 the maximum allowed number of messages are being held in the message queues. 4 the transmitted message was too long and was truncated to the maximum allowed length. The following example uses the SYSLIB routine, SCOPY, to load the string variables, MSGBUF and ICHNAM, then sends a message to the named chan- nel, JUNK. The program aborts if an error condition is returned. LOGICAL*1 MSGBUF ( 14 ) LOGICAL*1 ICHNAM ( 8 ) CALL SCOPY ( ' HELLO THERE',MSGBUF,12 ) CALL SCOPY ( 'JUNK ',ICHNAM,6 ) IERR = MSGSND ( ICHNAM,MSGBUF,12 ) IF ( IERR .NE. 0 ) STOP . . RCVMSG This routine is used to receive a message from a named channel if a message is pending on the channel. If no message is pending, an error code is returned, and the calling program is allowed to continue execution. The calling sequence is as follows: CALL RCVMSG ( ICHNAM,MSGBUF,IBUFSZ,MSGSIZ [ ,IERR ] ) TSXLIB V5.1 PAGE 45 Routine Descriptions where: ICHNAM is the six ASCII character name of the message channel. MSGBUF is the name of the receiving string array. IBUFSZ is the length of the receiving buffer in characters. MSGSIZ is the length of the received message in characters. IERR is one of the following: 0 no error. A message was received. 3 no message was queued on the named channel. 4 the message was longer than the receiving buffer. The following example sets up using the SYSLIB routine, SCOPY, to receive a message, and then attempts to receive a message on the named chan- nel, JUNK. The program is stopped if an error condition is returned. LOGICAL*1 ICHNAM ( 8 ) LOGICAL*1 MSGBUF ( 72 ) CALL SCOPY ( 'JUNK ',ICHNAM,6) CALL RCVMSG ( ICHNAM,MSGBUF,72,MSGSIZ,IERR) IF ( IERR .NE. 0 ) STOP . . RCVMSW This routine is used to suspend the execution of a program until a message becomes available on a named channel. The calling sequence is as follows: CALL RCVMSW ( ICHNAM,MSGBUF,IBUFSZ,MSGSIZ [ ,IERR ] ) where: ICHNAM is the six ASCII character name of the message channel. MSGBUF is the name of the receiving string array. IBUFSZ is the length of the receiving array in characters. MSGSIZ is the length of the received message in characters. IERR is one of the following: 0 a message has been received. 1 all message channels are busy. 4 the message was longer than the receiving buffer. The following example uses the SYSLIB routine, SCOPY, to load the vari- able, ICHNAM, then waits for a message to arrive on the named channel. The program is stopped if an error condition is returned. LOGICAL*1 MSGBUF ( 72 ) LOGICAL*1 ICHNAM ( 8 ) CALL SCOPY ( 'JUNK ',ICHNAM,6 ) CALL RCVMSW ( ICHNAM,MSGBUF,IBUFSZ,MSGSIZ,IERR) IF ( IERR .NE. 0 ) STOP . . RLCTL This routine is used to allow a running program to relinquish exclusive control of the system after the program finishes performing some time-critical task. The calling sequence is as follows: CALL RLCTL Operator privilege is required to execite this routine. TSXLIB V5.1 PAGE 46 Routine Descriptions RSTODT This routine is used to reset or clear the ODT activation mode. The calling sequence is as follows: CALL RSTODT SETODT This routine is used to set the ODT activation mode. The calling sequence is as follows: CALL SETODT In this mode TSX-Plus considers all characters to be activation characters except the digits, the comma, the dollar sign, and the semicolon. STDTJB This routine is used to start the execution of a detached job. The calling sequence is as follows: CALL STDTJB ( JOBNAM,JOBNUM [ ,IERR ] ) where: JOBNAM is the ASCII string, dev:filnam.ext, terminated by a null byte. JOBNUM is the returned job number. IERR is one of the following: 0 no error. 1 no detached job line is available. If a free detached job line is available, the specified command file, JOBNAM, is initiated as a detached job and the number of the detached job is returned in the variable, JOBNUM. The following example uses the SYSLIB routine, SCOPY, to load the vari- able, JOBNAM, then initiates the detached job, DETJOB.COM, from device, DY2:, storing the job number in the variable, JOBNUM. The program is termi- nated if an error condition is returned. LOGICAL*1 JOBNAM ( 16 ) CALL SCOPY ( 'DY2:DETJOB.COM',JOBNAM,14) CALL STDTJB ( JOBNAM,JOBNUM,IERR ) IF ( IERR .EQ. 1 ) STOP . . STPRLV This routine is used to set the user mode processor priority level from a running program. This may be used when it is necessary for a real time program to block interrupts for a short period of time while it is perform- ing some time critical operation. The calling sequence is as follows: CALL STPRLV ( IPRLVL ) where: IPRLVL is the desired user mode processor priority level in the range of zero through seven. Operator privilege is required to execute this routine. Interrupts should not be disabled for long periods of time or system clock interrupts and character input interrupts will be lost. The following example raises the priority level to seven and later reduces it back to zero. CALL STPRLV ( 7 ) . . CALL STPRLV ( 0 ) TSXLIB V5.1 PAGE 47 Routine Descriptions . . STUNAM This routine is used to set the user name associated with the current job. The calling sequences are as follows: CALL STUNAM ( USRNAM [ , IERR ] ) or IERR = STUNAM ( USRNAM ) where: USRNAM is the name of the twelve-character array that contains the new user name ASCII string. IERR is negative or as follows: 0 the job does not have operator privilege. The following example sets the user name to JOEBLOWHARD. LOGICAL*1 USRNAM(14) CALL SCOPY ( 'JOEBLOWHARD',USRNAM ) IERR = STUNAM ( USRNAM ) IF ( IERR .GE. 0 ) STOP . . TERMPA This routine is used to conclude a performance analysis. It has the effect of returning into a user supplied buffer the results of the analysis and freeing the performance analysis feature for use by other users. The calling sequence is as follows: CALL TERMPS ( IPARBF,IHSTBF,IHBSIZ [ ,IERR ] ) where: IPARBF is the name of a four element parameter buffer with the ele- ments assigned as follows: 1 is the base address of the monitored region. 2 is the top address of the monitored region. 3 is the number of bytes per histogram cell. 4 is a control and status flag with bit assignments as follows: 1 I/O wait time was included. 100000 at least one of the histogram cells overflowed. IHSTBF is the name of the histogram buffer. IHBSIZ is the number of elements or cells in the histogram buffer. IERR is negative or one of the following: 0 this job is not doing a performance analysis. 1 area provided for the histogram count vector is too small. The histogram data returned consists of a vector of 16-bit binary values, one value for each cell in the histogram. The first value cor- responds to the histogram cell that starts at the base address of the region that was monitored. The following example shows the complete performance analysis from initialization to termination. The program is stopped if an error condition is returned on termination of the analysis. TSXLIB V5.1 PAGE 48 Routine Descriptions DIMENSION IPARBF ( 4 ) DIMENSION IHSTBF ( 16 ) CALL INITPA ( "2000,"4000,"100,0 ) CALL ISTPA . . CALL ISPPA CALL TERMPA ( IPARBF,IHSTBF,IHBSIZ,IERR ) IF ( IERR .GE. 0 ) STOP . . TIMOUT This routine is used to set the time out value that is to be applied to the next terminal input operation. The calling sequence is as follows: CALL TIMOUT ( ITIME,IACTCH ) where: ITIME is the time out value in 0.5 second units. IACTCH is the value of the single character that is to be returned as the last or activation character of the field if a time out occurs. The value specified with this routine applies only to the next terminal input field. The time value is reset when the next field is received from the terminal or the time out occurs. A new time out value must be specified for each input field that is to be time controlled. The following example uses a time out value of twenty seconds and spec- ifies that a control-X is to be returned if the timeout occurs. . . CALL TIMOUT ( 40,24 ) . . TKCTL This routine is used to allow a running program to gain exclusive access to the system to perform some time-critical task. The calling sequence is as follows: CALL TKCTL The effect of this routine is to cause the TSX-Plus job scheduler to ignore all other jobs during the interval that the calling program has exclusive control of the system. Operator privilege is required to execute this routine. Exclusive access is relinquished when the calling program calls RLCTL, terminates, or aborts. Exclusive access is retained if the calling program chains to another program. TRMIN This routine is used to accept a string of characters from the termi- nal. The calling sequence is as follows: CALL TRMIN ( ICHBUF,IBFSIZ,ICOUNT [ ,IERR ] ) where: ICHBUF is the name of the buffer that is to receive the string. IBFSIZ is the length of the receiving buffer in characters. ICOUNT is the number of characters actually received. IERR is one of the following: 0 no error. TSXLIB V5.1 PAGE 49 Routine Descriptions 1 the specified buffer overflowed. This routine causes a program to wait until an activation character is entered on the terminal and then returns all characters received up to and including the last activation character. This routine is substancially more efficient than doing a series of the SYSLIB routin ITTINR. It is particu- larly well suited for accepting input from page buffered terminals. The following example accepts a string of characters from the terminal. The program is halted if the error condition is returned. LOGICAL*1 ICHBUF ( 24 ) CALL TRMIN ( ICHBUF,24,ICOUNT,IERR ) IF ( IERR .EQ. 1 ) STOP . . TRMMSG This routine is used to send a message to another line's terminal. The calling sequence is as follows: CALL TRMMSG ( ILINE,IMSGBF ) where: ILINE is the line number of the terminal that the message is to be sent. IMSGBF is the name of the buffer that contains the message. The message must be terminated with a null character. The following example sends a message to the terminal connected to line 14. LOGICAL*1 IMSGBF ( 30 ) CALL SCOPY ( ' THIS IS THE MESSAGE',IMSGBF,20 ) CALL TRMMSG ( 14,IMSGBF ) . . TRMOUT This routine is used to send a string of characters to the terminal. The calling sequence is as follows: CALL TRMOUT ( ICHSTR,ICOUNT ) where: ICHSTR is the name of the buffer containing the string of characters. ICOUNT is the number of characters in the string. This routine is much more efficient to use than a series of the SYSLIB routine, ITTOUR. It has the same efficiency as the SYSLIB routine, PRINT, but it uses a count of the number of characters to send instead of having the string terminated with a null character. The following example sends a string of characters to the terminal. LOGICAL*1 ICHSTR ( 22 ) CALL SCOPY ( ' THIS IS THE STRING.'ICHSTR,20 ) CALL TRMOUT ( ICHSTR,20 ) . . TSXLIB V5.1 PAGE 50 Building the Library 4. Building the Library The sources for the TSX-Plus Library consist of the MACRO-11 modules listed in Table 4-1. The process of constructing the library file, TSXLIB.OBJ, is the same when accomplished under either RT-11 or under TSX-Plus. Module Content CLLINE Communication line support. DETJBS Detached job support. DVALOC Device allocating and deallocating. JBSTMN Job status monitoring. MNTDEV Device mounting and dismounting. MSGCOM Interjob message communication. PRFANL Performance analysis support. RELTIM Real time program support. RUNTIM Shared run time system support. SHRFIL Shared file system support. SPOLER Spooler support. SYSTAT System status information. TRMCOM Terminal communication. TRMCTL Terminal control. TSFILS Special file information. TSLBID TSXLIB identification. TSXMSC Miscellaneous EMTs. TSXODT ODT activation mode support. USRNAM User name support. TSXLIB MACRO-11 source modules. Table 4-1. First the MACRO-11 modules are assembled as follows: .RUN SY:MACRO *CLLINE=CLLINE *DETJBS=DETJBS *JBSTMN=JBSTMN *MNTDEV=MNTDEV *MSGCOM=MSGCOM *PRFANL=PRFANL *RELTIM=RELTIM *RUNTIM=RUNTIM *SHRFIL=SHRFIL *SPOLER=SPOLER *SYSTAT=SYSTAT *TRMCOM=TRMCOM *TRMCTL=TRMCTL *TSFILS=TSFILS *TSLBID=TSLBID *TSXMSC=TSXMSC *TSXODT=TSXODT *USRNAM=USRNAM *^C Next the library file is constructed as follows: .RUN SY:LIBR *TSXLIB=CLLINE// *DETJBS *DVALOC *JBSTMN *MNTDEV *MSGCOM *PRFANL *RELTIM *RUNTIM *SHRFIL TSXLIB V5.1 PAGE 51 Building the Library *SPOLER *SYSTAT *TRMCOM *TRMCTL *TSFILS *TSLBID *TSXMSC *TSXODT *USRNAM *// *^C The command file, TSXLIB.COM, in the distribution kit will accomplish the construction of the library file, TSXLIB.OBJ. TSXLIB V5.1 PAGE 52 References References 1. S & H Computer Systems, Inc., "TSX-Plus Reference Manual", Third Edition, First Printing, Nashville, TN, February 1984. 2. S & H Computer Systems, Inc., "TSX-Plus Version 5.1 Release Notes", Nash- ville, TN, August 1984. 3. Digital Equipment Corporation, "PDP-11 MACRO-11 Language Reference Manual", AA-V027A-TC, Maynard, MA, March 1983. 4. Digital Equipment Corporation, "RT-11 System User's Guide", AA-5279C-TC, Maynard, MA, March 1983. 5. Digital Equipment Corporation, "RT-11 Programmer's Reference Manual", AA-H378B-TC, Maynard, MA, March 1983. TSXLIB V5.1 PAGE 53 Appendix A Appendix A This appendix lists all of the TSXLIB routines in functional groups and alphabetically within funcional groups. Communication Line Support ICNTSP Control the speed of a communication or timesharing line. IRDRCL Redirect a communication or timesharing line. Detached Job Support ISTDJ Get the status of a detached job. KLDTJB Kill a detached job. STDTJB Start a detached job. Device Allocating and Deallocating IALOC Allocate a device. ICALOC Check the allocation status of a device. IDALOC Deallocate a device. Device Mounting and Dismounting DISMNT Dismount a file structured device. MOUNT Mount a file structured device. Interprogram Message Communication MSGREQ Post a read request for a message. MSGSND Send a message to another job. RCVMSG Try to receive a message from another job. RCVMSW Wait for a message from another job. Job Status Monitoring IBSTCH Broadcast a job status change. ICNMCN Cancel a job status monitoring connection. IESMCN Establish a job status monitoring connection. Miscellaneous EMT Support GETREG Get the word and byte values stored in a processor register. ITSLIC Determine the TSX-Plus license number. ITSLIN Determine the TSX-Plus line number. ISPY Return values from within simulated RMON. ISTPRV Set the current job's priority value. TSXLIB V5.1 PAGE 54 Appendix A MEMSET Set the memory allocation. ODT Activation Mode Support RSTODT Reset normal activation mode. SETODT Set ODT activation mode. Performance Analysis Support INITPA Initialize for a performance analysis. ISPPA Stop a performance analysis. ISTPA Start a performance analysis. TERMPA Terminate from a performance analysis. Real Time Program Support CNVAPA Convert a virtual address to a physical address. IBICIO Bit clear a value into the I/O page. IBISIO Bit set a value into the I/O page. ICNINT Connect an interrupt vector to a completion routine. ICNRTN Connect a service routine to an interrupt vector. IPEKIO Peek at a value in the I/O page. IPOKIO Poke a value into the I/O page. IRLINT Release an interrupt vector connection. ITCRTN Trigger a completion routine from within an interrupt service routine. IUNLKM Unlock a job from memory. LKANMY Lock a job into any memory. LKLOMY Lock a job into low memory. MPIOPS Map the I/O page into the program space. MPRGN Map a region of virtual memory to a specified region of phy- sical memory. MPRMPS Map the simulated RMON into the program space. RLCTL Relinquish exclusive control of the system. STPRLV Set the user mode processor priority level. TKCTL Take exclusive control of the system. Shared Run Time System Support IASRNT Associate/disassociate a shared run time system with a job. MAPRNT Map a shared run time system into a job's region. Shared File Support ICKWTS Check for writes to a shared file. IDCLSF Declare a file to be shared. TSXLIB V5.1 PAGE 55 Appendix A ISVST Save the status of a shared file. IUALBK Unlock all locked blocks. IUSPBK Unlock a specific block. LKBLK Try to lock a block. LKBLKW Wait for a block to lock. Special File Information IFLINF Obtain some information about a file. ISTFTM Set the creation time of a file. Spooler Support ISPBLK Determine the number of free blocks in the spool file. ISPCTL Control the release time of a spooled file. System Status Information ICONTM Determine the connect time for a job. ICPUTM Get the CPU time used by a job. IEXSTS Get a job's execution status. ILNSTS Check the status of a line. IPGNAM Get the name of the program being run by a job. IPPNUM Get the project-programmer number for a job. MEMPOS Determine the position of a job in memory. MEMUSE Determine the amount of memory used by a job. Terminal Communications Support TRMIN Accept a string of characters from the terminal. TRMMSG Send a message to another terminal. TRMOUT Send a string of characters to the terminal. Terminal Control Support BRKCTL Establish break sentinal control. HIEFOF Turn off the high efficiency terminal mode. HIEFON Turn on the high efficiency terminal mode. IACTCH Check for pending activation characters. ITRCTL Perform lead-in character type terminal control functions. ITRERR Check for terminal input errors. ITRTYP Determine the terminal type. TIMOUT Set the terminal read time out value. User Name Support GTUNAM Get the user name associated with the current job. TSXLIB V5.1 PAGE 56 Appendix A STUNAM Set the user name associated with the current job. TSXLIB V5.1 PAGE 57 Appendix B Appendix B The TSXLIB distribution kit (DECUS #11-490) consists of the following files: TSXLIB.COM TSXLIB builder. ABSTRA.DOC Abstract. TSXLIB.DOC This document. CLLINE.MAC Communication line support. DETJBS.MAC Detached job support. DVALOC.MAC Device allocating and deallocating. JBSTMN.MAC Job status monitoring. MNTDEV.MAC Device mounting and dismounting. MSGCOM.MAC Interjob message communication. PRFANL.MAC Performance analysis support. RELTIM.MAC Real time program support. RUNTIM.MAC Shared run time system support. SHRFIL.MAC Shared file system support. SPOLER.MAC Spooler support. SYSTAT.MAC System status information. TRMCOM.MAC Terminal communication. TRMCTL.MAC Terminal control. TSFILS.MAC Special file information. TSLBID.MAC TSXLIB identification. TSXMSC.MAC Miscellaneous EMTs. TSXODT.MAC ODT Activation mode support. USRNAM.MAC User name support TSXLIB.OBJ The implemented library. TSXLIB V5.1 Reader's Comments Did you find any errors in this document? If so, please specify page and describe. Did you find this document understandable, usable, and well organized? Please make suggestions for improvement. Did you find this document sufficiently complete? If not, what material is missing and where should it be placed? Name/Date: Company: Address: City/State/Zip: Return to: NAB Software Services, Inc. PO Box 20009 Albuquerque, NM 87154-0009