Home

Occam 2 User Library Specifications

1. imos occam 2 User Library Specifications Steven R Huggins SW 0114 4 INMOS Limited Confidential APPROVED 5 February 1991 INMOS Limited Confidential occam User Lib Specs Contents Ts Introductio esos Ko uc o et a S m nd tetuer lume Peres pex 2 2 Related DOCUMEN S o na a RIEGO XC X Y xe 2 3v e uy t EN Ue a is ete v twi a 2 4 Compiler Libraries 2 5 debugilib i ss 5 enm sS Q Q Se dA SO eua Vau 4 0 COnvert llb 3 vuU EROR EE Rcx Oa OIM eX X Yu do Yo a we y 5 1 536 6 D Sas Soe rab a E Ro ka 9x eg e C WE epe E T zon o S e e ku e la AATAS e ee n se 7 9 snglmath llb se z gun sspepej vara S Seek da EE EEE TTA MAA a 37 TOdbIMAtA IDE 52358 y yy o ka estds e se eat NS e Eki 37 p Php ene e Rr amc TIITA TIT Iro 37 T2 msdos lib sy sen e pk Ee ER crue nae gh e A mm qu to le o 38 TS streami ND ad a i sm n a ka EK t a a a stet WY gu ups gs 41 WA SUMO ND cs pS resti Ex SUP ASS Vs 52 TS XINKID ced rnt ree Ye ee Ee 60 16 stfeamieo llb 5 sa s e e a NEA E a rede 62 TE GSX S Sq E E AE Aa WA ena va CE eN asa as as na 65 APPROVED 5 2 91 1 SW 0114 4 INMOS Limited Confidential occam User Lib Specs 1 In
2. follows HH MM SS DD MM YY long years FALSE days first TRUE HH MM SS DD MM YYYY long years TRUE days first TRUE HH MM SS MM DD YY long years FALSE days first FALSE HH MM SS MM DD YYYY long years TRUE days first FALSE where HH MM SS is hours minutes and seconds and DD MM YY is day month and year so today date CHAN OF SP s ts so date len INT date Purpose To give the time and date in the form of six integers of when this routine was called Channels fs from server ze ts to server Out date an array of six integers where the elements are index data 0 seconds past the minute 1 minutes past the hour 2 the hour in the 24 hour clock 3 the day of the month 4 the month where January is 1 5 the year expressed fully i e 4 digits Notes If the time and date are unavailable all elements of date are B set to zero Local time is used so today ascii CHAN OF SP fs ts VAL BOOL long years days first Purpose Channels In In Out APPROVED 52 91 so time string len BYTE string To give the time and date in formatted form of when this routine was called fs from server ts to server long years TRUE if a four digit year is desired FALSE if a two digit year is desired the digits being the tens and units followed by two spaces days first TRUE if date to be written with the days preceding the
3. or a sign is not allowed nor necessary since the most significant bit indicates the sign A and mean exactly the same thing the following digits form a hex integer A means add the given hex integer to MOSTNEG INT using modulo arithmetic to give the result Both upper and lower case hex digits are permissible A sign is allowed in the first character position if it is a decimal integer that is entered The number typed at the keyboard must be terminated by pressing RETURN So read echo int CHAN OF SP fs ts INT n BOOL error Purpose Channels Out Out Notes To read a string containing a representation of a decimal integer from the keyboard and to echo it to standard out fs from server ts to server n if error is FALSE the value of the integer read otherwise undefined error FALSE if nothing went wrong in the operation otherwise TRUE 1 if the integer read overflows the INT range 2 if a non numeric character is found in the input string other than a or in the first character position The integer may commence with a or a sign The number typed at the keyboard must be terminated by pressing RETURN So read echo int32 CHAN OF SP fs ts INT32 n BOOL error As so read echo int but for INT32s So read echo int64 CHAN OF SP fs ts INT64 n BOOL error As so read echo int but for INT64s So read echo hex int CHAN OF SP fs ts INT n BOOL
4. the index of str immediately after where the last character of the ASCII hexadecimal of number was written or SIZE str if this last character was written into the last positon of str Out str the string into which the hexadecimal ASCII form of number is to be written In number the integer to be converted to an ASCII hexadecimal representation and then written into str In width the field width of the ASCII hexadecimal representation of number if number cannot be represented in width characters then the representation is truncated at the left as necessary otherwise the representation is padded on the left with 0 s or F s to make up width characters it is an error if width is negative Notes If str overflows then this routine acts as an invalid process The conversion of number includes a as the first character so that the representation is always width l characters Any hexadecimal characters which are letters will be in upper case PROC append real32 INT len BYTE str VAL REAL32 number VAL INT Ip Dp Purpose To write an ASCII representation of a single precision APPROVED 5 2 91 5 SW 0114 4 INMOS Limited Confidential occam User Lib Specs In Out Out In Im In Notes real number into a given string len on entry the index of str at which the first character of the representation of number is to De placed on
5. the offset the lower two bytes of this parameter both unsigned Out bytes read if result is spr ok the number of bytes read otherwise zero Out block if result is spr ok the data read is held in the first bytes read bytes of block otherwise undefined The number of bytes requested to be read is SIZE block Out result spr ok if the read was successful otherwise takes on a value indicating what went wrong spr bad packet size too many bytes were requested to be read SIZE block dos max receive block buffer size gt spr operation failed the read failed so bytes read 0 see hostio inc or the server documentation for further details PROC dos call interrupt CHAN OF SP fs ts VAL INT16 interrupt VAL dos interrupt regs size BYTE register block in BYTE carry flag dos interrupt regs size BYTE register block out BYTE result Purpose To invoke an interrupt call on the host PC with the processor s registers initialised to desired values Channels fs from server ts to server In interrupt the interrupt number In register block in the register values to which to initialise the PC s registers on this interrupt Out carry flag if result is spr ok the value of the PC s carry flag on return from the interrupt otherwise undefined Out register block out if result is spr ok the values stored in the pr
6. Channels fs from server ts to server In streamid the identification number of the open stream to be APPROVED 5 2 91 11 SW 0114 4 INMOS Limited Confidential occam User Lib Specs flushed Out result equal to spr ok stream successfully flushed otherwise gt spr operation failed see hostio inc or iserver documentation for further details Notes To flush means to write out any internally buffered data to the stream that it is associated with The stream remains open PROC so flush CHAN OF SP fs ts VAL INT32 streamid BYTE result As sp flush PROC sp seek CHAN OF SP s ts VAL INT32 streamid offset origin BYTE result Purpose To set the file position for the specified stream Channels fs from server lt ts to server In streamid the identification number of the open stream associated with the file the position of which is to be set In offset the offset from origin of the new position for reading or writing For a binary file the new position will be offset bytes perhaps negative from the position defined by origin For a text file offset must be zero or a value returned by so tell in the latter case origin must be spo start and offset greater than equal to zero In origin one of spo start the start of the file spo current the current position in the file spo end the end of the file Out resul
7. the file has been reached or some error occurred see hostio inc or iserver documentation for further details Notes Characters are read until a newline sequence is found the end of the file is reached or the number of characters is not less than sp max readbuffer size If a newline sequence is found it is not included in data PROC so gets CHAN OF SP fs ts VAL INT32 streamid INT bytes read BYTE data BYTE result As sp gets PROC sp puts CHAN OF SP s ts VAL INT32 streamid VAL BYTE data BYTE result Purpose To write a line to the specified output stream Channels fs from server ts to server In streamid the identification number of the stream to be written to In data the line to be written without a terminating newline sequence Out result equal to spr ok if the line was successfully written otherwise takes on a value indicating what was wrong spr bad packet size too many bytes supplied SIZE data sp max writebuffer size s spr operation failed the write failed see hostio inc or iserver documentation for further details Notes A newline sequence is added to the end of the bytes to be written PROC so puts CHAN OF SP s ts VAL INT32 streamid VAL BYTE data BYTE result As sp puts PROC sp flush CHAN OF SP fs ts VAL INT32 streamid BYTE result Purpose To flush the specified output stream
8. In str the string in which to search for a byte which is not identical to any of the various bytes contained in possibles PROC append char INT len BYTE str VAL BYTE char Purpose To write a byte into a string In Out len on entry the byte char will be written at str len on exit len will be one greater than it was on entry Out str the string to write char to In char the byte which is to be written into str Notes If accessing str len for len on entry is invalid then this routine acts as an invalid process PROC append text INT len BYTE str VAL BYTE text Purpose To concatenate two strings In Out len on entry the index of str where the first character of text is to go on exit the index of str immediately after the last character of text inserted or SIZE str if the last character of text was placed in the last position of str Out str the concatenation of what str was on entry with text where text is placed in positions str len to stri len SIZE text 1 inclusive where len here is that on entry In text the string to be concatenated with str text being the second string Notes If str is not long enough to hold the concatenation then APPROVED 5 2 91 56 SW 0114 4 INMOS Limited Confidential occam User Lib Specs this routine acts as an invalid process PROC append int INT len BYTE str VAL INT nu
9. INT32 localtime UTCtime BYTE result Purpose Channels Out Out Out Notes To retrieve the local and UTC time from the host system fs from server ts to server localtime the local time UTCtime the Coordinated Universal Time if available zero if not available result spr ok if operation successful otherwise gt spr operation failed refer to hostio inc or iserver documentation for details Both times are expressed as the number of seconds that have elapsed since midnight on the lst of January 1970 and are given as unsigned INT32s UTC time used to be known as Greenwich Mean Time GMT so time CHAN OF SP fs ts INT32 localtime UTCtime Purpose Channels Out Out Notes sp system Purpose Channels In Out Out so system To retrieve the local and UTC time from the host system fs from server ts to server localtime the local time UTCtime the Coordinated Universal Time if available zero if not available Both times are expressed as the number of seconds that have elapsed since midnight on the lst of January 1970 and are given as unsigned INT32s UTC time used to be known as Greenwich Mean Time GMT CHAN OF SP fs ts VAL BYTE command INT32 status BYTE result To execute a command on the host system fs from server ts to server command the command to be executed which may be null status if command is not null and result is
10. characters in the name of the file A directory specification may form part of filename If a file of the same name exists it is overwritten Out result spr ok if the data sent on scrn was successfully written to the file filename otherwise it takes on a value indicating what went wrong spr bad packet size filename too large SIZE filename sp max openname size spr bad name null file name gt spr operation failed see hostio inc or iserver documentation for further details Notes This routine terminates on receipt of st endstream on scrn What is written to the file is the bytes that follow tags for those tags that have them with the exception that the st out int tag has its following INT32 truncated to a BYTE PROC so scrstream to stdout CHAN OF SP s ts CHAN OF SS scrn BYTE result Purpose To write the data sent on the given screen stream to standard out Channels fs from server APPROVED 5 2 91 44 SW 01 14 4 INMOS Limited Confidential occam User Lib Specs PROC ts to server scrn for input Out result spr ok if the data sent on scrn was successfully written to standard out otherwise is spr operation failed in which case see hostio inc or iserver documentation for further details Notes This routine terminates on receipt of st endstream on scrn What is written to the file is the bytes that follow tags for those tags that have them
11. exit the index of str of the byte immediately following the last character in str of the representation of number or SIZE str if the last character of the representation was placed into the last byte of str str the string into which to place the ASCII representation of number number a single precision real number in IEEE format Ip Dp formatting values for the real number see REAL32TOSTRING for their effect If str overflows this routine acts as an invalid process PROC append real64 INT len BYTE str Purpose In Out Out In In In Notes VAL REAL64 number VAL INT Ip Dp To write an ASCII representation of a double precision real number into a given string len on entry the index of str at which the first character of the representation of number is to be placed on exit the index of str of the byte immediately following the last character in str of the representation of number or SIZE str if the last character of the representation was placed into the last byte of str str the string into which to place the ASCII representation of number number a double precision real number in IEEE format Ip Dp formatting values for the real number see REAL64TOSTRING for their effect If str overflows this routine acts as an invalid process PROC append int64 INT len BYTE str VAL INT64 number VAL INT field Purpose In Out Out In In
12. occam8 lib occamutl liband virtual lib Only the user visible entry points are included here This then means that the contents of occamutl lib and virtual lib are not mentioned The compiler libraries are the only libraries which do not need to be USEd in the source code of a user s routine or program Entry Point Where Documented DRAW2D SW 0044 CLIP2D i MOVE2D APPROVED 5 2 91 2 SW 0114 4 INMOS Limited Confidential BITCOUNT CRCWORD CRCBYTE BITREVNBITS BITREVWORD FRACMUL UNPACKSN ROUNDSN IEEE32REM IEEE64REM REAL64EQ REAL64GT REAL320P IEEE320P REAL32REM REAL32EQ REAL32GT REAL64OP IEEE64OP REAL64REM IEEECOMPARE DIEEECOMPARE ABS FPINT ISNAN ORDERED NOTFINITE SCALEB FLOATING UNPACK ARGUMENT REDUCE MULBY2 DIVBY2 LOGB MINUSX COPYSIGN NEXTAFTER SQRT DABS DFPINT DISNAN DORDERED DNOTFINITE DSCALEB DFLOATING UNPACK DARGUMENT REDUCE DMULBY2 DDIVBY2 DLOGB DMINUSX DCOPYSIGN DNEXTAFTER DSQRT APPROVED 5 2 91 as for REAL32EQ but operates on REAL64 s as for REAL32GT but operates on REAL64 s occam 2 Reference Manual Appendix M occam 2 Reference Manual Appendix K occam User Lib Specs SW 0114 4 INMOS Limited Confidential occam User Lib Specs 5 debug lib 4 entry points PROC DEBUG ASSERT VAL BOOL assertion PROC Purpose In To possibly stop the calling process acting according to the value of an assertion assertion TRUE No effect assertion FA
13. 2 91 13 SW 0114 4 INMOS Limited Confidential occam User Lib Specs Purpose To delete the specified file Channels fs from server ts to server In name the name of the file to be deleted the filename must fill all of the bytes of name Out result equals spr ok if the file was removed otherwise takes on a value indicating what went wrong spr bad packet size name too large SIZE gt sp max removename size spr bad name name is null gt spr operation failed the delete failed see hostio inc or iserver documentation for further details Notes No path environment variable is used what is in name is all that is considered PROC so remove CHAN OF SP fs ts VAL BYTE name BYTE result As sp remove PROC sp rename CHAN OF SP fs ts VAL BYTE oldname newname BYTE result Purpose To rename the specified file Channels fs from server ts to server In oldname the present name of the file to be renamed In newname the desired name of the file to be renamed Out result equals spr ok if the renaming was successful otherwise takes on a value indicating what went wrong spr bad packet size the combined lengths of oldname and newname is too large it must be less than sp max renamename size spr bad name either or both of the filenames are null gt spr operation failed the renaming failed see hostio in
14. 28 so fwrite int64 hostio 28 so fwrite nl hostio 27 so fwrite real32 hostio 29 APPROVED 5 2 91 68 SW 0114 4 INMOS Limited Confidential occam User Lib Specs APPROVED 5 2 91 Entry Point Library Page so fwrite real64 hostio 30 so fwrite string hostio 26 so fwrite string nl hostio 27 so getenv hostio 15 so getkey hostio 15 so gets hostio 11 so keystream from file streamio 42 so keystream from kbd streamio 42 so keystream from stdin streamio 43 so multiplexor hostio 20 so open hostio 9 so open temp hostio 23 so overlapped buffer hostio 21 so overlapped multiplexor hostio 22 so overlapped pri multiplexor hostio 23 so parse command line hostio 25 so pollkey hostio 15 so popen read hostio 24 so pri multiplexor hostio 21 so puts hostio ti so read hostio 9 so read echo any int hostio 30 so read echo hex int hostio 31 so read echo hex int32 hostio 32 so read echo hex int64 hostio 32 so read echo int hostio 31 so read echo int32 hostio 31 so read echo int64 hostio 31 so read echo line hostio 33 so read echo real32 hostio 32 so read echo real64 hostio 32 so read line hostio 33 So remove hostio 14 so rename hostio 14 so scrstream to ANSI streamio 50 so scrstream to file streamio 44 so scrstream to stdout streamio 44 so scrstream to TVI920 streamio 50 so seek hostio 12 so system hostio 16 so tell hostio 13 so test exists hostio 24 so time hostio 16 so time to ascii hostio 35 so time to
15. INMOS Limited Confidential occam User Lib Specs Entry Point Library Page ss goto xy streamio 50 ss ins line streamio 52 ss insert char streamio 51 ss left streamio 51 ss right streamio 51 ss scrstream copy streamio 43 ss scrstream fan out streamio 43 ss scrstream from array streamio 44 ss scrstream multiplexor streamio 45 ss scrstream sink streamio 43 ss scrstream to array streamio 43 ss up streamio 51 ss write char streamio 49 ss write endstream streamio 49 ss write hex int streamio 48 ss write hex int64 streamio 48 ss write int streamio 48 ss write int64 streamio 48 ss write nl streamio 49 ss write real32 streamio 49 ss write real64 streamio 49 ss write string streamio 49 ss write text line streamio 50 str shift string 54 string pos string 55 STRINGTOBOOL convert 5 STRINGTOHEX convert 5 STRINGTOHEX16 convert 5 STRINGTOHEX32 convert 5 STRINGTOHEX64 convert 5 STRINGTOINT16 convert 5 STRINGTOINT32 convert 5 STRINGTOINT64 convert 5 STRINGTOINT convert 5 STRINGTOREAL32 convert 5 STRINGTOREAL64 convert 5 TAN snglmath and tbmaths 37 TANH snglmath and tbmaths 37 to lower case string 53 to upper case string 53 UNPACKSN compiler 3 up streamco 63 write char streamco 63 write endstream streamco 63 write full string streamco 62 write hex int streamco 63 write hex int64 streamco 63 write int streamco 63 write int64 streamco 63 write len string streamco 62 APPROVED 5 2 91 71 SW 01 14 4 INMOS Limited C
16. In data a string of bytes ALL of which are to be written to the file Out length this gives the number of bytes written if length SIZE data then an error occurred PROC sp gets CHAN OF SP fs ts VAL INT32 streamid INT bytes read BYTE data BYTE result Purpose To read a line from the specified input stream Channels fs from server ts to server In streamid the identification number of the open stream to be read from Out bytes read if result is spr ok this is the number of bytes read if result is spr buffer overflow then this will be SIZE data and will be less than the actual number of bytes read from the file otherwise zero Out data an array of bytes holding line read if result is spr ok or holding a truncation of the line if result is APPROVED 52 91 10 SW 01 14 4 INMOS Limited Confidential occam User Lib Specs spr buffer overflow It is undefined otherwise If result is spr ok or spr buffer overflow then the bytes will be data FROM 0 FOR bytes read Out result equal to spr ok if line was successfully read otherwise takes on a value indicating what went wrong spr bad packet size data is too large SIZE data gt sp max readbuffer size spr buffer overflow data not large enough to hold the line in which case the line is truncated to fit s spr operation failed the read failed either because the end of
17. Notes To convert a 64 bit integer into its representation as ASCII decimal digits with leading spaces if desired and write this into a given string len on entry the index of str at which the first character of the ASCII conversion of number is to be written on exit the index of str immediately after where the last character of the ASCII conversion of number was written or SIZE str if this last character was written into the last positon of str str the string into which the ASCII conversion of number is to be written number the 64 bit integer to be converted to an ASCII representation and then written into str field the field width of the ASCII representation of number if number cannot be represented in field characters then the representation is widened as necessary if field is larger than necessary then padding spaces are added on the left it is an error for field to be negative If str overflows then this routine acts as an invalid process The conversion of number will include a minus sign if applicable APPROVED 52 91 58 SW 01 14 4 INMOS Limited Confidential occam User Lib Specs PROC append hex int64 INT len BYTE str VAL INT64 number VAL INT width Purpose In Out Out In In Notes PROC next word Purpose In In Out Out Out In Out To convert a 64 bit integer into its representation as ASCII hexadecimal characters and write this i
18. PROC next int from line VAL BYTE line INT ptr number BOOL ok Purpose In In Out Out In Out Notes To determine the next integer in a given line skipping leading spaces and tabs line a string containing the line from which an integer is desired to be noted The string is considered to be of length SIZE line ptr on entry the index of line from which to start the search for an integer i e the search begins at line ptr with ptr increasing exit if ok is FALSE on entry then unchanged if ok is TRUE on entry then is either the index of the space or tab immediately after the found integer or is SIZE line where it is only ever greater than if it was passed in as such whether ok is subsequently set to FALSE or not number if ok is FALSE on entry then undefined if ok is TRUE on entry if ok TRUE on exit the integer read otherwise undefined ok on entry if FALSE ptr and ok remain unchanged and number is undefined otherwise a search for an integer is carried out exit if FALSE on entry then FALSE if TRUE on entry FALSE if there were no non space or non tab characters before the end of the string FALSE if the first sequence of non space non tab characters do not form an integer FALSE if an integer found that overflowed the range of INT otherwise TRUE Leading spaces and horizontal tabs from line ptr ptr on entry are skipped The first
19. a representation of a single precision real in occam syntax though a or is allowed as first character from the keyboard and to echo it to standard out Channels fs from server ts to server Out n if error is FALSE the IEEE single precision format of the real that was read otherwise undefined Out error FALSE if the real was read and converted to binary without problem TRUE otherwise if the string read does not conform to the syntax of an occam real number other than the fact that a plus or minus sign is allowed as the first character Notes The number typed at the keyboard must be terminated by pressing RETURN PROC so read echo real64 CHAN OF SP fs ts REAL64 n BOOL error Purpose To read a string containing a representation of a double precision real in occam syntax though a or is allowed as first character from the keyboard and to echo it to APPROVED 5 2 91 32 SW 0114 4 INMOS Limited Confidential occam User Lib Specs standard out Channels fs from server a ts to server Out n if error is FALSE the IEEE double precision format of the real that was read otherwise undefined Out error FALSE if the real was read and converted to binary without problem TRUE otherwise if the string read does not conform to the syntax of an occam real number other than the fact that a plus or minus sign is allowed
20. as the first character Notes The number typed at the keyboard must be terminated by pressing RETURN PROC so read line CHAN OF SP s ts INT len BYTE line BYTE result Purpose To read a line from the keyboard without echoing it Channels fs from server ts to server Out len the number of bytes in the parameter line that form the line that was read Out line if result spr ok the line that was read is in the first len bytes the remaining bytes being undefined or if mi the supplied byte array was not large enough for the read line the read line is truncated to fit otherwise undefined Out result spr ok if the line was successfully read otherwise gt spr operation failed see hostio inc or iserver documentation for further details Notes The line to be read is considered terminated by a carriage return ie ASCII M which has value OD 13 This carriage return is not included in the line and nor is a newline ASCII J 0 10 if present in the input If an error occurs whilst reading the line this routine terminates immediately PROC so read echo line CHAN OF SP fs ts INT len BYTE line BYTE result Purpose To read a line from the keyboard echoing it to standard out Channels fs from server ts to server Out len the number of bytes in line that form the line that was read Out line
21. between when the abort signal was received and the resetting of the channel streamco lib 53 entry points This library provides a simplified interface to streamio 1ib It is intended to help TDS users to port their programs to the toolset Entry Point keystream to screen write len string write full string newline read echo char read echo hex int read echo int read echo text line read echo int64 read echo hex int64 get real with del read echo real32 read echo real64 read hex int read hex int64 scrstream to array scrstream from array scrstream fan out Where Documented Transputer Development System Chapter 14 APPROVED 52 91 62 SW 01 14 4 INMOS Limited Confidential occam User Lib Specs scrstream sink scrstream copy keystream sink read char write char write text line write endstream read int read int64 read real32 read real64 write int write hex int write int64 write hex int64 write real32 write real64 goto xy clear eol clear eos beep up down left right insert char delete chr delete chl ins line del line read line see below scrstream to file keystream from file scrstream to ANSI scrstream to T VI920 E PROC PROC PROC PROC read line CHAN OF INT source INT len BYTE line INT char As ks read line in streamio lib scrstream to file CHAN OF ANY scrn CHAN OF SP fs ts VAL BYTE filename INT result As so scrstream to file in streamio lib wi
22. date hostio 34 so today ascii hostio 36 so today date hostio 36 so version hostio 19 so write hostio 10 so write char hostio 26 69 SW 0114 4 INMOS Limited Confidential occam User Lib Specs APPROVED 5 2 91 Entry Point Library Page so write hex int hostio 29 so write hex int32 hostio 29 so write hex int64 hostio 29 so write int hostio 28 so write int32 hostio 28 so write int64 hostio 28 so write nl hostio 27 so write real32 hostio 30 so write real64 hostio 30 so write string hostio 26 so write string nl hostio 26 sp buffer hostio 19 sp close hostio 9 sp commandline hostio 17 sp core hostio 18 sp eof hostio 13 sp exit hostio 17 sp ferror hostio 13 sp flush hostio 11 sp getenv hostio 15 sp getkey hostio 14 sp gets hostio 10 sp multiplexor hostio 19 sp open hostio 8 sp overlapped buffer hostio 21 sp overlapped multiplexor hostio 21 sp overlapped pri multiplexor hostio 22 sp pollkey hostio 15 sp pri multiplexor hostio 20 sp puts hostio 11 sp read hostio 9 sp receive packet hostio 34 sp remove hostio 13 sp rename hostio 14 sp seek hostio 12 sp send packet hostio 34 sp system hostio 16 sp tell hostio 12 sp time hostio 16 sp version hostio 18 sp write hostio 10 SQRT compiler 3 ss beep streamio 51 ss clear eol streamio 50 ss clear eos streamio 50 ss del line streamio 52 ss delete chl streamio 52 ss delete chr streamio 51 ss down streamio 51 70 SW 0114 4
23. del streamco 62 goto xy streamco 63 HEX16TOSTRING convert 5 HEX32TOSTRING convert 5 HEX64TOSTRING convert 5 HEXTOSTRING convert 5 IEEE320P compiler 3 IEEE32REM compiler 3 IEEE640P compiler 3 IEEE64REM compiler 3 IEEECOMPARE compiler 3 InputOrFail c xlink 61 InputOrFail t xlink 61 ins line streamco 63 66 SW 01 14 4 INMOS Limited Confidential occam User Lib Specs Entry Point Library Page insert char streamco 63 insert string string 55 INT16TOSTRING convert 5 INT32TOSTRING convert 5 INT64TOSTRING convert 5 INTTOSTRING convert 5 is digit string 53 is hex digit string 53 is id char string 53 is in range string 52 is lower string 52 is upper string 52 ISNAN compiler 3 keystream from file streamco 63 keystream sink streamco 63 keystream to screen streamco 62 ks keystream sink streamio 42 ks keystream to scrstream streamio 41 ks read char streamio 45 ks read int streamio 46 ks read int64 streamio 46 ks read line streamio 45 ks read real32 streamio 47 ks read real64 streamio 47 left streamco 63 LOGB compiler 3 MINUSX compiler 3 MOVE2D compiler 2 MULBY2 compiler 3 newline streamco 62 next int from line string 60 next word from line string 59 NEXTAFTER compiler 3 NOTFINITE compiler 3 ORDERED compiler 3 OutputOrFail c xlink 62 OutputOrFail t xlink 61 POWER snglmath and tbmaths 37 RAN snglmath and tbmaths 37 read char streamco 63 read echo char streamco 62 read echo hex int streamco 62 read echo hex int6
24. error Purpose To read an integer in two s complement hexadecimal form APPROVED 52 91 31 SW 01 14 4 INMOS Limited Confidential occam User Lib Specs from the keyboard and to echo it to standard out Channels fs from server ts to server Out n if error is FALSE the value of the hexadecimal number read otherwise undefined Out error FALSE if everything was in order TRUE otherwise 1 if the integer overflows the INT range 2 if there is a non hex character in the string read from the keyboard other than or in the first character position Notes The hexadecimal number must begin with one of H or a sign is not allowed nor necessary since the most significant bit indicates the sign A and mean exactly the same thing the following digits form a hex integer A means add the given hex integer to MOSTNEG INT using modulo arithmetic to give the result Both upper and lower case hex digits are permissible The number typed at the keyboard must be terminated by pressing RETURN PROC so read echo hex int32 CHAN OF SP fs ts INT32 n BOOL error As so read echo hex int but for INT32s PROC so read echo hex int64 CHAN OF SP fs ts INT64 n BOOL error As so read echo hex int but for INT64S PROC so read echo real32 CHAN OF SP fs ts REAL32 n BOOL error Purpose To read a string containing
25. host identifies the host via sph constants os identifies the host environment via spo constants board identifies the interface board via spb constants If any of the information has the value zero then that information is not available The parameter version cannot distinguish between e g 1 41 and 1 42 CHAN OF SP fs ts from user to user CHAN OF BOOL stopper To act as a communication buffer fs input to this routine ts output from this routine from user input to this routine to user output from this routine stopper input to this routine TRUE or FALSE received will terminate this routine No more than sp max packet data size bytes can be buffered Primary input to this routine must be on the guard input channels from user or stopper Input on from user is stored output on ts then a reply is expected on fs this reply is stored and then output on to user and all this must finish before any new input can be received on from user or stopper CHAN OF SP fs ts from user to user CHAN OF BOOL stopper As sp buffer PROC sp multiplexor CHAN OF SP s ts CHAN OF SP from user to user CHAN OF BOOL stopper APPROVED 5 2 91 19 SW 0114 4 INMOS Limited Confidential occam User Lib Specs PROC PROC Purpose To multiplex any number of pairs of SP protocol channels onto a single pair of SP protocol channels Channels single pair fs input to this routine ts output from this routine
26. length trailing spaces should be used to pad option parameters required indicates if the corresponding option in option strings requires a parameter The permissible values are spopt never never takes a parameter spopt maybe optionally takes a parameter spopt always must take a parameter option exists TRUE if the corresponding option was present on the command line otherwise FALSE option parameters if an option was followed by a parameter then the position in the array line where the parameter starts and the length of the parameter are given by the first and second elements respectively in the corresponding element of this parameter as long as an error did not occur APPROVED 52 91 25 SW 01 14 4 INMOS Limited Confidential occam User Lib Specs error len zero if no error occurs whilst the command line is being parsed otherwise greater than zero and is the number of bytes in line which will contain an error message line contains the command line as supplied by the server if there was no error in which case error len is zero otherwise contains an error message the length of which is given by error len There is no limitation on the size of line if it is not long enough for an error message then that message is truncated to fit if not long enough for the command line then an error message is put into line PROC so write string CHAN OF SP s ts VAL BYTE string Purpose Channels I
27. multiple pairs from user input to this routine to user output from this routine termination channel stopper input to this routine TRUE or FALSE received on this channel will cause the routine to terminate this channel has the highest priority amongst the channels Notes It is an error if the number of channels in from user is not equal to that in to user It is permissible for from user and hence to user to be null arrays No more than sp max packet data size bytes can be buffered as they passes through this routine Primary input to this routine must be on the guard input channels from user i or stopper Input on from user i is stored output on ts then a reply is expected on fs this reply is stored and then output on to user i and all this must finish before any new input can be received on any of the from user channels or stopper To attempt some degree of fairness there is a heirarchy of priorities from from user with index i for SIZE from user using modulo SIZE from user on the indexes with i starting from 0 and incrementing by one after each input accepted so multiplexor CHAN OF SP fs ts CHAN OF SP from user to user CHAN OF BOOL stopper As sp multiplexor sp pri multiplexor CHAN OF SP fs ts OF SP from user to user CHAN OF BOOL stopper Purpose To multiplex any number of pairs of SP protocol channels onto a single pair of SP protocol channels Channels single pair fs input
28. result spr ok if the write was successful otherwise gt spr operation failed Notes No check is made to ensure that the value written to the port has been correctly read by the device connected to the port if any PROC dos port read CHAN OF SP fs ts VAL INT16 port location BYTE value BYTE result Purpose To read a byte from a given port Channels fs from server ts to server In port location the address where the port is to be found APPROVED 52 91 40 SW 01 14 4 INMOS Limited Confidential occam User Lib Specs the address being in the I O space of the PC and hence is an unsigned number between 0 and 64K Out value the value read from port location Out result spr ok if the read was successful otherwise gt spr operation failed Notes No check is made to ensure that the value received from the port if any is valid The value returned in value is that of the given address at the moment the port is read by the host file server 13 streamio lib 45 entry points The key stream and screen stream protocols used by the routines in this library have their origins in the Transputer Development System TDS The key stream protocol KS is in fact simply INT This gives rise to some confusing terminology because the TDS and the naming of some of the routines in this library refer to characters when actually meaning an INT a word length quantity
29. sign or space If X is infinity or a NaN then the string will contain one of Inf Inf or NaN but not the quotes padded on the right to fill the field width All other combinations of Ip and Dp are meaningless and will cause an error PROC REAL64TOSTRING INT len BYTE string VAL REAL64 X VAL INT Ip Dp As REAL32TOSTRING but for double precision reals APPROVED 52 91 6 SW 01 14 4 INMOS Limited Confidential occam User Lib Specs 7 crc lib 2 entry points INT FUNCTION CRCFROMLSB VAL BYTE InputString VAL INT PolynomialGenerator VAL INT OldCRC Purpose To calculate a CRC value for a given string starting from the least significant bit Returned The CRC value calculated for InputString with generator PolynomialGenerator and initial CRC value OldCRC In InputString the string for which a CRC value is desired In PolynomialGenerator an integer which acts somewhat like an encryption key in that it is something which remains constant during the calculation but on which the CRC value intimately depends In OldCRC this is used only as the initial CRC value during the iteration over the string which does mean that the final CRC value the value that is returned depends on it Notes The string of bytes is polynomially divided starting from the least significant bit of the least significant byte in inreasing bit order INT FUNCTION CR
30. stream channel into given array Channels scrn for input APPROVED 5 2 91 43 SW 0114 4 INMOS Limited Confidential occam User Lib Specs Out buffer the array to which the data received on scrn is placed the data is stored in the form of TDS2 tt tags followed as necessary by further data bytes if buffer overflows then this procedure acts as an invalid process Notes This procedure terminates when st endstream is read on channel scrn This terminating st endstream is stored in buffer as tt endstream PROC ss scrstream from array CHAN OF SS scrn VAL BYTE buffer Purpose To output the data in the given array on the given screen stream channel Channels scrn for output Out buffer the array from which the data is to be sent on scrn the data should be in the form of TDS2 tt tags followed as necessary by further data bytes Notes This procedure terminates when tt endstream is found in buffer This tt endstream is not sent out as st endstream or anything else PROC so scrstream to file CHAN OF SP fs ts CHAN OF SS scrn VAL BYTE filename BYTE result Purpose To write the data sent on the given screen stream to a file Channels fs from server ts to server scrn for input In filename the name of the file to be write to The name of the file must fit exactly into filename i e there are SIZE filename
31. to this routine ts output from this routine multiple pairs from user input to this routine to user output from this routine There is a relative priority to the input channels from user i is of higher priority than from user j where i j termination channel stopper input to this routine TRUE or FALSE received on this channel will cause the routine to terminate this APPROVED 52 91 20 SW 01 14 4 INMOS Limited Confidential occam User Lib Specs channel has the lowest priority of all input channels Notes It is an error if the number of channels in from user is different to that in to user It is permissible for the number of channels in from user and hence also to user to be zero No more than sp max packet data size bytes be buffered as they passes through this routine Primary input to this routine must be on the guard input channels from user i or stopper Input on from user i is stored output on ts then a reply is expected on fs this reply is stored and then output on to user i and all this must finish before any new input can be received on any of the from user channels or stopper PROC so pri multiplexor CHAN OF SP s ts CHAN OF SP from user to user CHAN OF BOOL stopper As sp pri multiplexor PROC sp overlapped buffer CHAN OF SP s ts from user to user CHAN OF BOOL stopper Purpose To act as two almost independent b
32. unwritten data is flushed or any unread buffered input is discarded PROC so close CHAN OF SP fs ts VAL INT32 streamid BYTE result As sp close PROC sp read CHAN OF SP fs ts VAL INT32 streamid INT bytes read BYTE data BYTE result Purpose To read a limited number of bytes from a stream Channels fs from server ts to server In streamid the identification number of the open stream to be read from Out bytes read if result is spr ok then this gives the number of bytes read from the file these bytes will be data FROM 0 FOR bytes read if bytes read lt gt SIZE data then either an error occurred or the end of the file was reached If result is not spr ok then bytes read will be zero 0 lt bytes read lt sp max readbuffer size Out data if result is spr ok then this contains the bytes read from the file otherwise it is undefined The number of bytes requested to be read is SIZE data the limit to this is sp max readbuffer size Out result equal to spr bad packet size if too many bytes asked for ie SIZE data sp max readbuffer size otherwise it is equal to spr ok PROC so read CHAN SP fs ts VAL INT32 streamid INT bytes read BYTE data Purpose To read an unlimited number of bytes from a stream Channels fs from server ts to server APPROVED 5 2 91 9 SW 0114 4 INMOS Limited Confidential occam U
33. with the exception that the st out int tag has its following INT32 truncated to a BYTE and that the st beep tag is transformed into 07 ss scrstream multiplexor CHAN OF SS screen in CHAN OF SS screen out CHAN OF INT stopper Purpose To multiplex up to 256 screen stream channels onto a single such channel Channels screen in an array of input channels screen out the single output channel stopper input to this routine any integer received on this channel will terminate this routine this channel has highest priority Notes It is an error if there are more than 256 channels in screen in It is permissible for screen in to be a null array Each change of input channel directs output to the next line of the screen and each such line is annotated at the left with the array index of the channel used followed by gt The tag st endstream is ignored To attempt some degree of fairness let the implementation give priority in a heirarchy from screen in with index i for SIZE screen in using modulo SIZE screen in on the indexes starting from 0 and incrementing it by one after each input accepted ks read char CHAN OF KS source INT char Purpose To obtain the value of the next word length quantity from the given keystream channel Channels source for input Out char the value of the word obtained ks read line CHAN OF KS source INT len BYTE line INT char Purpose To read a line of text from the given key
34. 4 streamco 62 read echo int streamco 62 read echo int64 streamco 62 read echo real32 streamco 62 read echo real64 streamco 62 read echo text line streamco 62 read hex int streamco 62 read hex int64 streamco 62 APPROVED 5 2 91 6 SW 0114 4 INMOS Limited Confidential occam User Lib Specs Entry Point Library Page read int streamco 63 read int64 streamco 63 read line streamco 63 read rea132 streamco 63 read real64 streamco 63 REAL32EQ compiler 3 REAL32GT compiler 3 REAL320P compiler 3 REAL32REM compiler 3 REAL32TOSTRING convert 5 REAL64EQ compiler 3 REAL64GT compiler 3 REAL640P compiler 3 REAL64REM compiler 3 REAL64TOSTRING convert 6 Reinitialise xlink 60 right streamco 63 ROUNDSN compiler 3 SCALEB compiler 3 scrstream copy streamco 63 scrstream fan out streamco 62 scrstream from array streamco 62 scrstream sink streamco 63 scrstream to ANSI streamco 63 scrstream to array streamco 62 scrstream to file streamco 63 scrstream to TVI920 streamco 64 search match string 56 search no match string 56 SIN snglmath and tbmaths 37 SINH snglmath and tbmaths 37 so ask hostio 34 so buffer hostio 19 so close hostio 9 So commandline hostio 18 so core hostio 18 so date to ascii hostio 35 so eof hostio 13 so exit hostio 17 so ferror hostio 13 so flush hostio 12 so fwrite char hostio 26 so fwrite hex int hostio 28 so fwrite hex int32 hostio 29 so fwrite hex int64 hostio 29 so fwrite int hostio 27 so fwrite int32 hostio
35. CFROMMSB VAL BYTE InputString VAL INT PolynomialGenerator VAL INT OldCRC Purpose To calculate a CRC value for a given string starting from the most significant bit Returned The CRC value calculated for InputString with generator PolynomialGenerator and initial CRC value OldCRC In InputString the string for which a CRC value is desired In PolynomialGenerator an integer which acts somewhat like an encryption key in that it is something which remains constant during the calculation but on which the CRC value intimately depends In OldCRC this is used only as the initial CRC value during the iteration over the string which does mean that the final CRC value the value that is returned depends on it Notes The string of bytes is polynomially divided starting from the most significant bit of the most significant byte in decreasing bit order 8 hostio lib 103 entry points The routines in hostio lib are meant as the user s interface to the server and hence the host APPROVED 5 2 91 7 SW 0114 4 INMOS Limited Confidential occam User Lib Specs machine The routines are therefore dependent on the functionality of the iserver see SW 0102 Constants referred to in the following specifications are to be found in the include file hostio inc A naming convention has been adopted for these routines The basic ones use the server protocol directly and map directly onto server fun
36. D compiler 3 DABS compiler 3 DACOS dblmath and tbmaths 37 DALOG dblmath and tbmaths 37 DALOG10 dblmath and tomaths 37 DARGUMENT REDUCE compiler 3 DASIN dblmath and tbmaths 37 DATAN dblmath and tbmaths 37 DATAN2 dblmath and tbmaths 37 DCOPYSIGN compiler 3 DCOS dblmath and tbmaths 37 DCOSH dblmath and tbmaths 37 DDIVBY2 compiler 3 DEBUG ASSERT debug 4 DEBUG MESSAGE debug 4 DEBUG STOP debug 4 DEBUG TIMER debug 4 del line streamco 63 65 SW 0114 4 INMOS Limited Confidential APPROVED 5 2 91 occam User Lib Specs Entry Point Library Page delete chl streamco 63 delete chr streamco 63 delete string string 54 DEXP dblmath and tbmaths 37 DFLOATING UNPACK compiler 3 DFPINT compiler 3 DIEEECOMPARE compiler 3 DISNAN compiler 3 DIVBY2 compiler 3 DLOGB compiler 3 DMINUSX compiler 3 DMULBY2 compiler 3 DNEXTAFTER compiler 3 DNOTFINITE compiler 3 DORDERED compiler 3 dos call interrupt msdos 39 dos port read msdos 40 dos port write msdos 40 dos read regs msdos 40 dos receive block msdos 39 dos send block msdos 38 down streamco 63 DPOWER dblmath and tbmaths 37 DRAN dblmath and tbmaths 37 DRAW2D compiler 2 DSCALEB compiler 3 DSIN dblmath and tbmaths 37 DSINH dblmath and tbmaths 37 DSQRT compiler 3 DTAN dblmath and tbmaths 37 DTANH dblmath and tbmaths 37 eqstr string 54 EXP snglmath and tbmaths 37 FLOATING UNPACK compiler 3 FPINT compiler 3 FRACMUL compiler 3 get real with
37. LSE Action depends on whether debugger is running Debugger present sends an error message to the debugger along with Iptr and Wdesc for caller and stops process not present stops process or processor depending on error mode assertion the value of the assertion made in the call of this routine DEBUG MESSAGE VAL BYTE message Purpose In To send a message to the debugger which is to be displayed with normal program output The precise action depends on whether the debugger is running or not Debugger present sends a message to the debugger along with the Iptr and Wdesc for the caller not present no action message the message to send to the debugger DEBUG STOP Purpose To stop the calling process first sending information to the debugger if it is running Debugger present sends an error message to the debugger along with Iptr and Wdesc for caller and stops process not present stops process or processor depending on error mode DEBUG TIMER CHAN OF INT stop Purpose Channels Notes To enable the debugger to find a way into a deadlocked program by always ensuring there is a process on the timer or the run queues stop for input This procedure will continually wait on the timer until it is told to terminate by the receipt of any value on the stop input channel The odds are that this process will be found on the timer queue This process may be run at any priority on 16 and 32 bit proc
38. OF SP fs ts VAL INT n width Purpose To write an integer as hexadecimal ASCII characters preceded by the character to standard out Channels fs from server ts to server In n the integer to write out In width the field width to use when writing the hex if width is larger than the size of the number then the number is padded with leading 0 s or F s as appropriate if width is smaller than the size of the number then the number is truncated at the left to width characters width does not take the into account a negative field width is an error PROC so fwrite hex int32 CHAN OF SP fs ts VAL INT32 streamid n VAL INT width BYTE result As so fwrite hex int but for INT32s PROC so write hex int32 CHAN OF SP fs ts VAL INT32 n VAL INT width As so write hex int but for INT32s PROC so fwrite hex int64 CHAN OF SP fs ts VAL INT32 streamid VAL INT64 n VAL INT width BYTE result As so fwrite hex int but for INT64s PROC so write hex int64 CHAN OF SP fs ts VAL INT64 n VAL INT width As so write hex int but for INT64s PROC so fwrite real32 CHAN OF SP fs ts VAL INT32 streamid VAL REAL32 r VAL INT Ip Dp BYTE result Purpose To write a single precision real as decimal ASCII characters to a stream Channels fs from server ts to server In streamid the identification number of the stream to write the rea
39. The TDS requires values outside the ASCII range for its operation and so uses word length quantities and due to streamio lib being intended to facilitate porting of the TDS to the toolset the same terminology is used for the naming of the routines Hence for example ks read char actually reads a word length quantity rather than a BYTE There is a naming convention used in this library Procedures always begin with a prefix derived from the first parameter Stream processes ones which convert streams from keyboard or screen protocol to the server protocol SP or to related data structures where the sP channel is used in combination with either the KS or SS protocols are prefixed with so Stream input routines that is ones which use only the Ks protocol are prefixed with ks and stream output routines that is ones which use only the ss protocol are prefixed with ss The single KS to SS conversion routine which uses both protocols is prefixed with ks because it is the KS parameter which is first Constants referred to in the following specifications are to be found in the include files nostio inc and streamio inc PROC ks keystream to scrstream CHAN OF KS keyboard CHAN OF SS scrn Purpose To convert keystream protocol into screen stream protocol Channels keyboard for input scrn for output Notes This procedure is terminated by the receipt of ft terminated from the keyboard strea
40. alues BOOL FUNCTION eqstr VAL BYTE s1 s2 Purpose To determine if two strings are identical or not Returned TRUE if the two strings are identical in length and content FALSE otherwise In In sl s2 the strings to be compared PROC str shift BYTE str VAL INT start len shift BOOL not done Purpose To shift a substring In Out str on entry a string containing the substring to be shifted in positions str FROM start FOR len on exit the string once the substring has been shifted the only bytes of string that have changed being those that the substring was shifted into In start the index of str of the first character of the substring to be shifted In len the number of characters in the substring to be shifted In shift the number of places to the right to move the substring by so that a negative number for shift will move the substring left Out not done TRUE if any elements of the substring are shifted off either end of str though no access is made to invalid locations of str FALSE if the shifted substring is entirely within str PROC delete string INT len BYTE str VAL INT start size BOOL not done Purpose To remove a substring from a string In Out len on entry the number of significant characters in str on exit if not done is FALSE the number of significant characters in str being size subtracted from the ent
41. ame path variable name VAL BYTE open type INT full len BYTE full name INT32 stream id BYTE result To perform a general purpose open file for reading fs from server ts to server filename a string with the name of the file to be opened There may be an explicit directory part to the file s name path variable name a string holding the name of a path environment variable there is a limit imposed on the number of characters accepted from sp getenv for the environment variable contents the limit is imposed by this routine and is given by 256 path string size in the program text open type either spt binary for a file containing raw bytes only or spt text for a file stored as text records separated by newlines full len the number of characters in full name if result is spr ok undefined otherwise full name if result is spr ok full name FROM 0 FOR full len is the name of the file that was successfully opened undefined otherwise full name clearly should be at least as large as filename streamid if result is spr ok the identification number of the Stream associated with the file that was opened undefined APPROVED 52 91 24 SW 01 14 4 INMOS Limited Confidential occam User Lib Specs otherwise result spr ok if a file was opened successfully otherwise some value indicating what went wrong spr bad packet size SIZE filename gt sp max openname size or SIZE path variable name gt sp max getenvnam
42. andline CHAN OF SP fs ts VAL BYTE all Purpose Channels In Out Out Out INT length BYTE string BYTE result To return the command line passed to the server on invocation fs from server ts to server all either sp short commandline remove the server s own name its recognised options and their parameters or sp whole commandline the entire command line length the number of bytes returned in string starting from string 0 being zero in the case of result spr operation failed string contains the requested command line if result spr ok contains a truncation of the requested command line if result spr buffer overflow is undefined otherwise There is no restriction on the size of string result equal to spr ok if the command line was successfully returned otherwise takes on a value indicating what went wrong spr buffer overflow string is not long enough to contain the command line but the latter has been truncated to fit gt spr operation failed the operation failed refer to hostio inc or iserver documentation for further details APPROVED 5 2 91 17 SW 0114 4 INMOS Limited Confidential occam User Lib Specs PROC so commandline CHAN OF SP fs ts VAL BYTE all INT length BYTE string BYTE result As sp commandline PROC sp core CHAN OF SP s ts VAL INT32 offset INT bytes read BYTE data BYTE result Purpose To return the contents of the root
43. b Specs Notes A distinction must be made here Detween a character held in a byte and a character held in a word length quantity Here the former is referred to as a character and the latter as a character note the quotes Upper and lower case letters are permissible in a hexadecimal integer All input up to a plus sign a minus sign a hash symbol decimal digit or a negative valued word is skipped If it is the hash that is encountered first then it is a hexadecimal integer in two s complement form that is expected If it is a negative valued word that is encountered then input error has occurred that value is returned in char The integer is terminated when anything other than a valid digit hex and or decimal as the case may be is read and it is this terminating quantity that is returned in char if the integer read is not invalid PROC ks read real32 CHAN OF KS source REAL32 number INT char Purpose To read a single precision real number from the given keystream Channels source for input Out number if char on exit is not ft number error or less than zero then the real number read in single precision IEEE format otherwise undefined In Out char on entry the first character from the input to be read on exit ft number error if the characters read did not form an occam syntax real number with opt
44. b Specs INMOS Limited Confidential occam User Lib Specs 14 ss delete chl CHAN OF SS scrn Purpose Channels To delete the character to the left of the cursor on the terminal screen and move the rest of the line one place to the left The cursor also moves one place to the left scrn for output ss ins line CHAN OF SS scrn Purpose Channels To move all lines below the current line on the terminal down one line losing the bottom line with the inserted line blank scrn for output ss del line CHAN OF SS scrn Purpose To delete the current line on the terminal and move all lines below it up one line Channels scrn for output Notes The bottom line of the terminal screen becomes blank string lib 27 entry points BOOL FUNCTION is in range VAL BYTE char bottom top BOOL Purpose Returned In In In To determine whether the value of a byte lies in the inclusive range between two others TRUE if the value of char lies in the range value of bottom value of topl FALSE otherwise char the byte the value of which is to be tested to see whether it lies in a given range bottom the lowermost limit of the test range top the uppermost limit of the test range FUNCTION is upper VAL BYTE char Purpose Returned In To determine whether the value of a byte lies in the inclusive range that delimits upper case ASCII characters TRUE if the value of char corresponds to a
45. c or iserver documentation for further details PROC so rename CHAN OF SP fs ts VAL BYTE oldname newname BYTE result As sp rename PROC sp getkey CHAN OF SP fs ts BYTE key result Purpose To read a single character from the keyboard waiting for one if there is none Channels fs from server ts to server Out key the key that was read Out result equals spr ok if the read was successful otherwise gt Spr operation failed see hostio inc or iserver documentation for further details Notes The key is not echoed to the screen APPROVED 52 91 14 SW 01 14 4 INMOS Limited Confidential occam User Lib Specs PROC so getkey CHAN OF SP fs ts BYTE key result As sp getkey PROC sp pollkey CHAN OF SP fs ts BYTE key result Purpose To read a single character from the keyboard without waiting for one if there is none Channels fs from server ts to server Out key the key that was read Out result equals spr ok if there was a key to read and the read was successful otherwise spr operation failed refer to hostio inc or iserver documentation for further details Notes The key is not echoed to the screen PROC so pollkey CHAN OF SP fs ts BYTE key result As sp pollkey PROC sp getenv CHAN OF SP fs ts VAL BYTE name INT length BYTE value BYTE result Purpose To return the contents of an environm
46. cating what went wrong APPROVED 5 2 91 23 SW 0114 4 INMOS Limited Confidential occam User Lib Specs spr bad type invalid type spr notok there are already 10 000 such temp files gt spr operation failed the open failed refer to hostio inc or iserver documentation for further details The file will be opened in the current directory The file name of the temporary file is chosen as follows the first name tried is TEMP00 if there already exists such a file then TEMPOl is tried if there already exists such a file then TEMPO2 is tried etc up to TEMP99 when if such a file exists then TEM100 is tried and so on up to TEM999 at which point if such a file exists TE1000 is tried and so on up to TE9999 which is the last name tried i e a maximum of 10 000 possible temporary files can be created by this routine PROC so test exists CHAN OF SP fs ts VAL BYTE filename BOOL exists Purpose Channels In Out To test for the existence of a file s from server ts to server filename the name of the file to test for the existence of The name of the file must fit exactly into filename i e there are SIZE filename characters in the name of the file A directory specification may form part of filename exists TRUE if the file exists FALSE otherwise PROC so popen read CHAN OF SP s ts Purpose Channels In In In Out Out Out VAL BYTE filen
47. channel c In Out t a timer providing a clock to use for the time out In time the absolute time of when the time out for the communication over channel c should occur Out aborted TRUE if the communication timed out FALSE if the communication successfully took place One cannot be sure that the communication was not successful if aborted APPROVED 5 2 91 61 SW 0114 4 INMOS Limited Confidential occam User Lib Specs PROC 16 Notes is TRUE because it is just possible that the communication terminated successfully between when the time out occurred and the resetting of the channel If the time out occurs then the channel c is reset and this procedure terminates OutputOrFail c CHAN OF ANY c VAL BYTE mess CHAN OF INT kill Purpose Channels In Out BOOL aborted To provide through an abort control channel for communication failure on a channel expecting to output c the channel over which an output communication is to be made kill an abort control channel any integer received on this channel will cause the channel c to be reset and this procedure to terminate mess the message to be output over channel c aborted TRUE if the communication was signalled to be aborted FALSE if the communication successfully took place One cannot be sure that the communication was not successful if aborted is TRUE because it is just possible that the communication terminated successfully
48. ctions These have the prefix sp Routines which use the basic routines have the prefix so In many cases the mapping between the so routines and the sp routines is one to one Note that in some routines with a non VAL parameter of type 1 BYTE although the value on entry to the routine of the array is irrelevant the SIZE of the array is important In these routines such an array parameter is nevertheless described simply as out PROC sp open CHAN OF SP fs ts VAL BYTE name VAL BYTE type mode INT32 streamid BYTE result Purpose To open a file Channels fs from server ts to server In name the name of the file to be opened The name of the file must fit exactly into name i e there are SIZE name characters in the name of the file A directory specification may form part of name In type either spt binary for a file containing raw bytes only or spt text for a file stored as text records separated by newlines In mode one of spm input open existing file for reading spm output open new file or truncate existing one writing spm append open new file or append to existing one for writing spm existing update open existing file for update reading and writing starting at the beginning of the file spm new update open new file or truncate existing one as for update spm append update open new file or appe
49. d VAL INT width BYTE result As so fwrite int but for INT32s PROC so write int32 CHAN OF SP fs ts VAL INT32 n VAL INT width As so write int but for INT32s PROC so fwrite int64 CHAN OF SP fs ts VAL INT32 streamid VAL INT64 n VAL INT width BYTE result As so fwrite int but for INT64s PROC so write int64 CHAN OF SP fs ts VAL INT64 n VAL INT width As so write int but for INT64s PROC so fwrite hex int CHAN OF SP fs ts VAL INT32 streamid VAL INT n width BYTE result Purpose To write an integer as hexadecimal ASCII characters preceded by the character to a stream Channels fs from server ts to server In streamid the identification number of the stream to write to In n the integer to write out In width the field width to use when writing the hex if width is larger than the size of the number then the number is padded with leading 0 s or F s as appropriate if width is smaller than the size of the number then the number is truncated at the left to width characters width does not take the into account a negative field width is an error Out result spr ok if the integer was successfully written APPROVED 5 2 91 28 SW 0114 4 INMOS Limited Confidential occam User Lib Specs otherwise not all of the string could be written in which case gt result takes on a value of spr notok PROC so write hex int CHAN
50. d units followed by two spaces In days first TRUE if date to be written with the days preceding the month i e British format FALSE if the month is to precede the days i e U S format Out string an ASCII string representing the time and date as follows HH MM SS DD MM YY long years FALSE days first TRUE HH MM SS DD MM YYYY long years TRUE days first TRUE HH MM SS MM DD YY long years FALSE days first FALSE HH MM SS MM DD YYYY long years TRUE days first FALSE where HH MM SS is hours minutes and seconds and DD MM YY is day month and year PROC so time to ascii VAL INT32 time VAL BOOL long years VAL BOOL days first so time string len BYTE string Purpose To convert the number of seconds since the midnight before lst January 1970 into a formatted time and date In time the number of seconds since the midnight before lst January 1970 In long years TRUE if a four digit year is desired FALSE if a two digit year is desired the digits being the tens and units followed by two spaces In days first TRUE if date to be written with the days preceding the month i e British format FALSE if the month is to precede the days i e U S format Out string an ASCII string representing the time and date as APPROVED 5 2 91 35 SW 0114 4 PROC INMOS Limited Confidential occam User Lib Specs
51. dos lib 6 entry points Constants referred to in the following specifications are to be found in the include files msdos inc and hostio inc PROC dos send block CHAN OF SP fs ts VAL INT32 location Purpose Channels In In Out Out VAL BYTE block INT len BYTE result To write a block of data to host memory fs from server ts to server location the start memory address at which to write the block of data this address is arranged as the segment in the top two bytes and the offset in the lower two bytes of this parameter both unsigned block the data to be written that is SIZE block bytes len the number of bytes written result spr ok if the write was successful otherwise takes on a value indicating what went wrong spr bad packet size too many bytes requested to be written APPROVED 5 2 91 38 SW 0114 4 INMOS Limited Confidential occam User Lib Specs SIZE block dos max send block buffer size gt spr operation failed the write failed see hostio inc or the server documentation for further details PROC dos receive block CHAN OF SP fs ts VAL INT32 location INT bytes read BYTE block BYTE result Purpose To read a block of data from host memory Channels fs from server ts to server In location the start address of where to read the data from this address is arranged as the segment in the top two bytes
52. dure will act as an invalid process PROC ss write real64 CHAN OF SS scrn VAL REAL64 number VAL INT Ip Dp Purpose To format into ASCII characters and then write to the given screen stream a double precision real number Channels scrn for output In number the IEEE double precision real to format and write out In In Ip Dp formatting values see REAL64TOSTRING for their effect Notes If Ip Dp and number are such that the resulting formatted form is longer than 30 characters this procedure will act as an invalid process PROC ss write char CHAN OF SS scrn VAL BYTE char Purpose To send a character to the given screen stream Channels scrn for output In char the byte to send on the channel PROC ss write string CHAN OF SS scrn VAL BYTE str Purpose To send the given string on the given screen stream Channels scrn for output In str a string all the characters of which are sent on scrn PROC ss write nl CHAN OF SS scrn Purpose To send c n on the given screen stream Channels scrn for output PROC ss write endstream CHAN OF SS scrn Purpose To write a st endstream tag on the given screen stream Channels scrn for output APPROVED 5 2 91 49 SW 0114 4 INMOS Limited Confidential occam User Lib Specs PROC ss write text line CHAN OF SS scrn VAL BYTE str Purpose To send a text line on the given screen strea
53. e ASCII code of any legal occam identifier character In char the byte the value of which is to be tested PROC to upper case BYTE str Purpose To convert all lower case alphabetic characters in a given string to upper case In Out str the string the lower case characters of which are to be converted to upper case Notes Assumes the ASCII character set Characters which are not lower case letters remain unchanged PROC to lower case BYTE str Purpose To convert all upper case alphabetic characters in a given string to lower case In Out str the string the upper case characters of which are to be converted to lower case Notes Assumes the ASCII character set Characters which are not upper case letters remain unchanged INT FUNCTION compare strings VAL BYTE strl str2 APPROVED 5 2 91 53 SW 0114 4 INMOS Limited Confidential occam User Lib Specs Purpose To determine the lexicographical ordering of two strings Returned 0 for exact equality of both length and content 1 for str2 is leading substring of strl 1 for strl is leading substring of str2 2 for strl later than str2 2 for str2 later than strl In In strl str2 the strings to be compared Notes Lexicographical ordering is that which uses the ordinal values of the characters for comparison in sequence along the strings gt Here the ordinal values are the ASCII v
54. e here between a character held in a byte and a character held in a word length quantity Here the former is referred to as a character and the latter as a character note the quotes Upper and lower case letters are permissible in a hexadecimal integer All input up to a plus sign a minus sign a hash symbol decimal digit or a negative valued word is skipped If it is the hash that is encountered first then it is a hexadecimal integer in two s complement form that is expected If it is a negative valued word that is encountered then an input error has occurred and that value is returned in char The integer is terminated when anything other than a valid digit hex and or decimal as the case may be is read and it is this terminating quantity that is returned in char if the integer read is not invalid PROC ks read int64 CHAN OF KS source INT64 number INT char Purpose To read a 64 bit decimal or hexadecimal integer from the given keystream Channels source for input Out number if char is not ft number error the value of the integer read otherwise undefined In Out char on entry the first character from the input to be read on exit ft number error if the integer read overflowed the range of INT64 otherwise the character that terminated the integer APPROVED 52 91 46 SW 01 14 4 INMOS Limited Confidential occam User Li
55. e it is just possible that the communication terminated successfully between when the time out occurred and the resetting of the channel Notes If the time out occurs then the channel c is reset and this procedure terminates PROC InputOrFail c CHAN OF ANY c BYTE mess CHAN OF INT kill BOOL aborted Purpose To provide through an abort control channel for communication failure on a channel expecting input Channels c the channel over which an input communication is expected kill an abort control channel any integer received on this channel will cause the channel c to be reset and this procedure to terminate Out mess if aborted is FALSE the received message over channel c otherwise undefined Out aborted TRUE if the communication was signalled to be aborted FALSE if the communication successfully took place One cannot be sure that the communication was not successful if aborted is TRUE because it is just possible that the communication terminated successfully between when the abort signal was received and the resetting of the channel PROC OutputOrFail t CHAN OF ANY c VAL BYTE mess TIMER t VAL INT time BOOL aborted Purpose To provide through a time out for communication failure on a channel expecting to output Channels c the channel over which an output communication is to be made Out mess the message to output over
56. e size spr bad name null file name supplied spr bad type invalid file type specified spr full name too short SIZE full name not large enough to hold name of a file to open spr buffer overflow length of environment string gt 256 gt spr operation failed the open failed or could not read environment string see hostio inc or iserver documentation for more details This procedure performs the following actions 1 An attempt is made to open the file as given by filename so if there is no directory part to filename the current directory will be tried 2 If the attempt in l is not successful and there is no explicit directory part to filename the path is searched for the file PROC so parse command line CHAN OF SP s ts Purpose Channels In VAL I BYTE option strings VAL INT option parameters required BOOL option exists 2 INT option parameters INT error len BYTE line To read the server command line and parse it for specified options and associated parameters fs from server ts to server option strings a list of all possible options These options must not be longer than 256 bytes and any letters should be in upper case even though the options as given by the user on the command line are case insensitive To read a parameter that has no preceding option such as a filename then the first option string should contain only spaces Because all of these option strings must be the same
57. ed to be printable In display possible replies if TRUE the printable replies are displayed in upper case inside round brackets with commas inbetween each character this display being one space after the given prompt if FALSE then this is not done In echo reply if TRUE then the reply typed at the keyboard by the user is echoed if it is printable and it is echoed as an upper case letter if a letter if FALSE the reply typed is not echoed Out reply number an integer corresponding to the reply typed where 0 is associated with the first possible reply 1 with the second possible reply etc where the order is as in replies Notes After the prompt and possibly the printable replies is output and a valid key is waited for from the keyboard invalid keys are ignored PROC sp send packet CHAN OF SP ts VAL BYTE packet BOOL error Purpose To send an SP protocol packet Channel ts the channel on which to send the packet In packet the packet to send Out error FALSE if the packet size is greater than or equal to Sp min packet data size and is less than or equal to Sp max packet data size and is even TRUE otherwise in which case the packet is not sent PROC sp receive packet CHAN OF SP fs INT16 length BYTE packet BOOL error Purpose To receive an SP protocol packet Channel fs the channel on which to receive the packet O
58. efined In X the real number in IEEE format to be converted In Ip the first of two formatting values In Dp the second of two formatting values Notes Rounding mode is round to nearest Which format is used depends on the combination of values of Ip Dp and X In all cases any digits beyond the 9th significant digit for single precision or 17th significant digit for double precision will be given as 0 and cannot be considered accurate If string overflows this routine acts as an invalid process APPROVED 5 2 91 5 SW 0114 4 INMOS Limited Confidential occam User Lib Specs Case i Ip 0 Dp 0 free format Where possible a fixed point representation is used If it is not used then exponential form is used It is not used if more than 9 17 significant digits of accuracy single double would be required before the decimal point or if there are more than 3 zeroes after the decimal point before the first significant digit In any case the maximum number of characters returned in string is 15 for a single precision X and 24 for a double precision X string is left justified If X is infinity or a NaN then the string will contain one of Inf Inf or NaN but not the quotes Case ii Ip 0 Dp gt 0 exponential format The form of exponential format is firstly either a minus sign or a space this latter instead of an e
59. ent variable from whatever host is being used Channels fs from server ts to server In name a string containing the name of the desired environment variable should not have more than sp max getenvname size characters in it Out length if result is spr ok the number of bytes in value Starting at value 0 1 SIZE value if result is spr buffer overflow zero otherwise Out value the contents of the environment variable if result is spr ok truncated environment variable if result is spr buffer overflow undefined otherwise Out result spr ok if the environment string successfully returned some other value otherwise indicating the sort of problem spr bad name the specified name is a null string spr bad packet size SIZE name sp max getenvname size spr buffer overflow environment string too large for value it is truncated to fit gt spr operation failed could not read environment string see hostio inc or iserver documentation for further details Notes The largest size the returned contents of an environment variable can be is limited by the functionality of the server not by this routine PROC so getenv CHAN OF SP fs ts VAL BYTE name INT length BYTE value BYTE result APPROVED 5 2 91 15 SW 0114 4 INMOS Limited Confidential occam User Lib Specs PROC PROC As sp getenv sp time CHAN OF SP fs ts
60. essors APPROVED 5 2 91 4 SW 0114 4 INMOS Limited Confidential occam User Lib Specs 6 convert lib 22 entry points As regards the HEX routines here some extra information is in order Only capital hex digits are allowed i e F rather than a f and also no is allowed on the hex number for the STRINGTOHEX and STRINGTOHEXxx routines and a is not output by the HEXTOSTRING and HEXxxTOSTRING routines Entry Point Where Documented STRINGTOINT occam 2 Reference Manual Appendix O INTTOSTRING STRINGTOHEX HEXTOSTRING STRINGTOBOOL x BOOLTOSTRING STRINGTOINT16 4 INT16TOSTRING i STRINGTOINT32 INT32TOSTRING STRINGTOINT64 INT64TOSTRING STRINGTOHEX16 i HEX16TOSTRING STRINGTOHEXS2 HEX32TOSTRING STRINGTOHEX64 HEX64TOSTRING STRINGTOREAL32 STRINGTOREAL64 REAL32TOSTRING see below for latest spec REAL64TOSTRING PROC REAL32TOSTRING INT len BYTE string VAL REAL32 X VAL INT Ip Dp Purpose To take a binary representation of a real number and convert it into a string of characters that is the decimal representation of that number formatted according to given rules see Notes below Out len the number of characters BYTEs of string occupied by the formatted decimal representation of the real number Out string an array containing the formatted decimal representation of the real number in the first len bytes the remaining bytes being und
61. hat reading standard input failed see hostio inc or iserver documentation for further details Notes The value ft terminated is sent on keys out on termination Termination of this procedure is either when an error occurs or when all characters from standard input have been read ie when end of file from standard input is read A c is output to terminate a text line PROC ss scrstream copy CHAN OF SS scrn in scrn out Purpose To copy the output of one screen stream to the input of another Channels scrn in for input scrn out for output Notes Receipt of st endstream on scrn in will terminate this procedure without the stream terminator being passed on PROC ss scrstream fan out CHAN OF SS scrn screen outl screen out2 Purpose To copy everything received on the given screen stream input channel to both of the given screen stream output channels Channels scrn for input screen outl for output screen out2 for output Notes Receipt of st endstream on scrn will terminate this procedure without sending the stream terminator on PROC ss scrstream sink CHAN OF SS scrn Purpose To ignore all but st endstream of screen stream protocol and to terminate when it does receive st endstream Channels scrn for input PROC ss scrstream to array CHAN OF SS scrn BYTE buffer Purpose To put the data received on given screen
62. if result spr ok the line that was read is in the first len bytes the remaining bytes being undefined or if the supplied byte array was not large enough for the read line the read line is truncated to fit otherwise undefined Out result spr ok if no problems encountered otherwise gt spr operation failed refer to hostio inc or iserver documentation for further details Notes The line to be read is considered terminated by a carriage return ie ASCII M which has value OD 13 This carriage return is not included in line and nor is a newline ASCII J 0 10 if present in the input Carriage return and newline are not echoed APPROVED 5 2 91 33 SW 0114 4 INMOS Limited Confidential occam User Lib Specs If an error occurs whilst reading the line this routine terminates immediately PROC so ask CHAN OF SP fs ts VAL BYTE prompt replies VAL BOOL display possible replies echo reply INT reply number Purpose To provide a general purpose routine for interactively asking a user of a program a question requiring only a one character answer Channels fs from server ts to server In prompt the prompt to be displayed on the screen to the user but any list of possible replies and a question mark will be taken care of outside of this prompt In replies the possible single character replies allowed which do not necessarily ne
63. in which case spr notok Notes Behaves as an invalid process if the string to write is longer than 30 characters PROC so write real64 CHAN OF SP fs ts VAL REAL64 r VAL INT Ip Dp Purpose To write a double precision real as decimal ASCII characters to standard out Channels fs from server ts to server In r a double precision real In In Ip Dp formatting values see REAL64TOSTRING for their mim effect Notes Behaves as an invalid process if the string to write is longer than 30 characters PROC so read echo any int CHAN OF SP s ts INT n BOOL error Purpose To read an integer in either two s complement hexadecimal form or in decimal form from the keyboard and to echo it to standard out Channels fs from server APPROVED 52 91 30 SW 01 14 4 INMOS Limited Confidential occam User Lib Specs PROC ts to server n if error is FALSE the value of the integer read otherwise undefined error FALSE if everything was in order TRUE otherwise 1 if the integer overflows the INT range 2a if it is a hex integer if there is a non hex character in the string read from the keyboard other than or in the first character position 2b if it is a decimal integer if there is a non numeric character in the string read from the keyboard other than a or in the first character position The hexadecimal number must begin with one of H
64. inserted where any overflow of str at the high index results in truncation at the high index In start the index of str at which the first character of new str should go Out not done TRUE if start lt 0 start gt len len lt 0 new str had to be truncated to fit or if any significant characters of the original str could not be retained within str after the insertion otherwise FALSE Notes If new str can be fully inserted from the desired starting position then any significant characters in str that were originally after str start are moved to the right by SIZE new str with not done being set to TRUE if any of these characters are moved off the end of str though no invalid accesses are made FALSE otherwise INT FUNCTION string pos VAL BYTE search str Purpose To determine where the first occurrence is of a string within another string Returned the lowest index of str at which begins a substring exactly matching the string search was found or 1 if no such substring found In search the string to search for in the string str In str the string in which to search for the string search Notes The searching is case sensitive INT FUNCTION char pos VAL BYTE search VAL BYTE str Purpose To determine where the first occurrence of a character is in a given string Returned the lowest index of str at which a byte exactly ma
65. ional plus or minus sign as first character and permissible INT e rather than INT E or there were more than 24 characters read or the characters formed an infinity less than zero other than ft number error if there was an input error eg end of file read otherwise it is the character that terminated the sequence of characters read Notes A distinction must be made here between a character held in a byte and a character held in a word length quantity Here the former is referred to as a character and the latter as a character note the quotes All input up to a plus sign a minus sign or a decimal digit is skipped The real is terminated when anything other than a valid real character is encountered and it is this character that is returned in char if char is not set to ft number error PROC ks read real64 CHAN OF KS source REAL64 number INT char Purpose To read a double precision real number from the given keystream Channels source for input Out number if char on exit is not ft number error or less than zero then the real number read in double precision IEEE format otherwise undefined APPROVED 52 91 47 SW 01 14 4 INMOS Limited Confidential occam User Lib Specs In Out char on entry the first character from the input to be read on exit ft number error if the characters read did not form an occam
66. l to In r a single precision real In In Ip Dp formatting values see REAL32TOSTRING for their effect Out result spr ok if the string representing the real was written otherwise not all of the characters were written in which case APPROVED 5 2 91 29 SW 0114 4 INMOS Limited Confidential occam User Lib Specs spr notok Notes Behaves as an invalid process if the string to write is longer than 24 characters PROC so write rea132 CHAN OF SP fs ts VAL REAL32 r VAL INT ID Dp Purpose To write a single precision real as decimal ASCII characters to standard out Channels fs from server ts to server In a single precision real In In Ip Dp formatting values see REAL32TOSTRING for their effect Notes Behaves as an invalid process if the string to write is longer than 24 characters PROC so fwrite real64 CHAN OF SP s ts VAL INT32 streamid VAL REAL64 r VAL INT Ip Dp BYTE result Purpose To write a double precision real as decimal ASCII characters e to a stream Channels fs from server ts to server In streamid the identification number of the stream to write the real to In r a double precision real In In Ip Dp formatting values see REAL64TOSTRING for their effect Out result spr ok if the string representing the real was written otherwise not all of the characters were written
67. le failed see hostio inc or iserver documentation for further details Notes The value ft terminated is sent on keys out on termination Termination of this procedure is either when an error occurs or when all characters in the file have been read A c is output to terminate a text line so keystream from kbd CHAN OF SP s ts CHAN OF KS keys out CHAN OF BOOL stopper VAL INT ticks per poll Purpose To read keys from the keyboard at full speed if they are available otherwise waiting a given interval between polls of the keyboard and output them as integers on the given key stream Channels fs from server ts to server keys out for output stopper for input FALSE or TRUE received on this channel terminates this procedure In ticks per poll this procedure polls the keyboard at intervals of ticks per poll low priority transputer clock cycles if keys are not available a value of less than or equal to zero is an error Notes On termination ft terminated is sent on keys out APPROVED 5 2 91 42 SW 0114 4 INMOS Limited Confidential occam User Lib Specs PROC so keystream from stdin CHAN OF SP fs ts CHAN OF KS keys out BYTE result Purpose To read lines from standard input and output them on the given key stream channel Channels fs from server ts to server keys out for output Out result spr ok if the process was successful otherwise gt spr operation failed meaning t
68. lear eos CHAN OF SS scrn Purpose To clear the terminal screen from the cursor position to the end of the current line and APPROVED 5 2 91 50 SW 0114 4 INMOS Limited Confidential PROC PROC then to the end of the screen Channels scrn for output ss beep CHAN OF SS scrn Purpose To sound the computer s bell Channels scrn for output ss up CHAN OF SS scrn Purpose To move the cursor on the terminal screen one line up Channels scrn for output ss down CHAN OF SS scrn Purpose To move the cursor on the terminal screen one line down Channels scrn for output ss left CHAN OF SS scrn Purpose To move the cursor on the terminal screen one place to the left Channels scrn for output ss right CHAN OF SS scrn Purpose To move the cursor on the terminal screen one place to the right Channels scrn for output ss insert char CHAN OF SS scrn VAL BYTE ch Purpose To move the character at the cursor and all those to the right of it on the terminal screen one place to the right and then to insert the given character at the cursor The cursor moves one place to the right Channels scrn for output In ch the character to insert ss delete chr CHAN OF SS scrn Purpose To delete the character at the cursor on the terminal screen and move the rest of the line one place to the left The cursor does not move Channels scrn for output APPROVED 5 2 91 51 occam User Li
69. m For keystream values above ft tag only ft tag 1 to ft tag 8 are dealt with values above ft tag 8 and ft tag itself translated into st beep Keystream values which are negative other than ft terminated are ignored Keystream values in the range 0 ft tag are passed straight through other than c which is translated into c followed by n APPROVED 52 91 41 SW 01 14 4 INMOS Limited Confidential occam User Lib Specs PROC PROC ks keystream sink CHAN OF KS keys Purpose To read word length quantities from the given key stream until ft terminated is received at which point this procedure terminates Channels keys for input so keystream from file CHAN OF SP fs ts CHAN OF KS keys out VAL BYTE filename BYTE result Purpose To read lines from a text file and output them on the given key stream channel Channels fs from server ts to server keys out for output In filename the name of the file to be opened The name of the file must fit exactly into filename i e there are SIZE filename characters in the name of the file A directory specification may form part of filename Out result spr ok if the process was successful otherwise it takes on a value indicating what went wrong spr bad packet size filename too large SIZE filename sp max openname size spr bad name null file name gt spr operation failed the open failed or reading the fi
70. m Channels scrn for output In str the string of characters to send This string may be terminated by c or not but in either case the last two characters written are c n PROC so scrstream to ANSI CHAN OF SP fs ts CHAN OF SS scrn Purpose To convert output in screen stream protocol to output using ANSI screen conventions Channels fs from server ts to server scrn for input Notes Receipt of st endstream will terminate this procedure ANSI screen convertions are set out in ANSI X3 64 1979 Additional controls for use with american national Standard code for information interchange PROC so scrstream to TVI920 CHAN OF SP fs ts CHAN OF SS scrn Purpose To convert output in screen stream protocol to output using TVI920 screen conventions Channels fs from server ts to server scrn for input Notes Receipt of st endstream will terminate this procedure PROC ss goto xy CHAN OF SS scrn VAL INT x y Purpose To place the cursor on the terminal screen at the given position Channels scrn for output In In x y the coordinates of where to place the cursor where the origin 0 0 is at the top left hand corner of the screen PROC ss clear eol CHAN OF SS scrn Purpose To clear the terminal screen from the cursor position to the end of the current line Channels scrn for output PROC ss c
71. mber field Purpose To convert an integer into its representation as ASCII decimal digits with leading spaces if desired and write this into a given string In Out len on entry the index of str at which the first character of the ASCII conversion of number is to be written on exit the index of str immediately after where the last character of the ASCII conversion of number was written or SIZE str if this last character was written into the last positon of str Out str the string into which the ASCII conversion of number is to be written In number the integer to be converted to an ASCII representation and then written into str In field the field width of the ASCII representation of number if number cannot be represented in field characters then the representation is widened as necessary if field is larger than necessary then padding spaces are added on the left it is an error if field is negative Notes If str overflows then this routine acts as an invalid process The conversion of number will include a minus sign if applicable PROC append hex int INT len BYTE str VAL INT number width Purpose To convert an integer into its representation as ASCII hexadecimal characters and write this into a given string In Out len on entry the index of str at which the first character of the ASCII hexadecimal of number is to be written on exit
72. month i e British format FALSE if the month is to precede the days i e U S format string an ASCII string representing the time and date as follows HH MM SS DD MM YY long years FALSE days first TRUE HH MM SS DD MM YYYY long years TRUE days first TRUE HH MM SS MM DD YY long years FALSE days first FALSE HH MM SS MM DD YYYY long years TRUE days first FALSE where HH MM SS is hours minutes and seconds and DD MM YY is day month and year If the time and date are unavailable string is filled with spaces Local time is used 36 SW 0114 4 INMOS Limited Confidential 9 snglmath lib 15 entry points Entry Point ALOG ALOG10 EXP POWER SIN COS TAN ASIN ACOS ATAN ATAN2 SINH COSH TANH RAN 10 dblmath lib 15 entry points Entry Point DALOG DALOG10 DEXP DPOWER DSIN DCOS DTAN DASIN DACOS DATAN DATAN2 DSINH DCOSH DTANH DRAN 11 tbmaths lib 30 entry points Entry Point APPROVED 5 2 91 Where Documented occam 2 Reference Manual Appendix N Where Documented occam 2 Reference Manual Appendix N Where Documented 37 occam User Lib Specs SW 0114 4 INMOS Limited Confidential occam User Lib Specs ALOG ALOG10 EXP POWER SIN COS TAN ASIN ACOS ATAN ATAN2 SINH COSH TANH RAN DALOG DALOG10 DEXP DPOWER DSIN DCOS DTAN DASIN DACOS DATAN DATAN2 DSINH DCOSH DTANH DRAN occam 2 Reference Manual Appendix N 12 ms
73. n To write a string to standard out fs from server ts to server string the string to be written which can be any length PROC so fwrite string CHAN OF SP fs ts VAL INT32 streamid Purpose Channels In In Out VAL BYTE string BYTE result To write a string to a stream fs from server ts to server streamid the identification number of the stream to write the string to string the string to be written which can be any length result spr ok if the string was written spr notok if not all of the string was written PROC so write char CHAN OF SP fs ts VAL BYTE char Purpose Channels In To write a single character to standard out fs from server ts to server char the single character to write PROC so fwrite char CHAN OF SP fs ts VAL INT32 streamid VAL BYTE char Purpose Channels In In Out BYTE result To write a single character to a stream fs from server ts to server streamid the identification number of the stream to write to char the single character to write result spr ok if the character was written otherwise spr notok PROC so write string nl CHAN OF SP fs ts VAL BYTE string Purpose Channels To write a string appended by a newline to standard out fs from server APPROVED 52 91 26 SW 01 14 4 INMOS Limited Confidential occam User Lib Specs In Notes ts
74. n upper case ASCII character FALSE otherwise char the byte the value of which is to be tested FUNCTION is lower VAL BYTE char APPROVED 5 2 91 52 SW 0114 4 INMOS Limited Confidential occam User Lib Specs Purpose To determine whether the value of a byte lies in the inclusive range that delimits lower case ASCII characters Returned TRUE if the value of char corresponds to a lower case ASCII character FALSE otherwise In char the byte the value of which is to be tested BOOL FUNCTION is digit VAL BYTE char Purpose To determine whether the value of a byte lies in the inclusive range that delimits ASCII decimal digits Returned TRUE if the value of char corresponds to a decimal digit according to the ASCII code FALSE otherwise In char the byte the value of which is to be tested BOOL FUNCTION is hex digit VAL BYTE char Purpose To determine whether the value of a byte corresponds to the ASCII value of any hexadecimal digit Returned TRUE if the value of char corresponds to a hexadecimal digit according to the ASCII code where upper or lower case letters are allowed FALSE otherwise In char the byte the value of which is to be tested BOOL FUNCTION is id char VAL BYTE char Purpose To determine whether the value of a byte corresponds to the ASCII code of any legal occam identifier character Returned TRUE if the value of char corresponds to th
75. nd to existing one EM for update When a file is opened for update then the resulting stream may be used for input and output Out streamid if result is spr ok the identification number of the Stream associated with the file that was opened undefined otherwise Out result spr ok if the file was successfully opened otherwise it takes on a value indicating what went wrong spr bad packet size name too large SIZE mame gt sp max openname size spr bad name null file name spr bad type invalid type spr bad mode invalid mode gt spr operation failed the open failed see hostio inc or iserver documentation for further details Notes No path environment variable is used to locate the file what is in name is all that is used cf so popen read APPROVED 5 2 91 8 SW 0114 4 INMOS Limited Confidential occam User Lib Specs PROC so open CHAN OF SP fs ts VAL BYTE name VAL BYTE type mode INT32 streamid BYTE result As sp open PROC sp close CHAN OF SP fs ts VAL INT32 streamid BYTE result Purpose To close a stream Channels fs from server ts to server In streamid the identification number of the open stream to be closed Out result equal to spr ok if the stream closed properly otherwise spr operation failed refer to hostio inc or iserver documentation for further details Notes Before closing the stream
76. nt but the size of it is the maximum number of communications that can be output through this routine before a reply is received and to be passed back the values in queue on termination are equally irrelevant queue is used for storage only if it is of zero length then no communication can be done and the routine simply waits on stopper for an input which immediately causes termination of this routine Notes It is an error if the size of from user is different to that of to user It is permissible for the size of from user and hence to user to be zero The maximum number of bytes that can be channelled through this routine in each direction is sp max packet data size It is assumed that replies for messages are received in the same sequence as the messages are sent so overlapped pri multiplexor CHAN OF SP s ts OF SP from user to user CHAN OF BOOL stopper INT queue As sp overlapped pri multiplexor so open temp CHAN OF SP fs ts VAL BYTE type so temp filename length BYTE filename INT32 streamid BYTE result Purpose To open a temporary file in spm new update mode Channels fs from server ts to server In type either spt binary or spt text Out filename the name of the file opened Out streamid if result is spr ok the identification number of the stream associated with the file that was opened undefined otherwise Out result spr ok if all went well otherwise takes on a value indi
77. nto a given string len on entry the index of str at which the first character of the ASCII hexadecimal of number is to be written on exit the index of str immediately after where the last character of the ASCII hexadecimal of number was written or SIZE str if this last character was written into the last positon of str str the string into which the hexadecimal ASCII form of number is to be written number the 64 bit integer to be converted to an ASCII hexadecimal representation and then written into str width the field width of the ASCII hexadecimal representation of number if number cannot be represented in width characters then the representation is truncated at the left as necessary otherwise the representation is padded on the left with 0 s or F s to make up width characters a negative value for width is an error If str overflows then this routine acts as an invalid process The conversion of number includes a as the first character so that the representation is always width 1 characters Any hexadecimal characters which are letters will be in upper case from line VAL BYTE line INT ptr len BYTE word BOOL ok To determine the next word in a given line skipping leading Spaces and tabs line a string containing the line from which a word is desired to be noted The string is considered to be of length SIZE line ptr on entry the index of line from which to start the search for a word i e the
78. ocessor s registers on return from the interrupt otherwise undefined Out result spr ok if the interrupt was successful otherwise spr operation failed Notes Each register value occupies 4 bytes register start position in block least significant byte 0 APPROVED 5 2 91 39 SW 0114 4 INMOS Limited Confidential occam User Lib Specs bx 4 E cx 8 dx 12 di 16 m si 20 EUR cs 24 um ds 28 E es 32 AJ ss 36 PROC dos read regs CHAN OF SP s ts dos read regs size BYTE registers BYTE result Purpose To read the current values of some of the PC s registers Channels fs from server ts to server Out registers a block of bytes containing the values of the registers read Out result spr ok if the registers were read successfully otherwise spr operation failed Notes Each register value occupies 4 bytes register start position in block least significant byte ax 0 E bx 4 zz ex 8 dx 12 PROC dos port write CHAN OF SP fs ts VAL INT16 port location VAL BYTE value BYTE result Purpose To write a given value to a given port Channels fs from server ts to server In port location the address where the port is to be found the address being in the I O space of the PC and hence is unsigned number between 0 64K In value the value to write to port location Out
79. of the receipt of replies Channels single pair fs input to this routine ts output from this routine multiple pairs from user input to this routine to user output from this routine termination channel stopper input to this routine TRUE or FALSE received on this channel will cause the routine to stop listening on the from user channels and wait until all replies have been received before terminating stopper has the highest priority amongst the channels Out queue the values in queue on entry are irrelevant but the size of it is the maximum number of communications that can be output through this routine before a reply is received and to be passed back the values in queue on termination are equally irrelevant queue is used for storage only if it is of zero length then no communication can be done and the routine simply waits on stopper for an input which immediately causes termination of this routine Notes It is an error if the size of from user is different to that of to user It is permissible for the size of from user and hence to user to be zero The maximum number of bytes that be channelled through this routine in each direction is sp max packet data size It is assumed that replies for messages are received in the same sequence as the messages are sent To attempt some degree of fairness there is a heira
80. onfidential APPROVED 5 2 91 Entry Point Library Page write real32 streamco 63 write real64 streamco 63 write text line streamco 63 72 occam User Lib Specs SW 0114 4
81. otherwise PROC so core CHAN OF SP s ts VAL INT32 offset INT bytes read BYTE data BYTE result As sp core PROC sp version CHAN OF SP s ts BYTE version host os board result Purpose To return identification information about the server and the host that it is running on Channels fs from server ts to server Out version on division by 10 this gives the version of the server APPROVED 5 2 91 18 SW 0114 4 INMOS Limited Confidential occam User Lib Specs Out Out Out Out Notes host identifies the host via sph constants os identifies the host environment via spo constants board identifies the interface board via spb constants result spr ok if the request was successful otherwise gt spr operation failed refer to hostio inc or iserver documentation for further details If any of the information except result has the value zero then that information is not available The parameter version cannot distinguish between e g 1 41 and 1 42 PROC so version CHAN OF SP fs ts Purpose Channels Out Out Out Out Notes PROC sp buffer Purpose Channels Notes PROC so buffer BYTE version host os board To return identification information about the server and the host that it is running on fs from server ts to server version on division by 10 this gives the version of the server
82. r PROC ss write hex int CHAN OF SS scrn VAL INT number field Purpose To write an integer as hexadecimal ASCII characters preceded by the character to the given screen stream Channels scrn for output In number the integer to write out In field the field width to use when writing the hex if field is larger than the size of the number then the number is padded with leading 0 s or F s as appropriate if field is smaller than the size of the number then the number is truncated at the left to field characters field does not take the into account A negative field width is an error PROC ss write int64 CHAN OF SS scrn VAL INT64 number VAL INT field As ss write int but for INT64s PROC ss write hex int64 CHAN OF SS scrn VAL INT64 number VAL INT field APPROVED 52 91 48 SW 01 14 4 INMOS Limited Confidential occam User Lib Specs As ss write hex int but for INT64s PROC ss write real32 CHAN OF SS scrn VAL REAL32 number VAL INT Ip Dp Purpose To format into ASCII characters and then write to the given screen stream a single precision real number Channels scrn for output In number the IEEE single precision real to format and write out In In Ip Dp formatting values see REAL32TOSTRING for their effect Notes If Ip Dp and number are such that the resulting formatted form is longer than 24 characters this proce
83. rchy of priorities from from user with index i for SIZE from user using modulo SIZE from user on the indexes with i starting from 0 and incrementing by one after each input accepted PROC so overlapped multiplexor CHAN OF SP fs ts CHAN OF SP from user to user CHAN OF BOOL stopper INT queue As sp overlapped multiplexor PROC sp overlapped pri multiplexor CHAN OF SP fs ts CHAN OF SP from user to user CHAN OF BOOL stopper INT queue Purpose To multiplex any number of pairs of SP protocol channels onto a single pair of SP protocol channels where the multiplexing is overlapped so that output through this routine can continue independently of the receipt of APPROVED 5 2 91 22 SW 0114 4 INMOS Limited Confidential occam User Lib Specs PROC PROC replies Channels single pair fs input to this routine ts output from this routine multiple pairs from user input to this routine to user output from this routine There is a relative priority to the input channels from user i is of higher priority than from user j where i lt jg termination channel stopper input to this routine TRUE or FALSE received on this channel will cause the routine to stop listening on the from user channels and wait until all replies have been received before terminating this channel has the highest priority of all input channels Out queue the values in queue on entry are irreleva
84. ry value of len otherwise the same as it was on entry In Out str on entry the string from which it is desired to delete a substring on exit if not done is FALSE the original string with substring deleted where deleted means that the gap created by the deletion is filled from the left with those significant characters left in str that were originally after the end of the deleted substring and so that the number of significant characters remaining in str is len on exit otherwise the same as it was on entry In start the index of str of the first character of the substring to be deleted In size the number of characters in the substring to be deleted APPROVED 5 2 91 54 SW 0114 4 INMOS Limited Confidential occam User Lib Specs Out not done TRUE if size is less than zero start is less than zero or start size is greater than the entry value of len FALSE otherwise If TRUE then len and str are unchanged from their original values PROC insert string VAL BYTE new str INT len BYTE str VAL INT start BOOL not done Purpose To insert a string into another string In new str the string to be inserted In Out len on entry the number of significant characters in str on exit the number of significant characters in str In Out str on entry the string into which new str is to be inserted on exit the original str with new str
85. s BYTE result To write to the specified file stream an integer as decimal ASCII digits padded out with leading spaces and an optional sign to the specified field width fs from server ts to server streamid the identification number of the stream to which the string representing the integer is to be sent n the integer that is desired to be written width the desired field width of the string result equal to spr ok if the string was written all right otherwise not all of the string could be written in which case result takes on a value of spr notok If the field width is too small for the number then it is widened as necessary a zero value for the field width will APPROVED 5 2 91 27 SW 0114 4 INMOS Limited Confidential occam User Lib Specs give minimum width a negative value is an error PROC so write int CHAN OF SP s ts VAL INT n width Purpose To write to standard out an integer as decimal ASCII digits padded out with leading spaces and an optional sign to the specified field width Channels fs from server ts to server In n the integer that is desired to be written In width the desired field width of the string Notes If the field width is too small for the number then it is widened as necessary a zero value for the field width will give minimum width a negative field width is an error PROC so fwrite int32 CHAN OF SP fs ts VAL INT32 streami
86. search begins at line ptr with ptr increasing On exit if ok is FALSE on entry then unchanged if ok is TRUE on entry then is either the index of the space or tab immediately after the found word or is SIZE line where it is only ever greater than if it was passed in as such whether ok is subsequently set to FALSE or not len if ok is FALSE on entry then 0 if ok is TRUE on entry then gives the length of the first word found after the given Starting position whether ok is subsequently set to FALSE or not which in the case of no word found is 0 word if ok is FALSE on entry then undefined if ok is TRUE on entry then this contains the found word from line in the first len bytes the remaining bytes being undefined or if not large enough to contain the word or no word found it is undefined and ok is set to FALSE though len gives the correct length of the word found ok on entry if FALSE then len is set to 0 ptr and ok remain unchanged and word is undefined otherwise a search for a word is carried out On exit if FALSE on entry then FALSE if TRUE on entry FALSE if no word found FALSE if a APPROVED 52 91 59 SW 01 14 4 INMOS Limited Confidential occam User Lib Specs Notes word found that was too large to fit into word otherwise TRUE Leading spaces and horizontal tabs from line ptr ptr on entry are skipped A word continues until a space or tab or the end of the string is encountered
87. sequence of characters found after skipping spaces and tabs is taken to be the integer desired the integer continues until a space or tab or the end of the string is encountered A or are permissible as the first character of the integer 15 xlink lib 5 entry points PROC Reinitialise CHAN OF ANY c Purpose Channels Notes To re initialise a given channel c the channel to re initialise If c is a channel on a hardware link then that link s hardware is reset If this routine is used on a channel on which communication is not finished then the error flag is set and subsequent behaviour is undefined APPROVED 52 91 60 SW 01 14 4 INMOS Limited Confidential occam User Lib Specs PROC InputOrFail t CHAN OF ANY c BYTE mess TIMER t VAL INT time BOOL aborted Purpose To provide through a time out for communication failure on a channel expecting input Channels c the channel over which an input communication is expected Out mess if aborted is FALSE the received message over channel c otherwise undefined In Out t a timer providing a clock to use for the time out In time the absolute time of when the time out for the communication over channel c should occur Out aborted TRUE if the communication timed out FALSE if the communication successfully took place One cannot be sure that the communication was not successful if aborted is TRUE becaus
88. ser Lib Specs In streamid the identification number of the open stream to be read from Out bytes read this gives the number of bytes read from the file these bytes will be data FROM 0 FOR bytes read if bytes read SIZE data then either an error occurred or the end of the file was reached Out data this contains the bytes read from the file the number of bytes requested to be read is SIZE data PROC sp write CHAN OF SP fs ts VAL INT32 streamid VAL BYTE data INT length written BYTE result Purpose To write a limited number of bytes to a stream Channels fs from server ts to server In streamid the identification number of the open stream to write to In data a string of bytes ALL of which are to be written to the stream Out length written this gives the number of bytes written If length written SIZE data then an error occurred 0 length written sp max writebuffer size Out result if not equal to spr bad packet size meaning that too many bytes were requested ie SIZE data sp max writebuffer size mE then it is equal to spr ok PROC so write CHAN OF SP fs ts VAL INT32 streamid VAL BYTE data INT length Purpose To write an unlimited number of bytes to a stream channels fs from server Ee ts to server In streamid the identification number of the open stream to write to
89. spr ok then this is the return value of the command which is host dependent result equal to spr ok if a host command processor exists otherwise spr bad packet size command too large SIZE command gt sp max systemcommand size gt spr operation failed the operation failed see hostio inc or iserver documentation for further details CHAN OF SP fs ts VAL BYTE command INT32 status BYTE result As sp system APPROVED 5 2 91 16 SW 0114 4 INMOS Limited Confidential occam User Lib Specs PROC sp exit CHAN OF SP fs ts VAL INT32 status BYTE result Purpose Channels In Out To terminate the server fs from server ts to server status a value which the server passes directly on to the host environment except in the following two cases sps success a host specific success result is passed on sps failure a host specific failure result is passed on result equals spr ok if the operation succeeded otherwise gt spr operation failed see hostio inc or iserver documentation for further details PROC so exit CHAN OF SP s ts VAL INT32 status Purpose Channels In To terminate the server fs from server ts to server status a value which the server passes directly on to the host environment except in the following two cases sps success a host specific success result is passed on sps failure a host specific failure result is passed on PROC sp comm
90. spr operation failed if the end of file status has not been set PROC so eof CHAN OF SP fs ts VAL INT32 streamid BYTE result As sp eof PROC sp ferror CHAN OF SP fs ts VAL INT32 streamid INT32 error no INT length BYTE message BYTE result Purpose To test for the occurrence of an error on the specified stream Channels fs from server ts to server In streamid the identification number of the stream to be tested for error Out error no a host defined error number Out length the number of bytes in message Equal to zero if result spr operation failed Out message if result is not spr operation failed then this contains a possibly null message corresponding to the last file error on the specified stream this message is message FROM 0 FOR length Out result equals spr ok if there was an error on the specified stream and the message corresponding to it fits into message equals spr buffer overflow if there was an error on the specified stream but the message corresponding to it is too large to fit into message in which case it is truncated to fit gt spr operation failed if there was no error on the specified stream PROC so ferror CHAN OF SP fs ts VAL INT32 streamid INT32 error no INT length BYTE message BYTE result As sp ferror PROC sp remove CHAN OF SP fs ts VAL BYTE name BYTE result APPROVED 5
91. stream channel Channels source for input Out len the number of characters that have been put into line Out line the line that was read is line FROM 0 FOR len Out char the word that terminated the line Notes Although characters ie BYTE s are inserted into line APPROVED 52 91 45 SW 01 14 4 INMOS Limited Confidential occam User Lib Specs it is word length quantities that are read from source The line of text is deemed to be terminated by INT c or any negative value The word that terminated the line is not included in line Any word read with a value greater than 255 the maximum that a byte can hold is ignored Any n read is ignored If the array line is filled before a valid termination character is encountered then all further words are ignored PROC ks read int CHAN OF KS source INT number char Purpose To read a decimal or hexadecimal integer from the given keystream Channels source for input Out number if char is not ft number error or negative the value of the integer read otherwise undefined In Out char on entry the first character from the input to be read on exit ft number error if the integer read overflowed the range of INT a negative value other than ft number error indicating an input error otherwise the character that terminated the integer Notes A distinction must be mad
92. syntax real number with optional plus or minus sign as first character and permissible INT e rather than INT E or there were more than 30 characters read or the characters formed an infinity less than zero other than ft number error if there was an input error eg end of file read otherwise it is the character that terminated the sequence of characters read Notes A distinction must be made here between a character held in a byte and a character held in a word length quantity Here the former is referred to as a character and the latter as a character note the quotes All input up to a plus sign a minus sign or a decimal digit is skipped The real is terminated when anything other than a valid real character is encountered and it is this character that is returned in char if char is not set to ft number error PROC ss write int CHAN OF SS scrn VAL INT number field Purpose To write to the given screen stream an integer as decimal ASCII digits padded out with leading spaces to the specified field width Channels scrn for output In number the integer that is desired to be written In field the desired field width of the string Notes If the field width is too small for the number then it is widened as necessary a zero value for the field width will give minimum width a negative field width is an erro
93. t equal to spr ok if the file position was successfully set otherwise takes on a value indicating what the problem was spr bad origin invalid origin gt spr operation failed the seek failed see hostio inc or iserver documentation for further details PROC so seek CHAN OF SP s ts VAL INT32 streamid offset origin BYTE result As sp seek PROC sp tell CHAN OF SP fs ts VAL INT32 streamid INT32 position BYTE result Purpose To return the current file position for the specified stream Channels fs from server ts to server In streamid the identification number of the open stream associated whith the file the reading writing position of which is desired Out position the current file position Out result equal to spr ok if the file position determined otherwise spr operation failed refer to hostio inc or iserver documentation for further details APPROVED 5 2 91 12 SW 0114 4 INMOS Limited Confidential occam User Lib Specs PROC so tell CHAN OF SP fs ts VAL INT32 streamid INT32 position BYTE result As sp tell PROC sp eof CHAN OF SP fs ts VAL INT32 streamid BYTE result Purpose To test whether the specified stream has end of file status or not Channels fs from server ts to server In streamid the identification number of the stream to test Out result equals spr ok if end of file status is set gt
94. tching search was found 1 if such byte found In search the character to search for in the string str In str the string in which to search for the character search Notes The searching is case sensitive APPROVED 5 2 91 55 SW 0114 4 INMOS Limited Confidential occam User Lib Specs INT BYTE FUNCTION search match VAL BYTE possibles str Purpose To search a string for the first occurrence of any one of a given number of characters Returned From left to right 1f a match found this gives the lowest index of str at which the match occurs otherwise 1 if a match found this gives the byte of possibles which was found otherwise 255 BYTE In possibles a string each byte of which is to be individually checked for in str In str the string in which to search for any of the various bytes contained in possibles INT BYTE FUNCTION search no match VAL BYTE possibles str Purpose To search a string for the first occurrence of a character which does not match any of a given number of characters Returned From left to right 1f no match found this gives the lowest index of str at which the lack of a match occurs otherwise 1 if no match found this gives the byte of str which was found not to match otherwise 255 BYTE In possibles a string each byte of which is to be individually checked for non existence in str
95. th the result being returned as an INT keystream from file CHAN OF SP fs ts CHAN OF INT kbd VAL BYTE filename INT result As so keystream from file in streamio lib with the result being returned as an INT scrstream to ANSI CHAN OF ANY scrn CHAN OF SP fs ts APPROVED 52 91 63 SW 01 14 4 INMOS Limited Confidential occam User Lib Specs As so scrstream to ANSI in streamio lib PROC scrstream to TVI920 CHAN OF ANY scrn CHAN OF SP s ts As so scrstream to TVI920 in streamio lib APPROVED 5 2 91 64 SW 0114 4 INMOS Limited Confidential 17 Index APPROVED 5 2 91 occam User Lib Specs Entry Point Library Page ABS compiler 3 ACOS snglmath and tbmaths 37 ALOG snglmath and tbmaths 37 ALOG10 snglmath and tbmaths 37 append char string 56 append hex int64 string 59 append hex int string 57 append int64 string 58 append int string 57 append real32 string 57 append real64 string 58 append text string 56 ARGUMENT REDUCE compiler 3 ASIN snglmath and tbmaths 37 ATAN snglmath and tbmaths 37 ATAN2 snglmath and tbmaths 37 beep streamco 63 BITCOUNT compiler 3 BITREVNBITS compiler 3 BITREVWORD compiler 3 BOOLTOSTRING convert 5 char pos string 55 clear eol streamco 63 clear eos streamco 63 CLIP2D compiler 2 compare strings string 53 COPYSIGN compiler 3 COS snglmath and tbmaths 37 COSH snglmath and tbmaths 37 CRCBYTE compiler 3 CRCFROMLSB crc 7 CRCFROMMSB crc 7 CRCWOR
96. to server string the string to be written which can be any length The newline sequence is appended by this routine PROC so fwrite string nl CHAN OF SP fs ts VAL INT32 streamid Purpose Channels In In Out Notes VAL BYTE string BYTE result To write a string appended by a newline to a stream fs from server ts to server streamid the identification number of the stream to write the string to string the string to be written which can be any length result spr ok if the string was successfully written spr notok if not all of the string was written if spr operation failed refer to hostio inc or iserver documentation for further details The newline sequence is appended by this routine PROC so write nl CHAN OF SP s ts Purpose Channels To write a newline to standard out fs from server ts to server PROC so fwrite nl CHAN OF SP fs ts VAL INT32 streamid BYTE result Purpose Channels In Out To write a newline to a stream fs from server ts to server streamid the identification number of the stream to write to result spr ok if the newline was successfully written otherwise gt spr operation failed refer to hostio inc or iserver documentation for further details PROC so fwrite int CHAN OF SP fs ts VAL INT32 streamid VAL INT n width Purpose Channels In In In Out Note
97. transputer s memory as gt peeked from the transputer when the server was invoked with the analyse option Channels fs from server ts to server In offset this gives the offset from base of memory MOSTNEG INT of the memory segment to be read so offset should be non negative result will be gt spr operation failed if offset is larger than the amount of memory that was peeked Out bytes read the number of bytes read which will be data FROM 0 FOR bytes read if result spr ok otherwise will be zero Out data contains the contents of the memory read SIZE data is the amount of memory in bytes that is requested to be read Out result equal to spr ok if the peeked memory was successfully returned otherwise takes on a value indicating what the problem was spr bad packet size data is too large SIZE data sp max corerequest size gt spr operation failed the operation failed or the transputer was not analysed when the server was invoked or offset is greater than the amount of memory peeked refer to hostio inc or iserver documentation for further details Notes If offset SIZE data is larger than the total memory peeked then only those bytes from offset to the of that memory peeked are returned in data If both offset and SIZE data are zero the routine fails if the memory was not peeked succeeds
98. troduction This document is to give the specifications of the user visible entry points in the occam 2 toolset libraries The toolset in question is the D7205 for the IBM NEC PC the D6205 for the VAX the D5205 for the Sun3 and the D4205 for the Sun4 If the specifications have already been written elsewhere then the appropriate document is referred to otherwise the specification of the routine is given here All visible entry entry points are ones that are intended for the user and are documented in a user accessible place e g occam 2 toolset User Manual however documentation for the user and specifications are two different things hence this document A total of 383 entry points are mentioned here 2 Related Documents Reference is made to the following documents and publications occam 2 Reference Manual by INMOS Limited Prentice Hall Hemel Hempstead 1988 Prentice Hall International Series in Computer Science ISBN 0 13 629312 3 Transputer Development System by INMOS Limited Prentice Hall Hemel Hempstead 1st edi tion 1988 ISBN 0 13 928995 X 2nd edition 1988 1990 ISBN 0 13 929068 0 SW 0044 occam 2 language implementation manual Conor O Neill SW 0102 Iserver 1 42 Specification Bob Green 3 Definitions entry point a procedure or function identifier visible entry point an entry point that is a legal occam identifier 4 Compiler Libraries 55 entry points The compiler libraries are occam2 1ib occama lib
99. uffers Channels fs input to this routine and to buffer2 ts output from this routine and from bufferl from user input to this routine and to bufferl to user output from this routine and from buffer2 stopper input to this routine TRUE or FALSE received will cause bufferl to stop listening on the ts channel and to terminate when buffer2 has passed through the same number gt of reply communications on the fs to user channels as bufferl sent on the from user ts channels bufferl terminates immediately after bufferl the whole routine then terminates Notes The dependence of the buffers is given by the fact that the number of communications through one buffer buffer2 must match the number through the other buffer bufferl before the routine will terminate No more than sp max packet data size bytes can be buffered in each of the buffers PROC so overlapped buffer CHAN OF SP fs ts from user to user CHAN OF BOOL stopper As sp overlapped buffer PROC sp overlapped multiplexor CHAN OF SP s ts CHAN OF SP from user to user CHAN OF BOOL stopper INT queue Purpose To multiplex any number of pairs of SP protocol channels APPROVED 5 2 91 21 SW 0114 4 INMOS Limited Confidential occam User Lib Specs onto a single pair of SP protocol channels where the multiplexing is overlapped so that output through this routine can continue independently
100. ut length the number of bytes in the received packet Out packet the received packet left justified Out error TRUE if length is greater than sp max packet data size FALSE otherwise PROC so time to date VAL INT32 input time so date len INT date APPROVED 52 91 34 SW 01 14 4 INMOS Limited Confidential occam User Lib Specs Purpose To convert the number of seconds since the midnight before lst January 1970 into the associated time and date In input time the number of seconds since the midnight before lst January 1970 Out date an array of six integers where the elements are index data 0 seconds past the minute 1 minutes past the hour 2 the hour in the 24 hour clock 3 the day of the month 4 the month where January is 1 5 the year expressed fully i e 4 digits PROC so date to ascii VAL so date len INT date VAL BOOL long years VAL BOOL days first so time string len BYTE string Purpose To format a time and date given in the form of six integers In date an array of six integers where the elements are index data 0 seconds past the minute 1 minutes past the hour 2 the hour in the 24 hour clock mas 3 the day of the month 4 the month where January is 1 5 the year expressed fully i e 4 digits In long years TRUE if a four digit year is desired FALSE if a two digit year is desired the digits being the tens an
101. xplicit plus sign a fraction in the form digit digits the exponential symbol E the sign of the exponent or then the exponent which is two digits for a single precision X three digits for a double precision X Dp gives the number of digits in the fraction 1 before the point and the others after but not counting the point The total number of characters in string is Dp 6 for a single precision X and Dp 7 for a double precision X If Dp 1 then the fraction is of the form space digit which note will not result in occam syntax for the real If X is infinity or a NaN then the string will contain one of Inf Inf or NaN but not the quotes padded on the right to fill the field width Case iii Ip gt 0 Dp gt 0 fixed point if possible Ip gives the number of places before the point not counting the sign place Dp the number of places after the point Padding spaces are added on the left as necessary If the number will not fit the format then an exponential format is used with the same field width as the fixed point representation would have had If Ip and Dp are very small then an exponential representation may not fit in the field width so the special value Ov with a sign is returned There are always Ip Dp 2 characters in string the 2 being the decimal point and the

Occam 2 User Library Specifications

Contents

Download Pdf Manuals

Related Search

Related Contents