Reserved Variables/Functions [ System Debug Reference Manual ] MPE/iX 5.0 Documentation
System Debug Reference Manual
Appendix D Reserved Variables/Functions
The following names are reserved for the predefined environment variables
(env) and functions (func):
abstolog (func : lcptr) CM absolute address to logical address
arg0..arg3 (env : u32) Argument registers
asc (func : str) Converts an expression to an ASCII string
ascc (func : str) Coerces an expression to an ASCII string
autoignore (env : bool) Ignores errors on every command
autorepeat (env : bool) Repeat last command with carriage return
bin (func : u32) Converts an ASCII string to a number
bitd (func : u32) Bit deposit
bitx (func : u32) Bit extract
bool (func : bool) Coerces an expression to BOOL type
bound (func : str) Tests for current definition of an operand
btow (func : s16) Converts a CM byte offset to a word offset
ccode (env : str) Condition code
ccr (env : u32) Coprocessor configuration register
changes (env : str) Video enhancements for changed window values
cir (env : u16) Current instruction register
cisetvar (func : bool) Sets a new value for a CI variable
civar (func : any) Returns current value of a CI variable
cmaddr (func : lcptr) Logical address of a specified CM procedure
cmbpaddr (func : 1cptr) Logical address of a CM breakpoint index
cmbpindex (func : u16) Index number of CM breakpoint at address
cmbpinstr (func : s16) CM instruction at CM breakpoint address
cmdlinesubs (env : bool) Enables/disables command line substitutions
cmdnum (env : u32) Current command number
cmentry (func : lptr) Entry address of CM procedure
cmg (func : sptr) Short pointer address of CMGLOBALS record
cmnode (func : lptr) Closest CM node point
cmpc (env : lcptr) Full CM program counter logical address
cmpw (env : lcptr) Current CM program window logical address
cmproc (func : str) Returns the name of CM procedure
cmproclen (func : u16) Returns the length of CM procedure
cmseg (func : str) Returns the name of CM segment
cmstackbase (func : lptr) Virtual address of the CM stack base
cmstackdst (func : u16) Data segment number of the CM stack
cmstacklimit (func : lptr) Virtual address of the CM stack limit
cmstart (func : lptr) Start address of CM procedure
cmtonmnode (func : trans) Closest NM node to a CM logical address
cmva (func : lptr) Converts CM code address to virtual address
cm_inbase (env : str) Current CM input base
cm_outbase (env : str) Current CM output base
column (env : u16) Current output column position
console_debug (env : u16) Use system console for I/O
cpu (env : u16) CPU number of the current processor
cr0, cr8..cr31 (env : u32) Control registers
cst (func : cst) Coerces an expression to CST type
cstbase (env : lptr) Virtual address of the CM code segment table
cstx (func : cstx) Coerces an expression to CSTX type
cst_expansion (env : bool) CM CST Expansion is supported on MPE XL
date (env : str) Current date
db (env : u16) CM DB register
dbdst (env : u16) CM DB data segment number
disp (env : bool) Dispatcher is running
dl (env : u16) CM DL register
dp (env : sptr) Data pointer (alias for R27)
dstbase (env : lptr) Virtual address of the CM data segment table
dstva (func : lptr) Converts CM dst.off to virtual address
echo_cmds (env : bool) Echo commands before execution
echo_subs (env : bool) Echo command line substitutions
echo_use (env : bool) Echo use file commands before execution
eiem (env : u32) External interrupt enable mask
eirr (env : u32) External interrupt request register
entry_mode (env : str) Mode at entry ("cm" or "nm")
errmsg (func : str) Error message string for error number/subsys
error (env : s32) Most recent error number
exec_mode (env : str) Process execution mode from TCB ("cm" or "nm")
escapecode (env : u32) Last escapecode value
false (env : bool) The constant FALSE
fill (env : str) Fill character for data display
filter (env : str) Filter pattern for output
fp0 .. fp15 (env : lptr) Floating-point registers
fpe1 .. fpe7 (env : s32) Floating-point exception registers
fpstatus (env : u32) Floating-point status register
grp (func : grp) Coerces an expression to a GRP LCPTR type
hash (addr : ptr) Hash a virtual address
hexupshift (env : bool) Upshifts all HEX output to upper case
icsnest (env : u16) Number of nested pending ICS interrupts
icsva (env : lptr) Interrupt control stack virtual address
iir (env : u32) Interrupt instruction register
inbase (env : str) Current input base
ior (env : u32) Interrupt offset register
ipsw (env : u32) Interrupt processor status word
isr (env : u32) Interrupt space register
itmr (env : u32) Interval timer
iva (env : u32) Interrupt vector address
job_debug (env : u16) Enables/disables job debugging
justify (env : str) Controls justification for data display
lastpin (env : u16) PIN of process at entry
lgrp (func : lgrp) Coerces an expression to a LGRP type
list_input (env : u16) Echoes user input to list file
list_pagelen (env : u16) Page length (in lines) of list file
list_pagenum (env : u16) Current page number of list file
list_paging (env : bool) Enables/disables paging of list file
list_title (env : str) Title for each page of list file
list_width (env : u16) Width (in characters) of list file
logtoabs (func : acptr) CM logical address to absolute address
lookup_id (env : str) NM procedure name lookup mechanism
lptr (func : lptr) Coerces an expression to LPTR type
lpub (func : lpub) Coerces an expression to LPUB type
ltolog (func : lcptr) Converts long pointer to logical code pointer
ltos (func : sptr) Converts long pointer to short pointer
lw (env : lptr) Current LW address in form ldev.offset
macbody (func : str) Returns macro body string
macro_depth (env : u16) Current nested call level for macros
macros (env : u16) The number of macros that can be defined
macros_limit (env : u16) Absolute maximum limit for "macros" (above)
mapdst (env : s16) Current CST expansion mapping dst number
mapflag (env : s16) CM segment is logically or physically mapped
mapindex (func : u32) Index number of a MAPPED file
mapsize (func : u32) Size in bytes of a MAPPED file
mapva (func : lptr) Virtual address of a MAPPED file
markers (env : str) Video enhancement for windowed stack markers
mode (env : str) Current mode ("cm" or "nm")
monarchcpu (env : u16) CPU number of the monarch processor
multi_line_errs (env : u16) Controls quantity of lines to display for
errors in a multiple line command
nmaddr (func : ptr) Address of a NM procedure or global data
nmbpaddr (func : lptr) Address of a NM breakpoint index
nmbpindex (func : u32) Index number of NM breakpoint at address
nmbpinstr (func : s32) NM instruction at NM breakpoint address
nmcall (func : s32) Dynamically invokes the specified routine
nmentry (func : lptr) Entry address of NM procedure
nmfile (func : str) Name of file containing mapped vaddr
nmmod (func : str) Name of NM module
nmnode (func : trans) Closest NM node
nmpath (func : str) Code path for a virtual address
nmproc (func : str) Name of NM procedure
nmpw (env : lcptr) Current NM program window logical address
nmstackbase (func : lptr) Virtual address of the NM stack base
nmstacklimit (func : lptr) Virtual address of the NM stack limit
nmtocmnode (func : lptr) Closest CM node to NM translated code
nm_inbase (env : str) NM input base
nm_outbase (env : str) NM output base
nonlocalvars (env : bool) Enables/disables access to variables which
are not local during macro execution
off (func : u32) Extract offset part of a long pointer
outbase (env : str) Current output base
pc (env : lptr) NM program counter (sid.off)
pcb (func : sptr) Process control block
pcbx (func : sptr) Process control block extension
pcob (env : sptr) Program counter offset back (off)
pcof (env : sptr) Program counter offset front (off)
pcqb (env : lptr) Program counter queue back (sid.off)
pcqf (env : lptr) Program counter queue front (sid.off)
pcsb (env : u32) Program counter space back (sid)
pcsf (env : u32) Program counter space front (sid)
phystolog (func : lcptr) CM physical seg/map bit to logical code ptr
pib (func : sptr) Process info block
pibx (func : sptr) Process info block ext.
pid1 .. pid4 (env : u32) Protection ID registers
pin (env : u16) Current PIN
priv (env : u16) Current privilege level (based on PC)
priv_user (env : u16) User has PM (privileged mode) capability
prog (func : prog) Coerces an expression to PROG type
progname (env : str) Either "dat" or "debug"
prompt (env : str) Current user prompt
psp (env : u32) Previous stack pointer
pstate (func : str) Process state
pstmt (env : u16) Enables/disables the display of statement
numbers in NM program window
psw (env : u32) An alias for "ipsw"
pub (func : pub) Coerces an expression to PUB type
pw (env : lptr) Current program window logical address
pwo (env : sptr) Current program window (offset part)
pws (env : u32) Current program window (SID/seg part)
q (env : u16) CM Q register
quiet_modify (env : bool) Skip display of current values for modifies
r0 .. r31 (env : u32) General registers r0, r1, r2, .. r31
rctr (env : u32) Recovery counter
ret0 .. ret1 (env : u32) Return registers 0 and 1
rp (env : sptr) Return pointer
rtov (func : lptr) Real to virtual
s (env : u16) CM S register
s16 (func : s16) Coerces an expression to S16 type
s32 (func : s32) Coerces an expression to S32 type
s64 (func : s64) Coerces an expression to S64 type
sar (env : u32) Shift amount register
sdst (env : u16) CM stack data segment number
sid (func : u32) Extracts SID part of a long pointer
sl (env : sptr) Static link register
sp (env : sptr) Stack pointer register
sptr (func : sptr) Coerces an expression to SPTR type
sr0 .. sr7 (env : u32) Space registers sr0, sr1, sr2, .. sr7
status (env : u16) CM STATUS register
stol (func : lptr) Converts a short pointer to long pointer
stolog (func : lcptr) Converts short pointer to logical code pointer
str (func : str) Extracts a substring from a string
strapp (func : str) String append
strdel (func : str) String delete
strdown (func : str) Downshifts a string
strextract (func : str) Returns a string from memory
strinput (func : str) Prompts for a string input
strins (func : str) String insert
strlen (func : u32) Returns the current length of a string
strltrim (func : str) Removes leading blanks from a string
strmax (func : u32) Maximum length of a string (constant)
strpos (func : u32) Position of a substring within a string
strrpt (func : str) String repeat
strrtrim (func : str) Removes trailing blanks from a string
strup (func : str) Upshifts a string
strwrite (func : str) String write (ala Pascal strwrite)
symaddr (func : u32) Returns the offset to a symbol in a structure
symconst (func : any) Returns the value of a symbolic constant
syminset (func : bool) Test for membership of a symbol in a set
symlen (func : u32) Returns the length of a symbolic data structure
symtype (func : str) Returns the symbolic type of a specified path
symval (func : any) Returns the value at a virtual address based
on a specified symbolic path
sys (func : sys) Coerces an expression to a SYS LCPTR type
tcb (func : u32) Task control block
term_keeplock (env : bool) Retain the terminal locking semaphore
term_ldev (env : u16) The ldev used for I/O
term_locking (env : bool) Enables_disables terminal process queueing
term_loud (env : bool) Enables/disables output echoing to screen
term_paging (env : bool) Enables/disables terminal screen paging
term_width (env : u16) Width (in characters) of terminal output
time (env : str) Current time of day
tr0 .. tr7 (env : u32) Temp registers tr0, tr1, tr2, ..tr7
trace_func (env : u16) Trace function entry, exit, and parameters
trans (func : trans) Coerces an expression to a TRANS LCPTR type
true (env : bool) The constant TRUE
typeof (func : str) Returns type of an expression
u16 (func : u16) Coerces an expression to U16 type
u32 (func : u32) Coerces an expression to U32 type
user (func : user) Coerces an expression to a USER LCPTR
vainfo (func : any) Information about a virtual object
vars (env : u16) Number of variables that can be defined
vars_limit (env : u16) Absolute sum limit of "vars" and "vars_loc"
vars_loc (env : u16) Number of local variables that can be defined
vars_table (env : u16) Current sum of "vars" and "vars_loc"
version (env : str) Version ID for System Debug
vtor (func : u32) Virtual to real
vtos (func : lptr) Virtual to secondary storage address
vw (env : lptr) Current virtual window address (lptr)
vwo (env : sptr) Current virtual window address (offset part)
vws (env : u32) Current virtual window space
win_length (env : u32) Number of lines on display terminal
win_width (env : u32) Number of columns on display terminal
x (env : u16) CM X register (index register)
zw (env : u32) Current real memory window address
MPE/iX 5.0 Documentation