Abstract
========
-The Muddle programming language began existence in late 1970 as a
-successor to Lisp (Moon, 1974), a candidate vehicle for the Dynamic
-Modeling System, and a possible base for implementation of Planner
-(Hewitt, 1969). The original design goals included an interactive
-integrated environment for programming, debugging, loading, and
-editing: ease in learning and use; facilities for structured, modular,
-shared programs; extensibility of syntax, data types and operators:
-data-type checking for debugging and optional data-type declarations
-for compiled efficiency; associative storage, coroutining, and
-graphics. Along the way to reaching those goals, it developed flexible
-input/output (including the ARPA Network), and flexible interrupt and
-signal handling. It now serves as a base for software prototyping,
-research, development, education, and implementation of the majority
-of programs at MIT-DMS: a library of sharable modules, a coherent user
-interface, special research projects, autonomous daemons, etc.
+The Muddle programming language began existence in late 1970 (under
+the name Muddle) as a successor to Lisp (Moon, 1974), a candidate
+vehicle for the Dynamic Modeling System, and a possible base for
+implementation of Planner (Hewitt, 1969). The original design goals
+included an interactive integrated environment for programming,
+debugging, loading, and editing: ease in learning and use; facilities
+for structured, modular, shared programs; extensibility of syntax,
+data types and operators: data-type checking for debugging and
+optional data-type declarations for compiled efficiency; associative
+storage, coroutining, and graphics. Along the way to reaching those
+goals, it developed flexible input/output (including the ARPA
+Network), and flexible interrupt and signal handling. It now serves as
+a base for software prototyping, research, development, education, and
+implementation of the majority of programs at MIT-DMS: a library of
+sharable modules, a coherent user interface, special research
+projects, autonomous daemons, etc.
This document was originally intended to be a simple low-level
introduction to Muddle. It has, however, acquired a case of
misconceptions, I would like to thank Chris Reeve, Bruce Daniels, and
especially Gerald Sussman, one of whose good ideas I finally did use.
-*Greg Pfister\
-December 15, 1972*
+Greg Pfister\
+December 15, 1972
Since Greg left the fold, I have taken up the banner and updated his
document. The main sources for small revisions have been the on-line
("the oracle") for the patience to answer questions and resolve
doubts, as he no doubt as done innumerable times before.
-*S. W. Galley\
-May 23, 1979*
+S. W. Galley\
+May 23, 1979
This work was supported by the Advanced Research Projects Agency of
the Department of Defense and was monitored by the Office of Naval
are not covered in the text. Ignore examples as your peril.
This document does not assume knowledge of any specific programming
-language on the \[sic\] your part. However, "computational literacy"
-is assumed: you should have written at least one program before. Also
-very little familiarity is assumed with the interactive time-sharing
-operating systems under which Muddle runs -- ITS, Tenex, and Tops-20
--- namely just file and user naming conventions.
+language on your part. However, "computational literacy" is assumed:
+you should have written at least one program before. Also very little
+familiarity is assumed with the interactive time-sharing operating
+systems under which Muddle runs -- ITS, Tenex, and Tops-20 -- namely
+just file and user naming conventions.
### Notation
Most specifically indicated examples herein are composed of pairs of
lines. The first line of a pair, the input, always ends in `$` (which
-is how the ASCII character ESC is represented, and which always
+is how the ASCII character `ESC` is represented, and which always
represents it). The second line is the result of Muddle's groveling
over the first. If you were to type all the first lines at Muddle, it
would respond with all the second lines. (More exactly, the "first
An ellipsis (...) indicates that something uninteresting has been
omitted. The character `^` means that the following character is to be
-"controllified": it is usually typed by holding down a terminal's CTRL
-key and striking the other key.
+"controllified": it is usually typed by holding down a terminal's
+`CTRL` key and striking the other key.
Chapter 1. Basic Introduction
=============================
echoed (printed on your terminal) and remembered in a buffer. The only
characters for which this is normally not true act as follows:
-Typing `$` (ESC) causes Muddle to echo dollar-sign and causes the
+Typing `$` (`ESC`) causes Muddle to echo dollar-sign and causes the
contents of the buffer (the characters which you've typed) to be
interpreted as an expression(s) in Muddle. When this interpretation is
done, the result will be printed and Muddle will wait for more typing.
-ESC will be represented by the glyph `$` in this document.
-
-Typing the rubout character (DEL in the ITS and Top-20 versions,
-CTRL+A in the Tenex version) causes the last character in the buffer
--- the one most recently typed -- to be thrown away (deleted). If you
-now immediately type another rubout, once again the last character is
-deleted -- namely the second most recently typed. Etc. The character
-deleted is echoed, so you can see what you're doing. On some "display"
-terminals, rubout will "echo" by causing the deleted character to
-disappear. If no characters are in the buffer, rubout echoes as a
-carriage-return line-feed.
-
-Typing \^@ (CTRL+@) deletes everything you have typed since the last
-`$`, and prints a carriage-return line-feed.
-
-Typing \^D (CTRL+D) causes the current input buffer to be typed back
-out at you. This allows you to see what you really have, without the
-confusing re-echoed characters produced by rubout.
-
-Typing \^L (CTRL+L) produces the same effect as typing \^D, except
-that, if your terminal is a "display" terminal (for example, IMLAC,
-ARDS, Datapoint), it firsts clears the screen.
-
-Typing \^G (CTRL+G) causes Muddle to stop whatever it is doing and act
-as if an error had occurred ([section
-1.4](#14-errors-simple-considerations-1)). \^G is generally most
+`ESC` will be represented by the glyph `$` in this document.
+
+Typing the rubout character (`DEL` in the ITS and Top-20 versions,
+`CTRL`+`A` in the Tenex version) causes the last character in the
+buffer -- the one most recently typed -- to be thrown away (deleted).
+If you now immediately type another rubout, once again the last
+character is deleted -- namely the second most recently typed. Etc.
+The character deleted is echoed, so you can see what you're doing. On
+some "display" terminals, rubout will "echo" by causing the deleted
+character to disappear. If no characters are in the buffer, rubout
+echoes as a carriage-return line-feed.
+
+Typing `^@` (`CTRL`+`@`) deletes everything you have typed since the
+last `$`, and prints a carriage-return line-feed.
+
+Typing `^D` (`CTRL`+`D`) causes the current input buffer to be typed
+back out at you. This allows you to see what you really have, without
+the confusing re-echoed characters produced by rubout.
+
+Typing `^L` (`CTRL`+`L`) produces the same effect as typing `^D`,
+except that, if your terminal is a "display" terminal (for example,
+IMLAC, ARDS, Datapoint), it firsts clears the screen.
+
+Typing `^G` (`CTRL`+`G`) causes Muddle to stop whatever it is doing
+and act as if an error had occurred ([section
+1.4](#14-errors-simple-considerations-1)). `^G` is generally most
useful for temporary interruptions to check the progress of a
-computation. \^G is "reversible" -- that is, it does not destroy any
-of the "state" of the computation it interrupts. To "undo" a \^G, type
-the characters
+computation. `^G` is "reversible" -- that is, it does not destroy any
+of the "state" of the computation it interrupts. To "undo" a `^G`,
+type the characters
<ERRET T>$
(This is discussed more fully far below, in section 16.4.)
-Typing \^S (CTRL+S) causes Muddle to **throw away** what it is
+Typing `^S` (`CTRL`+`S`) causes Muddle to **throw away** what it is
currently doing and return a normal "listening" state. (In the Tenex
-and Tops-20 versions, \^O also should have the same effect.) \^S is
+and Tops-20 versions, `^O` also should have the same effect.) `^S` is
generally most useful for aborting infinite loops and similar terrible
-things. \^S **destroys** whatever is going on, and so it is **not**
+things. `^S` **destroys** whatever is going on, and so it is **not**
reversible.
Most expressions in Muddle include "brackets" (generically meant) that
must be correctly paired and nested. If you end your typing with the
-pair of characters `!$` (!+ESC), all currently unpaired brackets (but
-not double-quotes, which bracket strings of characters) will
-automatically be paired and interpretation will start. Without the !,
-Muddle will just sit there waiting for you to pair them. If you have
-improperly nested parentheses, brackets, etc., within the expression
-you typed, an error will occur, and Muddle will tell you what is
-wrong.
+pair of characters `!$` (`!`+`ESC`), all currently unpaired brackets
+(but not double-quotes, which bracket strings of characters) will
+automatically be paired and interpretation will start. Without the
+`!`, Muddle will just sit there waiting for you to pair them. If you
+have improperly nested parentheses, brackets, etc., within the
+expression you typed, an error will occur, and Muddle will tell you
+what is wrong.
Once the brackets are properly paired, Muddle will immediately echo
carriage-return and line-feed, and the next thing it prints will be
you have some expression unclosed. In that case, if you have not typed
any characters beyond the `$`, you can usually rub out the `$` and
other characters back to the beginning of the unclosed expression.
-Otherwise, what you have typed is beyond the help of rubout and \^@;
-if you want to abort it, use \^S.
+Otherwise, what you have typed is beyond the help of rubout and `^@`;
+if you want to abort it, use `^S`.
Muddle accepts and distinguishes between upper and lower case. All
"built-in functions" must be referenced in upper case.
met. Instead, the right-hand column will be used to state just what
`READ` thought the input in the left-hand column really was.
- ----------------------------------------------------------------------------------
+ ------------------------------------------------------------------------------------
Input Explanation
- --------------------------- ------------------------------------------------------
+ --------------------------- --------------------------------------------------------
`ABC$` an `ATOM` of `PNAME` `ABC`
`abc$` an `ATOM` of `PNAME` `abc`
something else (The something else will contain an
`ATOM` of `PNAME` beginning `cd.`)
- `12345A34$` an `ATOM` of `PNAME` `12345A35` (If the A had been an
- E, the object would have been a `FLOAT`.)
- ----------------------------------------------------------------------------------
+ `12345A34$` an `ATOM` of `PNAME` `12345A35` (If the A had been an E,
+ the object would have been a `FLOAT`.)
+ ------------------------------------------------------------------------------------
#### 2.6.3.3. (Backslash) in ATOMs
error, but because commenting is needed: `PRINT` doesn't do it full
justice.
- ------------------------------------------------------------------------------
+ -------------------------------------------------------------------------------
Input Explanation
- ------------------------ -----------------------------------------------------
+ ------------------------ ------------------------------------------------------
`a\ one\ and\ a\ two$` one `ATOM`, whose `PNAME` has four spaces in it
`1234\56789$` an `ATOM` of `PNAME` `123456789`, which `PRINT`s as
`\123\`, with a space on the end
`\\$` an `ATOM` whose `PNAME` is a single backslash
- ------------------------------------------------------------------------------
+ -------------------------------------------------------------------------------
Chapter 3. Built-in Functions
=============================
found in chapter 13.
Example: the following `FUNCTION` reads characters from the current
-input channel until an `$` (ESC) is read, and then returns what was
+input channel until an `$` (`ESC`) is read, and then returns what was
read as one `STRING`. (The `SUBR` `READCHR` reads one character from
the input channel and returns it. `NEXTCHR` returns the next
`CHARACTER` which `READCHR` will return -- chapter 11.)
### 11.1.1. Input
All of the following input Subroutines, when directed at a terminal,
-hang until `$` (ESC) is typed and allow normal use of rubout, \^D, \^L
-and \^@.
+hang until `$` (`ESC`) is typed and allow normal use of `rubout`,
+`^D`, `^L` and `^@`.
#### 11.1.1.1. READ
eventually returns `"DONE"`. First, however, it `READ`s and `EVAL`s
every Muddle object in the file pointed to by *input*, and then
-`CLOSE`s *input*. Any occurrences of rubout, ^@, ^D, \^L, etc., in the
-file are given no special meaning; they are simply `ATOM`
+`CLOSE`s *input*. Any occurrences of `rubout`, `^@`, `^D`, `^L`, etc.,
+in the file are given no special meaning; they are simply `ATOM`
constituents.
*look-up* is optional, used to specify a `LIST` of `OBLIST`s for the
<ECHOPAIR terminal-in:channel terminal-out:channel>
returns its first argument, after making the two `CHANNEL`s "know
-about each other" so that rubout, ^@, ^D and \^L on *terminal-in* will
-cause the appropriate output on *terminal-out*.
+about each other" so that `rubout`, `^@`, `^D` and `^L` on
+*terminal-in* will cause the appropriate output on *terminal-out*.
### 11.8.2. TTYECHO
<TYI terminal-input:channel>
returns one `CHARACTER` from *channel* (optional, `.INCHAN` by
-default) when it is typed, rather than after `$` (ESC) is typed, as is
-the case with `READCHR`. The following example echos input characters
-as their ASCII values, until a carriage-return is typed:
+default) when it is typed, rather than after `$` (`ESC`) is typed, as
+is the case with `READCHR`. The following example echos input
+characters as their ASCII values, until a carriage-return is typed:
<REPEAT ((FOO <TTYECHO .INCHAN <>>))
<AND <==? 13 <PRINC <ASCII <TYI .INCHAN>>>>
should use to do so. This is particularly true with respect to
locatives to `LVAL`s; the fact that they are independent of changes in
binding can save a lot of fooling around with `EVAL` and
-`ENVIRONMENT`s. \# Chapter 13. Association (Properties)
+`ENVIRONMENT`s.
+
+Chapter 13. Association (Properties)
+====================================
There is an "associative" data storage and retrieval system embedded
in Muddle which allows the construction of data structures with
inputs (what `READ` returns) in it, most recent first. Similarly, if
the `ATOM` `L-OUTS` has a local value that is a `LIST`, `LISTEN` will
keep recent outputs (what `EVAL` returns) in it, most recent first.
-The keeping is done before the `PRINT`ing, so that \^S does not defeat
-its purpose. The user can decide how much to keep around by setting
-the length of each `LIST`. Even if `L-OUTS` is not used, the atom
-`LAST-OUT` is always `SET` to the last object returned by `EVAL` in
-the standard `LISTEN` loop. Example:
+The keeping is done before the `PRINT`ing, so that `^S` does not
+defeat its purpose. The user can decide how much to keep around by
+setting the length of each `LIST`. Even if `L-OUTS` is not used, the
+atom `LAST-OUT` is always `SET` to the last object returned by `EVAL`
+in the standard `LISTEN` loop. Example:
<SET L-INS (NEWEST NEWER NEW)>$
(NEWEST NEWER NEW)
16.7. Control-G (\^G)
-Typing control-G (\^G, `<ASCII 7>`) at Muddle causes it to act just as
-if an error had occurred in whatever was currently being done. You can
-then examine the values of variables as above, continue by applying
-`ERRET` to one argument (which is ignored), `RETRY` a `FRAME` lower on
-the control stack, or flush everything by applying `ERRET` to no
-arguments.
+Typing control-G (`^G`, `<ASCII 7>`) at Muddle causes it to act just
+as if an error had occurred in whatever was currently being done. You
+can then examine the values of variables as above, continue by
+applying `ERRET` to one argument (which is ignored), `RETRY` a `FRAME`
+lower on the control stack, or flush everything by applying `ERRET` to
+no arguments.
16.8. Control-S (\^S)
-Typing control-S (
\^S, `<ASCII 19>`) at Muddle causes it to stop what
+Typing control-S (
`^S`, `<ASCII 19>`) at Muddle causes it to stop what
is happening and return to the `FRAME` `.LERR\ !-INTERRUPTS`,
-returning the `ATOM` `T`. (In the Tenex and Tops-20 versions, \^O also
-has the same effect.)
+returning the `ATOM` `T`. (In the Tenex and Tops-20 versions, `^O`
+also has the same effect.)
16.9. OVERFLOW
----------------------
`RSUBR`s ("relocatable subroutines") are machine-language programs
-written to run in the MDL environment. They are usually produced by
-the MDL assembler (often from output produced by the compiler)
+written to run in the Muddle environment. They are usually produced by
+the Muddle assembler (often from output produced by the compiler)
although this is not necessary. All `RSUBR`s have two components: the
"reference vector" and the "code vector". In some cases the code
vector is in pure storage. There is also a set of "fixups" associated
with every `RSUBR`, although it may not be available in the running
-MDL.
+Muddle.
19.2. The Reference Vector
--------------------------
where *name* names the entry in the user's pure-`RSUBR` table, and
*offset* is the offset. (Obviously, `PCODE` is also the name of a
`SUBR`, which generates a pure code vector.) Pure `RSUBR`s may also
-move around, but only by being included in MDL's page map at different
-places. Once again `M` can be used exactly as before to do
+move around, but only by being included in Muddle's page map at
+different places. Once again `M` can be used exactly as before to do
location-independent address referencing. Individual pure code vectors
can be "unmapped" (marked as being not in primary storage but in their
original pure-code disk files) if the space in storage allocated for
=======================
In order to handle user `NEWTYPE`s reasonably, the internal `TYPE`
-codes for them have to be able to be different from one MDL run to
+codes for them have to be able to be different from one Muddle run to
another. Therefore, references to the `TYPE` codes must be in the
reference vector rather than the code vector. To help handle this
problem, two `TYPE`s exist, `TYPE-C` ("type code") and `TYPE-W` ("type
<RSUBR [code name decl ref ref ...]>
`CHTYPE`s its argument to an `RSUBR`, after checking it for legality.
-`RSUBR` is rarely called other than in the MDL Assembler (Lebling,
+`RSUBR` is rarely called other than in the Muddle Assembler (Lebling,
1979). It can be used if changes must be made to an `RSUBR` that are
-prohibited by MDL's built-in safety mechanisms. For example, if the
+prohibited by Muddle's built-in safety mechanisms. For example, if the
`GVAL` of *name* is an `RSUBR`:
<SET FIXIT <CHTYPE ,name VECTOR>>$
versions) in a special large file that contains all currently-used
pure code, or (in the Tenex version) in a file in a special disk
directory with first name the same as the *name* argument to `PCODE`
-for the `RSUBR`. The pure-code file is page-mapped directly into MDL
-storage in read-only mode. It can be unmapped when the pure storage
-must be reclaimed, and it can be mapped at a different storage address
-when pure storage must be compacted. There is also a "fixup" file (see
-below) or portion of a file associated with the `FBIN` to round out
-the triad.
-
-An initial MDL can have pure `RSUBR`s in it that were "loaded" during
-the initialization procedure. The files are not page-mapped in until
-they are actually needed. The "loading" has other side effects, such
-as the creation of `OBLIST`s (chapter 15). Exactly what is pre-loaded
-is outside the scope of this document.
+for the `RSUBR`. The pure-code file is page-mapped directly into
+Muddle storage in read-only mode. It can be unmapped when the pure
+storage must be reclaimed, and it can be mapped at a different storage
+address when pure storage must be compacted. There is also a "fixup"
+file (see below) or portion of a file associated with the `FBIN` to
+round out the triad.
+
+An initial Muddle can have pure `RSUBR`s in it that were "loaded"
+during the initialization procedure. The files are not page-mapped in
+until they are actually needed. The "loading" has other side effects,
+such as the creation of `OBLIST`s (chapter 15). Exactly what is
+pre-loaded is outside the scope of this document.
19.9. Fixups
------------
The purpose of "fixups" is to correct references in the `RSUBR` to
-parts of the interpreter that change from one release of MDL to the
+parts of the interpreter that change from one release of Muddle to the
next. The reason the fixups contain a release number is so that they
can be completely ignored when an `RSUBR` is loaded into the same
-release of MDL as that from which it was last written out.
+release of Muddle as that from which it was last written out.
There are three forms of fixups, corresponding to the three kinds of
`RSUBR` files. ASCII `RSUBR`s, found in `BINARY` files, have ASCII
fixups. The fixups are contained in a `LIST` that has the following
format:
- (MDL-release:fix
+ (Muddle-release:fix
name:atom value:fix (use:fix use:fix ...)
name:atom value:fix (use:fix use:fix ...)
...)
create an `RSUBR`, so that it can be written out with its fixups.
In the case of pure `RSUBR`s (`FBIN` files), things are a little
-different. If a pure-code file exists for this release of MDL, it is
-used immediately, and the fixups are completely ignored. If a
+different. If a pure-code file exists for this release of Muddle, it
+is used immediately, and the fixups are completely ignored. If a
pure-code file for this release doesn't exist, the fixup file is used
to create a new copy of the file from an old one, and also a new
version of the fixup file is created to go with the new pure-code
Chapter 20. Coroutines
======================
-This chapter purports to explain the coroutine primitives of MDL. It
-does make some attempt to explain coroutines as such, but only as
+This chapter purports to explain the coroutine primitives of Muddle.
+It does make some attempt to explain coroutines as such, but only as
required to specify the primitives. If you are unfamiliar with the
basic concepts, confusion will probably reign.
-A coroutine in MDL is implemented by an object of `TYPE` `PROCESS`. In
-this manual, this use of the word "process" is distinguished by a
+A coroutine in Muddle is implemented by an object of `TYPE` `PROCESS`.
+In this manual, this use of the word "process" is distinguished by a
capitalization from its normal use of denoting an operating-system
process (which various systems call a process, job, fork, task, etc.).
-MDL's built-in coroutine primitives do not include a "time-sharing
+Muddle's built-in coroutine primitives do not include a "time-sharing
system". Only one `PROCESS` is ever running at a time, and control is
passed back and forth between `PROCESS`es on a coroutine-like basis.
The primitives are sufficient, however, to allow the writing of a
-"time-sharing system" **in MDL**, with the additional use of the MDL
-interrupt primitives. This has, in fact, been done.
+"time-sharing system" **in Muddle**, with the additional use of the
+Muddle interrupt primitives. This has, in fact, been done.
20.1. PROCESS (the TYPE)
------------------------
<RESUME 2 ,SUMUP>$
8
-Just as a note, by taking advantage of MDL's order of evaluation, SUM3
-could be have been written as:
+Just as a note, by taking advantage of Muddle's order of evaluation,
+SUM3 could be have been written as:
<DEFINE SUM3 (A)
<REPEAT ((S .A))
#DECL ((A S0 <OR FIX FLOAT>)
- <SET S <RESUME <+ .S <RESUME "GOT 1"> <RESUME "GOT
- 2">>>>>>
+ <SET S <RESUME <+ .S <RESUME "GOT 1"> <RESUME "GOT 2">>>>>>
20.7. Other Coroutining Features
--------------------------------
### 20.7.2. MAIN
-When you initially start up MDL, the `PROCESS` in which you are
+When you initially start up Muddle, the `PROCESS` in which you are
running is slightly "special" in these two ways:
1. Any attempt to cause it become `DEAD` will be met with an error.
Chapter 21. Interrupts
======================
-The MDL interrupt handling facilities provide the ability to say the
-following: whenever "this event" occurs, stop whatever is being done
-at the time and perform "this action"; when "this action" is finished,
-continue with whatever was originally being done. "This event" can be
-things like the typing of a character at a terminal, a time interval
-ending, a `PROCESS` becoming blocked, or a program-defined and
--generated "event". "This action" is the application of a specified
-`APPLICABLE` object to arguments provided by the MDL interrupt system.
-The sets of events and actions can be changed in extremely flexible
-ways, which accounts for both the variety of `SUBR`s and arguments,
-and the rich interweaving of the topics in this chapter. Interrupt
-handling is a kind of parallel processing: a program can be divided
-into a "main-level" part and one or more interrupt handlers that
-execute only when conditions are ripe.
+The Muddle interrupt handling facilities provide the ability to say
+the following: whenever "this event" occurs, stop whatever is being
+done at the time and perform "this action"; when "this action" is
+finished, continue with whatever was originally being done. "This
+event" can be things like the typing of a character at a terminal, a
+time interval ending, a `PROCESS` becoming blocked, or a
+program-defined and -generated "event". "This action" is the
+application of a specified `APPLICABLE` object to arguments provided
+by the Muddle interrupt system. The sets of events and actions can be
+changed in extremely flexible ways, which accounts for both the
+variety of `SUBR`s and arguments, and the rich interweaving of the
+topics in this chapter. Interrupt handling is a kind of parallel
+processing: a program can be divided into a "main-level" part and one
+or more interrupt handlers that execute only when conditions are ripe.
21.1. Definitions of Terms
--------------------------
-An **interrupt** is not an object in MDL, but rather a class of
+An **interrupt** is not an object in Muddle, but rather a class of
events, for example, "ticks" of a clock, garbage collections, the
typing of a character at a terminal, etc.
An interrupt is said to **occur** when one of the events in its class
takes place.
-An **external** interrupt is one whose occurrences are signaled to MDL
-by the operating system, for example, "ticks" of a clock. An
-**internal** interrupt is one whose occurrences are detected by MDL
-itself, for example, garbage collections. MDL can arrange for the
+An **external** interrupt is one whose occurrences are signaled to
+Muddle by the operating system, for example, "ticks" of a clock. An
+**internal** interrupt is one whose occurrences are detected by Muddle
+itself, for example, garbage collections. Muddle can arrange for the
operating system to not signal occurrences of an external interrupt to
-it; then, as far as MDL is concerned, that interrupt does not occur.
+it; then, as far as Muddle is concerned, that interrupt does not
+occur.
Each interrupt has a **name** which is either a `STRING` (for example,
`"GC"`, `"CHAR"`, `"WRITE"`) or an `ATOM` with that `PNAME` in a
high-priority interrupt has been handled.
In each `IHEADER` is a (possibly empty) list of `HANDLER`s. (This list
-is not a MDL `LIST`.) Each `HANDLER` corresponds to an action to
+is not a Muddle `LIST`.) Each `HANDLER` corresponds to an action to
perform. There are `SUBR`s for creating a `HANDLER`, adding it to an
`IHEADER`'s list, and later removing it.
- The argument must be a `LOCATIVE` if and only if *name* is
`"READ"` (or `READ!-INTERRUPTS`) or `"WRITE"` (or
`WRITE!-INTERRUPTS`). In this case it specifies an object to be
- "monitored" for usage by (interpreted) MDL programs (section
+ "monitored" for usage by (interpreted) Muddle programs (section
21.8.9).
-If the interrupt is external, MDL arranges for the operating system to
-signal its occurrences.
+If the interrupt is external, Muddle arranges for the operating system
+to signal its occurrences.
21.3. HANDLER (the SUBR)
------------------------
removes the association between *iheader* and the name of its
interrupt, and then disables *iheader* and returns it. (An error
-occurs if there is no association.) If the interrupt is external, MDL
-arranges for the operating system not to signal its occurrences.
+occurs if there is no association.) If the interrupt is external,
+Muddle arranges for the operating system not to signal its
+occurrences.
<OFF name which>
finds the `IHEADER` associated with *name* and proceeds as above,
returning the `IHEADER`. *which* must be given only for certain
-*names*, as for `EVENT`. Caution: if you `<OFF "CHAR" ,INCHAN>`, MDL
-will become deaf.
+*names*, as for `EVENT`. Caution: if you `<OFF "CHAR" ,INCHAN>`,
+Muddle will become deaf.
<OFF handler>
#type most-interesting-component
The contents of `IHEADER`s and `HANDLER`s can be changed by `PUT`, and
-the new values will then determine the behavior of MDL.
+the new values will then determine the behavior of Muddle.
Before describing the elements of these `TYPE`s in detail, here are a
picture and a Pattern, both purporting to show how they look:
occurred is saved away for processing when the interrupt level becomes
low enough.
-When the processing of an interrupt's actions is completed, MDL
+When the processing of an interrupt's actions is completed, Muddle
usually (1) "acts as if" the previously-existing interrupt level is
restored, and processing continues on what was left off (perhaps for
no time duration); and (2) "acts as if" any queued interrupt
21.8. Specific Interrupts
-------------------------
-Descriptions of the characteristics of particular "built-in" MDL
+Descriptions of the characteristics of particular "built-in" Muddle
interrupts follow. Each is named by its `STRING` name. Expect this
list to be incomplete yesterday.
serves duty in several ways. These different ways will be described in
several different sections. All ways are concerned with characters or
machine words that arrive or depart at unpredictable times, because
-MDL is communicating with a person or another processor. Each `"CHAR"`
-`IHEADER` has a `CHANNEL` for the element that names the interrupt,
-and the mode of the `CHANNEL` tells what kinds of `"CHAR"` interrupts
-occur to be handled through that `IHEADER`.
+Muddle is communicating with a person or another processor. Each
+`"CHAR"` `IHEADER` has a `CHANNEL` for the element that names the
+interrupt, and the mode of the `CHANNEL` tells what kinds of `"CHAR"`
+interrupts occur to be handled through that `IHEADER`.
1. If the `CHANNEL` is for `INPUT`, "CHAR" occurs every time an
"interesting" character (see below) is received from the
which it was typed.
In the ITS version, the "interesting" characters are those "enabled
-for interrupts" on a real terminal, namely <kbd>\^@</kbd> through
-<kbd>\^G</kbd>, <kbd>\^K</kbd> through <kbd>\^\_</kbd>, and
-<kbd>DEL</kbd> (that is, ASCII codes 0-7, 13-37, and 177 octal.)
+for interrupts" on a real terminal, namely `^@` through `^G`, `^K`
+through `^_`, and `DEL` (that is, ASCII codes 0-7, 13-37, and 177
+octal.)
In the Tenex and Tops-20 versions, the operating system can be told
which characters typed on a terminal should cause this interrupt to
containing those characters (no more than six, all with ASCII codes
less than 33 octal). If called with no argument, `ACTIVATE-CHARS`
returns a `STRING` containing the characters that currently interrupt.
-Initially, only <kbd>\^G</kbd>, <kbd>\^S</kbd>, and <kbd>\^O</kbd>
-interrupt.
+Initially, only `^G`, `^S`, and `^O` interrupt.
-An initial MDL already has `"CHAR"` enabled on `,INCHAN` with a
+An initial Muddle already has `"CHAR"` enabled on `,INCHAN` with a
priority 8 (eight), the `SUBR` `QUITTER` for a handler to run in
-`#PROCESS 0` (the running `PROCESS`); this is how <kbd>`^G`</kbd> and
-<kbd>`^S`</kbd> are processed. In addition, every time a new `CHANNEL`
-is `OPEN`ed in `"READ"` mode to a terminal, a similar `IHEADER` and
-`HANDLER` are associated with that new `CHANNEL` automatically. These
+`#PROCESS 0` (the running `PROCESS`); this is how `^G` and `^S` are
+processed. In addition, every time a new `CHANNEL` is `OPEN`ed in
+`"READ"` mode to a terminal, a similar `IHEADER` and `HANDLER` are
+associated with that new `CHANNEL` automatically. These
automatically-generated `IHEADER`s and `HANDLER`s use the standard
machinery, and they can be `DISABLE`d or `OFF`ed at will. **However**,
-the `IHEADER` for `,INCHAN` should not be `OFF`ed: MDL knows that `$`
-is typed only by an interrupt!
+the `IHEADER` for `,INCHAN` should not be `OFF`ed: Muddle knows that
+`$` is typed only by an interrupt!
Example: the following causes the given message to be printed out
-whenever a <kbd>`^Y`</kbd> is typed on `.INCHAN`:
+whenever a `^Y` is typed on `.INCHAN`:
<SET H <HANDLER <GET .INCHAN INTERRUPT>
#FUNCTION ((CHAR CHAN)
which started waiting (which will also be the `PROCESS` in which the
handler runs, if no specific one is in the `HANDLER`).
-Example: the following will cause MDL to acquire a `*` prompting
+Example: the following will cause Muddle to acquire a `*` prompting
character.
<ON "BLOCKED" #FUNCTION ((IGNORE) <PRINC !\*>) 5>
### 21.8.8. "UNBLOCKED"
-`"UNBLOCKED"` occurs whenever a `$` (<kbd>`ESC`</kbd>) is typed on a
-terminal if a program was hanging and waiting for input, or when a TYI
-call (which see) is satisfied. A handler takes one argument: the
-`CHANNEL` via which the `$` or character is input.
+`"UNBLOCKED"` occurs whenever a `$` (`ESC`) is typed on a terminal if
+a program was hanging and waiting for input, or when a TYI call (which
+see) is satisfied. A handler takes one argument: the `CHANNEL` via
+which the `$` or character is input.
### 21.8.9. "READ" and "WRITE"
`"READ"` and `"WRITE"` are associated with read or write references to
-MDL objects. These interrupts are often called "monitors", and
+Muddle objects. These interrupts are often called "monitors", and
enabling the interrupt is often called "monitoring" the associated
object. A "read reference" to an `ATOM`'s local value includes
applying `BOUND?` or `ASSIGNED?` to the `ATOM`; similarly for a global
### 21.8.11. "ERROR"
-In an effort to simplify error handling by programs, MDL has a
+In an effort to simplify error handling by programs, Muddle has a
facility allowing errors to be handled like interrupts. `SETG`ing
`ERROR` to a user function is a distasteful method, not safe if any
bugs are around. An `"ERROR"` interrupt wants a handler that takes any
### 21.8.13. "INFERIOR"
-`"INFERIOR"` occurs when an inferior ITS process interrupts the MDL
+`"INFERIOR"` occurs when an inferior ITS process interrupts the Muddle
process. It is not available in the Tenex and Tops-20 versions. A
handler takes one argument: A `FIX` between `0` and `7` inclusive,
telling which inferior process is interrupting.
These are not available in the Tenex and Tops-20 versions.
-`"RUNT"`, if enabled, occurs **once**, *N* seconds of MDL running time
-(CPU time) after calling `<RUNTIMER N:fix-or-float>`, which returns
-its argument. A handler takes no arguments. If `RUNTIMER` is called
-with no argument, it returns a `FIX`, the number of run-time seconds
-left until the interrupt occurs, or `#FALSE ()` if the interrupt is
-not going to occur.
+`"RUNT"`, if enabled, occurs **once**, *N* seconds of Muddle running
+time (CPU time) after calling `<RUNTIMER N:fix-or-float>`, which
+returns its argument. A handler takes no arguments. If `RUNTIMER` is
+called with no argument, it returns a `FIX`, the number of run-time
+seconds left until the interrupt occurs, or `#FALSE ()` if the
+interrupt is not going to occur.
`"REALT"`, if enabled, occurs **every** *N* seconds of real-world time
after calling `<REALTIMER N:fix-or-float>`, which returns its
### 21.8.15. "Dangerous" Interrupts
-`"MPV"` ("memory protection violation") occurs if MDL tries to refer
-to a storage address not in its address space. `"PURE"` occurs if MDL
-tries to alter read-only storage. `"ILOPR"` occurs if MDL executes and
-illegal instruction ("operator"). `"PARITY"` occurs if the CPU detects
-a parity error in MDL's address space. All of these require a handler
-that takes one argument: the address (`TYPE` `WORD`) following the
-instruction that was being executed at the time.
+`"MPV"` ("memory protection violation") occurs if Muddle tries to
+refer to a storage address not in its address space. `"PURE"` occurs
+if Muddle tries to alter read-only storage. `"ILOPR"` occurs if Muddle
+executes and illegal instruction ("operator"). `"PARITY"` occurs if
+the CPU detects a parity error in Muddle's address space. All of these
+require a handler that takes one argument: the address (`TYPE` `WORD`)
+following the instruction that was being executed at the time.
-`"IOC"` occurs if MDL tries to deal illegally with an I/O channel. A
-handler must take two arguments: a three-element `FALSE` like one that
-`OPEN` might return, and the `CHANNEL` that got the error.
+`"IOC"` occurs if Muddle tries to deal illegally with an I/O channel.
+A handler must take two arguments: a three-element `FALSE` like one
+that `OPEN` might return, and the `CHANNEL` that got the error.
Ideally these interrupts should never occur. In fact, in the Tenex and
Tops-20 versions, these interrupts always go to the superior operating
-system process instead of to MDL. In the ITS version, if and when a
+system process instead of to Muddle. In the ITS version, if and when a
"dangerous" interrupt does occur:
- If no `IHEADER` is associated with the interrupt, then the
-----------------------------
If the interrupt name given to `EVENT` or `ON` is **not** one of the
-standard predefined interrupts of MDL, they will gleefully create an
-`ATOM` in `<INTERRUPTS>` and an associated `IHEADER` anyway, making
+standard predefined interrupts of Muddle, they will gleefully create
+an `ATOM` in `<INTERRUPTS>` and an associated `IHEADER` anyway, making
the assumption that you are setting up a "program-defined" interrupt.
Program-defined interrupts are made to occur by applying the `SUBR`
is possible that nothing "really happened" (yet).
`INTERRUPT` can also be used to cause "artificial" occurrences of
-standard predefined MDL interrupts.
+standard predefined Muddle interrupts.
Making a program-defined interrupt occur is similar to calling a
handler directly, but there are differences. The value returned by a
==============================
The reason this chapter comes so late in this document is that, except
-for special cases, MDL programs have their storage needs handled
+for special cases, Muddle programs have their storage needs handled
automatically. There is usually no need even to consider storage
management, except as it affects efficiency (chapter 24). This chapter
gives some explanation of why this is so, and covers those special
means by which a program can assume control of storage management.
-The MDL address space is divided into five parts, which are usually
+The Muddle address space is divided into five parts, which are usually
called
1. movable garbage-collected space,
5. internal storage.
Internal storage occupies both the highest and lowest addresses in the
-address space, and its size never changes as MDL executes. The other
-spaces can vary in size according to the needs of the executing
+address space, and its size never changes as Muddle executes. The
+other spaces can vary in size according to the needs of the executing
program. Generally the interpreter allocates a contiguous set of
addresses for each space, and each space gradually fills up as new
objects are created and as disk files are mapped in. The action taken
22.1. Movable Garbage-collected Storage
---------------------------------------
-Most storage used explicitly by MDL programs is obtained from a pool
-of free storage managed by a "garbage collector". Storage is obtained
-from this pool by the `SUBR`s which construct objects. When a `SUBR`
-finds that the pool of available storage is exhausted, it
+Most storage used explicitly by Muddle programs is obtained from a
+pool of free storage managed by a "garbage collector". Storage is
+obtained from this pool by the `SUBR`s which construct objects. When a
+`SUBR` finds that the pool of available storage is exhausted, it
automatically calls the garbage collector.
The garbage collector has two algorithms available to it: the
If the request for more storage still cannot be satisfied from
reclaimed storage, the garbage collector will attempt to obtain more
-total storage from the operating system under which MDL runs. (Also,
-if there is a gross superfluity of storage space, the garbage
+total storage from the operating system under which Muddle runs.
+(Also, if there is a gross superfluity of storage space, the garbage
collector will politely return some storage to the operating system.)
Only when the total system resources are exhausted will you finally
lose.
### 22.1.1. Stacks and Other Internal Vectors
-Control stacks are used in MDL to control the changes in environment
-caused by calling and binding. Each active `PROCESS` has its own
-control stack. On this stack are stored `LVAL`s for `ATOM`s;
+Control stacks are used in Muddle to control the changes in
+environment caused by calling and binding. Each active `PROCESS` has
+its own control stack. On this stack are stored `LVAL`s for `ATOM`s;
`PRIMTYPE` `TUPLE`s, which are otherwise like `VECTOR`s; `PRIMTYPE`
`FRAME`s, which are generated by calling Subroutines; and
`ACTIVATION`s, which are generated by calling `FUNCTION`s with named
the other one, so that a top-level `LVAL` will be found only if the
`ATOM` is not currently bound elsewhere, namely in the other section.
-MDL also has an internal stack, used for calling and temporary storage
-within the interpreter and compiled programs. It too is stored like a
-`VECTOR` and can overflow. There are other internal vectors that can
-overflow: the "global vector" holds pairs ("slots") of `ATOM`s and
-corresponding `GVAL`s ("globally bound" or `GBOUND?` means that the
-`ATOM` in question is in this vector, whether or not it currently has
-a global value), and the "`TYPE` vector" holds `TYPE` names
-(predefined and `NEWTYPE`s) and how they are to be treated.
+Muddle also has an internal stack, used for calling and temporary
+storage within the interpreter and compiled programs. It too is stored
+like a `VECTOR` and can overflow. There are other internal vectors
+that can overflow: the "global vector" holds pairs ("slots") of
+`ATOM`s and corresponding `GVAL`s ("globally bound" or `GBOUND?` means
+that the `ATOM` in question is in this vector, whether or not it
+currently has a global value), and the "`TYPE` vector" holds `TYPE`
+names (predefined and `NEWTYPE`s) and how they are to be treated.
22.2. Immovable Storage
-----------------------
An object of `PRIMTYPE` `STORAGE` is really a frozen `UVECTOR` whose
`UTYPE` is of `PRIMTYPE` `WORD`, but it is always pointed to by
-something internal to MDL and thus is never garbage-collectible. The
-use of `FREEZE` is always preferable, except when for historical
+something internal to Muddle and thus is never garbage-collectible.
+The use of `FREEZE` is always preferable, except when for historical
reasons a `STORAGE` is necessary.
22.3. Other Storage
-------------------
User pure/page space serves two purposes. First, when a user program
-`PURIFY`s (see below) MDL objects, they are copied into this space.
+`PURIFY`s (see below) Muddle objects, they are copied into this space.
Second, so-called hand-crafted `RSUBR`s (assembled but not compiled)
can call on the interpreter to map pages of disk files into this space
for arbitrary purposes.
Pure-`RSUBR` mapping space is used by the interpreter to dynamically
-map pages of pure compiled programs into and out of the MDL address
+map pages of pure compiled programs into and out of the Muddle address
space. Pure code can refer to impure storage through the "transfer
vector", another internal vector. This space is the most vulnerable to
being compressed in size by the long-term growth of other spaces.
program itself is pure and sharable, while impure storage is used for
internal pointers, counters, and flags, for example, pointers to the
boundaries of other spaces. In the pure part of this space are most of
-the `ATOM`s in an initial MDL, along with their `OBLIST` buckets
+the `ATOM`s in an initial Muddle, along with their `OBLIST` buckets
(`LIST`s) and `GVAL` slots (a pure extension of the global vector),
where possible. A `SET` or `SETG` of a pure `ATOM` automatically
impurifies the `ATOM` and as much of its `OBLIST` bucket as needs to
---------------------------------
When either of the garbage-collected spaces (movable or immovable)
-becomes full, MDL goes through the following procedure:
+becomes full, Muddle goes through the following procedure:
1. A `"DIVERT-AGC"` interrupt occurs if the garbage collection can be
deferred temporarily by shifting boundaries between storage spaces
2. The garbage collector begins execution. The "copying" algorithm
creates an inferior operating-system process (named `AGC` in the
ITS version) whose address space is used to hold the new copies of
- non-garbage objects. MDL accesses the inferior's address space
+ non-garbage objects. Muddle accesses the inferior's address space
through two pages ("frontier" and "window") in its internal space
that are shared with the inferior. If the garbage collection
occurred because movable garbage-collected space was exhausted,
5. Finally, the "mark-sweep" algorithm sweeps through the storage
space, adding unmarked objects to the internal free lists for
later re-use. The "copying" algorithm maps the inferior process's
- address space into MDL's own, replacing old garbagey with the new
- compact storage, and the inferior process is destroyed.
+ address space into Muddle's own, replacing old garbagey with the
+ new compact storage, and the inferior process is destroyed.
22.5 GC
-------
<BLOAT-STAT length-27:uvector>
fills the *uvector* with information about the state of storage of
-MDL. The argument should be a `UVECTOR` of length 27 and `UTYPE`
+Muddle. The argument should be a `UVECTOR` of length 27 and `UTYPE`
`FIX`. If `BLOAT-STAT` does not get an argument, it will provide its
own `UVECTOR`. The information returned is as follows: the first 8
elements indicate the number of garbage collections that are
9. number of words of movable storage
10. number of words of movable storage used since last `BLOAT-STAT`
11. maximum number of words of movable storage ever existing
-12. number of words of movable storage used since MDL began running
+12. number of words of movable storage used since Muddle began running
13. maximum size of control stack
14. number of words on control stack in use
15. maximum size of control stack(s) ever reached
Two `SUBR`s, described next, use only part of the garbage-collector
algorithm, in order to find all pointers to an object. `GC-DUMP` and
`GC-READ`, as their names imply, also use part in order to translate
-between MDL objects and binary representation thereof.
+between Muddle objects and binary representation thereof.
### 22.9.1. SUBSTITUTE
or `ASOC`. Sharing between operating-system processes actually occurs
after a `SAVE`, if and when the `SAVE` file is `RESTORE`d.
-Chapter 23. MDL as a System Process
-===================================
+Chapter 23. Muddle as a System Process
+======================================
-This chapter treats MDL considered as executing in an operating-system
-process, and interactions between MDL and other operating-system
-processes. See also section 21.8.13.
+This chapter treats Muddle considered as executing in an
+operating-system process, and interactions between Muddle and other
+operating-system processes. See also section 21.8.13.
23.1. TIME
----------
`TIME` takes any number of arguments, which are evaluated but ignored,
-and returns a `FLOAT` giving the number of seconds of CPU time the MDL
-process has used so far. `TIME` is often used in machine-level
-debugging to examine the values of its arguments, by having MDL's
+and returns a `FLOAT` giving the number of seconds of CPU time the
+Muddle process has used so far. `TIME` is often used in machine-level
+debugging to examine the values of its arguments, by having Muddle's
superior process (say, DDT) plant a breakpoint in the code for `TIME`.
23.2. Names
<UNAME>
-returns a `STRING` which is the "user name" of MDL's process. This is
-the "uname" process-control variable in the ITS version and the
+returns a `STRING` which is the "user name" of Muddle's process. This
+is the "uname" process-control variable in the ITS version and the
logged-in directory in the Tenex and Tops-20 versions.
<XUNAME>
-returns a `STRING` which is the "intended user name" of MDL's process.
-This is the "xuname" process-control variable in the ITS version and
-identical to `<UNAME>` in the Tenex and Tops-20 versions.
+returns a `STRING` which is the "intended user name" of Muddle's
+process. This is the "xuname" process-control variable in the ITS
+version and identical to `<UNAME>` in the Tenex and Tops-20 versions.
<JNAME>
-returns a `STRING` which is the "job name" of MDL's process. This is
-the "jname" process-control variable in the ITS version and the
+returns a `STRING` which is the "job name" of Muddle's process. This
+is the "jname" process-control variable in the ITS version and the
`SETNM` name in the Tenex and Tops-20 versions. The characters belong
to the "sixbit" or "printing" subset of ASCII, namely those between
`<ASCII *40*>` and `<ASCII *137*>` inclusive.
<XJNAME>
-returns a `STRING` which is the "intended job name" of MDL's process.
-This is the "xjname" process-control variable in the ITS version and
-identical to `<JNAME>` in the Tenex and Tops-20 versions.
+returns a `STRING` which is the "intended job name" of Muddle's
+process. This is the "xjname" process-control variable in the ITS
+version and identical to `<JNAME>` in the Tenex and Tops-20 versions.
23.3. Exits
-----------
<LOGOUT>
attempts to log out the process in which it is executed. It will
-succeed only if the MDL is the top-level process, that is, it is
+succeed only if the Muddle is the top-level process, that is, it is
running disowned or as a daemon. If it succeeds, it of course never
returns. If it does not, it returns `#FALSE ()`.
<QUIT>
-causes MDL to stop running, in an orderly manner. In the ITS version,
-it is equivalent to a `.LOGOUT 1` instruction. In the Tenex and
-Tops-20 versions, it is equivalent to a control-C signal, and control
-passes to the superior process.
+causes Muddle to stop running, in an orderly manner. In the ITS
+version, it is equivalent to a `.LOGOUT 1` instruction. In the Tenex
+and Tops-20 versions, it is equivalent to a control-C signal, and
+control passes to the superior process.
<VALRET string-or-fix>
("value return") seldom returns. It passes control back up the process
-tree to the superior of MDL, passing its argument as a message to that
-superior. If it does return, the value is `#FALSE ()`. If the argument
-is a `STRING`, it is passed to the superior as a command to be
-executed, via `.VALUE` in the ITS version and `RSCAN` in the Tops-20
-version. If the argument is a `FIX`, it is passed to the superior as
-the "effective address" of a `.BREAK 16`, instruction in the ITS
-version and ignored in other versions.
+tree to the superior of Muddle, passing its argument as a message to
+that superior. If it does return, the value is `#FALSE ()`. If the
+argument is a `STRING`, it is passed to the superior as a command to
+be executed, via `.VALUE` in the ITS version and `RSCAN` in the
+Tops-20 version. If the argument is a `FIX`, it is passed to the
+superior as the "effective address" of a `.BREAK 16`, instruction in
+the ITS version and ignored in other versions.
23.4. Inter-process Communication
---------------------------------
version.
The IPC ("inter-process communication") device is treated as an I/O
-device by ITS but not explicitly so by MDL: that is, it is never
-`OPEN`ed. It allows MDL to communicate with other ITS processes by
+device by ITS but not explicitly so by Muddle: that is, it is never
+`OPEN`ed. It allows Muddle to communicate with other ITS processes by
means of sending and receiving messages. A process identifies itself
as sender or recipient of a message with an ordered pair of "sixbit"
`STRING`s, which are often but not always `<UNAME>` and `<JNAME>`. A
### 23.4.2. The "IPC" Interrupt
-When your MDL process receives an IPC message, `"IPC"` occurs (chapter
-21). A handler is called with either four or six arguments gleaned
-from the message. *body*, *type*, *othern1*, and *othern2* are
+When your Muddle process receives an IPC message, `"IPC"` occurs
+(chapter 21). A handler is called with either four or six arguments
+gleaned from the message. *body*, *type*, *othern1*, and *othern2* are
supplied only if they are not this process's `<UNAME>` and `<JNAME>`.
There is a built-in `HANDLER` for the `"IPC"` interrupt, with a
arguments are provided, listening is on `<UNAME>` `<JNAME>`. When a
message arrives, `"IPC"` occurs.
-MDL is initially listening as `<UNAME>` `<JNAME>` with the built-in
+Muddle is initially listening as `<UNAME>` `<JNAME>` with the built-in
`HANDLER` set up on the `"IPC"` interrupt with a priority of `1`.
### 23.4.5. DEMSIG
24.1. Efficiency
----------------
-Actually, you make MDL programs efficient by thinking hard about what
-they really make the interpreter **do**, and making them do less. Some
-guidelines, in order of decreasing expense:
+Actually, you make Muddle programs efficient by thinking hard about
+what they really make the interpreter **do**, and making them do less.
+Some guidelines, in order of decreasing expense:
1. Free storage is expensive.
2. Calling functions is expensive.
1. Unnecessary use of free storage (creating needless `LIST`s,
`VECTOR`s, `UVECTOR`s, etc.) will cause the garbage collector to
- run more often. This is **expensive!** A fairly large MDL (for
+ run more often. This is **expensive!** A fairly large Muddle (for
example, 60,000 36-bit words) can take ten seconds of PDP-10 CPU
time for a garbage collection. Be especially wary of constructions
like `(0)`. Every time that is evaluated, it creates a new
if an *unmanifest* is referenced more than twice. Example:
<DEFINE MAP-LOOKUP (THINGS "AUX" (DB ,DATA-BASE))
- #DECL ((VALUE) VECTOR (THINGS DB) <UNSPECIAL <PRIMTYPE
- LIST>>)
+ #DECL ((VALUE) VECTOR (THINGS DB) <UNSPECIAL <PRIMTYPE LIST>>)
<MAPF ,VECTOR <FUNCTION (T) <MEMQ .T .DB>> .THINGS>>
24.4. Global and Local Values
24.6. Tables
------------
-There are several ways in MDL to store a table, that is, a collection
-of (names and) values that will be searched. Unsurprisingly, choosing
-the best way is often dictated by the size of the table and/or the
-nature of the (names and) values.
+There are several ways in Muddle to store a table, that is, a
+collection of (names and) values that will be searched.
+Unsurprisingly, choosing the best way is often dictated by the size of
+the table and/or the nature of the (names and) values.
For a small table, the names and values can be put in (separate)
structures -- the choice of `LIST` or array being determined by
vector can be used, kept sorted, and searched with a binary search.
For a large table, where reasonably efficient searches are required, a
-hashing scheme is probably best. Two methods are available in MDL:
+hashing scheme is probably best. Two methods are available in Muddle:
associations and `OBLIST`s.
In the first method, `PUTPROP` and `GETPROP` are used, which are very
You can see the nature of the choices. Nesting is still and all better
than `GO`.
+
+Appendix 1. A Look Inside
+=========================
+
+This appendix tells about the mapping between Muddle objects and
+PDP-10 storage -- in other words, the way things look "on the inside".
+None of this information is essential to knowing how to program in
+Muddle, but it does give some reasons for capabilities and
+restrictions that otherwise you have to memorize. The notation and
+terminology get a little awkward in this discussion, because we are in
+a twilight zone between the worlds of Muddle objects and of bit
+patterns. In general the words and phrases appearing in diagrams refer
+to bit patterns not Muddle objects. A lower-case word (like "tuple")
+refers to the storage occupied by an object of the corresponding
+`PRIMTYPE` (like `TUPLE`).
+
+First some terminology needs discussion. The sine qua non of any
+Muddle object is a **pair** of 36-bit computer words. In general,
+lists consist of pairs chained together by pointers (addresses), and
+vectors consist of contiguous blocks of pairs. `==?` essentially tests
+two pairs to see whether they contain the same bit patterns.
+
+The first (lower-addressed) word of a pair is called the **`TYPE`
+word**, because it contains a numeric **`TYPE` code** that represents
+the object's `TYPE`. The second (higher-addressed) word of a pair is
+called the **value word**, because it contains (part of or the
+beginning of) the "data part" of the object. The `TYPE` word (and
+sometimes the value word) is considered to be made of a left half and
+a right half. We will picture a pair like this:
+
+ ---------------------------------
+ | TYPE | |
+ | - - - - - - - - - - - - - - - |
+ | value |
+ ---------------------------------
+
+where a vertical bar in the middle of a word means the word's halves
+are used independently. You can see that the `TYPE` code is confined
+to the left half of the `TYPE` word. (Half-)words are sometimes
+subdivided into **fields** appropriate for the context; fields are
+also pictured as separated by vertical bars. The right half of the
+`TYPE` word is used for different purposes depending on the `TYPE` of
+the object and actual location of the value.
+
+Actually the 18-bit `TYPE` field is further decoded. The high-order
+(leftmost) bit is the mark bit, used exclusively by the garbage
+collector when it runs. The next two bits are monitor bits, used to
+cause `"READ"` and `"WRITE"` interrupts on read and write references
+to the pair. The next bit is used to differentiate between list
+elements and vector dope words. The next bit is unused but could be
+used in the future for an "execute" monitor. The remaining 13 bits
+specify the actual `TYPE` code. What `CHTYPE` does is to copy the pair
+and put a new `TYPE` code into the new pair.
+
+Each data `TYPE` (predefined and `NEWTYPE`s) must belong to one of
+about 25 "storage allocation classes" (roughly corresponding to Muddle
+`PRIMTYPE`s). These classes are characterized primarily by the manner
+in which the garbage collector treats them. Some of these classes will
+now be described.
+
+"One Word"
+
+This class includes all data that are not pointers to some kind of
+structure. All external (program-available) `TYPE`s in this class are
+of `PRIMTYPE` `WORD`. Example:
+
+ ---------------------------------
+ | FIX | 0 |
+ | - - - - - - - - - - - - - - - |
+ | 105 |
+ ---------------------------------
+
+"Two Word"
+
+The members of this class are all 18-bit pointers to list elements.
+All external `TYPE`s in this class are of `PRIMTYPE` `LIST`. Example:
+
+ ---------------------------------
+ | LIST | 0 |
+ | - - - - - - - - - - - - - - - |
+ | 0 | pointer |
+ ---------------------------------
+
+where `pointer` is a pointer to the first list element. If there are
+no elements, `pointer` is zero; thus empty objects of `PRIMTYPE`
+`LIST` are `==?` if their `TYPE`s are the same.
+
+"Two N Word"
+
+Members of this class are all "counting pointers" to blocks of
+two-word pairs. The right half of a counting pointer is an address,
+and the left half is the negative of the number of 36-bit words in the
+block. (This format is tailored to the PDP-10 `AOBJN` instruction.)
+The number of pairs in the block (`LENGTH`) is half that number, since
+each pair is two words. All external `TYPE`s in this class are of
+`PRIMTYPE` `VECTOR`. Example:
+
+ ---------------------------------
+ | VECTOR | 0 |
+ | - - - - - - - - - - - - - - - |
+ | -2*length | pointer |
+ ---------------------------------
+
+where `length` is the `LENGTH` of the `VECTOR` and `pointer` is the
+location of the start (the element selected by an `NTH` argument of 1)
+of the `VECTOR`.
+
+"N word"
+
+This class is the same as the previous one, except that the block
+contains objects all of the same `TYPE` without individual `TYPE`
+words. The `TYPE` code for all the elements is in vector dope words,
+which are at addresses just larger than the block itself. Thus, any
+object that carries information in its `TYPE` word cannot go into the
+block: `PRIMTYPE`s `STRING`, `BYTES`, `TUPLE` (and the corresponding
+locatives `LOCS`, `LOCB`, `LOCA`), `FRAME`, and `LOCD`. All external
+`TYPE`s in this class are of `PRIMTYPE` `UVECTOR`. Example:
+
+ ---------------------------------
+ | UVECTOR | 0 |
+ | - - - - - - - - - - - - - - - |
+ | -length | pointer |
+ ---------------------------------
+
+where `length` is the `LENGTH` of the `UVECTOR` and `pointer` points
+to the beginning of the `UVECTOR`.
+
+"Byte String" and "Character String"
+
+These two classes are almost identical. Byte strings are byte pointers
+to strings of arbitrary-size bytes. `PRIMTYPE` `BYTES` is the only
+member of this class. Character strings are byte pointers to strings
+of ASCII characters. `PRIMTYPE` `STRING` is the only member of this
+class. Both of these classes consist of a length and a PDP-10 byte
+pointer. In the case of character strings, the byte-size field in the
+byte pointer is always seven bits per byte (hence five bytes per
+word). Example:
+
+ ---------------------------------
+ | STRING | length |
+ | - - - - - - - - - - - - - - - |
+ | byte-pointer |
+ ---------------------------------
+
+where `length` is the `LENGTH` of the `STRING` (in bytes) and
+`byte-pointer` points to a byte just before the beginning of the
+string (an `ILDB` instruction is needed to get the first byte). A
+newly-created `STRING` always has `*010700*` in the left half of
+`byte-pointer`. Unless the string was created by `SPNAME`,
+`byte-pointer` points to a uvector, where the elements (characters) of
+the `STRING` are stored, packed together five to a word.
+
+"Frame"
+
+This class gives the user program a handle on its control and
+variable-reference structures. All external `TYPE`s in this class are
+of `PRIMTYPE` `FRAME`. Three numbers are needed to designate a frame:
+a unique 18-bit identifying number, a pointer to the frame's storage
+on a control stack, and a pointer to the `PROCESS` associated with the
+frame. Example:
+
+ ---------------------------------
+ | FRAME |PROCESS-pointer|
+ | - - - - - - - - - - - - - - - |
+ | unique-id | frame-pointer |
+ ---------------------------------
+
+where `PROCESS-pointer` points to the dope words of a `PROCESS`
+vector, and `unique-id` is used for validating (testing `LEGAL?`) the
+`frame-pointer`, which points to a frame for some Subroutine call on
+the control stack.
+
+"Tuple"
+
+A tuple pointer is a counting pointer to a vector on the control
+stack. It may be a pointer to the arguments to a Subroutine or a
+pointer generated by the `"TUPLE"` declaration in a `FUNCTION`. Like
+objects in the previous class, these objects contain a unique
+identifying number used for validation. `PRIMTYPE` `TUPLE` is the only
+member of this class. Example:
+
+ ---------------------------------
+ | TUPLE | unique-id |
+ | - - - - - - - - - - - - - - - |
+ | -2*length | pointer |
+ ---------------------------------
+
+Other Storage Classes
+
+The rest of the storage classes include strictly internal `TYPE`s and
+pointers to special kinds of lists and vectors like locatives, `ATOM`s
+and `ASOC`s. A pair for any `LOCATIVE` except a `LOCD` looks like a
+pair for the corresponding structure, except of course that the `TYPE`
+is different. A `LOCD` pair looks like a tuple pair and needs a word
+and a half for its value; the `unique-id` refers to a binding on the
+control stack or to the "global stack" if zero. Thus `LOCD`s are in a
+sense "stack objects" and are more restricted than other locatives.
+
+An `OFFSET` is stored with the `INDEX` in the right half of the value
+word and the Pattern in the left half. Since the Pattern can be either
+an `ATOM` or a `FORM`, the left half actually points to a pair, which
+points to the actual Pattern. The Patttern `ANY` is recognized as a
+special case: the left-half pointer is zero, and no pair is used.
+Thus, if you're making the production version of your program and want
+to save some storage, can do something like
+`<SETG FOO <PUT-DECL ,FOO ANY>>` for all `OFFSET`s.
+
+Basic Data Structures
+---------------------
+
+Lists
+
+List elements are pairs linked together by the right halves of their
+first words. The list is terminated by a zero in the right half of the
+last pair. For example the `LIST` `(1 2 3)` would look like this:
+
+ -------------
+ | LIST | 0 |
+ | - - - - - | ----------- ----------- -----------
+ | 0 | ------>| FIX | ------->| FIX | ------->| FIX | 0 |
+ ------------- | - - - - | | - - - - | | - - - - |
+ | 1 | | 2 | | 3 |
+ ----------- ----------- -----------
+
+The use of pointers to tie together elements explains why new elements
+can be added easily to a list, how sharing and circularity work, etc.
+The links go in only one direction through the list, which is why a
+list cannot be `BACK`ed or `TOP`ped: there's no way to find the
+`REST`ed elements.
+
+Since some Muddle values require a word and a half for the value in
+the pair, they do not fit directly into list elements. This problem is
+solved by having "deferred pointers". Instead of putting the datum
+directly into the list element, a pointer to another pair is used as
+the value with the special internal `TYPE` `DEFER`, and the real datum
+is put in the deferred pair. For example the `LIST` `(1 "hello" 3)`
+would look like this:
+
+ -------------
+ | LIST | 0 |
+ | - - - - - | ----------- ----------- -----------
+ | 0 | ------>| FIX | ------->|DEFER| ------->| FIX | 0 |
+ ------------- | - - - - | | - - - - | | - - - - |
+ | 1 | | ----- | 3 |
+ ----------- ----------- | -----------
+ |
+ ----------- |
+ |STRING| 5|<-
+ | - - - - |
+ |byte-pntr|
+ -----------
+
+Vectors
+
+A vector is a block of contiguous words. More than one pair can point
+to the block, possibly at different places in the block; this is how
+sharing occurs among vectors. Pointers that are different arise from
+`REST` or `GROW`/`BACK` operations. The block is followed by two "dope
+words", at addresses just larger than the largest address in the
+block. Dope words have the following format:
+
+ / /
+ | |
+ | |
+ ---------------------------------
+ | type | grow |
+ | - - - - - - - - - - - - - - - |
+ | length | gc |
+ ---------------------------------
+
+The various fields have the following meanings:
+
+`type` -- The fourth bit from the left (the "vector bit", `40000`
+octal) is always one, to distinguish these vector dope words from a
+`TYPE`/value pair.
+
+If the high-order bit is zero, then the vector is a `UVECTOR`, and the
+remaining bits specify the uniform `TYPE` of the elements. `CHUTYPE`
+just puts a new `TYPE` code in this field. Each element is limited to
+a one-word value: clearly `PRIMTYPE` `STRING`s and `BYTES`es and stack
+objects can't go in uniform vectors.
+
+If the high-order bit is one and the `TYPE` bits are zero, then this
+is a regular `VECTOR`.
+
+If the high-order bit is one and the `TYPE` bits are not all zero,
+then this is either an `ATOM`, a `PROCESS`, an `ASOC`, or a
+`TEMPLATE`. The special internal format of these objects will be
+described a little later in this appendix.
+
+`length` -- The high-order bit is the mark bit, used by the garbage
+collector. The rest of this field specifies the number of words in the
+block, including the dope words. This differs from the length given in
+pairs pointing to this vector, since such pairs may be the result of
+`REST` operations.
+
+`grow` -- This is actually two nine-bit fields, specifying either
+growth or shrinkage at both the high and low ends of the vector. The
+fields are usually set only when a stack must be grown or shrunk.
+
+`gc` -- This is used by the garbage collector to specify where this
+vector is moving during compaction.
+
+Examples (numbers in octal): the `VECTOR` `[1 "bye" 3]` looks like:
+
+ ---------------
+ | VECTOR | 0 |
+ | - - - - - - | -----------------
+ | -6 | ----------->| FIX | |
+ --------------- | - - - - - - - |
+ | 1 |
+ -----------------
+ | STRING | 3 |
+ | - - - - - - - |
+ | byte pointer |
+ -----------------
+ | FIX | |
+ | - - - - - - - |
+ | 3 |
+ -----------------
+ | 440000 | 0 |
+ | - - - - - - - |
+ | 10 | |
+ -----------------
+
+The `UVECTOR` `![-1 7 -4!]` looks like:
+
+ ---------------
+ | UVECTOR | 0 |
+ | - - - - - - | -----------------
+ | -3 | ----------->| -1 |
+ --------------- -----------------
+ | 7 |
+ -----------------
+ | -4 |
+ -----------------
+ | 40000+FIX | 0 |
+ | - - - - - - - |
+ | 5 | |
+ -----------------
+
+Atoms
+
+Internally, atoms are special vector-like objects. An atom contains a
+value cell (the first two words of the block, filled in whenever the
+global or local value of the `ATOM` is referenced and is not already
+there), an `OBLIST` pointer, and a print name (`PNAME`), in the
+following format:
+
+ ---------------------------------
+ | type | bindid |
+ ---------------------------------
+ | pointer-to-value |
+ ---------------------------------
+ | pointer-to-oblist |
+ ---------------------------------
+ | print-name |
+ / /
+ / /
+ |(ASCII with NUL padding on end)|
+ ---------------------------------
+ | ATOM | valid-type |
+ | - - - - - - - - - - - - - - - |
+ | length | gc |
+ ---------------------------------
+
+If the type field corresponds to `TYPE` `UNBOUND`, then the `ATOM` is
+locally and globally unbound. (This is different from a pair, where
+the same `TYPE` `UNBOUND` is used to mean unassigned.) If it
+corresponds to `TYPE` `LOCI` (an internal `TYPE`), then the value cell
+points either to the global stack, if `bindid` is zero, or to a local
+control stack, if `bindid` is non-zero. The `bindid` field is used to
+verify whether the local value pointed to by the value cell is valid
+in the current environment. The `pointer-to-OBLIST` is either a
+counting pointer to an oblist (uvector). a positive offset into the
+"transfer vector" (for pure `ATOM`s), or zero, meaning that this
+`ATOM` is not on an `OBLIST`. The `valid-type` field tells whether or
+not the `ATOM` represents a `TYPE` and if so the code for that `TYPE`:
+`grow` values are never needed for atoms.
+
+Associations
+
+Associations are also special vector-like objects. The first six words
+of the block contain `TYPE`/value pairs for the `ITEM`, `INDICATOR`
+and `AVALUE` of the `ASOC`. The next word contains forward and
+backward pointers in the chain for that bucket of the association hash
+table. The last word contains forward and backward pointers in the
+chain of all the associations.
+
+ ---------------------------------
+ | ITEM |
+ | - - - - - - - - - - - - - - - |
+ | pair |
+ ---------------------------------
+ | INDICATOR |
+ | - - - - - - - - - - - - - - - |
+ | pair |
+ ---------------------------------
+ | AVALUE |
+ | - - - - - - - - - - - - - - - |
+ | pair |
+ ---------------------------------
+ | bucket-chain-pointers |
+ ---------------------------------
+ | association-chain-pointers |
+ ---------------------------------
+ | ASOC | 0 |
+ | - - - - - - - - - - - - - - - |
+ | 12 octal | gc |
+ ---------------------------------
+
+`PROCESS`es
+
+A `PROCESS` vector looks exactly like a vector of `TYPE`/value pairs.
+It is different only in that the garbage collector treats it
+differently from a normal vector, and it contains extremely volatile
+information when the `PROCESS` is `RUNNING`.
+
+Templates
+
+In a template, the number in the type field (left half or first dope
+word) identifies to which "storage allocation class" this `TEMPLATE`
+belongs, and it is used to find PDP-10 instructions in internal tables
+(frozen uvectors) for performing `LENGTH`, `NTH`, and `PUT` operations
+on any object of this `TYPE`. The programs to build these tables are
+not part of the interpreter, but the interpreter does know how to use
+them properly. The compiler can put these instructions directly in
+compiled programs if a `TEMPLATE` is never `REST`ed; otherwise it must
+let the interpreter discover the appropriate instruction. The value
+word of a template pair contains, not a counting pointer, but the
+number of elements that have been `REST`ed off in the left half and a
+pointer to the first dope word in the right half.
+
+The Control Stack
+-----------------
+
+Accumulators with symbolic names `AB`, `TB`, and `TP` are all pointers
+into the `RUNNING` `PROCESS`'s control stack. `AB` ("argument base")
+is a pointer to the arguments to the Subroutine now being run. It is
+set up by the Subroutine-call mediator, and its old value is always
+restored after a mediated Subroutine call returns. `TB` ("temporaries
+base") points to the frame for the running Subroutine and also serves
+as a stack base pointer. The `TB` pointer is really all that is
+necessary to return from a Subroutine -- given a value to return, for
+example by `ERRET` -- since the frame specifies the entire state of
+the calling routine. `TP` ("temporaries pointer") is the actual stack
+pointer and always points to the current top of the control stack.
+
+While we're on the subject of accumulators, we might as well be
+complete. Each accumulator contains the value word of a pair, the
+corresponding `TYPE` words residing in the `RUNNING` `PROCESS` vector.
+When a `PROCESS` is not `RUNNING` (or when the garbage collector is
+running), the accumulator contents are stored in the vector, so that
+the Objects they point to look like elements of the `PROCESS` and thus
+are not garbage-collectible.
+
+Accumulators `A`, `B`, `C`, `D`, `E` and `O` are used almost entirely
+as scratch accumulators, and they are not saved or restored across
+Subroutine calls. Of course the interrupt machinery always saves these
+and all other accumulators. `A` and `B` are used to return a pair as
+the value of a Subroutine call. Other than that special feature, they
+are just like the other scratch accumulators.
+
+`M` and `R` are used in running `RSUBR`s. `M` is always set up to
+point to the start of the `RSUBR`'s code, which is actually just a
+uniform vector of instructions. All jumps and other references to the
+code use `M` as an index register. This makes the code
+location-insensitive, which is necessary because the code uvector will
+move around. `R` is set up to point to the vector of objects needed by
+the `RSUBR`. This accumulator is necessary because objects in
+garbage-collected space can move around, but the pointers to them in
+the reference vector are always at the same place relative to its
+beginning.
+
+`FRM` is the internal frame pointer, used in compiled code to keep
+track of pending Subroutine calls when the control stack is heavily
+used. `P` is the internal-stack pointer, used primarily for internal
+calls in the interpreter.
+
+One of the nicest features of the Muddle environment is the uniformity
+of the calling and returning sequence. All Subroutines -- both
+built-in F/SUBRs and compiled `RSUBR(-ENTRY)`s -- are called in
+exactly the same way and return the same way. Arguments are always
+passed on the control stack and results always end up in the same
+accumulators. For efficiency reasons, a lot of internal calls within
+the interpreter circumvent the calling sequence. However, all calls
+made by the interpreter when running user programs go through the
+standard calling sequence.
+
+A Subroutine call is initiated by one of three UUOs (PDP-10
+instructions executed by software rather than hardware). `MCALL`
+("Muddle call") is used when the number of arguments is known at
+assemble or compile time, and this number is less than 16. `QCALL`
+("quick call") may be used if, in addition, an `RSUBR(-ENTRY)` is
+being called that can be called "quickly" by virtue of its having
+special information in its reference vector. `ACALL` ("accumulator
+call") is used otherwise. The general method of calling a Subroutine
+is to `PUSH` (a PDP-10 instruction) pairs representing the arguments
+onto the control stack via `TP` and then either (1) `MCALL` or `QCALL`
+or (2) put the number of arguments into an accumulator and `ACALL`.
+Upon return the object returned by the Subroutine will be in
+accumulators `A` and `B`, and the arguments will have been `POP`ped
+off the control stack.
+
+The call mediator stores the contents of `P` and `TP` and the address
+of the calling instruction in the current frame (pointed to by `TB`).
+It also stores Muddle's "binding pointer" to the topmost binding in
+the control stack. (The bindings are linked together through the
+control stack so that searching through them is more efficient than
+looking at every object on the stack.) This frame now specifies the
+entire state of the caller when the call occurred. The mediator then
+builds a new frame on the control stack and stores a pointer back to
+the caller's frame (the current contents of `TB`), a pointer to the
+Subroutine being called, and the new contents of `AB`, which is a
+counting pointer to the arguments and is computed from the information
+in the `MCALL` or `QCALL` instruction or the `ACALL` accumulator. `TB`
+is then set up to point to the new frame, and its left half is
+incremented by one, making a new `unique-id`. The mediator then
+transfers control to the Subroutine.
+
+A control stack frame has seven words as shown:
+
+ ---------------------------------
+ | ENTRY | called-addr |
+ ---------------------------------
+ | unique-id | prev frame |
+ ---------------------------------
+ | argument pointer |
+ ---------------------------------
+ | saved binding pointer |
+ ---------------------------------
+ | saved P |
+ ---------------------------------
+ | saved TP |
+ ---------------------------------
+ | saved calling address |
+ ---------------------------------
+
+The first three words are set up during the call to the Subroutine.
+The rest are filled in when this routine calls another Subroutine. The
+left half of `TB` is incremented every time a Subroutine call occurs
+and is used as the `unique-id` for the frame, stored in frame and
+tuple pairs as mentioned before. Obviously this `id` is not strictly
+unique, since each 256K calls it wraps around to zero. The right half
+of `TB` is always left pointing one word past the
+saved-calling-address word in the frame. `TP` is also left pointing at
+that word, since that is the top of the control stack at Subroutine
+entry. The arguments to the called Subroutine are below the frame on
+the control stack (at lower storage addresses), and the temporaries
+for the called Subroutine are above the frame (at higher storage
+addresses). These arguments and temporaries are just pairs stored on
+the control stack while needed: they are all that remain of
+`UNSPECIAL` values in compiled programs.
+
+The following figure shows what the control stack might look like
+after several Subroutine calls.
+
+ / /
+ | |
+ -----------------
+ | |
+ | args for S1 |
+ | |
+ -----------------
+ | frame for S1 |
+ ----------------- <--
+ | | |
+ | temps for S1 | |
+ | | |
+ ----------------- |
+ | | |
+ | args for S2 | |
+ | | |
+ ----------------- |
+ | frame for S2 | ---
+ ----------------- <------
+ | | |
+ | temps for S2 | |
+ | | |
+ ----------------- |
+ | args for S3 | |
+ ----------------- |
+ | frame for S3 | -------
+ -----------------
+ | |
+ | temps for S3 |
+ | |
+ | |
+ -----------------
+ (top)
+
+The above figure shows the frames all linked together through the
+control stack (the "execution path"), so that it is easy to return to
+the caller of a given Subroutine (`ERRET` or `RETRY`).
+
+Subroutine exit is accomplished simply by the call mediator, which
+loads the right half of `TB` from the previous frame pointer, restores
+the "binding pointer", `P`, and `TP`, and transfers control back to
+the instruction following the saved calling address.
+
+Variable Bindings
+-----------------
+
+All local `ATOM` values are kept on the control stack of the `PROCESS`
+to which they are local. As described before, the atom contains a word
+that points to the value on the control stack. The pointer is actually
+to a six-word "binding block" on the control stack. Binding blocks
+have the following format:
+
+ ---------------------------------
+ | BIND or UBIND | prev |
+ ---------------------------------
+ | pointer to ATOM |
+ ---------------------------------
+ | value |
+ | - - - - - - - - - - - - - - - |
+ | pair |
+ ---------------------------------
+ | decl | unique-id |
+ ---------------------------------
+ | previous-binding |
+ ---------------------------------
+
+where:
+
+- `BIND` means this is a binding for a `SPECIAL` `ATOM` (the only
+ kind used by compiled programs), and `UBIND` means this is a
+ binding for an `UNSPECIAL` `ATOM` -- for `SPECIAL` checking by the
+ interpreter;
+- `prev` points to the closest previous binding block for any `ATOM`
+ (the "access path" -- `UNWIND` objects are also linked in this
+ chain);
+- `decl` points to a `DECL` associated with this value, for
+ `SET(LOC)` to check;
+- `unique-id` is used for validation of this block; and
+- `previous-binding` points to the closest previous binding for this
+ `ATOM` (used in unbinding).
+
+Bindings are generated by an internal subroutine called `SPECBIND`
+(name comes from `SPECIAL`). The caller to `SPECBIND` `PUSH`es
+consecutive six-word blocks onto the control stack via `TP` before
+calling `SPECBIND`. The first word of each block contains the `TYPE`
+code for `ATOM` in its left half and all ones in its right half.
+`SPECBIND` uses this bit pattern to identify the binding blocks.
+`SPECBIND`'s caller also fills in the next three words and leaves the
+last two words empty. `SPECBIND` fills in the rest and leaves the
+"binding pointer" pointing at the topmost binding on the control
+stack. `SPECBIND` also stores a pointer to the current binding in the
+value cell of the atom.
+
+Unbinding is accomplished during Subroutine return. When the previous
+frame is being restored, the call mediator checks to see if the saved
+"binding pointer" and the current one are different; if they are,
+`SPECSTORE` is called. `SPECSTORE` runs through the binding blocks,
+restoring old value pointers in atoms until the "binding pointer" is
+equal to the one saved in the frame.
+
+Obviously variable binding is more complicated than this, because
+`ATOM`s can have both local and global values and even different local
+values in different `PROCESS`es. The solution to all of these
+additional problems lies in the `bindid` field of the atom. Each
+`PROCESS` vector also contains a current `bindid`. Whenever an ATOM's
+local value is desired, the `RUNNING` `PROCESS`'s `bindid` is checked
+against that of the atom: if they are the same, the atom points to the
+current value; if not, the current `PROCESS`'s control stack must be
+searched to find a binding block for this `ATOM`. This binding scheme
+might be called "shallow binding". The searching is facilitated by
+having all binding blocks linked together. Accessing global variables
+is accomplished in a similar way, using a `VECTOR` that is referred to
+as the "global stack". The global stack has only an `ATOM` and a value
+slot for each variable, since global values never get rebound.
+
+`EVAL` with respect to a different environment causes some additional
+problems. Whenever this kind of `EVAL` is done, a brand new `bindid`
+is generated, forcing all current local value cells of atoms to appear
+invalid. Local values must now be obtained by searching the control
+stack, which is inefficient compared to just pulling them out of the
+atoms. (The greatest inefficiency occurs when an `ATOM`'s `LVAL` is
+never accessed twice in a row in the same environment.) A special
+block is built on the control stack and linked into the binding-block
+chain. This block is called a "skip block" or "environment splice",
+and it diverts the "access path" to the new environment, causing
+searches to become relative to this new environment.
projects / mudman.git / blobdiff