REQUEST=SHAREMEMOBJ option of IARV64

The requirements for the caller are:

None.

This macro supports multiple versions. Some keywords are unique to certain versions. See PLISTVER parameter description.

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

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

None

The REQUEST=SHAREMEMOBJ option of the IARV64 macro is written as follows:

The parameters are explained as follows:

name

An optional symbol, starting in column 1, that is the name on the IARV64 macro invocation. The name must conform to the rules for an ordinary assembler language symbol.

REQUEST=SHAREMEMOBJ

REQUEST=SHAREMEMOBJ requests that the caller wants to be given shared access to the specified memory object. The memory object specified must be a SHARED memory object, such as the result of a GETSHARED invocation.

,USERTKN=usertkn

A required doubleword input parameter that identifies the user token to be associated with the memory object. This can be used on a later DETACH request to free all memory objects associated with this value.

To avoid inadvertent collisions in the values specified, the left word (bits 0-31) should represent an address of some storage related to the caller. The system enforces the rule that the left word is non-zero for authorized callers. The right word should represent the virtual address of some storage related to the caller, which could be a control block address, an entry point address, etc.; the choice of which to use is made by the application.

To code: Specify the RS-type address, or address in register (2)-(12), of a required doubleword field that identifies the user token to be associated with the shared memory object.

,RANGLIST=ranglist

A required input parameter. The range list consists of a number of entries (as specified by NUMRANGE) where each entry is 16 bytes long. A description of the fields in each entry follows:

VSA

VSA denotes the starting address of the data to be acted on. The virtual address must be within a memory object returned by GETSHARED (not GETSTOR or GETCOMMON).

The length of this field is 8 bytes.

RESERVED

Reserved for future use, must be in binary zeros.

The length of this field is 8 bytes.

To code: Specify the RS-type address, or address in register (2)-(12), of an eight-byte pointer field.

,NUMRANGE=numrange

,NUMRANGE=1

An optional input parameter that specifies the number of entries in the supplied range list. The value specified must be no greater than 16. The default is 1.

To code: Specify the RS-type address, or address in register (2)-(12), of a fullword field.

,ALETVALUE=aletvalue

,ALETVALUE=0

An optional input parameter that indicates the ALET of the address space that will be given access to the shared memory object.

The only supported values are 0 (primary) and 2 (home). The ALETVALUE parameter can be used only by callers running in supervisor state or with PSW key 0-7. The default is 0.

To code: Specify the RS-type address, or address in register (2)-(12), of a fullword field.

,SVCDUMPRGN=YES

,SVCDUMPRGN=NO

An optional parameter that specifies whether the memory object should be included in an SVC dump when region is requested. The default is SVCDUMPRGN=YES.

,SVCDUMPRGN=YES

The memory object should be included in an SVC dump when RGN is specified on SDATA.

,DUMPPRIORITY=dumppriority

The name of an optional one-byte integer input parameter that specifies the dump priority of the memory object. This must be a non-zero value in the range of 1-99, with 1 being the highest priority and 99 being the lowest. The default value is 99.

,SVCDUMPRGN=NO

The memory object should not be included in an SVC dump when RGN is specified on SDATA.

,COND=NO

,COND=YES

An optional keyword input that specifies whether the request is unconditional or conditional. When you code COND=YES and there is insufficient storage to satisfy the request, instead of the request being abnormally ended the request will complete but a return code will be set to indicate that the request could not be completed successfully. In all cases the request will be abnormally ended for invalid requests, including violation of environmental restrictions. The default is COND=NO.

,COND=NO

The request is unconditional. The request will be abnormally ended when the request cannot be satisfied.

,COND=YES

The request is conditional. The request will not be abnormally ended for resource unavailability.

,RETCODE=retcode

An optional output parameter into which the return code is to be copied from GPR 15.

To code: Specify the RS-type address of a fullword field, or register (2)-(12).

,RSNCODE=rsncode

An optional output parameter into which the reason code is to be copied from GPR 0.

To code: Specify the RS-type address of a fullword field, or register (2)-(12).

,PLISTVER=IMPLIED_VERSION

,PLISTVER=MAX

,PLISTVER=0, 1, 2, 3 or 4

An optional input parameter that specifies the version of the macro. PLISTVER determines which parameter list the system generates. PLISTVER is an optional input parameter on all forms of the macro, including the list form. When using PLISTVER, specify it on all macro forms used for a request and with the same value on all of the macro forms. The values are:

• IMPLIED_VERSION, which is the lowest version that allows all parameters specified on the request to be processed. If you omit the PLISTVER parameter, IMPLIED_VERSION is the default.
• MAX, if you want the parameter list to be the largest size currently possible. This size might grow from release to release and affect the amount of storage that your program needs.

  If you can tolerate the size change, IBM® recommends that you always specify PLISTVER=MAX on the list form of the macro. Specifying MAX ensures that the list-form parameter list is always long enough to hold all the parameters you might specify on the execute form, when both are assembled with the same level of the system. In this way, MAX ensures that the parameter list does not overwrite nearby storage.

• 0, supports all parameters except those specifically referenced in higher versions.
• 1, supports both the following parameters and parameters from version 0:
  • CONVERTSIZE64
  • CONVERTSTART
  • GUARDSIZE64
  • V64SHARED
• 2, supports both the following parameters and parameters from version 0 and 1:
  • AMOUNTSIZE
  • DETACHFIXED
  • DOAUTHCHECKS
  • DUMP
  • DUMPPRIORITY
  • DUMPPROTOCOL
  • LOCALSYSAREA
  • MEMLIMIT
  • OPTIONVALUE
  • ORDER
  • OWNERASID
  • OWNERCOM
  • TYPE
  • UNLOCKED
  • USERTOKEN
  • V64COMMON
• 3, supports both the following parameters and parameters from versions 0, 1, 2:
  • ATTRIBUTE
  • OWNERJOBNAME
  • TRACKINFO
• 4, supports both the following parameter and parameters from versions 0, 1, 2, 3:
  • DMAPAGETABLE

To code: Specify one of the following:

• IMPLIED_VERSION
• MAX
• A decimal value of 0, 1, 2, 3 or 4

,MF=S

,MF=(L,list addr)

,MF=(L,list addr,attr)

,MF=(L,list addr,0D)

,MF=(E,list addr)

,MF=(E,list addr,COMPLETE)

An optional input parameter that specifies the macro form.

Use MF=S to specify the standard form of the macro, which builds an inline parameter list and generates the macro invocation to transfer control to the service. MF=S is the default.

Use MF=L to specify the list form of the macro. Use the list form together with the execute form of the macro for applications that require reentrant code. The list form defines an area of storage that the execute form uses to store the parameters. Only the PLISTVER parameter may be coded with the list form of the macro.

Use MF=E to specify the execute form of the macro. Use the execute form together with the list form of the macro for applications that require reentrant code. The execute form of the macro stores the parameters into the storage area defined by the list form, and generates the macro invocation to transfer control to the service.

,list addr

The name of a storage area to contain the parameters. For MF=S and MF=E, this can be an RS-type address or an address in register (1)-(12).

,attr

An optional 1- to 60-character input string that you use to force boundary alignment of the parameter list. Use a value of 0F to force the parameter list to a word boundary, or 0D to force the parameter list to a doubleword boundary. If you do not code attr, the system provides a value of 0D.

,COMPLETE

Specifies that the system is to check for required parameters and supply defaults for omitted optional parameters.