Subversion Repositories HelenOS-doc

Compare Revisions

Ignore whitespace Rev 154 → Rev 166

/usrman/trunk/running/running.tex
4,82 → 4,82
When the HelenOS kernel starts up, it configures its output device
and starts booting. During the boot process it writes out some some
lines regarding memory size and available CPUs. The userspace
drivers and tasks take over the console as soon as the start-up activity
and developer kernel tests are finished.
drivers and tasks take over the console as soon as the start-up activities are finished.
When kernel tests are compiled in, the userspace layer is not started.
 
The console driver provides 12 virtual consoles, 11 reserved
The console driver provides 12 virtual consoles, 11 are used
for applications, console 12 is reserved for kernel console. Pressing
function keys F1-F12 switches between the consoles.
 
If the architecture supports framebuffer device larger with
resolution at least 800x600, nice graphical console is shown. At the top
of the screen a row of buttons for the virtual console is drawn. If
If the architecture supports framebuffer device with
at least 800x600 resolution, a nice graphical console is shown. At the top
of the screen, a row of buttons for the virtual console is drawn. If
the button contains console number, an application is connected to it.
The red button signifies that there was an activity on the terminal
The red button means that there was an activity on the terminal
since it was last shown to the user.
 
\section{KConsole}
KConsole is a kernel thread operating completely in priviledged mode.
It allows user to interact directly with the kernel and even start directly
\section{Kernel Console}
{\em kconsole} is a kernel thread operating completely in priviledged mode.
It allows the user to interact directly with the kernel and even start directly
functions inside the kernel.
 
The KConsole is shown by switching to console number 12. On some platforms
The kernel console is shown by switching to console number 12. On some platforms
the kconsole screen is not restored to its previous contents. Press
enter to see a KConsole prompt. The function keys for switching terminals
do not work in KConsole, to switch back to other console, use
enter to see {\em kconsole}'s prompt. The function keys for switching terminals
do not work in the console. In order to switch back to other consoles, use
the {\em continue} command. After executing the command, press a function key
to switch to other consoles.
to switch to the console of your choice.
 
The basic editing facilities are very similar to {\em readline} conventions.
The left and right arrows, backspace and delete keys allow for convenient
editing of the text. The history of last ten commands can be retrieved
using up and down arrows. KConsole supports tab completion, double tab
shows a list of available commands.
The left and right arrows, backspace and delete keys allow convenient
editing of text. The history of last ten commands can be retrieved
using up and down arrows. The kernel console supports tab completion, double tab
shows a list of available commands.
 
The first class of commands prints useful statistics from the running
operating systems. The commands are:
\begin{description}
\item[zones] --- Prints a list of memory zones.
\item[zone $<$zone number$>$] --- Prints a detailed statistics about frame allocator.
\item[slabs] --- Prints a details statistics about slab allocator.
\item[scheduler] --- Prints scheduler queues on all cpus.
\item[zones] --- Prints a list of memory zones.
\item[zone $<$zone number$>$] --- Prints a detailed statistics about the frame allocator.
\item[slabs] --- Prints detailed statistics about the slab allocator.
\item[scheduler] --- Prints out the contents of scheduler run queues for all cpus.
\item[threads] --- Prints list of existing threads, including information about
the thread state
\item[tasks] --- Prints list of tasks along with some basic IPC informations.
their state.
\item[tasks] --- Prints list of tasks along with some basic IPC information.
\item[ipc\_task $<$taskid$>$] --- Prints detailed information about IPC queues of a particular task.
\item[tlb] --- Prints contents of the Translation Lookaside Buffer on a processor (supported only on some platforms)
\item[exc] --- Prints table of registered exception handlers
\item[tlb] --- Prints contents of the Translation Lookaside Buffer on a processor (supported only on some platforms).
\item[exc] --- Prints table of registered exception handlers.
\end{description}
 
Kernel contains a searchable version of its symbol table. This is used
in error processing as well as for extending functionality of KConsole.
The kernel contains a searchable version of its symbol table. This is used
in error processing as well as for extending functionality of the kernel console.
The following commands are supported:
\begin{description}
\item[symaddr $<$address$>$] --- Finds an address in symbol table and prints appropriate
\item[symaddr $<$address$>$] --- Finds an address in symbol table and prints the appropriate
symbol name.
\item[call0, call1... $<$function$>$ $<$args...$>$] --- Calls a C function function(args...).
Note that the tab-completion works for the function names. Because
\item[call0, call1... $<$function$>$ $<$args...$>$] --- Calls a C function {\em function(args...)}.
Note that the tab-completion also works for function names. Because
of architecture calling convention, this command does not work correctly
on the ia64 platform. The arguments can be specified
\begin{itemize}
\item as a number or hexadecimal number: call1 task\_kill 8
\item as a string: call1 printf "Hello world"
\item as a hexadecimal number preceded by '*'. The argument is then read from
\item as a hexadecimal number preceeded by '*'. The argument is then read from
the given address: call2 printf "%X" *0x8000000
\item as a symbol name. In such case the value located in the memory
in the symbols address is used: call2 printf "%d" task_counter
\item as a symbol name preceded by '\&'. The address is used.
\item as a symbol name preceded by '*'. In such a case the symbol is dereferenced.
\item as a symbol name. In such case, the value located in the memory
location corresponding to the symbol name is used: call2 printf "%d" task_counter
\item as a symbol name preceeded by '\&'. The address is used.
\item as a symbol name preceeded by '*'. In such case, the symbol is dereferenced.
\end{itemize}
\item[set4 <address|symbol name>] --- Saves 4-byte value on a given address.
\item[set4 <address|symbol name>] --- Stores a 4-byte value into a given address.
\end{description}
 
The mips, ia32 and amd64 platforms provide additional commands regarding
The mips32, ia32 and amd64 platforms provide additional commands regarding
debugging facility - set and clear hardware breakpoints and watchpoints.
 
\section{KConsole Task Control}
KConsole {\em call} commands can be used to start and kill the tasks.
To repeatably start the task, the following procedure should be used:
\section{Kernel Console Task Control}
The kconsole {\em call} commands can be used to start and kill tasks.
To repeatably start a task, the following procedure should be used:
\begin{verbatim}
.... kernel boot data ....
init[8].addr=0x8027b000, init[8].size=86016
89,7 → 89,7
Result: 0x80086500
\end{verbatim}
 
To kill a task, the function {\em task\_kill} is appropriate. The {\em taskid}
To kill a task, use of the function {\em task\_kill} is appropriate. The {\em taskid}
parameter is a 64-bit number on all platforms, thus on the 32-bit platforms
call2 should be used with 2 32-bit parameters instead.
\begin{verbatim}
99,11 → 99,11
\end{verbatim}
 
\section{Emergency Functions}
It may happen that the IPC communication dies or that there appear some
problems in the communication chain
It may happen that the IPC communication dies or that some
problems arise in the communication chain
{\em keboard driver} - {\em console} - {\em output driver}.
As long that at least the keyboard driver works, pressing Escape key three
times transfers control to the KConsole immediately. Because the screen is not
As long as at least the keyboard driver works, pressing Escape key three
times transfers control to the kernel console immediately. Because the screen is not
updated, the user should press Enter to see the kconsole prompt.
 
If a kernel panic occurs, the error handling automatially switches control
114,13 → 114,13
 
\section{How to Do a Kernel Panic}
Kernel panic is extremely rare in HelenOS. However, if the user wishes to
simulate it, KConsole contains proper commands. For example the following
simulate it, the kernel console contains proper commands. For example, the following
command simulates a write to the unmapped address 0x4:
\begin{verbatim}
kconsole> set4 4 0
\end{verbatim}
 
To test the autodebugging possibilities of the IA32 platform, the following
To test the autodebugging possibilities of the ia32 platform, the following
sequence can be executed:
\begin{verbatim}
kconsole> bkpts
135,14 → 135,13
 
 
\section{KLog}
To avoid disturbing the framebuffer driver with kernel messages, a circular
buffer communication between kernel and userspace area is established.
Non-critical messages are sent to the
KLog application. User can see messages about task faults
and task cleanup completion.
In order to avoid disturbing the framebuffer driver with kernel messages, a circular
buffer communication between the kernel and the userspace area is established.
Non-critical messages are sent to the KLog application. The user can see messages about
task faults and task cleanup completion.
 
\section{IPCC - testing application}
To test thouroughly some aspects of the task activities, IPCC application
allows user to generate page faults
For the sake of thourough testing of some aspects of task activities, IPCC application
allows the user to generate faulting behaviour such as page faults and unaligned references\footnote{Some architectures
do not fault on an unaligned memory reference.}.
 
\section{Tetris}
/usrman/trunk/usrman.tex
7,7 → 7,7
 
\title{
\Huge{\bf HelenOS project}\\
\LARGE{\it user's manual}
\LARGE{\it user manual}
}
\date{}
 
/usrman/trunk/intro/intro.tex
1,6 → 1,6
\chapter{Introduction}
 
HelenOS is an development operating system intended to
HelenOS is a development operating system intended to
be a testbed for research in the field of operating
systems and system-level programming. This manual is
a guide for building, running and enhancing HelenOS.
7,18 → 7,18
 
The system, as any other operating system, can be divided
into platform independent and platform dependent parts.
An user space program could be written in such
A user space program could be written in such
a way that it can be compiled and executed on any
of the platforms HelenOS supports without any modifications.
However it might work as a device driver or perform
other special tasks and thus being platform dependent.
other special tasks and thus become platform dependent.
 
\section{Structure of HelenOS}
 
The HelenOS system cosists of three major parts:
The HelenOS operating system consists of three major parts:
 
\begin{itemize}
\item Kernel
\item User space tasks
\item User space layer
\item Boot infrastructure
\end{itemize}
/usrman/trunk/building/building.tex
19,7 → 19,7
in the file {\em Makefile.config} in the boot/, kernel/ and uspace/
directories and are automatically used for each subsequent build.
 
To change the parameters, the user should change to the particular subsystem
directory and type {\em make config}. When the build configuration parameter
are changed, the whole subsystem should be completely rebuilt. The
configuration system offers user to do this automatically.
In order to modify the parameters, the user should change to the particular subsystem
directory and type {\em make config}. When the build configuration parameters
are changed, the whole subsystem should be completely rebuilt. The
configuration system offers to do this automatically for the user.