/* range.c: ADDRESS RANGE IMPLEMENTATION
*
* $Id: //info.ravenbrook.com/project/mps/master/code/range.c#12 $
* Copyright (c) 2013-2020 Ravenbrook Limited. See end of file for license.
*
* .design: <design/range>
*/
#include "check.h"
#include "mpm.h"
#include "range.h"
SRCID(range, "$Id: //info.ravenbrook.com/project/mps/master/code/range.c#12 $");
Bool RangeCheck(Range range)
{
CHECKL(range->base <= range->limit);
return TRUE;
}
void RangeInit(Range range, Addr base, Addr limit)
{
AVER(range != NULL);
AVER(base <= limit);
range->base = base;
range->limit = limit;
AVERT(Range, range);
}
void RangeInitSize(Range range, Addr base, Size size)
{
RangeInit(range, base, AddrAdd(base, size));
}
void RangeFinish(Range range)
{
AVERT(Range, range);
/* Make range invalid and recognisably so, since Range doesn't have
a signature. */
range->limit = (Addr)0;
range->base = (Addr)(Word)0xF191583D; /* FINISHED */
}
Res RangeDescribe(Range range, mps_lib_FILE *stream, Count depth)
{
Res res;
AVERT(Range, range);
AVER(stream != NULL);
res = WriteF(stream, depth,
"Range $P {\n", (WriteFP)range,
" base: $P\n", (WriteFP)RangeBase(range),
" limit: $P\n", (WriteFP)RangeLimit(range),
" size: $U\n", (WriteFU)RangeSize(range),
"} Range $P\n", (WriteFP)range, NULL);
if (res != ResOK) {
return res;
}
return ResOK;
}
Bool RangesOverlap(Range range1, Range range2)
{
AVERT(Range, range1);
AVERT(Range, range2);
return RangeBase(range1) < RangeLimit(range2)
&& RangeBase(range2) < RangeLimit(range1);
}
Bool RangesNest(Range outer, Range inner)
{
AVERT(Range, outer);
AVERT(Range, inner);
return RangeBase(outer) <= RangeBase(inner)
&& RangeLimit(inner) <= RangeLimit(outer);
}
Bool RangesEqual(Range range1, Range range2)
{
AVERT(Range, range1);
AVERT(Range, range2);
return RangeBase(range1) == RangeBase(range2)
&& RangeLimit(range1) == RangeLimit(range2);
}
Bool RangeIsAligned(Range range, Align alignment)
{
AVERT(Range, range);
return AddrIsAligned(RangeBase(range), alignment)
&& AddrIsAligned(RangeLimit(range), alignment);
}
Addr (RangeBase)(Range range)
{
AVERT(Range, range);
return RangeBase(range);
}
Addr (RangeLimit)(Range range)
{
AVERT(Range, range);
return RangeLimit(range);
}
void (RangeSetBase)(Range range, Addr addr)
{
AVERT(Range, range);
AVER(addr >= RangeBase(range));
RangeSetBase(range, addr);
}
void (RangeSetLimit)(Range range, Addr addr)
{
AVERT(Range, range);
AVER(addr <= RangeLimit(range));
RangeSetLimit(range, addr);
}
Size (RangeSize)(Range range)
{
AVERT(Range, range);
return RangeSize(range);
}
void RangeCopy(Range to, Range from)
{
AVERT(Range, from);
RangeInit(to, RangeBase(from), RangeLimit(from));
}
/* C. COPYRIGHT AND LICENSE
*
* Copyright (C) 2013-2020 Ravenbrook Limited <https://www.ravenbrook.com/>.
*
* 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.
*
* 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 AND FITNESS FOR A
* PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
* HOLDER OR 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.
*/