[ac7d5ef0] | 1 | /* wkspace.h |
---|
| 2 | * |
---|
[3a4ae6c] | 3 | * This include file contains information related to the |
---|
[ac7d5ef0] | 4 | * RAM Workspace. This Handler provides mechanisms which can be used to |
---|
[3a4ae6c] | 5 | * define, initialize and manipulate the workspace. |
---|
[ac7d5ef0] | 6 | * |
---|
| 7 | * COPYRIGHT (c) 1989, 1990, 1991, 1992, 1993, 1994. |
---|
| 8 | * On-Line Applications Research Corporation (OAR). |
---|
| 9 | * All rights assigned to U.S. Government, 1994. |
---|
| 10 | * |
---|
| 11 | * This material may be reproduced by or for the U.S. Government pursuant |
---|
| 12 | * to the copyright license under the clause at DFARS 252.227-7013. This |
---|
| 13 | * notice must appear in all copies of this file and its derivatives. |
---|
| 14 | * |
---|
[da6375b] | 15 | * $Id$ |
---|
[ac7d5ef0] | 16 | */ |
---|
| 17 | |
---|
[3a4ae6c] | 18 | #ifndef __WORKSPACE_h |
---|
| 19 | #define __WORKSPACE_h |
---|
[ac7d5ef0] | 20 | |
---|
| 21 | #ifdef __cplusplus |
---|
| 22 | extern "C" { |
---|
| 23 | #endif |
---|
| 24 | |
---|
[5e9b32b] | 25 | #include <rtems/score/heap.h> |
---|
| 26 | #include <rtems/score/interr.h> |
---|
[ac7d5ef0] | 27 | |
---|
| 28 | /* |
---|
[3a4ae6c] | 29 | * The following is used to manage the Workspace. |
---|
[ac7d5ef0] | 30 | * |
---|
| 31 | */ |
---|
| 32 | |
---|
| 33 | EXTERN Heap_Control _Workspace_Area; /* executive heap header */ |
---|
| 34 | |
---|
| 35 | /* |
---|
| 36 | * _Workspace_Handler_initialization |
---|
| 37 | * |
---|
| 38 | * DESCRIPTION: |
---|
| 39 | * |
---|
| 40 | * This routine performs the initialization necessary for this handler. |
---|
| 41 | */ |
---|
| 42 | |
---|
| 43 | STATIC INLINE void _Workspace_Handler_initialization( |
---|
| 44 | void *starting_address, |
---|
| 45 | unsigned32 size |
---|
| 46 | ); |
---|
| 47 | |
---|
| 48 | /* |
---|
| 49 | * _Workspace_Allocate |
---|
| 50 | * |
---|
| 51 | * DESCRIPTION: |
---|
| 52 | * |
---|
| 53 | * This routine returns the address of a block of memory of size |
---|
| 54 | * bytes. If a block of the appropriate size cannot be allocated |
---|
| 55 | * from the workspace, then NULL is returned. |
---|
| 56 | */ |
---|
| 57 | |
---|
| 58 | STATIC INLINE void *_Workspace_Allocate( |
---|
| 59 | unsigned32 size |
---|
| 60 | ); |
---|
| 61 | |
---|
| 62 | /* |
---|
| 63 | * _Workspace_Allocate_or_fatal_error |
---|
| 64 | * |
---|
| 65 | * DESCRIPTION: |
---|
| 66 | * |
---|
| 67 | * This routine returns the address of a block of memory of size |
---|
| 68 | * bytes. If a block of the appropriate size cannot be allocated |
---|
[3a4ae6c] | 69 | * from the workspace, then the internal error handler is invoked. |
---|
[ac7d5ef0] | 70 | */ |
---|
| 71 | |
---|
[45819022] | 72 | void *_Workspace_Allocate_or_fatal_error( |
---|
[ac7d5ef0] | 73 | unsigned32 size |
---|
| 74 | ); |
---|
| 75 | |
---|
| 76 | /* |
---|
| 77 | * _Workspace_Free |
---|
| 78 | * |
---|
| 79 | * DESCRIPTION: |
---|
| 80 | * |
---|
| 81 | * This function frees the specified block of memory. If the block |
---|
| 82 | * belongs to the Workspace and can be successfully freed, then |
---|
| 83 | * TRUE is returned. Otherwise FALSE is returned. |
---|
| 84 | */ |
---|
| 85 | |
---|
| 86 | STATIC INLINE boolean _Workspace_Free( |
---|
| 87 | void *block |
---|
| 88 | ); |
---|
| 89 | |
---|
[5e9b32b] | 90 | #include <rtems/score/wkspace.inl> |
---|
[ac7d5ef0] | 91 | |
---|
| 92 | #ifdef __cplusplus |
---|
| 93 | } |
---|
| 94 | #endif |
---|
| 95 | |
---|
| 96 | #endif |
---|
| 97 | /* end of include file */ |
---|