Table 96 summarizes the storage manager domain’s specific
gates. It shows the level-1 trace point IDs of the modules providing the functions
for the gates, the functions provided by the gates, and whether or not the
functions are available through the exit programming interface (XPI).
Table 96. Storage manager domain’s specific gates
Gate |
Trace |
Function |
XPI |
SMAD |
SM 0201
SM 0202
|
ADD_SUBPOOL
DELETE_SUBPOOL
START_SUBPOOL_BROWSE
GET_NEXT_SUBPOOL
END_SUBPOOL_BROWSE
INQUIRE_SUBPOOL
|
NO
NO
NO
NO
NO
NO
|
SMAR |
SM 0F01
SM 0F02
|
ALLOCATE_TRANSACTION_STG
RELEASE_TRANSACTION_STG
|
NO
NO
|
SMCK |
SM 0901
SM 0902
|
CHECK_STORAGE
RECOVER_STORAGE
|
NO
NO
|
SMGF |
SM 0301
SM 0302
|
GETMAIN
FREEMAIN
INQUIRE_ELEMENT_LENGTH
|
NO
NO
NO
|
SMMC |
SM 0601
SM 0602
SM 0C01
SM 0C02
SM 0D01
SM 0D02
SM 0E01
SM 0E02
SM 0E01
SM 0E02
|
INITIALIZE
GETMAIN
FREEMAIN
FREEMAIN_ALL_TERMINAL
INQUIRE_ELEMENT_LENGTH
INQUIRE_TASK_STORAGE
|
NO
YES
YES
NO
YES
YES
|
SMSR |
SM 0401
SM 0402
|
INQUIRE_DSA_SIZE
SET_DSA_LIMIT
INQUIRE_DSA_LIMIT
SET_STORAGE_RECOVERY
SET_STORAGE_PROTECT
INQUIRE_STORAGE_PROTECT
INQUIRE_ACCESS_TOKEN
INQUIRE_ACCESS
SET_REENTRANT_PROGRAM
SET_TRANSACTION_ISOLATION
INQUIRE_REENTRANT_PROGRAM
INQUIRE_TRANSACTION_ISOLATION
SWITCH_SUBSPACE
INQUIRE_SHORT_ON_STORAGE
UPDATE_SUBSPACE_TCB_INFO
|
NO
NO
NO
NO
NO
NO
NO
YES
NO
NO
NO
NO
YES
YES
NO
|
The ADD_SUBPOOL function of the SMAD gate is used to create a new subpool
with given attributes.
Input parameters
- USAGE
- indicates whether the subpool is for task or domain use. It can have
either of these values:
TASK|DOMAIN
- ELEMENT_TYPE
- indicates whether the subpool elements are of fixed or variable length.
It can have either of these values:
FIXED|VARIABLE
- [FIXED_LENGTH]
- is the element length for a fixed-length subpool.
- ELEMENT_CHAIN
- indicates whether a chain of the addresses and lengths of the elements
is to be kept. It can have either of these values:
YES|NO
- BOUNDARY
- is the boundary on which all elements within the subpool must be aligned.
The boundary must be a power of two in the range 8 through 4096.
- LOCATION
- specifies whether all elements within the subpool must be allocated
below the maximum 24-bit address, or may be allocated anywhere. It can have
either of these values:
BELOW|ANY
- SUBPOOL_NAME
- is the 8-character name by which the subpool is known.
- INITIAL_FREE
- is the size of the initial free storage area for the subpool.
- [STORAGE_CHECK]
- indicates whether storage zone checking is to be enabled for this subpool.
It can have either of these values:
YES|NO
Output parameters
- SUBPOOL_TOKEN
- is the token identifying the newly created subpool.
- [DSA_NAME]
- is the name of the CICS® dynamic storage area (DSA) in which the subpool resides.
It can have any of these values:
CDSA|UDSA|SDSA|RDSA|ECDSA|EUDSA|ESDSA|ERDSA
- RESPONSE
- is the domain’s response to the call. It can have any of these
values:
OK|EXCEPTION|DISASTER|INVALID|KERNERROR|PURGED
- [REASON]
- is returned when RESPONSE is EXCEPTION or INVALID. Possible values are:
RESPONSE |
Possible REASON values |
EXCEPTION |
INSUFFICIENT_STORAGE |
INVALID |
INVALID_FIXED_LENGTH
INVALID_BOUNDARY
INVALID_SUBPOOL_NAME
INVALID_INITIAL_FREE
DUPLICATE_SUBPOOL_NAME
|
The DELETE_SUBPOOL function of the SMAD gate is used to delete a subpool.
Input parameters
- SUBPOOL_TOKEN
- is the token identifying the subpool to be deleted.
Output parameters
- RESPONSE
- is the domain’s response to the call. It can have any of these
values:
OK|EXCEPTION|DISASTER|INVALID|KERNERROR|PURGED
- [REASON]
- is returned when RESPONSE is INVALID. Possible values are:
RESPONSE |
Possible REASON values |
INVALID |
INVALID_SUBPOOL_TOKEN
NOT_SUBPOOL_OWNER
SUBPOOL_NOT_EMPTY
|
The START_SUBPOOL_BROWSE function of the SMAD gate is used to start a browse
of the storage manager domain subpools.
Input parameters
None
Output parameters
- BROWSE_TOKEN
- is the token identifying the browse operation.
- RESPONSE
- is the domain’s response to the call. It can have any of these
values:
OK|EXCEPTION|DISASTER|INVALID|KERNERROR|PURGED
- [REASON]
- is returned when RESPONSE is EXCEPTION, with the following value:
RESPONSE |
REASON value |
EXCEPTION |
INSUFFICIENT_STORAGE |
The GET_NEXT_SUBPOOL function of the SMAD gate is used in a storage manager
domain subpool browse to get the next subpool.
Input parameters
- BROWSE_TOKEN
- is the token identifying the browse operation.
Output parameters
- SUBPOOL_NAME
- is name of the subpool returned by the browse.
- [DSA_NAME]
- is the name of the DSA in which the subpool resides. It can have one
of the following values:
CDSA|UDSA|SDSA|RDSA|ECDSA|EUDSA|ESDSA|ERDSA
- RESPONSE
- is the domain’s response to the call. It can have any of these
values:
OK|EXCEPTION|DISASTER|INVALID|KERNERROR|PURGED
- [REASON]
- is returned when RESPONSE is EXCEPTION, with the following value:
RESPONSE |
REASON value |
EXCEPTION |
BROWSE_END |
The END_SUBPOOL_BROWSE function of the SMAD gate is used to end a browse
of the storage manager domain subpools.
Input parameters
- BROWSE_TOKEN
- is the token identifying the browse operation.
Output parameters
- RESPONSE
- is the domain’s response to the call. It can have any of these
values:
OK|EXCEPTION|DISASTER|INVALID|KERNERROR|PURGED
- [REASON]
- None.
The INQUIRE_SUBPOOL function of the SMAD gate is used to inquire about
a storage mangaer domain subpool.
Input parameters
- SUBPOOL_NAME
- is the name of a storage manager domain subpool.
Output parameters
- [DSA_NAME]
- is the name of the DSA in which the subpool resides. It can have one
of the following values:
CDSA|UDSA|SDSA|RDSA|ECDSA|EUDSA|ESDSA|ERDSA
- RESPONSE
- is the domain’s response to the call. It can have any of these
values:
OK|EXCEPTION|DISASTER|INVALID|KERNERROR|PURGED
- [REASON]
- is returned when RESPONSE is EXCEPTION, with the following value:
RESPONSE |
REASON value |
EXCEPTION |
SUBPOOL_NOT_FOUND |
The ALLOCATE_TRANSACTION_STG function of the SMAR gate is used at task
initialization to add the four task lifetime storage subpools.
Input parameters
- TASK_DATALOC
- indicates the location of task data for the transaction, as specified
by the TASKDATALOC attribute on the associated TRANSACTION resource definition.
It can have either of these values:
BELOW|ANY
- TASK_DATAKEY
- indicates the storage key for the task-lifetime storage and program-related
storage (for all programs that run under the transaction) for the transaction,
as specified by the TASKDATAKEY attribute on the associated TRANSACTION resource
definition. It can have either of these values:
CICS|USER
- ISOLATE
- indicates whether CICS is to isolate the transaction’s user-key
task-lifetime storage to provide application-to-application protection, as
specified by the ISOLATE attribute on the associated TRANSACTION resource
definition. It can have either of these values:
YES|NO
- STORAGE_FREEZE
- indicates whether or not task-lifetime storage freemains should be delayed
until task termination. It can have either of these values:
YES|NO
- STORAGE_CLEAR
- indicates whether task lifetime storage should be cleared to zeros when
it is freemained. It can have either of these values:
YES|NO
Output parameters
- RESPONSE
- is the domain’s response to the call. It can have any of these
values:
OK|EXCEPTION|DISASTER|INVALID|KERNERROR|PURGED
- [REASON]
- is returned when RESPONSE is DISASTER. Possible values are:
RESPONSE |
Possible REASON values |
DISASTER |
ABEND
INSUFFICIENT_STORAGE
|
The RELEASE_TRANSACTION_STG function of the SMAR gate is used at task termination
to freemain all remaining task-lifetime storage and deletes the four task
lifetime subpools.
Input parameters
None.
Output parameters
- RESPONSE
- is the domain’s response to the call. It can have any of these
values:
OK|EXCEPTION|DISASTER|INVALID|KERNERROR|PURGED
- [REASON]
- is returned when RESPONSE is DISASTER. Possible values are:
RESPONSE |
Possible REASON values |
DISASTER |
ABEND
DEACTIVATE_FAILURE
INSUFFICIENT_STORAGE
STORAGE_VIOLATION
|
The CHECK_STORAGE function of the SMCK gate is used to check the storage
check zones of task lifetime storage and the storage accounting areas (SAAs)
of terminal storage for consistency.
Input parameters
- TASK_STORAGE
- specifies whether the storage check zones of task lifetime storage are
to be checked for the current task or all tasks, or is not to be checked.
It can have any one of these values:
NO|CURRENT_TASK|ALL_TASKS
- TP_STORAGE
- specifies whether the SAAs of terminal storage are to be checked for
the current terminal, or is not to be checked. It can have either of these
values:
NO|CURRENT_TERMINAL
Output parameters
- RESPONSE
- is the domain’s response to the call. It can have any of these
values:
OK|EXCEPTION|DISASTER|INVALID|KERNERROR|PURGED
- [REASON]
- is returned when RESPONSE is DISASTER. Possible values are:
RESPONSE |
Possible REASON values |
DISASTER |
ABEND
LOOP
STORAGE_VIOLATION
|
The RECOVER_STORAGE function of the SMCK gate is used to recover storage.
Input parameters
- TASK_STORAGE
- specifies whether or not the task lifetime storage for the current task
is to be recovered. It can have any one of these values:
NO|CURRENT_TASK
- TP_STORAGE
- specifies whether or not the SAAs of terminal storage for the current
terminal are to be recovered. It can have either of these values:
NO|CURRENT_TERMINAL
Output parameters
- RESPONSE
- is the domain’s response to the call. It can have any of these
values:
OK|EXCEPTION|DISASTER|INVALID|KERNERROR|PURGED
- [REASON]
- is returned when RESPONSE is DISASTER or EXCEPTION. Possible values
are:
RESPONSE |
Possible REASON values |
DISASTER |
ABEND
LOOP
|
EXCEPTION |
STORAGE_NOT_RECOVERED |
The GETMAIN function of the SMGF gate is used to allocate an element of
storage from a subpool.
Input parameters
Note:
Either STORAGE_CLASS or SUBPOOL_TOKEN, but not both, must
be specified.
- [REMARK]
- is an optional 8-character field that is used to identify the GETMAIN
operation for problem determination. This field is highlighted when the GETMAIN
trace is interpreted. Typically, it is the name of the control block whose
storage is being obtained.
- [STORAGE_CLASS]
- identifies the class of storage that is being allocated. It can have
any one of these values:
CICS|CICS24|USER|USER24|TASK|TASK24
- [SUBPOOL_TOKEN]
- is a token identifying the subpool within which the element is to be
allocated.
- [GET_LENGTH]
- is the length of the storage requested.
- SUSPEND
- If there is insufficient storage to satisfy the request, SUSPEND(YES)
causes the caller to be suspended until the request can be satisfied, and
SUSPEND(NO) causes REASON to be set to INSUFFICIENT_STORAGE. It can have either
of these values:
YES|NO
- [INITIAL_IMAGE]
- is an optional byte value to which every byte in the new element is
set.
Output parameters
- ADDRESS
- is the address of the new element.
- [ELEMENT_LENGTH]
- is the actual length of the new element (when it has been rounded up
to a multiple of the boundary for the subpool).
- RESPONSE
- is the domain’s response to the call. It can have any of these
values:
OK|EXCEPTION|DISASTER|INVALID|KERNERROR|PURGED
- [REASON]
- is returned when RESPONSE is DISASTER, EXCEPTION, or INVALID. Possible
values are:
RESPONSE |
Possible REASON values |
DISASTER |
ABEND
ACTIVATE_FAILURE
LOOP
|
EXCEPTION |
INSUFFICIENT_STORAGE |
INVALID |
INVALID_SUBPOOL_TOKEN
INVALID_GET_LENGTH
INVALID_STORAGE_CLASS
NO_GET_LENGTH
NOT_SUBPOOL_OWNER
INVALID_INITIAL_IMAGE
|
The FREEMAIN function of the SMGF gate is used to release an element of
storage within a subpool.
Input parameters
Note:
Either STORAGE_CLASS or SUBPOOL_TOKEN, but not both, must
be specified.
- [REMARK]
- is an optional 8-character field that is used to identify the FREEMAIN
operation for problem determination. This field is highlighted when the FREEMAIN
trace is interpreted. Typically, it is the name of the control block whose
storage is being released.
- [STORAGE_CLASS]
- identifies the class of storage that is being released. It can have
any one of these values:
CICS|CICS24|USER|USER24|TASK|TASK24
- [SUBPOOL_TOKEN]
- is a token identifying the subpool within which the element is to be
released.
- ADDRESS
- is the address of the element to be released.
- [FREE_LENGTH]
- is the length of the element to be released.
Output parameters
- RESPONSE
- is the domain’s response to the call. It can have any of these
values:
OK|EXCEPTION|DISASTER|INVALID|KERNERROR|PURGED
- [REASON]
- is returned when RESPONSE is DISASTER or INVALID. Possible values are:
RESPONSE |
Possible REASON values |
DISASTER |
ABEND
DEACTIVATE_FAILURE
LOOP
|
INVALID |
INVALID_SUBPOOL_TOKEN
INVALID_ADDRESS
INVALID_FREE_LENGTH
INVALID_STORAGE_CLASS
NO_FREE_LENGTH
NOT_SUBPOOL_OWNER
SUBPOOL_EMPTY
|
The INQUIRE_ELEMENT_LENGTH function of the SMGF gate is used to return
the length of an element of storage whose address is known.
Input parameters
Note:
Either STORAGE_CLASS or SUBPOOL_TOKEN, but not both, must
be specified.
- [STORAGE_CLASS]
- identifies the class of storage that is being inquired upon. It can
have any one of these values:
CICS|CICS24|USER|USER24|TASK|TASK24
- [SUBPOOL_TOKEN]
- is a token identifying the subpool within which the element has been
allocated.
- ADDRESS
- is the address of the element whose length is being inquired on.
Output parameters
- ELEMENT_LENGTH
- is the length of the element.
- RESPONSE
- is the domain’s response to the call. It can have any of these
values:
OK|EXCEPTION|DISASTER|INVALID|KERNERROR
- [REASON]
- is returned when RESPONSE is DISASTER, EXCEPTION, or INVALID. Possible
values are:
RESPONSE |
Possible REASON values |
DISASTER |
ABEND
LOOP
|
EXCEPTION |
ADDRESS_NOT_FOUND |
INVALID |
INVALID_STORAGE_CLASS
INVALID_SUBPOOL_TOKEN
|
The INQUIRE_ELEMENT_LENGTH function of the SMMC gate is used to obtain
the start address and length of the storage element that contains the address
that was specified on the input to the call. This function only searches the
current task’s task-lifetime storage for the required storage element.
Input parameters
- ADDRESS
- is the address to be searched for.
Output parameters
- ELEMENT_LENGTH
- is the length of the storage element that contains the input address.
- [ELEMENT_ADDRESS]
- is the start address of the element that contains the input address.
- RESPONSE
- is the domain’s response to the call. It can have any of these
values:
OK|EXCEPTION|DISASTER|INVALID|KERNERROR|PURGED
- [REASON]
- is returned when RESPONSE is DISASTER or EXCEPTION. Possible values
are:
RESPONSE |
Possible REASON values |
DISASTER |
ABEND
LOOP
|
EXCEPTION |
INVALID_ADDRESS |
The INQUIRE_TASK_STORAGE function of the SMMC gate is used to obtain details
of all the task-lifetime storage associated with the current task (if the
input parameter TRANSACTION_NUMBER is omitted from the call) or for the specified
task.
Input parameters
- [TRANSACTION_NUMBER]
- indicates the transaction that you wish to obtain storage details about.
If this parameter is omitted, the current task is assumed.
- ELEMENT_BUFFER
- is a buffer in which the storage manager lists the start addresses of
all the specified task’s task-lifetime storage.
- LENGTH_BUFFER
- is a buffer in which the storage manager lists the lengths of all the
specified task’s task-lifetime storage.
Output parameters
- NUMBER_OF_ELEMENTS
- is the number of elements in each buffer.
- RESPONSE
- is the domain’s response to the call. It can have any of these
values:
OK|EXCEPTION|DISASTER|INVALID|KERNERROR|PURGED
- [REASON]
- is returned when RESPONSE is DISASTER or EXCEPTION. Possible values
are:
RESPONSE |
Possible REASON values |
DISASTER |
ABEND
LOOP
|
EXCEPTION |
INSUFFICIENT_STORAGE
NO_TRANSACTION_ENVIRONMENT
|
The INITIALIZE function of the SMMC gate is used to perform macro-compatibility
interface initialization.
Input parameters
None.
Output parameters
- RESPONSE
- is the domain’s response to the call. It can have any of these
values:
OK|EXCEPTION|DISASTER|INVALID|KERNERROR|PURGED
- [REASON]
- is returned when RESPONSE is DISASTER. Possible values are:
RESPONSE |
Possible REASON values |
DISASTER |
ABEND
LOOP
|
The GETMAIN function of the SMMC gate is used to allocate an element of
storage.
Input parameters
- [REMARK]
- is an optional 8-character field that is used to identify the GETMAIN
operation for problem determination. This field is highlighted when the GETMAIN
trace is interpreted. Typically, it is the name of the control block whose
storage is being obtained.
- GET_LENGTH
- is the length of storage requested. For storage classes that have 8-byte SAAs,
the requested length excludes the lengths of the initial and duplicate SAAs.
However, for storage classes that have only a 4-byte SAA, the requested length
must include the length of the SAA.
- SUSPEND
- specifies whether the request is to be suspended if there is insufficient
storage to satisfy the request. It can have either of these values:
YES|NO
- [INITIAL_IMAGE]
- specifies a byte value to which the user’s part of the allocated
storage element is to be set.
- [TCTTE_ADDRESS]
- is an optional field that must be specified for GETMAIN requests for
the TERMINAL storage class.
- STORAGE_CLASS
- is the class of storage to be allocated. It can have any one of these
values:
TERMINAL24|CICS|SHARED_CICS|LINE|TERMINAL|
TASK|TASK24|CICS24_SAA|SHARED_CICS24_SAA|
CICS24|TRANSDATA|TEMPSTG|USER|USER24|
SHARED_CICS24|CONTROL|TACLE|SHARED_USER24|
SHARED_USER
- [CALLER]
- can have any one of these values:
EXEC|MACRO|SYSTEM
Output parameters
- ADDRESS
- is the address of the allocated storage.
- RESPONSE
- is the domain’s response to the call. It can have any of these
values:
OK|EXCEPTION|DISASTER|INVALID|KERNERROR|PURGED
- [REASON]
- is returned when RESPONSE is DISASTER, EXCEPTION or INVALID. Possible
values are:
RESPONSE |
Possible REASON values |
DISASTER |
ABEND
ACTIVATE_FAILURE
LOOP
|
EXCEPTION |
INSUFFICIENT_STORAGE
INVALID_GET_LENGTH
|
INVALID |
NO_TCTTE_ADDRESS
INVALID_STORAGE_CLASS
|
The FREEMAIN function of the SMMC gate is used to release an element of
storage.
Input parameters
- [REMARK]
- is an optional 8-character field that is used to identify the FREEMAIN
operation for problem determination. This field is highlighted when the FREEMAIN
trace is interpreted. Typically, it is the name of the control block whose
storage is being released.
- ADDRESS
- is the address of the storage to be freed.
- [TCTTE_ADDRESS]
- is an optional field that must be specified if the FREEMAIN is for storage
of a LINE or TERMINAL class.
- [STORAGE_CLASS]
- is an optional field specifying the class of storage that is being freed.
It can have any one of these values:
TERMINAL24|CICS|SHARED_CICS|LINE|TERMINAL|
TASK|TASK24|CICS24_SAA|SHARED_CICS24_SAA|
CICS24|TRANSDATA|TEMPSTG|USER|USER24|
SHARED_CICS24|CONTROL|TACLE|SHARED_USER24|
SHARED_USER
- [CALLER]
- can have any one of these values:
EXEC|MACRO|SYSTEM
- [EXEC_KEY]
- is the execution key of the program issuing the EXEC FREEMAIN request.
It can have either of these values:
CICS|USER
Output parameters
- RESPONSE
- is the domain’s response to the call. It can have any of these
values:
OK|EXCEPTION|DISASTER|INVALID|KERNERROR|PURGED
- [REASON]
- is returned when RESPONSE is DISASTER, EXCEPTION, or INVALID. Possible
values are:
RESPONSE |
Possible REASON values |
DISASTER |
ABEND
DEACTIVATE_FAILURE
LOOP
|
EXCEPTION |
INVALID_EXEC_KEY |
INVALID |
INVALID_ADDRESS
NO_TCTTE_ADDRESS
|
The FREEMAIN_ALL_TERMINAL function of the SMMC gate is used to release
all terminal storage.
Input parameters
- TCTTE_ADDRESS
- is the address of the TCTTE whose storage is to be freed.
Output parameters
- RESPONSE
- is the domain’s response to the call. It can have any of these
values:
OK|EXCEPTION|DISASTER|INVALID|KERNERROR|PURGED
- [REASON]
- is returned when RESPONSE is DISASTER. Possible values are:
RESPONSE |
Possible REASON values |
DISASTER |
ABEND
LOOP
|
The INQUIRE_ISOLATION_TOKEN function of the SMSR gate is used to return
an isolation token which can be used on SWITCH_SUBSPACE calls.
Input parameters
None.
Output parameters
- ISOLATION_TOKEN
- an isolation token which can be used on SWITCH_SUBSPACE calls.
- RESPONSE
- is the domain’s response to the call. It can have any of these
values:
OK|DISASTER|INVALID|KERNERROR
- [REASON]
- is returned when RESPONSE is DISASTER. Possible values are:
RESPONSE |
Possible REASON values |
DISASTER |
ABEND
LOOP
|
The INQUIRE_REENTRANT_PROGRAM function of the SMSR gate is used to return
whether the read-only DSAs, RDSA and ERDSA, have been allocated from read-only
key-0 protected storage or CICS-key storage, as set by the RENTPGM system initialization parameter.
Input parameters
None.
Output parameters
- RENTPGM
- indicates whether CICS has obtained the storage for the read-only DSAs
from key-0 non-fetch protected storage (PROTECT) or from CICS-key storage
(NOPROTECT). It can have either of these values:
PROTECT|NOPROTECT
- RESPONSE
- is the domain’s response to the call. It can have any of these
values:
OK|DISASTER|INVALID|KERNERROR
- [REASON]
- is returned when RESPONSE is DISASTER. Possible values are:
RESPONSE |
Possible REASON values |
DISASTER |
ABEND
LOOP
|
The INQUIRE_SHORT_ON_STORAGE function of the SMSR gate is used to return
whether or not CICS is currently short-on-storage.
Input parameters
None.
Output parameters
- SOS_BELOW_THE_LINE
- indicates whether or not CICS is short-on-storage below the 16MB line.
It can have either of these values:
YES|NO
- SOS_ABOVE_THE_LINE
- indicates whether or not CICS is short-on-storage above the 16MB line.
It can have either of these values:
YES|NO
- RESPONSE
- is the domain’s response to the call. It can have any of these
values:
OK|DISASTER|INVALID|KERNERROR
- [REASON]
- is returned when RESPONSE is DISASTER. Possible values are:
RESPONSE |
Possible REASON values |
DISASTER |
ABEND
LOOP
|
The INQUIRE_DSA_SIZE function of the SMSR gate is used to return the size
of the CICS DSAs.
Input parameters
- DSA_NAME
- is the name of the DSA whose size is being inquired on. It can have
any of these values:
CDSA|UDSA|SDSA|RDSA|ECDSA|EUDSA|ESDSA|ERDSA
Output parameters
- DSA_SIZE
- is the size of the DSA.
- RESPONSE
- is the domain’s response to the call. It can have any of these
values:
OK|DISASTER|INVALID|KERNERROR
- [REASON]
- is returned when RESPONSE is DISASTER. Possible values are:
RESPONSE |
Possible REASON values |
DISASTER |
ABEND
LOOP
|
The SET_STORAGE_RECOVERY function of the SMSR gate is used to set the storage
recovery option.
Input parameters
- RECOVERY
- is the value to which the storage recovery option is to be set. It can
have either of these values:
YES|NO
Output parameters
- RESPONSE
- is the domain’s response to the call. It can have any of these
values:
OK|DISASTER|INVALID|KERNERROR
- [REASON]
- is returned when RESPONSE is DISASTER. Possible values are:
RESPONSE |
Possible REASON values |
DISASTER |
ABEND
LOOP
|
The SET_TRANSACTION_ISOLATION function of the SMSR gate is used to set
whether or not you want transaction isolation in your CICS region. This value
is initially set by the TRANISO system initialization parameter.
Input parameters
- TRANSACTION_ISOLATION
- indicates whether or not transaction isolation is active in your CICS
region. It can have either of these values:
ACTIVE|INACTIVE
Output parameters
- RESPONSE
- is the domain’s response to the call. It can have any of these
values:
OK|DISASTER|INVALID|KERNERROR
- [REASON]
- is returned when RESPONSE is DISASTER. Possible values are:
RESPONSE |
Possible REASON values |
DISASTER |
ABEND
LOOP
|
The SWITCH_SUBSPACE function of the SMSR gate is used to change a task’s
subspace.
Input parameters
- SPACE
- indicates the type of subspace you wish this task to execute in. It
can have any of these the values:
BASESPACE|SUBSPACE|RESET_SPACE
- [ISOLATION_TOKEN]
- an isolation token which can be returned from an INQUIRE_ISOLATION_TOKEN
call.
- [TRANSACTION_TOKEN]
- a transaction manager token (which can be returned from an XMIQ INQUIRE_TRANSACTION_TOKEN
call) that represents the task whose subspace you wish to change.
- [WORK_REGISTER]
- a work register.
Output parameters
- RESPONSE
- is the domain’s response to the call. It can have any of these
values:
OK|DISASTER|INVALID|KERNERROR
- [REASON]
- is returned when RESPONSE is DISASTER. Possible values are:
RESPONSE |
Possible REASON values |
DISASTER |
ABEND
LOOP
|
The INQUIRE_DSA_LIMIT function of the SMSR gate is used to return the DSA
storage limits above (EDSA) and below (DSA) the 16MB line. These limits are
the maximum amounts of storage that CICS can use for all the DSAs above and below the 16MB line.
Input parameters
None.
Output parameters
- [DSA_LIMIT]
- indicates the DSA storage limit.
- [EDSA_LIMIT]
- indicates the EDSA storage limit.
- RESPONSE
- is the domain’s response to the call. It can have any of these
values:
OK|DISASTER|INVALID|KERNERROR
- [REASON]
- is returned when RESPONSE is DISASTER. Possible values are:
RESPONSE |
Possible REASON values |
DISASTER |
ABEND
LOOP
|
The SET_DSA_LIMIT function of the SMSR gate is used to set the DSA storage
limits above (EDSA) and below (DSA) the 16MB line. These limits are the maximum
amounts of storage that CICS can use for all the DSAs
above and below the 16MB line.
Input parameters
- [DSA_LIMIT]
- indicates the DSA storage limit required.
- [EDSA_LIMIT]
- indicates the EDSA storage limit required.
Output parameters
- RESPONSE
- is the domain’s response to the call. It can have any of these
values:
OK|DISASTER|INVALID|KERNERROR
- [REASON]
- is returned when RESPONSE is DISASTER or EXCEPTION. Possible values
are:
RESPONSE |
Possible REASON values |
DISASTER |
ABEND
LOOP
|
EXCEPTION |
INSUFFICIENT_STORAGE
INVALID_DSA_LIMIT
|
The SET_STORAGE_PROTECT function of the SMSR gate is used to set the storage
protection option.
Input parameters
- STORAGE_PROTECT
- can have either of these values:
YES|NO
Output parameters
- RESPONSE
- is the domain’s response to the call. It can have any of these
values:
OK|EXCEPTION|DISASTER|INVALID|KERNERROR
- [REASON]
- is returned when RESPONSE is DISASTER or EXCEPTION. Possible values
are:
RESPONSE |
Possible REASON values |
DISASTER |
ABEND
LOOP
|
EXCEPTION |
NO_HARDWARE_SUPPORT
|
The INQUIRE_STORAGE_PROTECT function of the SMSR gate is used to return
the current value of the storage protection option.
Input parameters
None.
Output parameters
- STORAGE_PROTECT
- is the current storage protection mode. It can have either of these
values:
YES|NO
- RESPONSE
- is the domain’s response to the call. It can have any of these
values:
OK|DISASTER|INVALID|KERNERROR
- [REASON]
- is returned when RESPONSE is DISASTER. Possible values are:
RESPONSE |
Possible REASON values |
DISASTER |
ABEND
LOOP
|
The INQUIRE_ACCESS function of the SMSR gate is used to return the access
key of an element of storage.
Input parameters
- [ACCESS_TOKEN]
- is the access token for the element of storage (returned by the INQUIRE_ACCESS_TOKEN
function).
- ELEMENT_ADDRESS
- is the start address of the storage element.
- ELEMENT_LENGTH
- is the length of the storage element.
Output parameters
- ACCESS
- is the type of access for the storage element. It can have any of these
values:
CICS|USER|READ_ONLY
- [DSA_NAME]
- is the name of the DSA in which the storage element resides.
- [DSA_EXTENT_START]
- indicates the start address of the DSA extent that contains the input
address.
- [DSA_EXTENT_END]
- indicates the end address of the DSA extent that contains the input
address.
- RESPONSE
- is the domain’s response to the call. It can have any of these
values:
OK|EXCEPTION|DISASTER|INVALID|KERNERROR
- [REASON]
- is returned when RESPONSE is DISASTER or EXCEPTION. Possible values
are:
RESPONSE |
Possible REASON values |
DISASTER |
ABEND
LOOP
|
EXCEPTION |
INVALID_ELEMENT |
The SET_REENTRANT_PROGRAM function of the SMSR gate is used to set the
reentrant program option for the RDSA and the ERDSA.
Input parameters
- REENTRANT_PROGRAM
- is the reentrant program option for the RDSA and the ERDSA. It can have
either of these values:
PROTECT|NOPROTECT
Output parameters
- RESPONSE
- is the domain’s response to the call. It can have any of these
values:
OK|EXCEPTION|DISASTER|INVALID|KERNERROR
- [REASON]
- is returned when RESPONSE is DISASTER. Possible values are:
RESPONSE |
Possible REASON values |
DISASTER |
ABEND
LOOP
|
The INQUIRE_ACCESS_TOKEN function of the SMSR gate is used to return the
access token for a storage element.
Input parameters
None.
Output parameters
- ACCESS_TOKEN
- is the access token for the storage element.
- RESPONSE
- is the domain’s response to the call. It can have any of these
values:
OK|EXCEPTION|DISASTER|INVALID|KERNERROR
- [REASON]
- is returned when RESPONSE is DISASTER. Possible values are:
RESPONSE |
Possible REASON values |
DISASTER |
ABEND
LOOP
|
The UPDATE_SUBSPACE_TCB_INFO function informs SM of the deletion of open
TCBs which are associated with subspaces.
Input parameters
- SUBSPACE_TOKEN
- indicates the subspace which is associated with the deleted TCBs.
- OPEN_TCBS_DELETED
- is a 32-bit string indicating the mode(s) of deleted TCB(s).
Output parameters
- RESPONSE
- is the domain’s response to the call. It can have any of these
values:
OK|DISASTER|INVALID|KERNERROR
[[ Contents Previous Page | Next Page Index ]]