ANSI IMPLEMENTATION OF PROTECTION MODULE
                           design.mps.protan
                             incomplete doc
                             drj 1997-03-19

INTRODUCTION

.readership: Any MPS developer

.intro: This is the design for the ANSI implementation of the Protection Module.


REQUIREMENTS

.req.test: This module is required for testing.  Particularly on platforms 
where no real implementation of the protection module exists.

.req.rapid-port: This module is required for rapid porting.  It should enable a 
developer to port a minimally useful configuration of the MPS to new platforms 
very quickly.


OVERVIEW

.overview: Most of the functions in the module do nothing.  The exception is 
ProtSync which traverses over all segments in the arena and simulates an access 
to each segment that has any protection on it.  This means that this module 
depends on certain fields in the segment structure.

.overview.noos: No operating system specific (or even ANSI hosted specific) 
code is in this module.  It can therefore be used on any platform, particularly 
where no real implementation of the module exists.  It satisfies .req.test and 
.req.rapid-port in this way.


FUNCTIONS

.fun.protsetup:

ProtSetup

Does nothing as there is nothing to do (under UNIX we might expect the 
Protection Module to install one or more signal handlers at this pointer, but 
that is not appropropriate for the ANSI implementation).  Of course, we can't 
have an empty function body, so there is a NOOP; here.

.fun.sync:

ProtSync

.fun.sync.what:
ProtSync is called to ensure that the actual protection of each segment (as 
determined by the OS) is in accordance with the segments's pm field.  In the 
ANSI implementation we have no way of changing the protection of a segment, so 
instead we generate faults on all protected segments in the assumption that 
that will remove the protection on segments.

.fun.sync.how:
Continually loops over all the segments until it finds that all segments have 
no protection.  .sync.seg: If it finds a segment that is protected then 
PoolAccess is called on that segment's pool and with that segment.  The call to 
PoolAccess is wrapped with a ShieldEnter and ShieldLeave thereby giving the 
pool the illusion that the fault was generated outside the MM.  This depends on 
being able to determine the protection of a segment (using the pm field), on 
being able to call ShieldEnter and ShieldLeave, and on being able to call 
PoolAccess.

A. References

B. Document History

C. Copyright and License

This document is copyright © 1995-2002 Ravenbrook Limited. All rights reserved. This is an open source license. Contact Ravenbrook for commercial licensing options.

Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:

1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
3. Redistributions in any form must be accompanied by information on how to obtain complete source code for the this software and any accompanying software that uses this software. The source code must either be included in the distribution or be available for no more than the cost of distribution plus a nominal fee, and must be freely redistributable under reasonable conditions. For an executable file, complete source code means the source code for all modules it contains. It does not include source code for modules or files that typically accompany the major components of the operating system on which the executable file runs.

This software is provided by the copyright holders and contributors "as is" and any express or implied warranties, including, but not limited to, the implied warranties of merchantability, fitness for a particular purpose, or non-infringement, are disclaimed. In no event shall the copyright holders and contributors be liable for any direct, indirect, incidental, special, exemplary, or consequential damages (including, but not limited to, procurement of substitute goods or services; loss of use, data, or profits; or business interruption) however caused and on any theory of liability, whether in contract, strict liability, or tort (including negligence or otherwise) arising in any way out of the use of this software, even if advised of the possibility of such damage.