| (* Storage.mod implement the ISO Storage specification. | |
| Copyright (C) 2001-2026 Free Software Foundation, Inc. | |
| Contributed by Gaius Mulley <gaius.mulley@southwales.ac.uk>. | |
| This file is part of GNU Modula-2. | |
| GNU Modula-2 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 3, or (at your option) | |
| any later version. | |
| GNU Modula-2 is distributed in the hope that it will be useful, but | |
| WITHOUT ANY WARRANTY; without even the implied warranty of | |
| MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU | |
| General Public License for more details. | |
| Under Section 7 of GPL version 3, you are granted additional | |
| permissions described in the GCC Runtime Library Exception, version | |
| 3.1, as published by the Free Software Foundation. | |
| You should have received a copy of the GNU General Public License and | |
| a copy of the GCC Runtime Library Exception along with this program; | |
| see the files COPYING3 and COPYING.RUNTIME respectively. If not, see | |
| <http://www.gnu.org/licenses/>. *) | |
| IMPLEMENTATION MODULE Storage ; | |
| FROM libc IMPORT memcpy, abort, malloc, free, printf ; | |
| IMPORT SysStorage ; | |
| FROM M2RTS IMPORT Halt ; | |
| FROM SYSTEM IMPORT TSIZE ; | |
| FROM M2EXCEPTION IMPORT M2Exceptions ; | |
| FROM RTentity IMPORT Group, InitGroup, GetKey, PutKey, DelKey, IsIn ; | |
| FROM EXCEPTIONS IMPORT ExceptionNumber, RAISE, | |
| AllocateSource, ExceptionSource, IsCurrentSource, | |
| IsExceptionalExecution ; | |
| CONST | |
| DebugTrace = FALSE ; | |
| UseMallocFree = FALSE ; | |
| PROCEDURE ALLOCATE (VAR addr: SYSTEM.ADDRESS; amount: CARDINAL) ; | |
| BEGIN | |
| Init ; | |
| IF DebugTrace | |
| THEN | |
| printf ("request m2iso:Storage.ALLOCATE (..., %d bytes)\n", amount) | |
| END ; | |
| IF UseMallocFree | |
| THEN | |
| addr := malloc (amount) | |
| ELSE | |
| SysStorage.ALLOCATE (addr, amount) | |
| END ; | |
| IF DebugTrace | |
| THEN | |
| printf ("return m2iso:Storage.ALLOCATE (%p, %d bytes)\n", addr, amount) | |
| END ; | |
| IF addr#NIL | |
| THEN | |
| PutKey (storageTree, addr, amount) | |
| END | |
| END ALLOCATE ; | |
| PROCEDURE DEALLOCATE (VAR addr: SYSTEM.ADDRESS; amount: CARDINAL) ; | |
| BEGIN | |
| assert (initialized) ; | |
| IF DebugTrace | |
| THEN | |
| printf ("m2iso:Storage.DEALLOCATE (%p, %d bytes)\n", addr, amount) | |
| END ; | |
| IF VerifyDeallocate (addr, amount) | |
| THEN | |
| IF UseMallocFree | |
| THEN | |
| free (addr) | |
| ELSE | |
| SysStorage.DEALLOCATE (addr, amount) | |
| END ; | |
| addr := NIL | |
| END | |
| END DEALLOCATE ; | |
| (* | |
| LowerReallocate - attempts to reallocate amount of storage by | |
| calling ALLOCATE and then coping the amount of data | |
| pointed to by addr into the new space. | |
| Lastly the original addr is deallocated. | |
| *) | |
| PROCEDURE LowerReallocate (VAR addr: SYSTEM.ADDRESS; amount: CARDINAL) ; | |
| VAR | |
| newa: SYSTEM.ADDRESS ; | |
| n : CARDINAL ; | |
| BEGIN | |
| IF NOT IsIn (storageTree, addr) | |
| THEN | |
| RAISE (storageException, ORD(pointerToUnallocatedStorage), | |
| 'trying to reallocate memory which has never been allocated') ; | |
| END ; | |
| n := GetKey (storageTree, addr) ; | |
| ALLOCATE(newa, amount) ; | |
| IF n<amount | |
| THEN | |
| newa := memcpy(newa, addr, n) | |
| ELSE | |
| newa := memcpy(newa, addr, amount) | |
| END ; | |
| DEALLOCATE(addr, n) ; | |
| addr := newa | |
| END LowerReallocate ; | |
| PROCEDURE REALLOCATE (VAR addr: SYSTEM.ADDRESS; amount: CARDINAL); | |
| (* If addr is NIL then ALLOCATE is called otherwise it | |
| attempts to reallocate amount of storage. Effectively it | |
| calls ALLOCATE, copies the amount of data pointed to by | |
| addr into the new space and DEALLOCATES the addr. | |
| This procedure is a GNU extension. | |
| *) | |
| BEGIN | |
| assert (initialized) ; | |
| IF addr = NIL | |
| THEN | |
| ALLOCATE (addr, amount) | |
| ELSE | |
| LowerReallocate (addr, amount) | |
| END | |
| END REALLOCATE ; | |
| PROCEDURE IsStorageException () : BOOLEAN; | |
| BEGIN | |
| Init ; | |
| RETURN( IsCurrentSource (storageException) ) | |
| END IsStorageException ; | |
| PROCEDURE StorageException () : StorageExceptions ; | |
| BEGIN | |
| Init ; | |
| IF NOT IsExceptionalExecution () | |
| THEN | |
| RAISE (storageException, ORD (functionException), 'no storage exception raised') | |
| END ; | |
| RETURN currentException | |
| END StorageException ; | |
| (* | |
| VerifyDeallocate - | |
| *) | |
| PROCEDURE VerifyDeallocate (addr: SYSTEM.ADDRESS; amount: CARDINAL) : BOOLEAN ; | |
| VAR | |
| a: CARDINAL ; | |
| BEGIN | |
| Init ; | |
| IF addr=NIL | |
| THEN | |
| RAISE (storageException, ORD(nilDeallocation), 'deallocating pointer whose value is NIL') ; | |
| RETURN FALSE | |
| ELSE | |
| IF NOT IsIn(storageTree, addr) | |
| THEN | |
| RAISE (storageException, ORD(pointerToUnallocatedStorage), 'trying to deallocate memory which has never been allocated') ; | |
| RETURN FALSE | |
| END ; | |
| a := GetKey (storageTree, addr) ; | |
| IF a#amount | |
| THEN | |
| RAISE (storageException, ORD(wrongStorageToUnallocate), 'wrong amount of storage being deallocated') ; | |
| RETURN FALSE | |
| END | |
| END ; | |
| DelKey (storageTree, addr) ; | |
| RETURN TRUE | |
| END VerifyDeallocate ; | |
| (* | |
| assert - simple assertion procedure. | |
| *) | |
| PROCEDURE assert (condition: BOOLEAN) ; | |
| BEGIN | |
| IF NOT condition | |
| THEN | |
| Halt ('internal runtime error, module Storage has not been initialized yet', | |
| __FILE__, __FUNCTION__, __LINE__) | |
| END | |
| END assert ; | |
| (* | |
| Init - | |
| *) | |
| PROCEDURE Init ; | |
| BEGIN | |
| IF NOT initialized | |
| THEN | |
| initialized := TRUE ; | |
| storageTree := InitGroup () ; | |
| AllocateSource (storageException) | |
| END | |
| END Init ; | |
| VAR | |
| storageException: ExceptionSource ; | |
| currentException: StorageExceptions ; | |
| storageTree : Group ; | |
| initialized : BOOLEAN ; (* Set to FALSE when the bss is created. *) | |
| END Storage. |