student guide to the kaya operating system project guide to the kaya operating system project the...

22
Student Guide to the Kaya Operating System Project The Virtual Square Lab Michael Goldweber Xavier University Renzo Davoli University of Bologna

Upload: trandiep

Post on 23-May-2018

221 views

Category:

Documents


1 download

TRANSCRIPT

Page 1: Student Guide to the Kaya Operating System Project Guide to the Kaya Operating System Project The Virtual Square Lab Michael Goldweber Xavier University Renzo Davoli University of

Student Guide to theKaya

Operating System Project

The Virtual Square Lab

Michael GoldweberXavier University

Renzo DavoliUniversity of Bologna

Page 2: Student Guide to the Kaya Operating System Project Guide to the Kaya Operating System Project The Virtual Square Lab Michael Goldweber Xavier University Renzo Davoli University of

Kaya, µMPS & µMPS2 are products of the Virtual Square Lab.See virtualsquare.org/ and wiki.virtualsquare.org/.The µMPS & µMPS2 home page is www.cs.xu.edu/uMPS/

Copyright c!2009, 2011Michael Goldweber, Renzo Davoli and the Virtual SquareLab. Permission is granted to copy, distribute and/or modify this document un-der the terms of the GNU Free Documentation License, Version 1.2 or any laterversion published by the Free Software Foundation; with the exception of theFront-Cover text, the Title Page with the Logo (recto of this page), and the Back-Cover text. As per the Virtual Square Lab Logo: all rights reserved.

Kaya v1.2

Page 3: Student Guide to the Kaya Operating System Project Guide to the Kaya Operating System Project The Virtual Square Lab Michael Goldweber Xavier University Renzo Davoli University of

Contents

Preface vi

1 Introduction 11.1 Notational conventions . . . . . . . . . . . . . . . . . . . . . . . 2

2 Phase 1 - Level 2: The Queues Manager 42.1 The Allocation and Deallocation of ProcBlk’s . . . . . . . . . . . 52.2 Process Queue Maintenance . . . . . . . . . . . . . . . . . . . . 72.3 Process Tree Maintenance . . . . . . . . . . . . . . . . . . . . . 82.4 The Active Semaphore List . . . . . . . . . . . . . . . . . . . . . 92.5 Nuts and Bolts . . . . . . . . . . . . . . . . . . . . . . . . . . . . 122.6 Testing . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13

3 Phase 2 - Level 3: The Nucleus 153.1 The Scheduler . . . . . . . . . . . . . . . . . . . . . . . . . . . . 163.2 Nucleus Initialization . . . . . . . . . . . . . . . . . . . . . . . . 173.3 SYS/Bp Exception Handling . . . . . . . . . . . . . . . . . . . . 183.4 PgmTrap Exception Handling . . . . . . . . . . . . . . . . . . . 243.5 TLB Exception Handling . . . . . . . . . . . . . . . . . . . . . . 243.6 Interrupt Exception Handling . . . . . . . . . . . . . . . . . . . . 253.7 Nuts and Bolts . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26

4 Phase 3 - Level 4: The VM-I/O Support Level 324.1 SYS/Bp Exception Handling . . . . . . . . . . . . . . . . . . . . 344.2 PgmTrap Exception Handling . . . . . . . . . . . . . . . . . . . 394.3 Delay Facility . . . . . . . . . . . . . . . . . . . . . . . . . . . . 404.4 Virtual P and V Service . . . . . . . . . . . . . . . . . . . . . . . 414.5 Implementing Virtual Memory . . . . . . . . . . . . . . . . . . . 43

iii

Page 4: Student Guide to the Kaya Operating System Project Guide to the Kaya Operating System Project The Virtual Square Lab Michael Goldweber Xavier University Renzo Davoli University of

iv CONTENTS

4.6 VM-I/O Support Level Initialization . . . . . . . . . . . . . . . . 494.7 U-proc Initialization . . . . . . . . . . . . . . . . . . . . . . . . . 504.8 Nuts and Bolts . . . . . . . . . . . . . . . . . . . . . . . . . . . . 52

References 59

Page 5: Student Guide to the Kaya Operating System Project Guide to the Kaya Operating System Project The Virtual Square Lab Michael Goldweber Xavier University Renzo Davoli University of

List of Figures

2.1 Process Queue . . . . . . . . . . . . . . . . . . . . . . . . . . . . 72.2 Process Tree . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 92.3 Active Semaphore List . . . . . . . . . . . . . . . . . . . . . . . 11

4.1 RAM Frame Layout Organization . . . . . . . . . . . . . . . . . 45

v

Page 6: Student Guide to the Kaya Operating System Project Guide to the Kaya Operating System Project The Virtual Square Lab Michael Goldweber Xavier University Renzo Davoli University of

Preface

In my junior year as an undergraduate I took a course titled, “Systems Program-ming.” The goal of this course was for each student to write a small, simple multi-tasking operating system, in S/360 assembler, for an IBM S/360. The studentswere given use of a machine emulator, Assist-V, for the development process.Assist, was a S/360 assembler programming environment. (Think SPIM for the70’s.) Assist-Vwas an extension of Assist that supported privileged instructions inaddition to various emulated “attached” devices. The highlight of the course wasif your operating system ran correctly (or at least without discernible errors), youwould be granted the opportunity, in the dead of night, to boot the University’smainframe, an IBM S/370, with your operating system. (Caveat: The Univer-sity used VM, IBM’s virtual machine technology. Hence students didn’t actuallyboot the whole machine with their OS’s, but just one VM partition. Neverthe-less, booting/running a VM partition and booting/running the whole machine areisomorphic tasks.) No question, booting and running a handful of tasks concur-rently on the University’s mainframe with my own OS was one of highlights ofmy undergraduate education!

My experience of writing a complete operating system repeated itself in grad-uate school. In this case the machine emulator was the Cornell Hypothetical In-struction Processor (CHIP); a made up architecture that was a cross between aPDP-11 and an IBM S/370. The operating system design was a three phase/layeraffair called HOCA by its creator. While there was no real machine to test with,the thrill and sense of accomplishment of successfully completing the task, to saynothing of the many lessons learned throughout the experience were no less thanthe earlier experience.

In the late 1990’s Professor Renzo Davoli and one of his graduate studentsMauro Morsiani, in the spirit of both Assist-V/370 and CHIP, created MPS, aMIPS 3000 machine emulator that not only authentically emulated the processor(still no floating point), but also faithfully emulated five different device cate-gories. Furthermore, they updated the HOCA project, which they called TINA,

vi

Page 7: Student Guide to the Kaya Operating System Project Guide to the Kaya Operating System Project The Virtual Square Lab Michael Goldweber Xavier University Renzo Davoli University of

PREFACE vii

for this new architecture. Once again, students could take their operating system,developed and debugged on MPS (which also contained an excellent debuggingfacility) and run it unchanged on a real machine.

MPS, with its faithful emulation of the MIPS 3000, though, proved to be toocomplex for a one semester undergraduate project. Hence Renzo and myself setout to create µMPS – a pedagogically appropriate machine emulator appropriatefor use by undergraduates. In addition, we updated TINA for this new architecture.This new project is called Kaya.

µMPS and Kaya were originally released in 2004. Kaya was later updated andfirst published in its current form in 2009. Finally in 2011 µMPS was updated byTomislav Jonjic to µMPS2 with a new GUI and multiprocessor support. µMPS2is 100% backward compatible with µMPS. While µMPS is still available (thoughunsupported), this guide assumes the use of µMPS2. While the Kaya projectdescribed herein can be implemented on µMPS, this version (v1.2) makes use ofa couple of hardware features new to µMPS2.

A raw machine emulator, such as µMPS2, which is fully described in “µMPS2Principles of Operation,” can support a wide variety of undergraduate, and graduate-level projects. The Kaya project is just one such project. The Virtual Square Lab,which produced both Kaya and µMPS2 is also currently producing additionalprojects for µMPS2 as well as for VDE, the Virtual Distributed Ethernet tool alsoproduced by the Virtual Square Lab.

These other projects, like Kaya, are all designed to be accomplished by ad-vanced undergraduates working either solo or in teams in the context of a semester-long multi-phase project.

Finally Renzo and myself wish to offer our heartfelt thanks to Mauro Mor-siani who generously donated his time to modify MPS into µMPS, and TomislavJonjic who extended µMPS to create the backward compatible µMPS2. We alsowish to thank our wives, Alessandra and Mindy and our children, without whoseinexhaustible patience projects such as this would never see the light of day.

Michael GoldweberAugust, 2009

Updated: August, 2011

Page 8: Student Guide to the Kaya Operating System Project Guide to the Kaya Operating System Project The Virtual Square Lab Michael Goldweber Xavier University Renzo Davoli University of
Page 9: Student Guide to the Kaya Operating System Project Guide to the Kaya Operating System Project The Virtual Square Lab Michael Goldweber Xavier University Renzo Davoli University of

The least of learning is done in the classrooms.Thomas Merton

1Introduction

The Kaya OS described below is similar to the T.H.E. system outlined by Dijkstraback in 1968[4]. Dijkstra’s paper described an OS divided into six layers. Eachlayer i was an ADT or abstract machine to layer i + 1; successively building upthe capabilities of the system for each new layer to build upon. The OS describedhere also contains six layers, though the final OS is not as complete as Dijkstra’s.

Kaya is actually the latest instantiation of an older “learning” operating systemdesign. Ozalp Babaoglu and Fred Schneider originally described this operatingsystem, calling it the HOCAOS[3], for implemention on the Cornell HypotheticalInstruction Processor (CHIP)[2, 1]. Later, Renzo Davoli and Mauro Morsianireworked HOCA, calling it TINA[6] and ICAROS[5], for implementation on theMicroprocessor (without) Pipeline Stages (MPS)[7, 6].

Level 0: The base hardware of µMPS2.There are two versions of the µMPS hardware; the original µMPS emulator,and µMPS2, a 100% backwards compatible extension of µMPS with animproved GUI and multiprocessor support. While both emulators are stillavailable (though the original µMPS is no longer supported), this guideassumes the use of µMPS2 due to its superior GUI and additional hardwarefeatures.

Level 1: The additional services provided in ROM. This includes the services pro-

1

Page 10: Student Guide to the Kaya Operating System Project Guide to the Kaya Operating System Project The Virtual Square Lab Michael Goldweber Xavier University Renzo Davoli University of

2 CHAPTER 1. INTRODUCTION

vided by the ROM-Excpt handler (i.e. processor state save and load), theROM-TLB-Refill handler (i.e. searching PTE’s for matching entries andloading them into the TLB), and the additional ROM services/instructions(i.e. LDST, FORK, PANIC, and HALT).The µMPS2 Principles of Operation contains a complete description of bothLevel 0 and 1.

Level 2: The Queues Manager (Phase 1 – described in Chapter 2). Based on thekey operating systems concept that active entities at one layer are just datastructures at lower layers, this layer supports the management of queues ofstructures; ProcBlk’s.

Level 3: The Kernel (Phase 2 – described in Chapter 3). This level implements eightnew kernel-mode process management and synchronization primitives inaddition to multiprogramming, a process scheduler, device interrupt han-dlers, and deadlock detection.

Level 4: The Support Level (Phase 3 – described in Chapter 4). Level 3 is ex-tended to support a system that can support multiple user-level cooperatingprocesses that can request I/O and which run in their own virtual addressspace. Furthermore, this level adds user-level synchronization, and a pro-cess sleep/delay facility.

Level 5: The File System (Phase 4) This level implements the abstraction of a flatfile system by implementing primitives necessary to create, rename, delete,open, close, and modify files.

Level 6: The Interactive Shell – why not?

1.1 Notational conventions• Words being defined are italicized.

• Register, fields and instructions are bold-marked.

• Field F of register R is denoted R.F.

• Bits of storage are numbered right-to-left, starting with 0.

• The i-th bit of a storage unit named N is denoted N[i].

Page 11: Student Guide to the Kaya Operating System Project Guide to the Kaya Operating System Project The Virtual Square Lab Michael Goldweber Xavier University Renzo Davoli University of

1.1. NOTATIONAL CONVENTIONS 3

• Memory addresses and operation codes are given in hexadecimal and dis-played in big-endian format.

• All diagrams illustrate memory and going from low addresses to high ad-dresses using a left to right, bottom to top orientation.

• References to the µMPS2 Principles of Operation will have a pops suffix.e.g. A reference to the chapter on Exception Handling will be denoted:Chapter 3-pops.As there are two versions of the µMPS emulator, there are two versions ofthe Principles of Operation manual. As the original µMPS emulator is nolonger supported, this guide assumes the use of µMPS2 Principles of Operation.

Page 12: Student Guide to the Kaya Operating System Project Guide to the Kaya Operating System Project The Virtual Square Lab Michael Goldweber Xavier University Renzo Davoli University of

UNIX is basically a simple operating system, but you have to be a ge-nius to understand the simplicity.

Dennis Ritchie

2Phase 1 - Level 2: The Queues

Manager

Level 2 of Kaya instantiates the key operating system concept that active entities atone layer are just data structures at lower layers. In this case, the active entities ata higher level are processes (i.e. programs in execution) and the data structure(s)that represent them at this level are process control blocks (ProcBlk’s).

4

Page 13: Student Guide to the Kaya Operating System Project Guide to the Kaya Operating System Project The Virtual Square Lab Michael Goldweber Xavier University Renzo Davoli University of

2.1. THE ALLOCATION AND DEALLOCATION OF PROCBLK’S 5

/* process control block type */typedef struct pcb t {

/* process queue fields */struct pcb t *p next, /* pointer to next entry */

/* process tree fields */*p prnt, /* pointer to parent */*p child, /* pointer to 1st child */*p sib; /* pointer to sibling */

state t p s; /* processor state */int *p semAdd; /* pointer to sema4 on */

/* which process blocked */

/* plus other entries to be added later */} pcb t;

The queue manager will implement four ProcBlk related functions:

• The allocation and deallocation of ProcBlk’s.

• The maintenance of queues of ProcBlk’s.

• The maintenance of trees of ProcBlk’s.

• The maintenance of a single sorted list of active semaphore descriptors,each of which supports a queue of ProcBlk’s.

2.1 The Allocation and Deallocation of ProcBlk’sOne may assume that Kaya supports no more that MAXPROC concurrent pro-cesses; where MAXPROC should be set to 20 (in the file CONST.H).1 Thus thislevel needs a “pool” of MAXPROC ProcBlk’s to allocate from and deallocate to.Assuming that there is a set of MAXPROC ProcBlk’s, the free or unused ones can

1The recommended installation location for a “starter” CONST.H is/USR/LOCAL/SHARE/KAYA/

Page 14: Student Guide to the Kaya Operating System Project Guide to the Kaya Operating System Project The Virtual Square Lab Michael Goldweber Xavier University Renzo Davoli University of

6 CHAPTER 2. PHASE 1 - LEVEL 2: THE QUEUES MANAGER

be kept on a NULL-terminated single linearly linked list (using the p next field),called the pcbFree List, whose head is pointed to by the variable pcbFree h.

To support the allocation and deallocation of ProcBlk’s there should be thefollowing three externally visible functions:

• ProcBlk’s which are no longer in use can be returned to the pcbFree list byusing the method:void freePcb(pcb t *p)

/* Insert the element pointed to by p onto the pcbFree list. */

• ProcBlk’s should be allocated by using:pcb t *allocPcb()

/* Return NULL if the pcbFree list is empty. Otherwise, removean element from the pcbFree list, provide initial values for ALLof the ProcBlk’s fields (i.e. NULL and/or 0) and then return apointer to the removed element. ProcBlk’s get reused, so it isimportant that no previous value persist in a ProcBlk when itgets reallocated. */

There is still the question of how one acquires storage forMAXPROC ProcBlk’sand gets these MAXPROC ProcBlk’s initially onto the pcbFree list. Unfortu-nately, there is no malloc() feature to acquire dynamic (i.e. non-automatic)storage that will persist for the lifetime of the OS and not just the lifetime of thefunction they are declared in. Instead, the storage for the MAXPROC ProcBlk’swill be allocated as static storage. A static array of MAXPROC ProcBlk’s willbe declared in initPcbs(). Furthermore, this method will insert each of theMAXPROC ProcBlk’s onto the pcbFree list.

• To initialize the pcbFree List:initPcbs()

/* Initialize the pcbFree list to contain all the elements of thestatic array of MAXPROC ProcBlk’s. This method will be calledonly once during data structure initialization. */

Page 15: Student Guide to the Kaya Operating System Project Guide to the Kaya Operating System Project The Virtual Square Lab Michael Goldweber Xavier University Renzo Davoli University of

2.2. PROCESS QUEUE MAINTENANCE 7

2.2 Process Queue MaintenanceThe methods below do not manipulate a particular queue or set of queues. Insteadthey are generic queue manipulation methods; one of the parameters is a pointerto the queue upon which the indicated operation is to be performed.

The queues of ProcBlk’s to be manipulated, which are called process queues,are all single circularly linked, via the p next pointer field, lists. Instead of ahead pointer, each queue will be pointed at by a tail pointer. One may optionallywish to make all these queues double circularly linked lists for greater efficiency.(This requires adding a p prev pointer to the pcb t structure definition.)

Figure 2.1: Process Queue

To support process queues there should be the following externally visiblefunctions:pcb t *mkEmptyProcQ()

/* This method is used to initialize a variable to be tail pointer to aprocess queue.Return a pointer to the tail of an empty process queue; i.e. NULL. */

int emptyProcQ(pcb t *tp)

/* Return TRUE if the queue whose tail is pointed to by tp is empty.Return FALSE otherwise. */

insertProcQ(pcb t **tp, pcb t *p)

/* Insert the ProcBlk pointed to by p into the process queue whosetail-pointer is pointed to by tp. Note the double indirection throughtp to allow for the possible updating of the tail pointer as well. */

Page 16: Student Guide to the Kaya Operating System Project Guide to the Kaya Operating System Project The Virtual Square Lab Michael Goldweber Xavier University Renzo Davoli University of

8 CHAPTER 2. PHASE 1 - LEVEL 2: THE QUEUES MANAGER

pcb t *removeProcQ(pcb t **tp)

/* Remove the first (i.e. head) element from the process queue whosetail-pointer is pointed to by tp. Return NULL if the process queuewas initially empty; otherwise return the pointer to the removed ele-ment. Update the process queue’s tail pointer if necessary. */

pcb t *outProcQ(pcb t **tp, pcb t *p)

/* Remove the ProcBlk pointed to by p from the process queue whosetail-pointer is pointed to by tp. Update the process queue’s tailpointer if necessary. If the desired entry is not in the indicated queue(an error condition), return NULL; otherwise, return p. Note that pcan point to any element of the process queue. */

pcb t *headProcQ(pcb t *tp)

/* Return a pointer to the first ProcBlk from the process queue whosetail is pointed to by tp. Do not remove this ProcBlkfrom the processqueue. Return NULL if the process queue is empty. */

2.3 Process Tree MaintenanceIn addition to possibly participating in a process queue, ProcBlk’s are also orga-nized into trees of ProcBlk’s, called process trees. The p prnt, p child, andp sib pointers are used for this purpose.

The process trees should be implemented as follows. A parent ProcBlk con-tains a pointer (p child) to a NULL-terminated single linearly linked list of itschild ProcBlk’s. Each child process has a pointer to its parent ProcBlk (p prnt)and possibly the next child ProcBlk of its parent (p sib). For greater efficiencyyou may want to make the linked list of child ProcBlk’s a NULL-terminated dou-ble linearly linked list.

To support process trees there should be the following externally visible func-tions:int emptyChild(pcb t *p)

/* Return TRUE if the ProcBlk pointed to by p has no children. Re-turn FALSE otherwise. */

insertChild(pcb t *prnt, pcb t *p)

Page 17: Student Guide to the Kaya Operating System Project Guide to the Kaya Operating System Project The Virtual Square Lab Michael Goldweber Xavier University Renzo Davoli University of

2.4. THE ACTIVE SEMAPHORE LIST 9

Figure 2.2: Process Tree

/* Make the ProcBlk pointed to by p a child of the ProcBlk pointedto by prnt. */

pcb t *removeChild(pcb t *p)

/* Make the first child of the ProcBlk pointed to by p no longer achild of p. Return NULL if initially there were no children of p.Otherwise, return a pointer to this removed first child ProcBlk. */

pcb t *outChild(pcb t *p)

/* Make the ProcBlk pointed to by p no longer the child of its parent.If the ProcBlk pointed to by p has no parent, return NULL; otherwise,return p. Note that the element pointed to by p need not be the firstchild of its parent. */

2.4 The Active Semaphore ListA semaphore is an important operating system concept which is needed for Phase2/Level 3. While understanding semaphores is not needed for this level, this levelnevertheless implements an important data structure/abstraction which supportsKaya’s implementation of semaphores.

For the purposes of this level it is sufficient to think of a semaphore as aninteger. Associated with this integer is its address (semaphores, like all integers,have a physical address) and a process queue. A semaphore is active if there is at

Page 18: Student Guide to the Kaya Operating System Project Guide to the Kaya Operating System Project The Virtual Square Lab Michael Goldweber Xavier University Renzo Davoli University of

10 CHAPTER 2. PHASE 1 - LEVEL 2: THE QUEUES MANAGER

least one ProcBlk on the process queue associated it. (i.e. The process queue isnot empty: emptyProcQ(s procq) is FALSE.)

The following implementation is suggested: Maintain a sorted NULL-terminatedsingle linearly linked list (using thes next field) of semaphore descriptors whosehead is pointed to by the variable semd h. The list semd h points to will rep-resent the Active Semaphore List (ASL). Keep the ASL sorted in ascending orderusing the s semAdd field as the sort key.

/* semaphore descriptor type */typedef struct semd t {

struct semd t *s next; /* next element on the ASL */int *s semAdd; /* pointer to the semaphore*/pcb t *s procQ; /* tail pointer to a */

/* process queue */} semd t;

Maintain a second list of semaphore descriptors, the semdFree list, to hold theunused semaphore descriptors. This list, whose head is pointed to by the variablesemdFree h, is kept, like the pcbFree list, as a NULL-terminated single linearlylinked list (using the s next field).

The semaphore descriptors themselves should be declared, like the ProcBlk’s,as a static array of size MAXPROC of type semd t.

There is no reason to make the ASL doubly linked, though for greater ASLtraversal efficiency one may opt to place a dummy node at either the head or boththe head and tail of the ASL. (In this case the size of the static array will increaseby either one or two.)

Page 19: Student Guide to the Kaya Operating System Project Guide to the Kaya Operating System Project The Virtual Square Lab Michael Goldweber Xavier University Renzo Davoli University of

2.4. THE ACTIVE SEMAPHORE LIST 11

Figure 2.3: Active Semaphore List

To support the ASL there should be the following externally visible functions:int insertBlocked(int *semAdd, pcb t *p)

/* Insert the ProcBlk pointed to by p at the tail of the process queueassociated with the semaphore whose physical address is semAddand set the semaphore address of p to semAdd. If the semaphore iscurrently not active (i.e. there is no descriptor for it in the ASL), allo-cate a new descriptor from the semdFree list, insert it in the ASL (at

Page 20: Student Guide to the Kaya Operating System Project Guide to the Kaya Operating System Project The Virtual Square Lab Michael Goldweber Xavier University Renzo Davoli University of

12 CHAPTER 2. PHASE 1 - LEVEL 2: THE QUEUES MANAGER

the appropriate position), initialize all of the fields (i.e. set s semAddto semAdd, and s procq to mkEmptyProcQ()), and proceed asabove. If a new semaphore descriptor needs to be allocated and thesemdFree list is empty, return TRUE. In all other cases return FALSE.*/

pcb t *removeBlocked(int *semAdd)

/* Search the ASL for a descriptor of this semaphore. If none isfound, return NULL; otherwise, remove the first (i.e. head) ProcBlkfrom the process queue of the found semaphore descriptor and re-turn a pointer to it. If the process queue for this semaphore becomesempty (emptyProcQ(s procq) is TRUE), remove the semaphoredescriptor from the ASL and return it to the semdFree list. */

pcb t *outBlocked(pcb t *p)

/* Remove the ProcBlk pointed to by p from the process queue asso-ciated with p’s semaphore (p" p semAdd) on the ASL. If ProcBlkpointed to by p does not appear in the process queue associated withp’s semaphore, which is an error condition, return NULL; otherwise,return p. */

pcb t *headBlocked(int *semAdd)

/* Return a pointer to the ProcBlk that is at the head of the pro-cess queue associated with the semaphore semAdd. Return NULLif semAdd is not found on the ASL or if the process queue associ-ated with semAdd is empty. */

initASL(

/* Initialize the semdFree list to contain all the elements of the arraystatic semd t semdTable[MAXPROC]This method will be only called once during data structure initializa-tion. */

2.5 Nuts and BoltsThere is no one right way to implement the functionality of this level. One ap-proach is to create two modules: one for the ASL and one for ProcBlk initializa-tion/allocation/deallocation, process queue maintenance, and process tree mainte-nance.

Page 21: Student Guide to the Kaya Operating System Project Guide to the Kaya Operating System Project The Virtual Square Lab Michael Goldweber Xavier University Renzo Davoli University of

2.6. TESTING 13

The second module, PCB.C, in addition to the public and HIDDEN/privatehelper functions, will also contain the declaration for the private global variablethat points to the head of the pcbFree list

HIDDEN pcb t *pcbFree h;The ASLmodule, ASL.C, in addition to the public and HIDDEN/private helper

functions, will also contain the declarations for semd h and semdFree hHIDDEN semd t *semd h, *semdFree h;

Since the ASL module will make calls to the process queue module to ma-nipulate the process queue associated with each active semaphore, this moduleshould

#include ’’pcb.e’’This will insure that the ASL can only use the externally visible functions from

PCB.C for maintaining its process queues.Furthermore, the declaration for pcb t would then be placed in TYPES.H.2

This is because many other modules will need to access this definition. The dec-laration for semd t is placed in ASL.C because no other module will ever needto access this definition; hence it is local to the module.

As with any non-trivial system, you are strongly encouraged to use the makeprogram to maintain your code. A sample make file has been supplied for you touse.

2.6 TestingThere is a provided test file, P1TEST.C that will “exercise” your code.3

You should compile the three source files separately using the commands:MIPSEL-LINUX-GCC -ANSI -PEDANTIC -WALL -C PCB.CMIPSEL-LINUX-GCC -ANSI -PEDANTIC -WALL -C ASL.CMIPSEL-LINUX-GCC -ANSI -PEDANTIC -WALL -C P1TEST.C

The three object files should then be linked together using the command:MIPSEL-LINUX-LD -T

/USR/LOCAL/SHARE/UMPS2/ELF32LTSMIP.H.UMPSCORE.X/USR/LOCAL/LIB/UMPS2/CRTSO.O P1TEST.O ASL.O PCB.O/USR/LOCAL/LIB/UMPS2/LIBUMPS.O -O KERNEL

2The recommended installation location for a “starter” TYPES.H is/USR/LOCAL/SHARE/KAYA/

3The recommended installation location for P1TEST.C along with a sample Makefile is/USR/LOCAL/SHARE/KAYA/

Page 22: Student Guide to the Kaya Operating System Project Guide to the Kaya Operating System Project The Virtual Square Lab Michael Goldweber Xavier University Renzo Davoli University of

14 CHAPTER 2. PHASE 1 - LEVEL 2: THE QUEUES MANAGER

The files ELF32LTSMIP.H.UMPSCORE.X, CRTSO.O, and LIBUMPS.O are partof the µMPS2 distribution. /USR/LOCAL/XXXX/UMPS2/ are the recommendedinstallation locations for these files. Make sure you know where they are installedin your local environment and alter this command appropriately. The order of theobject files in this command is important: specifically, the first two support filesmust be in their respective positions.4

The linker produces a file in the ELF object file format which needs to beconverted prior to its use with µMPS2. This is done with the command:

UMPS2-ELF2UMPS -K KERNELwhich produces the file KERNEL.CORE.UMPS

Finally, your code can be tested by launching µMPS2. Entering:UMPS2

without any parameters loads the file KERNEL.CORE.UMPS by default. SeeChapter 9-pops for details on using the µMPS2 simulator and it GUI interface.

Hopefully the above will illustrate the benefits for using a Makefile to auto-mate the compiling, linking, and converting of a collection of source files into aµMPS2 executable file.

The test program reports on its progress by writing messages to TERMINAL0.These messages are also added to one of two memory buffers; errbuf for errormessages and okbuf for all other messages. At the conclusion of the test pro-gram, either successful or unsuccessful, µMPS2 will display a final message andthen enter an infinite loop. The final message will either be SYSTEM HALTED forsuccessful termination, or KERNEL PANIC for unsuccessful termination.

4As documented in Section 8.1-pops, if one is working on a big-endian machine one shouldmodify the above commands appropriately; substitute MIPS- for MIPSEL- above.