reference

一个操作系统的源代码

/** Reference
 **                                                              
 ** Original Author: Guido de Jong                        
 ** Date: 01-26-00
 ** 
 ** Description:
 ** Apostle micro-kernel Reference Manual
 **                                       
 ** Revision History:
 ** First draft 01-26-00 Guido de Jong
 **
 ** This program is free software, you can redistribute it and/or
 ** modify it under the terms of the GNU General Public License  
 ** as published by the Free Software Foundation; either version 
 ** 2 of the License, or (at your option) any later version.     
 **                                                              
 ** This program is distributed in the hope that it will be      
 ** useful, but WITHOUT ANY WARRANTY; without even the implied   
 ** warranty or MERCHANTABILITY or FITNESS FOR A PARTICULAR      
 ** PURPOSE.  See the GNU General Public License for more       
 ** details.                                                     
 **                                                              
 ** You should have received a copy of the GNU General Public    
 ** License along with this program; if not, write to the        
 ** Free Software Foundation, Inc., 59 Temple Place, Suite 330,  
 ** Boston, MA 02111-1307 USA                                    
 **                                                              
 *********************************************************Apostle OS**/


Apostle micro-kernel Reference Manual


1. Introduction

This document contains a first draft of a reference manual for the Apostle
micro-kernel. The goal of this first draft is to describe how user processes
can interface with the micro-kernel and consequently with other user processes.


2. System Calls

Interaction with the Apostle micro-kernel is done by means of system calls. The
system calls are mapped to interrupts 0x30 and on. For Interprocess
Communication (IPC) a number of system calls are available. A short list of
system calls:

- SendTo
- ReceiveFrom
- CallRemote
- SendReceive
- Unmap
- CreateProcess
- DestroyProcess
- ProcessID
- RequestProcessor
- Idle
- Yield
- Sleep

Next each system call will be desribed in detail. Table 2.1 and table 2.2
contain more information on bitmaps of the IPC Options and the Return Flags.


2.1 SendTo

Description:	Send a message to another process
Interrupt:	0x30
Registers:	eax = IPC Options
		edx = Process ID
		ecx = Timeout
		ebx = Register Message 0 / Activation (*)
		ebp = Register Message 1
                esi = Register Message 2 / Source Flexible Page (#)
                edi = Register Message 3
Returns:	eax = Return Flags
		edx = Receiver Process ID

A process ID 0 signifies the multiplexer.

(*) When replying to a CallRemote EBX contains the Activation, otherwise it can
    be used for register messages.
(#) When sending a flexible page message ESI contains the source page,
    otherwise it can be used for register messages.


2.2 ReceiveFrom

Description:	Receive a message from another process
Interrupt:	0x31
Registers:	eax = IPC Options
		edx = Process ID
		ecx = Timeout
		ebx = Register Message 0
                ebp = Register Message 1
                esi = Register Message 2
		edi = Register Message 3 / Destination Flexible Page (#)
Returns:	eax = Return Flags
		edx = Sender Process ID
		ecx = Caller Activation (+)

A process ID 0 signifies receiving from any process.

(#) When receiving a flexible page message EDI contains the destination page,
    otherwise it can be used for register messages.
(+) Only when receiving RPC, otherwise undefined.


2.3 CallRemote

Description:	Call a remote procedure
Interrupt:	0x32
Registers:	eax = IPC Options
		edx = Process ID
		ecx = Timeout
                ebx = Register Message 0
                ebp = Register Message 1
                esi = Register Message 2 / Source Flexible Page (#)
		edi = Register Message 3 / Destination Flexible Page (#)
Returns:	eax = Return Flags
		edx = Callee Process ID

A process ID 0 signifies the multiplexer. The timeout is used for both the
initial call and the waiting for a reply. It is not possible to both send and
receive a flexible page.

(#) When sending a flexible page message ESI contains the source page,
    otherwise it can be used for register messages. When receiving a flexible
    page message EDI contains the destination page, otherwise it can be used
    for register messages.


2.4 SendReceive

Description:	Reply a message to a process and receive next message from any
		process
Interrupt:	0x33
Registers:	eax = IPC Options
		edx = Process ID
		ecx = Timeout
                ebx = Register Message 0 / Activation (*)
                ebp = Register Message 1
                esi = Register Message 2 / Source Flexible Page (#)
		edi = Register Message 3 / Destination Flexible Page (#)
Returns:	eax = Return Flags
		edx = Sender Process ID
		ecx = Caller Activation (+)

The process ID is only used for replying. The timeout is only for receiving,
the reply is done with timeout 0. It is not possible to both send and receive
a flexible page.

(*) When replying to a CallRemote EBX contains the Activation, otherwise it
    can be used for register messages.
(#) When sending a flexible page message ESI contains the source page,
    otherwise it can be used for register messages. When receiving a flexible
    page message EDI contains the destination page, otherwise it can be used
    for register messages.
(+) Only when receiving RPC, otherwise undefined.


2.5 Unmap

Description:	Unmap proviuosly mapped/granted pages
Interrupt:	0x34
Registers:	eax = Unmap Options
		esi = Source Flexible Page
Return:		eax = Success: TRUE/FALSE


2.6 CreateProcess

Description:	Create new process, assign memory to the process and place it
		in the ready queue.
Interrupt:	0x35
Registers:	eax = Page Flags
		esi = Source Flexible Page
Return:		eax = Process ID


2.7 Exit

Description:	Cleanly exit current process
Interrupt:	0x36
Registers:	-
Return:		-


2.8 ProcessID

Description:	Get process ID of calling process
Interrupt:	0x37
Registers:	-
Return:		eax = Process ID


2.9 RequestProcessor

Description:
Interrupt:	0x38
Registers:
Return:


2.10 Idle

Description:
Interrupt:	0x39
Registers:
Return:


2.11 Yield

Description:	Give up share of processing time in favor of other processes
Interrupt:	0x3a
Registers:	-
Return:		-


2.12 Sleep

Description:	Wait for a number of clock ticks
Interrupt:	0x3b
Registers:	eax = number of ticks
Return:		-


Table 2.1: IPC Options

15 14 13 12 11 10 9 8 7 6 5 4 3 2 1 0
 |  |  |  |  |  | | | | | | | | | | |
 |  |  |  |  |  | | | | | | | | | | +- infinite send timeout
 |  |  |  |  |  | | | | | | | | | +--- send register message
 |  |  |  |  |  | | | | | | | | +----- send flexpage message
 |  |  |  |  |  | | | | | | | +------- send IO map message
 |  |  |  |  |  | | | | | | +--------- send mapping
 |  |  |  |  |  | | | | | +----------- send granting
 |  |  |  |  |  | | | | +------------- send read-only
 |  |  |  |  |  | | | +--------------- send no access
 |  |  |  |  |  | | +----------------- infinite receive timeout
 |  |  |  |  |  | +------------------- receive register message
 |  |  |  |  |  +--------------------- receive flexpage message
 |  |  |  |  +------------------------ receive IO map message
 |  |  |  +--------------------------- receive mapping
 |  |  +------------------------------ receive granting
 |  +--------------------------------- receive read-only
 +------------------------------------ receive no access

Bits 16-30 are reserved.
Bit 31 signifies if the message is part of call remote sequence


Table 2.2: IPC Return Flags

 3 2 1 0
 | | | |
 | | | +- register message OK
 | | +--- flexpage message OK
 | +----- IO map message OK
 +------- call remote OK


Table 2.3: Assign Options

 3 2 1 0
 | | | |
 | | | +- assign mapping
 | | +--- assign granting
 | +----- assign read-only
 +------- assign no access


Table 2.4: Unmap Options

 1 0
 | |
 | +- unmap partial
 +--- unmap me too


Multiplexer Protocol

When calling the multiplexer, the specified process ID (in EDX) must be 0. The
value in ESI (the source flexible page) determines the subfunction of the
system call.

ESI = 0xffffffff (-1):
The multiplexer will try to map/grant (determined by the IPC options in EAX)
an arbitrary free page to the destination flexible page specified by EDI.

ESI < 0x20000000 (kernel space):
The multiplexer will try to map/grant (determined by the IPC options in EAX)
the flexible page specified in ESI to the destination flexible page specified
by EDI.

ESI = ? (to be determined)
The multiplexer will try to grant access to specific IO ports to the calling
process.