[BACK]Return to freem.texi CVS log [TXT] [DIR] Up to [Coherent Logic Development] / freem / doc

Diff for /freem/doc/freem.texi between versions 1.28 and 1.34

version 1.28, 2025/04/18 19:43:18 version 1.34, 2025/04/28 14:52:54
Line 4 Line 4
 @settitle The FreeM Manual  @settitle The FreeM Manual
   
 @copying  @copying
 This manual is for FreeM, (version 0.64.0-rc0), which is a free and open-source implementation of the M programming language.  This manual is for FreeM, (version 0.64.0-rc1), which is a free and open-source implementation of the M programming language.
   
   
 Copyright @copyright{} 2014-2025 Coherent Logic Development LLC  Copyright @copyright{} 2014-2025 Coherent Logic Development LLC
Line 18  Permission is granted to copy, distribut Line 18  Permission is granted to copy, distribut
   
 @title The FreeM Manual  @title The FreeM Manual
 @subtitle @sc{The Official Manual of FreeM}  @subtitle @sc{The Official Manual of FreeM}
 @subtitle Version 0.64.0-rc0  @subtitle Version 0.64.0-rc1
 @c@vskip 10pt  @c@vskip 10pt
 @c@center @image{freem-logo-sm,,,,.png}  @c@center @image{freem-logo-sm,,,,.png}
 @author Serena Willis  @author Serena Willis
Line 73  This is the official manual for the Free Line 73  This is the official manual for the Free
 * Global Aliasing::                     Defining alternate names for globals.  * Global Aliasing::                     Defining alternate names for globals.
 * Global Mappings::                     Mapping global names to non-default namespaces.  * Global Mappings::                     Mapping global names to non-default namespaces.
   
 * Transaction Processing::              Transactions in FreeM.  
 * Asynchronous Event Handling::         Handling asynchronous events in FreeM.  * Asynchronous Event Handling::         Handling asynchronous events in FreeM.
 * Global Triggers::                     Responding to global accesses in M code.  * Global Triggers::                     Responding to global accesses in M code.
 * Synchronous Event Handling::          Synchronous events in FreeM.  * Synchronous Event Handling::          Synchronous events in FreeM.
Line 371  Attempting to start a FreeM interpreter Line 370  Attempting to start a FreeM interpreter
 The FreeM direct-mode environment is the mode entered when FreeM is invoked without the use of @option{-r @emph{<entryref>}} or @option{--routine=@emph{<entryref>}}:  The FreeM direct-mode environment is the mode entered when FreeM is invoked without the use of @option{-r @emph{<entryref>}} or @option{--routine=@emph{<entryref>}}:
   
 @example  @example
 Coherent Logic Development FreeM version 0.64.0-rc0 (x86_64-pc-linux-gnu)  Coherent Logic Development FreeM version 0.64.0-rc1 (x86_64-pc-linux-gnu)
 Copyright (C) 2014, 2020, 2021 Coherent Logic Development LLC  Copyright (C) 2014, 2020, 2021 Coherent Logic Development LLC
   
   
Line 2515  In the above @emph{inclusive} form, @cod Line 2514  In the above @emph{inclusive} form, @cod
 @cartouche  @cartouche
 @quotation  @quotation
 @emph{Note}  @emph{Note}
 The below @emph{argumentless} and @emph{exclusive} forms of @code{KSUBSCRIPTS} are not implemented in FreeM, as of version 0.64.0-rc0, but are planned for a future release.  The below @emph{argumentless} and @emph{exclusive} forms of @code{KSUBSCRIPTS} are not implemented in FreeM, as of version 0.64.0-rc1, but are planned for a future release.
 @end quotation  @end quotation
 @end cartouche  @end cartouche
   
Line 2550  In the above @emph{inclusive} form, @cod Line 2549  In the above @emph{inclusive} form, @cod
 @cartouche  @cartouche
 @quotation  @quotation
 @emph{Note}  @emph{Note}
 The below @emph{argumentless} and @emph{exclusive} forms of @code{KVALUE} are not implemented in FreeM, as of version 0.64.0-rc0, but are planned for a future release.  The below @emph{argumentless} and @emph{exclusive} forms of @code{KVALUE} are not implemented in FreeM, as of version 0.64.0-rc1, but are planned for a future release.
 @end quotation  @end quotation
 @end cartouche  @end cartouche
   
Line 4405  An @code{INTEGER} is an interpretation o Line 4404  An @code{INTEGER} is an interpretation o
 @cindex data types, REAL  @cindex data types, REAL
 @cindex types, REAL  @cindex types, REAL
   
   A @code{REAL} is a numeric interpretation of data including a fractional part.
   
 @node STRING  @node STRING
 @section STRING  @section STRING
 @cindex data types, STRING  @cindex data types, STRING
 @cindex types, STRING  @cindex types, STRING
   
   A @code{STRING} is any data in FreeM.
   
 @node Custom Types (Classes)  @node Custom Types (Classes)
 @section Custom Types (Classes)  @section Custom Types (Classes)
 @cindex data types, custom  @cindex data types, custom
Line 4424  See @ref{Classes}. Line 4427  See @ref{Classes}.
 @cindex variables, global  @cindex variables, global
 @cindex data  @cindex data
   
   @menu
   * Globals Overview::            Basics of FreeM persistent storage.
   * Creating Globals::            How to create globals.
   * Removing Globals::            How to remove globals.
   * Global Storage::              How globals are stored.
   @end menu
   
   @node Globals Overview
   @section Globals Overview
   
   FreeM supports typical M globals, which are often described as persistent, hierachical sparse arrays. Globals make it relatively simple to include persistent data in an application without requiring the developer to use an external database management system, and offer syntax and semantics so similar to M local variables and structured system variables that moving from one to the other is seamless.
   
   Each global comprises three elements:
   
   @itemize @bullet
   @item
   An alphabetic name beginning with a caret (@code{^}) or a caret and a percent sign (@code{^%})
   @item
   Optionally, one or more comma-delimited subscripts, enclosed in parentheses
   @item
   A value of up to 255 characters in length
   @end itemize
   
   The percent sign will force the named global into the @code{SYSTEM} namespace of the current FreeM environment.
   
   @node Creating Globals
   @section Creating Globals
   @cindex globals, creating
   
   To create a global, you can use the @code{SET} command:
   
   @example
   SET ^MYGLOBAL("foo","bar")="this is the data value"
   @end example
   
   @node Removing Globals
   @section Removing Globals
   @cindex globals, removing
   
   To remove an entire global, you can use the @code{KILL} command with the unsubscripted name of the global:
   
   @example
   KILL ^MYGLOBAL
   @end example
   
   If you only want to remove part of a global, i.e., beginning at a certain subscript level, use the @code{KILL} command with a subscripted name:
   
   @example
   KILL ^MYGLOBAL("foo")
   @end example
   
   This will remove only the @code{"foo"} subscript and all of its children.
   
   If you only want to remove the data value at a specific subscript level, leaving the subscript itself intact, use @code{KVALUE}:
   
   @example
   KVALUE ^MYGLOBAL("foo")
   @end example
   
   @node Global Storage
   @section Global Storage
   @cindex globals, storage
   
   FreeM globals are stored in @code{$PREFIX/var/freem/@emph{<environment-name>}/@emph{<namespace-name>}/globals} in a binary format.
   
   Global files have a header of the following format:
   
   @verbatim
   typedef struct global_header {
       
       char magic[5]; /* FRMGL */
       int format_version;
       char host_triplet[40];
       char host_id[256];
       
       unsigned long block_size;
       unsigned long last_transaction_id;
   
       long created;
       long last_backup;
       
   } global_header;
   @end verbatim
   
 @node Concurrency Control  @node Concurrency Control
 @chapter Concurrency Control  @chapter Concurrency Control
 @cindex concurrency control  @cindex concurrency control
 @cindex locking  @cindex locking
 @cindex transaction processing  @cindex transaction processing
   
   @menu
   * Concurrency Control Overview::                Basics of concurrency control.
   * Advisory Locks::                              Coordinating access voluntarily.
   * Transaction Processing::                      Ensuring logical consistency.
   @end menu
   
   @node Concurrency Control Overview
   @section Concurrency Control Overview
   
   Multitasking, multi-user FreeM applications must concern themselves with conscientious management of concurrent access to globals in order to maintain logical consistency and prevent concurrent reads and writes from conflicting with each other.
   
   In FreeM, there are two mechanisms provided for managing concurrent global access: @emph{advisory locks}, and @emph{transaction processing}.
   
   Advisory locks allow applications to voluntarily coordinate concurrent access to globals with the @code{LOCK} command, and require each application to check the @code{LOCK} status prior to accessing a global.
   
   Transaction processing allows applications to delineate sets of global operations (sets, kills, etc.) as being part of a transaction, in which no operations are performed against the globals contained within the transaction until the transaction is committed. In addition, processes other than the one running the transaction will be forced to wait to access globals for either the duration of the commit phase (@emph{batch mode}), or for the entire duration of the transaction (@emph{serial mode}).
   
   @node Advisory Locks
   @section Advisory Locks
   
   @node Transaction Processing
   @section Transaction Processing
   @cindex transaction processing
   
   FreeM implements a significant subset of the transaction processing features from @emph{ANSI X11.1-1995}. This allows a series of global operations to be conducted all at once, either in batch mode (where concurrency is not disturbed), or in serial mode (where writes are guaranteed to be atomic, consistent, isolated, and durable).
   
   @subsection Theory of Operation
   
   FreeM uses a pessimistic concurrency control mechanism for @code{SERIAL} transactions, meaning that any @code{TSTART} command that includes the @code{SERIAL} transaction parameter will cause the process to acquire the transaction processing mutex, which prevents any process but the one holding the mutex from performing any data access (read or write) until either @code{TCOMMIT} or @code{TROLLBACK} is called, either committing or rolling back the transaction, respectively.
   
   Any transaction in between its @code{TSTART} and @code{TCOMMIT}/@code{TROLLBACK} is said to be @emph{in-flight}. During the in-flight stage, pending global operations are held only in memory and after-image journals.
   
   FreeM maintains a list of all globals affected during a transaction in-flight. When a @code{TCOMMIT} is reached, FreeM will generate a @emph{checkpoint} of each global data file to be changed by the transaction. These checkpoints allow all FreeM globals to be restored to their pre-transaction state if a @code{TCOMMIT} should fail part of the way through its operation. 
   
   Checkpoints can have one of two modes:
   
   @table @asis
   
   @item @code{CP_REMOVE}
   Used for globals that did not exist prior to the beginning of this transaction. Simply marks the entire global data file for deletion in case of @code{TCOMMIT} failure.
   
   @item @code{CP_RESTORE}
   Used for globals that @emph{did} exist prior to the beginning of this transaction. In this case, the entire global data file is copied to a new file with a @code{.chk} extension. In cases of @code{TCOMMIT} failure, @code{CP_RESTORE} checkpoint files will be restored over the partially-modified live data file.
   
   @end table
   
   The below example shows a few global operations and checkpoints for a transaction in-flight using the @code{trantab} direct-mode command:
   
   @verbatim
   TL1:DEFAULT.USER> trantab
    $TLEVEL 1*
     Operations for Transaction ID: 6ea14aad-b8f1-47f9-9f52-4f513f892bc0 [RESTARTABLE SERIAL]
   
      OP. NO.   ACTION         KEY/DATA
      -------   ------         --------
      1         SET            ^FOO=3
      2         KILL           ^FOO
      3         SET            ^snw=10
      4         SET            ^BRANDNEW=6
   
     Global checkpoints:
   
      GLOBAL                        MODE                FILES
      ------                        ----                -----
      ^BRANDNEW                     CP_REMOVE           IN:   /usr/local/var/freem/USER/globals/^BRANDNEW
      ^snw                          CP_RESTORE          IN:   /usr/local/var/freem/USER/globals/^snw
                                                        OUT:  /usr/local/var/freem/USER/globals/^snw.23390.1.chk
      ^FOO                          CP_RESTORE          IN:   /usr/local/var/freem/USER/globals/^FOO
                                                        OUT:  /usr/local/var/freem/USER/globals/^FOO.23390.1.chk
   @end verbatim
   
   In the above example, @code{IN} files are the live data file that will be overwritten or removed, and @code{OUT} files are the checkpoints themselves. Note that @code{OUT} files are only used for @code{CP_RESTORE} checkpoints.
   
   @subsection Using Transaction Processing
   
   To use transactions in FreeM, you need to be familiar with three commands:
   
   @itemize @bullet
   @item
   @code{TSTART}
   @item
   @code{TCOMMIT}
   @item
   @code{TROLLBACK}
   @end itemize
   
   With transaction processing, global variable operations occurring between @code{TSTART} and @code{TCOMMIT} commands will be contained within the transaction.
   
   The atomicity, consistency, isolation, and durability facets of FreeM transaction hinge on the transaction mode.
   
   @subsubsection BATCH Transactions
   @code{BATCH} transactions offer higher performance, and allow other applications aside from the one doing the transaction to continue normal operations until the transaction is committed with @code{TCOMMIT}. In batch mode, other processes are only locked out of normal operation during the commit phase of the transaction.
   
   The effect of this is that the operations within the batch transaction will not be interleaved with global writes from other applications, but the entire lifetime of the transaction is not guaranteed to be serialized with respect to the transaction processing activities of other running applications in the environment.
   
   @subsubsection SERIAL Transactions
   @code{SERIAL} transactions offer full ACID compliance at the expense of multiprocessing performance. In serial mode, a @code{TSTART} blocks all activity from all other FreeM processes in the environment, and this blocking effect is not released until the transaction is committed with @code{TCOMMIT} or rolled back with @code{TROLLBACK} (or due to abnormal conditions in the environment that preclude the successful completion of the transaction).
   
 @node Local Variables  @node Local Variables
 @chapter Local Variables  @chapter Local Variables
 @cindex variables, local  @cindex variables, local
Line 4482  See @ref{Classes}. Line 4667  See @ref{Classes}.
 @cindex programming, object-oriented  @cindex programming, object-oriented
   
 @menu  @menu
 * Classes::             The basis of object-oriented programming.  * Classes::                         The basis of object-oriented programming.
   * Inheritance::                     Basing one class upon another.
   * Methods::                         Attaching code to a class.
   * Public and Private Variables::    Managing class member access.
   * Instantiating Objects::           Creating instances of classes.
   * Determining Object Class::        Getting object information at runtime.
 @end menu  @end menu
   
 @node Classes  @node Classes
 @section Classes  @section Classes
   
 @menu  @menu
 * Inheritance::         Basing one class upon another.  * Class Overview::                  Class basics.
 * Methods::             Attaching code to a class.  * Constructors::                    Managing object creation.
 * Public Variables::    Variables visible outside of a class.  * Destructors::                     Cleaning up.
 * Private Variables::   Variables only visible within a class.  * Runtime Polymorphism::            Selecting methods at runtime.
 @end menu  @end menu
   
   @node Class Overview
   @subsection Class Overview
   
   A @emph{class} is the primary organizing concept of FreeM support for object-oriented programming, and in FreeM, is simply an M routine with a few special properties:
   
   @example
   MYCLASS(THIS,INIT):OBJECT ; Constructor for MYCLASS, inherits OBJECT
     ; two private variables
     S THIS("NUMERATOR"):PRIVATE=$P(INIT,"/",1)
     S THIS("DENOMINATOR"):PRIVATE=$P(INIT,"/",2)
     Q
     ;
   DESTROY(THIS) ; This is the destructor
     Q
   @end example
   
   The above example demonstrates general class syntax.
   
   @node Constructors
   @subsection Constructors
   
   A @emph{constructor} is an M entry point that is called when a new instance of a class is created.
   
   A constructor must be the first entry point in a class routine, its tag must match the class/routine name, and it must take two arguments, @code{THIS} and @code{INIT}.
   
   @code{THIS} represents the instance of the object being accessed, and @code{INIT} represents an initializer that can be used to assign an initial value to the object when instantiating the class.
   
   A constructor looks like this:
   
   @example
   %FRACTION(THIS,INIT):OBJECT ;
      S THIS("NUMERATOR"):PRIVATE=$P(INIT,"/",1)
      S THIS("DENOMINATOR"):PRIVATE=$P(INIT,"/",2)
      Q
   @end example
   
   @emph{Syntax}
   @example
   @emph{<class-name>}(THIS,INIT)[:@emph{<superclass>}]
   @end example
   
   In the above example, @emph{<superclass>} represents the name of a class from which this class should inherit. In this case, the @code{FRACTION} class inherits from the @code{OBJECT} class. Note that this is not strictly necessary in this case, as all classes in FreeM automatically inherit from @code{OBJECT}.
   
   @node Destructors
   @subsection Destructors
   A @code{destructor} is called when you @code{KILL} an instance variable. Its tag must be @code{DESTROY}, and it must take one argument (@code{THIS}).
   
   The destructor should be used to clean up any resources used by class methods.
   
   A destructor looks like this:
   
   @example
   DESTROY(THIS) ;
     ; free any resources that should be freed at the end of the object's lifetime
     Q
   @end example
   
 @node Inheritance  @node Inheritance
 @subsection Inheritance  @section Inheritance
   
   Every class you create will automatically inherit the methods and functionality of the @code{OBJECT} class, supplied with FreeM.
   
   When attempting to call a method, FreeM will first search the class routine for a matching entry point, and then follow the inheritance chain upwards until a matching entry point is found. If the final class in the chain does not have a matching entry point, FreeM will try to find a matching entry point in the @code{OBJECT} class.
   
   Inheritance is achieved by specifying the name of the superclass in the constructor:
   
   @example
   CLASS(THIS,INIT):SUPERCLASS
   @end example
   
   @node Runtime Polymorphism
   @subsection Runtime Polymorphism
   
   You can achieve runtime polymorphism by subclassing, and defining methods in the subclass that match the names of existing methods in the superclass. Following FreeM inheritance rules, the overridden method in the subclass will be called, and the method in the superclass will not.
   
   Note that the overridden method in the subclass can take a different set or number of arguments than the @emph{formallist} of the superclass method would specify.
   
 @node Methods  @node Methods
 @subsection Methods  @section Methods
   Class methods are defined as tags with @emph{formallist}s in a class routine, and per the typical FreeM object pattern, must take at least one argument, being @code{THIS} (representing a reference to the object instance being accessed).
   
   The following class (@code{MYCLASS}) has a constructor, a destructor, and a method called @code{MYMETHOD}:
   
   @example
   %MYCLASS(THIS,INIT) ;
     Q THIS
   DESTROY(THIS) ;
     Q
   MYMETHOD(THIS) ;
     Q "VALUE"
   @end example
   
   The dot operator is used to invoke class methods:
   
   @example
   DEFAULT.USER> N MYOBJ=$#^%MYCLASS("")
   DEFAULT.USER> W MYOBJ.MYMETHOD()
   VALUE
   @end example
   
 @node Public Variables   @node Public and Private Variables 
 @subsection Public Variables  @section Public and Private Variables
   
   FreeM supports private fields with the @code{:PRIVATE} specifier in the @code{SET} command, enforcing classical object-oriented data encapsulation. The @code{:PUBLIC} specifier is provided for completeness, and is the default.
   
   The below constructor for a @code{FRACTION} class defines two private fields:
   
   @example
   %FRACTION(THIS,INIT):OBJECT ;
      S THIS("NUMERATOR"):PRIVATE=$P(INIT,"/",1)
      S THIS("DENOMINATOR"):PRIVATE=$P(INIT,"/",2)
      Q
   @end example   
   
   Either of the following commands will create a public field:
   
   @example
     S THIS("VARNAM")="Initial Value"
     S THIS("VARNAM"):PUBLIC="Initial Value"
   @end example
   
   Attempting to access private fields from outside of the class will raise error condition @code{ZOBJFLDACCV}. 
   
   @node Instantiating Objects
   @section Instantiating Objects
   
   To instantiate an object (i.e., create an object from a certain class), you will use the @code{NEW} command as follows:
   
   @example
   NEW MYSTR=$#^%STRING("myString")
   @end example
   
 @node Private Variables  This will create a local variable called MYSTR of type STRING, and initialize it with the value myString. 
 @subsection Private Variables  
   @node Determining Object Class
   @section Determining Object Class
   
   To determine the class of any FreeM local variable, you will use the @code{$$TYPE()} method:
   
   @example
   USER> W MYSTR.$$TYPE()
   ^%STRING
   @end example
   
   The @code{$$TYPE()} method is a member of the @code{OBJECT} class. 
   
 @node Libraries  @node Libraries
 @chapter Libraries  @chapter Libraries
Line 4613  To remove the above mapping, any of the Line 4937  To remove the above mapping, any of the
   KILL ^$SYSTEM("MAPPINGS","GLOBAL","^FOO")    KILL ^$SYSTEM("MAPPINGS","GLOBAL","^FOO")
 @end example  @end example
   
 @node Transaction Processing  
 @chapter Transaction Processing  
 @cindex transaction processing  
   
 FreeM implements a significant subset of the transaction processing features from @emph{ANSI X11.1-1995}. This allows a series of global operations to be conducted all at once, either in batch mode (where concurrency is not disturbed), or in serial mode (where writes are guaranteed to be atomic, consistent, isolated, and durable).  
   
 @section Theory of Operation  
   
 FreeM uses a pessimistic concurrency control mechanism for @code{SERIAL} transactions, meaning that any @code{TSTART} command that includes the @code{SERIAL} transaction parameter will cause the process to acquire the transaction processing mutex, which prevents any process but the one holding the mutex from performing any data access (read or write) until either @code{TCOMMIT} or @code{TROLLBACK} is called, either committing or rolling back the transaction, respectively.  
   
 Any transaction in between its @code{TSTART} and @code{TCOMMIT}/@code{TROLLBACK} is said to be @emph{in-flight}. During the in-flight stage, pending global operations are held only in memory and after-image journals.  
   
 FreeM maintains a list of all globals affected during a transaction in-flight. When a @code{TCOMMIT} is reached, FreeM will generate a @emph{checkpoint} of each global data file to be changed by the transaction. These checkpoints allow all FreeM globals to be restored to their pre-transaction state if a @code{TCOMMIT} should fail part of the way through its operation.   
   
 Checkpoints can have one of two modes:  
   
 @table @asis  
   
 @item @code{CP_REMOVE}  
 Used for globals that did not exist prior to the beginning of this transaction. Simply marks the entire global data file for deletion in case of @code{TCOMMIT} failure.  
   
 @item @code{CP_RESTORE}  
 Used for globals that @emph{did} exist prior to the beginning of this transaction. In this case, the entire global data file is copied to a new file with a @code{.chk} extension. In cases of @code{TCOMMIT} failure, @code{CP_RESTORE} checkpoint files will be restored over the partially-modified live data file.  
   
 @end table  
   
 The below example shows a few global operations and checkpoints for a transaction in-flight using the @code{trantab} direct-mode command:  
   
 @verbatim  
 TL1:DEFAULT.USER> trantab  
  $TLEVEL 1*  
   Operations for Transaction ID: 6ea14aad-b8f1-47f9-9f52-4f513f892bc0 [RESTARTABLE SERIAL]  
   
    OP. NO.   ACTION         KEY/DATA  
    -------   ------         --------  
    1         SET            ^FOO=3  
    2         KILL           ^FOO  
    3         SET            ^snw=10  
    4         SET            ^BRANDNEW=6  
   
   Global checkpoints:  
   
    GLOBAL                        MODE                FILES  
    ------                        ----                -----  
    ^BRANDNEW                     CP_REMOVE           IN:   /usr/local/var/freem/USER/globals/^BRANDNEW  
    ^snw                          CP_RESTORE          IN:   /usr/local/var/freem/USER/globals/^snw  
                                                      OUT:  /usr/local/var/freem/USER/globals/^snw.23390.1.chk  
    ^FOO                          CP_RESTORE          IN:   /usr/local/var/freem/USER/globals/^FOO  
                                                      OUT:  /usr/local/var/freem/USER/globals/^FOO.23390.1.chk  
 @end verbatim  
   
 In the above example, @code{IN} files are the live data file that will be overwritten or removed, and @code{OUT} files are the checkpoints themselves. Note that @code{OUT} files are only used for @code{CP_RESTORE} checkpoints.  
   
   
 @node Asynchronous Event Handling  @node Asynchronous Event Handling
Removed from v.1.28  
changed lines
  Added in v.1.34

FreeBSD-CVSweb <freebsd-cvsweb@FreeBSD.org>