We can neither verify the correctness of the data on the tapes nor
get any information about a tape's exact contents, exported symbols,
and dependencies.\\
-So there is a need for the collector to verify, analyze, sort, split, and
+So there is a need for the collector to verify, analyse, sort, split, and
recombine his paper tape software.\\
The \pname program provides a handy approach to
help doing this using a newer computer with an UNIX style operating system,
The Honeywell Series 16 assembly program DAP-16 \cite{ser16:dap16:manual}
and the FOTRAN IV compiler program \cite{ser16:frtn:manual}
read source code from punched paper tape and translate it into relocatable
-object code which is then punched out on paper tape again.
+object code which then again is punched out on paper tape.
See \cite{ser16:progref} for operation details.\\
-The object data is organized in blocks of variable layout and length consisting
-of 16 bit wide native machine words. The block format is described
+The object data is organised in blocks of variable layout and length consisting
+of 16 bit wide native Series 16 machine words. The block format is described
in \cite{ser16:progref}, pages 5-21ff. \\
To store the object blocks on punched paper tapes, each word in the block is
divided into three parts: the first one is 4 bits wide, the second and
Each frame is now translated so that the resulting paper tape frames don't
contain any printable or control characters. Then the block is enclosed by
control characters and sent out to the paper tape punch device.\\
-The resulting ''silent 4/6/6 code'' can be easily processed by the ASR 33
+The resulting ''silent 4/6/6 code'' can be easily processed by the ASR 33/35
printing terminal. It is even possible to mix listing and object code
on one tape because the text between the silent data blocks is
ignored by the loader.\\
concept, but be aware that the translation table in the document contains
\emph{severe} errors.\\
-\subsection{Functional Overview}
-\pname is a program which is capable of analyzing object tapes.\\
+\subsection{\pname Functionality}
+\pname is a program which is capable of object and library tape image analysis.\\
It reads in the data from a file or a serial line, retranslates
-the mangled characters, and reassembles the data blocks into an internal
+the mangled characters (4/6/6 code, see above), and reassembles the data blocks into an internal
representation.\\
The block checksum is checked immediately after a
block has been read in. This provides for immediate error reporting and
-handling. One input data error handling possibility is to immediately
+handling.
+ One input data error handling possibility is to immediately
stop a tape reader connected to a serial port so that the user has a clue
where to look for faulty regions on the paper tape. This is very useful
when reading in last existing copies of old software.\\
After the error-free blocks are present in the program's memory, it is
-possible to do various operations on it. Examples are extracting and
-listing of symbol names, split up the data of a library into several files
-or even reverse assembly and relocating into a virtual Series 16 main memory
-(not in the base variant of the program).
+possible to do various operations on it. Examples are symbol name extraction and listing,
+splitting up a tape image's contents into several distinct files,
+or even reverse assembly and relocating into a virtual Series 16 main memory.
+
-\section{Functional Specification}
+\section{General Requirements}
+
+\subsection{Must Criteria}
+\begin{itemize}
+\item The program shall run on any computer running GNU/Linux.
+\item It has no graphical user interface but a help option and command line error reporting.
+\item The program shall support and check all block types according to \cite{ser16:progref:bformats}.
+\item The Program must be able to list a tape image's contents.
+\item The program shall be capable of splitting tape images into single object files.
+\item The program's structure must be modular and easily extendable.
+\end{itemize}
+
+\subsection{Optional features}
+\begin{itemize}
+\item Possibility to split a tape image into single data block files.
+\item Software handshake paper tape reader control:\\
+A paper paper tape reader connected to the computer's serial port could be motion-controlled
+by use of XON and XOFF characters. This is useful when error breaks for tape inspection are
+enabled and the paper tape device does not support RTS/CTS hardware handshake.
+\item Full POSIX.1, 2004 edition, compliance.\\
+ This enables the program to be usable under many different UNIX style operating
+ systems.
+\end{itemize}
+
+\subsection{Further additions explicitely beyond the scope of this project}
+\begin{itemize}
+\item Detailed data block analysis:
+ \begin{itemize}
+ \item Linking objects into a virtual memory representation.
+ \item Generating disassembly listings of block contents
+ \end{itemize}
+
+\item Support for self loading system tapes generated by \emph{PAL-AP} (see \cite{ser16:opmanual}).
+
+\end{itemize}
+
+%*******************************************************************************
+\newpage
+\section{Detailed Functional Specification}
%*******************************************************************************
\subsection{Data input processing}
a zero-padded three digit number and EOT blocks are not suppressed.
}
+
+%*******************************************************************************
+\newpage
+\subsection{Error handling}
+
+
+\newcommand{\esup}{
+ This error shall lead to an error message and immediate program
+ termination or a warning message and program continuation.
+}
+
+\newcommand{\enosup}{
+ This error shall always lead to an error message and immediate
+ program termination.
+}
+
+\rd{err001}{Error types}{
+ The following distinguished error types shall exist:
+ \begin{itemize}
+ \item Input/output error:\\
+ Error occuring during reading from the input file descriptor
+ or during writing to an output file.\\
+ \enosup
+ \item Block integrity error:\\
+ Caused by failed check according to \req{chk001}.\\
+ \esup
+ \item Checksum error:\\
+ Caused by failed check according to \req{chk002}.\\
+ \esup
+ \item Unknown block type error:\\
+ Caused by failed check according to \req{chk003}.\\
+ \esup
+ \item Object integrity error:\\
+ Caused by failed check according to \req{chk004}.\\
+ \esup
+ \item Usage error:\\
+ Error caused by errors in the program configuration i.e. wrong
+ parameters or impossible combinations of parameters.\\
+ \enosup \\
+ Additionally, the help (\req{h001}) message is output.
+ \item Internal program error:\\
+ Error caused by internal program problems.\\
+ This error should never occur.\\
+ \enosup
+ \end{itemize}
+}
+
+\rd{err002}{Program exit codes}{
+ \begin{table}[H]
+ \begin{center}
+ \begin{tabular}{|r|c|}
+ \hline
+ \multicolumn{1}{|c|}{\bf Exit condition} & \bf Return code\\
+ \hline
+ Successfull program completion & 0 \\
+ File open error & 1\\
+ Input/output error & 2\\
+ Block integrity error & 3\\
+ Checksum error & 4\\
+ Unknown block type error & 5\\
+ Object integrity error & 6\\
+ Usage error & 7\\
+ Internal program error & 100 \\
+ \hline
+ \end{tabular}
+ \caption[Program Exit codes]{Exit codes}
+ \end{center}
+ \end{table}
+}
+
+\rd{err003}{Error and warning messages}{
+ Error messages shall consinst of ''Error:'' and the error reason.\\
+ Warning messages shall consist of ''Warning:'' and a descriptive
+ text.\\
+ The following texts shall be used to form error and warning messages:
+ \begin{table}[H]
+ \begin{center}
+ \begin{tabular}{|l|l|}
+ \hline
+ \bf Error condition & \bf Descriptive text\\ \hline
+ File open error & Could not open $<$filename$>$ for reading/writing!\\
+ Input error & Could not read from $<$filename$>$!\\
+ Output error & Could not write to $<$filename$>$!\\
+ Block integrity error & Block integrity check failed!\\
+ Checksum error & Block checksum wrong!\\
+ Unknown block type & Unknown block type!\\
+ Object integrity & Object integrity check failed!\\
+ Usage error & $<$Specific message describing the problem$>$\\
+ \hline
+ \end{tabular}
+ \end{center}
+ \caption[Error and warning messages]{Messages}
+ \end{table}
+}
+
+\rd{err004}{Error message output}{
+ Any error messages shall be output to standard error.\\
+ There shall be no way to suppress error messages.
+}
+
+\rd{err005}{Warning message output}{
+ Any warning messages shall be output to standard error.\\
+ There shall be a possibility to suppress warning messages.
+}
+
%*******************************************************************************
\newpage
\subsection{Program configuration}
configuration file.
\item Configuration parameters passed via the command line:\\
Parameters passed on the command line will override
- values from previously read configuration files.
+ values from previously read configuration files. If the command line
+ mentiones a configuration file to read, this file is processed before
+ the other parameters supplied on the command line.
\end{enumerate}
}
\newpage
\rd{cfg007}{Configuration implications}{
\begin{itemize}
- \item pause\_on\_checksum\_errors implies ignore\_checksum\_errors.
- \item pause\_on\_checksum\_errors is completely ignored when input
+ \item \emph{pause\_on\_checksum\_errors} implies \emph{ignore\_checksum\_errors}.
+ \item \emph{pause\_on\_checksum\_errors} is completely ignored when input
is read from standard input.
- \item output\_* inhibits tape information output (\req{da001}).
- \item help inhibits all other actions.
+ \item \emph{output\_*} inhibits tape information output (\req{da001}).
+ \item \emph{help} inhibits all other actions.
\end{itemize}
}
\item All error conditions result in immediate program termination
and an error message.
\item Tape information according to \req{da001} is output.
- \item Text is output to standard output.
- \end{itemize}
-}
-
-%*******************************************************************************
-\newpage
-\subsection{Error handling}
-
-
-\newcommand{\esup}{
- This error shall lead to an error message and immediate program
- termination or a warning message and program continuation.
-}
-
-\newcommand{\enosup}{
- This error shall always lead to an error message and immediate
- program termination.
-}
-
-\rd{err001}{Error types}{
- The following distinguished error types shall exist:
- \begin{itemize}
- \item Input/output error:\\
- Error occuring during reading from the input file descriptor
- or during writing to an output file.\\
- \enosup
- \item Block integrity error:\\
- Caused by failed check according to \req{chk001}.\\
- \esup
- \item Checksum error:\\
- Caused by failed check according to \req{chk002}.\\
- \esup
- \item Unknown block type error:\\
- Caused by failed check according to \req{chk003}.\\
- \esup
- \item Object integrity error:\\
- Caused by failed check according to \req{chk004}.\\
- \esup
- \item Usage error:\\
- Error caused by errors in the program configuration i.e. wrong
- parameters or impossible combinations of parameters.\\
- \enosup \\
- Additionally, the help (\req{h001}) message is output.
- \item Internal program error:\\
- Error caused by internal program problems.\\
- This error should never occur.\\
- \enosup
+ \item Normal Text is output to standard output.
+ \item Error messages are output to standard error.
\end{itemize}
}
-
-\rd{err002}{Program exit codes}{
- \begin{table}[H]
- \begin{center}
- \begin{tabular}{|r|c|}
- \hline
- \multicolumn{1}{|c|}{\bf Exit condition} & \bf Return code\\
- \hline
- Successfull program completion & 0 \\
- File open error & 1\\
- Input/output error & 2\\
- Block integrity error & 3\\
- Checksum error & 4\\
- Unknown block type error & 5\\
- Object integrity error & 6\\
- Usage error & 7\\
- Internal program error & 100 \\
- \hline
- \end{tabular}
- \caption[Program Exit codes]{Exit codes}
- \end{center}
- \end{table}
-}
-
-\rd{err003}{Error and warning messages}{
- Error messages shall consinst of ''Error:'' and the error reason.\\
- Warning messages shall consist of ''Warning:'' and a descriptive
- text.\\
- The following texts shall be used to form error and warning messages:
- \begin{table}[H]
- \begin{center}
- \begin{tabular}{|l|l|}
- \hline
- \bf Error condition & \bf Descriptive text\\ \hline
- File open error & Could not open $<$filename$>$ for reading/writing!\\
- Input error & Could not read from $<$filename$>$!\\
- Output error & Could not write to $<$filename$>$!\\
- Block integrity error & Block integrity check failed!\\
- Checksum error & Block checksum wrong!\\
- Unknown block type & Unknown block type!\\
- Object integrity & Object integrity check failed!\\
- Usage error & $<$Specific message describing the problem$>$\\
- \hline
- \end{tabular}
- \end{center}
- \caption[Program Exit codes]{Exit codes}
- \end{table}
-}
-
-\rd{err004}{Error message output}{
- Any error messages shall be output to standard error.\\
- There shall be no way to suppress error messages.
-}
-
-\rd{err005}{Warning message output}{
- Any warning messages shall be output to standard error.\\
- There shall be a possibility to suppress warning messages.
-}
-
projects / h316.git / commitdiff