Set_Persistent_Interest_Data (ATRSPID, ATR4SPID)

ATRSPID is for AMODE(31) callers.
ATR4SPID is for AMODE(64) callers and allows parameters in 64 bit addressable storage.

A resource manager calls the Set_Persistent_Interest_Data service to provide persistent interest data for a protected interest in a unit of recovery (UR). In response to the call, RRS returns a return code.

Note: Set_Persistent_Interest_Data can be used for an interest in a UR in local transaction mode, but the data will not be logged.

The call can also be used to delete existing persistent interest data.

Persistent Interest Data: When it hardens information for the interest in an RRS log, RRS records the persistent interest data. Because the data is hardened, it will be available if your resource manager restarts or if RRS restarts, forcing your resource manager to restart.

Your resource manager can also provide persistent interest data in a call to the following services: Express_UR_Interest, Change_Interest_Type, or Retain_Interest. Your resource manager can retrieve persistent interest data in a call to the Retrieve_UR_Interest service or the Retrieve_UR_Data service.

Environment

The requirements for the caller are:

Minimum authorization:

PKM allowing key 0-7, or supervisor state

Dispatchable unit mode:

Task or SRB

Cross memory mode:

Any PASN, any HASN, any SASN

AMODE:

31 bit (ATRSPID)
64 bit (ATR4SPID)

ASC mode:

Primary or access register (AR)

Interrupt status:

Enabled for I/O and external interrupts

Locks:

No locks held

Control parameters:

Control parameters must be in the primary address space and addressable by the caller.

Linkage:

MVS™ standard linkage conventions are used.

Programming requirements

Either link edit your object code with the linkable stub routine ATRRCSS (31 bit) or ATRR4CSS (64 bit) from SYS1.CSSLIB, or LOAD and CALL the callable service. The high level language (HLL) definitions for the callable service are:

HLL definition	Description
ATRRASM	390 Assembler declarations
ATRRC	C/390 declarations

Restrictions

The state of the resource manager associated with the specified UR interest token must be run, which means it has registered, set its exit routines with RRS, and completed restart.

Input register information

Before issuing the call, the caller does not have to place any information into any register unless using it in register notation for the parameters, or using it as a base register.

Output register information

When control returns to the caller, the GPRs contain:.

Register: Contents
0-1: Used as work registers by the system
2-13: Unchanged
14: Used as a work register by the system
15: Return code

When control returns to the caller, the ARs contain:.

Register: Contents
0-1: Used as work registers by the system
2-13: Unchanged
14-15: Used as work registers by the system

Some callers depend on register contents remaining the same before and after issuing a call. If the system changes the contents of registers on which the caller depends, the caller must save them before calling the service, and restore them after the system returns control.

Performance implications

None.

Syntax

Write the call as shown in the syntax diagram. You must code the parameters in the CALL statement as shown.

CALL ATRSPID

(return_code
,ur_interest_token
,persistent_interest_data_length
,persistent_interest_data)

CALL ATR4SPID

(return_code
,ur_interest_token
,persistent_interest_data_length
,persistent_interest_data)

Parameters

The parameters are explained as follows:

return_code

Returned parameter

Type: Integer
Length: 4 bytes

Contains the return code from the Set_Persistent_Interest_Data service.

,ur_interest_token

Supplied parameter

Type: Character string
Character Set: No restriction
Length: 16 bytes

Specifies the UR interest token that identifies your resource manager's interest in the UR. Your resource manager received the token from the Express_UR_Interest service or the Retain_Interest service.

,persistent_interest_data_length

Supplied parameter

Type: Integer
Length: 4 bytes

Specifies, in hexadecimal, the length of the persistent interest data. The length can be from X'0' to X'1000' (0 - 4096) bytes. The maximum amount of data that can be logged for a particular UR is 60K (61440) bytes, which includes the persistent data and all other data that RRS must log for the UR.

If the call specifies a length of zero, RRS deletes the persistent interest data for the interest.

,persistent_interest_data

Supplied parameter

Type: Character string
Character Set: No restriction
Length: Specified in persistent_interest_data_length

Specifies the persistent interest data you want to set for your resource manager's interest.

ABEND codes

The call might result in an abend X'5C4' with a reason code of either X'00100000' or X'00100001'. See z/OS MVS System Codes for the explanations and actions.

Return codes

When the service returns control to the resource manager, GPR 15 and return_code contain a hexadecimal return code.

Return Code in: Hexadecimal Equate Symbol	Meaning and action
0 ATR_OK	Meaning: Successful completion. Action: None.
103 ATR_INTERRUPT_STATUS_INV	Meaning: Program error. The resource manager is disabled; the interrupt status must be enabled for I/O and external interrupts. The system rejects the service call. Action: Check the resource manager for a probable coding error. Correct the resource manager and rerun it.
105 ATR_LOCKS_HELD	Meaning: Program error. The resource manager is holding one or more locks; no locks must be held. The system rejects the service call. Action: Check the resource manager for a probable coding error. Correct the resource manager and rerun it.
107 ATR_UNSUPPORTED_RELEASE	Meaning: Environmental error. The system release does not support this service. The system rejects the service call. Action: Remove the resource manager from the system, and install it on a system that supports RRS. Then rerun the resource manager.
370 ATR_URI_TOKEN_INV	Meaning: Program error. The UR interest token specified in the call is not one of the currently valid interests. The system rejects the service call. Action: Check the resource manager for a probable coding error. Correct the resource manager and rerun it.
376 ATR_PERSISTENT_DATA_LEN_INV	Meaning: Program error. The length specified in the persistent_interest_data_len parameter in the call is not valid. The system rejects the service call. Action: Check the resource manager for a probable coding error. Correct the resource manager and rerun it.
701 ATR_RM_STATE_ERROR	Meaning: Program error. The resource manager associated with the UR interest token specified in the call is not in a valid state to issue the service call. The resource manager state must be run. The system rejects the service call. Action: Check the resource manager for a probable coding error. Correct the resource manager and rerun it.
702 ATR_RM_EXITS_UNSET	Meaning: Program error. RRS has unset the RRS exit routines for the resource manager. The system rejects the service call. Action: Check the resource manager for a probable coding error. Correct the resource manager and rerun it.
730 ATR_NOT_PROTECTED_INTEREST	Meaning: Program error. The UR interest token does not represent a protected interest. The system rejects the service call. Action: Check the resource manager for a probable coding error. Correct the resource manager and rerun it.
749 ATR_MAX_UR_LOG_DATA_ EXCEEDED	Meaning: Environmental error. This request will exceed the maximum amount of data that RRS can log for a UR. The system rejects the service call. Action: Fail the client program request or back out the UR. Verify that the space set up for logging is adequate.
F00 ATR_NOT_AVAILABLE	Meaning: RRS is not available. Action: The system rejects the service request. Retry the request later. Before retrying the request, the resource manager must reset its RRS exit routine information and begin restart processing with RRS.
F06 ATR_WAS_NOT_AVAILABLE	Meaning: RRS was available to the resource manager, but went down and came back up again. A commit or backout operation may or may not have been in progress for the context under which the Set_Persistent_Interest_Data was done at the time of the RRS failure. A new unit of recovery can not be created until the current unit of recovery is completed. Action: The system rejects the service request. Restart your resource manager, making sure to reset the resource manager's exit routines with RRS. The resource manager must inform the application that one of the following actions must be taken to complete the current unit of recovery: If a commit or backout request was not active at the time of the RRS failure, a commit or backout must be requested before a new unit of recovery can begin. If a commit or backout request was active at the time of the RRS failure, the context must be ended, via the CTXENDC service, before a new unit of recovery can begin.
FFF ATR_UNEXPECTED_ERROR	Meaning: System error. The service that was called encountered an unexpected error. The system rejects the service call. Action: Search problem reporting databases for a fix for the problem. If no fix exists, contact the IBM® Support Center.

Example

In the pseudocode example, the resource manager issues a call to provide persistent interest data.

⋮
URI_TOKEN = MY_URI_TOKEN
P_DATA_LEN = LENGTH(MY_P_DATA)
P_DATA = MY_P_DATA
CALL ATRSPID(RC,URI_TOKEN,P_DATA_LEN,P_DATA)
IF RC ≠ ATR_OK THEN
   /* Handle error */
⋮