Guardian Procedure Calls Reference Manual

is always equal to the address specified for pool plus the value of pool-size. Pool space
overhead and adjustments for alignment do not cause the pool to extend past this boundary.
alignment
input
INT:value
specifies the alignment of blocks allocated from the pool.
8 byte alignment0
4 byte alignment4
8 byte alignment8
16 byte alignment (the default alignment)16
On TNS processors, an eight-byte alignment is recommended.
On native processors, a smaller alignment generates the most compact pool with the least
cache alignment, and a larger alignment generates the least compact pool with most cache
alignment.
priv-only
input
This parameter can only be used by a privileged caller.
Returned Value
INT
Outcome of the call:
No error.0
Required parameter missing. pool and pool-size must be specified or a non-privileged caller specified
a nonzero value for priv-only.
2
Bounds error. pool is in a read-only segment, or pool-size is larger than the space available.3
Invalid size. pool-size is too small to allocate the minimum size pool including the pool header.4
Alignment error on pool. pool is not in alignment with the selected alignment.5
Invalid alignment. alignment is not 0, 4, 8, or 16.6
Considerations
NOTE: There are additional considerations for privileged callers.
• Internal variable-length pool header
The POOL_DEFINE_ procedure creates an internal variable-length pool header at the beginning
of the pool. The length of the header can change between RVUs or processor types. Information
in the header is retrieved by calling the POOL_GETINFO_ procedure; the header should not
be accessed directly, since it is subject to change.
• Stack addresses converted to extended addresses
If the pool is in the user data stack, the TAL compiler automatically converts data stack addresses
to extended addresses.
• Read-only segments
If you specify a pool in an extended data segment that is allocated as a read-only segment,
the POOL_DEFINE_ procedure returns error 3 (bounds error).
940 Guardian Procedure Calls (P)