Source code upload

eoe/cmd/react/relnotes/Makefile

@@ -0,0 +1,12 @@
+# Makefile for REACT release notes
+# $Revision: 1.2 $
+
+# Edit the CMM and AMM macros to contain the list of chapters and appendices
+# in this book.  Do not use abbreviations (i.e. ch[1-8].cmm), because the
+# Makefile dependencies will not work.
+
+CMM	= ch1.cmm ch2.cmm ch3.cmm
+AMM	=
+RELPROD	=react
+
+include $(ROOT)/usr/include/make/relnotesrules

eoe/cmd/react/relnotes/ch1.cmm

@@ -0,0 +1,119 @@
+.nr H1 0
+.H 1 "Introduction"
+This document describes the features of Release 4.0 of 
+the REACT/Pro software option for IRIX\(tm. The REACT/Pro option
+includes the Frame Scheduler software.
+.\"
+.\"	Here is some info about the s/w license agreement.
+.\"	It should go as near to the beginning of the introduction
+.\"	as you can comfortably put it.
+.\"
+.VL 7
+.LI "\f6Note:\f1"
+Packaged with your software is
+a separate sheet that contains the
+Software License Agreement.
+This software is provided to you
+solely under the terms and conditions of the 
+Software License Agreement.
+Please take a few moments to review the Agreement.
+.LE
+.P
+This document contains the following chapters:
+.\"
+.\"
+.\" Delete whichever of the following do not apply.
+.\"
+.\"
+.AL 1 +5
+.LI
+Introduction
+.LI
+Installation Information
+.LI
+New Release Information
+.LE
+.P
+.\" Add the following paragraph if your release notes include
+.\" man pages.
+.\" 
+.\" The release note includes man pages only if the <PRODUCT>.
+.\" does not have a user's or programmer's guide in which to
+.\" place them.
+.\"
+.\" Delete the following paragraph if you don't need it.
+.\"
+.\" Appendix A lists the <PRODUCT> man pages. 
+.bp
+.H 2 "Release Identification Information" 
+.P
+Following is the release identification information for REACT/Pro:
+.P
+.KS
+.TS
+lfPB l .
+\f3Software Option Product\f1	T{
+.fi
+REACT/Pro
+T}
+.sp 0.5
+\f3Version\f1	T{
+.fi
+4.0
+T}
+.sp 0.5
+\f3Product Code\f1	T{
+.fi
+SC4-REACT-4.0
+T}
+.sp 0.5
+\f3System Software Requirements\f1	T{
+.fi
+IRIX 6.5.2 or later
+T}
+.sp 0.5
+.TE
+.KE
+.ps 11
+.vs 13
+.H 2 "Hardware Requirements"
+Multiprocessor Origin, Onyx, Power Onyx, Onyx2, Octane, Challenge, and Power Challenge
+systems.
+.\"
+.\" List here any special hardware configurations users need to
+.\" run this software product.     
+.\"
+.H 2 "On-Line Release Notes"
+After you install the online documentation for a product
+(the \f2relnotes\fP subsystem),
+you can view the release notes on your screen.
+.P
+If you have a graphics system, select ``Release Notes''
+from the Tools submenu of the Toolchest. This displays
+the \f2grelnotes\f1(1) graphical browser for the online release notes.
+.P
+Refer to the \f2grelnotes\f1(1) man page for information on options
+to this command.
+.P
+If you do not have a graphics system, you can use the \f2relnotes\f1 command.
+Refer to the \f2relnotes\f1(1) man page for accessing the online release
+notes.
+.VL 7
+.LI "\f6Note:\f1
+You can read the online release notes for most products before 
+installing the software.
+Refer to the booklet in your CD-ROM case for more information.
+.LE
+.H 2 "Product Support"
+Silicon Graphics, Inc., provides a comprehensive
+product support maintenance program for its products.
+.P
+If you are in North America and would like support
+for your Silicon Graphics-supported products, contact
+the Technical Assistance Center at
+.br
+1-800-800-4SGI.
+.P
+If you are outside North America,
+contact the Silicon Graphics subsidiary or authorized
+distributor in your country.

eoe/cmd/react/relnotes/ch2.cmm

@@ -0,0 +1,73 @@
+.nr H1 1
+.H 1 "Installation Information"
+.\"
+.\"	Developer
+.\"
+This chapter lists supplemental information to 
+the \f2IRIS\(rg Software Installation Guide.\f1
+The information listed here is product-specific;
+use it with the installation guide to install 
+this product.
+.H 2 "The REACT/Pro Subsystems"
+..\"
+.\" Each subsystem should be described in enough detail so that
+.\" users can decide whether or not they need to install it.
+.\" Hints such as "You need to install this subsystem if you want to use
+.\" Visual System Administration Tools" or "This subsystem is useful only
+.\" if you want to display Kanji characters" would be nice. For subsystems
+.\" such as eoe2.sw.4Dwm that are important if you have graphics, but not 
+.\" important for servers and aren't marked required in the spec file (inst 
+.\" doesn't show + and doesn't require their installation), be sure to make
+.\" this very clear in the description or in a separate list.
+.\"
+.VL 28
+.LI "\f4react.books.REACT_PG\f1"
+The Real-Time Programmer's Guide
+.LI "\f4react.man.man\f1"
+Irix man pages for the Frame Scheduler
+.LI "\f4react.man.relnotes\f1"
+This Release Note
+.LI "\f4react.sw.demos\f1"
+Frame Scheduler Demos
+.LI "\f4react.sw.dev\f1"
+Development Environment (32bit)
+.LI "\f4react.sw64.dev\f1"
+Development Environment (64bit)
+.LI "\f4react.sw.frs\f1"
+Frame Scheduler Kernel Module
+.LI "\f4react.sw.src\f1"
+Frame Scheduler Demo Source Code
+.LI "\f4react.sw.usio\f1"
+User Serialio Kernel Module
+.LE
+.H 2 "The Frame Scheduler Subsystem"
+.\"
+.\" The size of each subsystem should be listed so that users get an idea
+.\" of the disk space requirements before they get into inst.
+.\"
+This subsystem adds the real-time frame rate scheduling option to the standard
+IRIX scheduler. To install the frame scheduler, the target system
+must be running IRIX 6.5.2 or later (maintenance or feature streams). 
+.VL 7
+.H 2 "Installation Method"
+.\"
+.\" The installation methods are called "miniroot installation" and 
+.\" "IRIX installation". The specific subsystems that require Miniroot
+.\" Installation should be listed, or state that the product can be 
+.\" installed with IRIX Installation.
+.\"
+.\" If some subsystems of this option must be installed using the miniroot
+.\" and others can be installed using IRIX, fill in the table below:
+.\"
+The installation of the frame scheduler requires an additional step to define
+the processors that will be used for realtime. This definition is done by editing
+the file /var/sysgen/systems/irix.sm, using the directive NOINTR to specify 
+the realtime processors. This directive will prevent the system from assigning 
+device interrupts to the specified processors, thereby enhancing the realtime
+behavior.
+.H 2 "Examples"
+The installation process creates the directory /usr/react/bin which contains
+executable examples for the frame scheduler, while the source code for
+these programs is installed in /usr/share/src/react/examples.
+
+

eoe/cmd/react/relnotes/ch3.cmm

@@ -0,0 +1,152 @@
+.nr H1 2
+.H 1 "New Release Information"
+.\"
+.\"	Developer
+.\"
+
+REACT/Pro 4.0 adds many new features and enhancements, providing more
+solutions for real-time computing problems. 
+.P
+This chapter lists the differences between this release of REACT/Pro
+and previous releases. 
+
+.H 2 "IRIXview 2.0"
+
+REACT/Pro 4.0 also works with IRIXview 2.0 (available as a seperate product), a
+graphical tool for recording the events of the software system and analyzing their
+relationships.  IRIXview replaces WindView, encompassing all of WindView's
+functionality, as well as, adding many new features and
+enhancements, including:
+.BL
+.LI
+Expanded system event types
+.LI
+CPU graph views
+.LI
+System thread tracking
+.LI
+Scheduler statistics
+.LI
+System call tracing
+.LE
+.P
+For more information about IRIXview, see the "\f4IRIXview User's Guide\fP",
+included in this release.
+
+.H 2 "Frame Scheduler Performance and Scalability"
+
+The time spent processing Frame Scheduler time base interrupts has been
+reduced, decreasing overhead and increasing system response time.
+.P
+Scalability has been increased, enabling more slaves to be chained to a master
+Frame Scheduler, without incurring significant system overhead. This allows for
+larger Frame Scheduled system configurations.
+
+.H 2 "Frame Scheduler Interrupt Sources"
+
+User-level interrupts (uli) may now be used as an interrupt source for
+Frame Scheduled applications on Origin systems: FRS_INTRSOURCE_ULI.
+The PCI or VME interrupt must be routed to the master Frame Scheduled processor
+for the frame Scheduler to recognize it. For more information about using
+user-level interrupts, see the uli(3) reference page.
+.P
+The per-cpu clock interrupt source definition has been renamed from
+\f4FRS_INTRSOURCE_R4KTIMER\fP to \f4FRS_INTRSOURCE_CPUTIMER\fP.
+While the original definition is still supported, all future documentation
+will reference \f4FRS_INTRSOURCE_CPUTIMER\fP.
+  
+.H 2 "Octane Support"
+
+REACT/Pro 4.0 introduces Frame Scheduler support for the Octane platform.
+The following Frame Scheduler time base interrupt sources are supported:
+.BL
+.LI
+FRS_INTRSOURCE_CPUTIMER
+.LI
+FRS_INTRSOURCE_DRIVER
+.LI
+FRS_INTRSOURCE_USER
+.LI
+FRS_INTRSOURCE_VSYNC
+.LE
+
+.H 2 "Variable Length Frames"
+
+The Frame Scheduler has been enhanced to support variable length minor frames,
+where each minor frame may have a different duration. For usage information,
+see the frs_create_vmaster(3) reference page.
+
+.H 2 "Multiple Interrupt Sources"
+
+The Frame Scheduler has been enhanced to support multiple interrupt sources,
+where each minor frame may be triggered by a different interrupt source. For
+usage information, see the frs_create_vmaster(3) reference page.
+
+.H 2 "Example Programs"
+
+The suite of Frame Scheduler example programs (binary and source code) has been
+expanded to also demonstrate:
+.BL
+.LI
+variable length frames
+.LI
+multiple interrupt sources
+.LI
+and frame scheduled pthread applications
+.LE
+.P
+A list of each program and descriptions of what they demonstrate is available
+in README file (shipped with the source code), in the following directory:
+\f4/usr/share/src/react/examples/\fP.
+.P
+Note that not all example programs run on all systems, as some have
+platform specific requirements. For example, programs demonstrating:
+.BL
+.LI
+slaving multiple Frame Schedulers together require multiple processors
+to execute,
+.LI
+external interrupts require a machine with an external interrupt port
+(Challenge or Origin),
+.LI
+the usage of the FRS_INTRSOURCE_CCTIMER do not execute on Octane systems,
+since this interrupt source is not supported on Octane.
+.LE
+
+.H 3 "CPU timer example:"
+
+The r4k_intr Frame Scheduler example code and binary, has been renamed to cpu_intr,
+and uses the FRS_INTRSOURCE_CPUTIMER interrupt source instead of the
+FRS_INTRSOURCE_R4KTIMER.
+
+.H 3 "Insert Example:"
+ 
+A new example program, called insert, has been included to demonstrate the dynamic
+insertion and removing of processes on a minor frame.
+
+.H 3 "Pthread Examples:"
+Frame scheduled pthread applications are only supported
+on releases of REACT/Pro 3.2 or greater. 
+
+.H 2 "Frame Scheduler Signals"
+Signals are not sent to every thread/process in a frame scheduler; they
+are sent either to the controller thread/process or to the thread/process
+directly involved in the action requiring a signal to be sent.
+See the "\f4Real-Time Programmer's Guide\fP" for further information.
+
+.H 2 "Data Structures"
+Applications accessing the \f2pid\fP field of the following Frame Scheduler
+data structures need to be modified to compile properly on a system with
+REACT/Pro 3.2 or later installed:
+.BL
+.LI
+frs_queue_info_t
+.LI
+frs_attr_info_t
+.LE
+.P
+The \f2pid\fP field has been renamed to \f2thread\fP to better support
+multi-threaded applications.
+.P
+Note that it is not necessary for applications to recompile as a result of
+this change.

eoe/cmd/react/relnotes/front.x

@@ -0,0 +1,39 @@
+.nr TY 2
+.\" This file is the source file for the cover and credits pages included
+.\" in printed release notes.
+.\"
+.\" The lines below should be editted to match your product by replacing
+.\" the words in angle brackets (<>) with your text.
+.\" The document part number should be obtained from the Tech Pubs folks, if you
+.\" do not know it.  It normally changes from release to release.
+.\"
+.\" NOTE: there must be *no* white space at the ends of lines in this file,
+.\" or punctuation will be incorrect in the resulting copy.
+.\"
+.\"	first line of Release Notes title (<= 4.25 inches long)
+.ds TI 5.3 REACT/pro
+.\"	second line of Release Notes title
+.\".ds TJ 
+.\".ds TK
+.\"	document part number (xxx-xxxx-xxx)
+.ds DN XXX-XXXX-XXX
+.\"	list of names after "Written by" on the credits page
+.\"	(separate names by commas and let the line wrap if it is very long)
+.ds WB Luis Stevens
+.\"	name(s) after "Editted by" (names are comma-separated)
+.\".ds EB <names>
+.\"	name(s) after "Illustrated by" (names are comma-separated)
+.\".ds IB <names>
+.\"	name(s) after "Production by" (names are comma-separated)
+.\".ds PB Diane Wilford
+.\"	list of names after "Engineering contributions by"
+.\"	(separate names by commas and let the line wrap if it is very long)
+.ds EG Luis Stevens, Ralph Humphries, Rich Altmaier 
+.\"	copyright year for the credits page (e.g. 1992)
+.ds YR 1994
+.\"	trademark information (use as many lines as you need)
+.de TR
+Silicon Graphics and IRIS are registered trademarks and IRIX is a trademark
+of Silicon Graphics, Inc.
+UNIX is a registered trademark of UNIX System Laboratories, Inc.
+..