z/OS DFSMSdfp Advanced Services
Previous topic | Next topic | Contents | Contact z/OS | Library | PDF


LSPACE–DSECT Form

z/OS DFSMSdfp Advanced Services
SC23-6861-01

The format of the DSECT form of the LSPACE macro is:

Read syntax diagramSkip visual syntax diagram
>>-+-------+--LSPACE--MF=-+-D-----------+----------------------->
   '-label-'              +-(D,MSG)-----+   
                          +-(D,EXPMSG)--+   
                          +-(D,XEXPMSG)-+   
                          +-(D,DATA)----+   
                          '-(D,EXPDATA)-'   

>--+-------------------------+---------------------------------><
   '-,PLISTVER=-+-plistver-+-'   
                '-MAX------'     

MF=D or (D,MSG) or (D,EXPMSG) or (D,XEXPMSG) or (D,DATA) or (D,EXPDATA)
Specifies the DSECT form of the LSPACE macro.
D
Generates a DSECT that maps the LSPACE parameter list. No other parameters are allowed. See Table 1 for the format of the LSPACE parameter list.
(D,MSG)
Generates a DSECT that maps the message return area. No other parameters are allowed. For the format of the area, see Message Return Area.
(D,EXPMSG)
Generates a DSECT that maps the expanded message return area. No other parameters are allowed. For the format of the area, see Expanded Message Return Area.
(D,XEXPMSG)
Generates a DSECT that maps the extended expanded message return area (95-bytes). No other parameters are allowed. Use this keyword to obtain the message data area for all volume sizes including ones with cylinder-managed space. For the format of the area, see Expanded Message Return Area.
(D,DATA)
Generates a DSECT that maps the data return area. No other parameters are allowed. For the format of the area, see Data Return Area.
(D,EXPDATA)
Generates a DSECT that maps the base and expanded data return area. No other parameters are allowed. Use the keyword to obtain the data area for all volume sizes including ones with cylinder-managed space. For the format of the area, see Data Return Area.
PLISTVER=plistver | MAX
This keyword defines the version of the LSPACE parameter list that should be generated for the MF=D form of the LSPACE macro.
PLISTVER=plistver specifies the version of the LSPACE parameter list that should be generated, where plistver is either 1 or 2.This PLISTVER= keyword is required for any macro keys associated with version 2 or larger to be specified, The macro keys associated with each supported version of the macro are listed below:
PLISTVER=1
PLISTVER=1 is associated with the following macro keys:
  • DATA
  • EXPMSG
  • F4DSCB
  • MSG
  • SMF
PLISTVER=2
PLISTVER=2 is associated with the following macro keys:
  • XEXPMSG
  • EXPDATA
  • DATATYPE

When PLISTVER= MAX is specified, the generated parameter list is the largest size currently supported. This size may grow from release to release thus possibly affecting the amount of storage needed by your program. If your program can tolerate this, IBM® recommends that you always specify MAX when creating the list form parameter list as that will ensure that the list form parameter list is always long enough to hold whatever parameters might be specified on the execute form.

When PLISTVER is omitted, the default is the lowest version of the parameter list mapping.

Table 1. Format of the LSPACE Parameter List (MF=D)
Name Offset Bytes Description
LSPAPL      
LSPAPLID 0(X'00') 4 EBCDIC 'LSPA'.
LSPANGTH 4(X'04') 2 Length of parameter list.
LSPAFLAG 6(X'06') 1 Parameter flag byte.
LSPASMFY   10 . . . . . . SMF=YES.
LSPASMFT   01 . . . . . . SMF=TEST.
LSPADATA   . . 1 0 0 . . . Free space data request.
LSPAMSG   . . 0 1 0 . . . Message data returned.
LSPAEMSG   . . 0 0 1 . . . Expanded message data requested.
LSPAEPLP   . . 0 0 0 1 . . Expanded LSPACE parameter input list provided
LSPAXINF   . . 0 0 0 0 1 . Set on when expanded data (EXPDATA) or extended expanded message (XEXPMSG) information is returned by LSPACE processing. Systems prior to z/OS® V1R10 do not set this flag. A program assembled (on a z/OS V1R10 or later system) with the LSPACE macro using the extended EXPMSG information respectively when the program is run on a system prior to z/OS V1R10.
LSPAFRES   . . . . . . . x Reserved.
LSPAXTIM 7(X'07') 1 Input/output (I/O) timeout value in seconds for first LSPACE channel program (default: 240 seconds)
LSPAERCD 8(X'08') 1 LSPACE return code. See Figure 1.
LSPASFID 9(X'09') 1 LSPACE subfunction code to further describe the LSPACE result.
LSPASFPC   X'00' Processing complete.
LSPASFVP   X'01' Validate parameters.
LSPASFUS   X'02' Check UCB status.
LSPASFNQ   X'03' ENQ on SYSZDMNT.
LSPASF45   X'04' Read F4 and first F5 DSCB (EXCP).
LSPASFN5   X'05' Read next F5 DSCB (EXCP).
LSPASFRV   X'06' Read volume label (EXCP).
LSPASF07   X'07' Read volume label with Timeout.
LSPASF4X   X'80' Read F4 and maps (CVAFDIR).
LSPASFEX   X'81' Get free extents (CVAFDSM).
LSPASFF0   X'82' Get F0 count (CVAFDSM).
LSPASFVR   X'83' Get VIR count (CVAFDSM).
LSPASFVD   X'84' Check for VRF (CVAFVRF).
LSPASF85   X'85' ESTAE routine entered. Processing error in LSPACE.
LSPASF86   X'86' LSPACE STIMERM timeout
LSPASFRT 10(X'0A') 1 Subfunction return code.
LSPASFRS 11(X'0B') 1 Subfunction reason code.
LSPARS01   X'01' Invalid parameter list storage key.
LSPARS02   X'02' Invalid parameter list ID.
LSPARS03   X'03' Invalid LSPACE flag.
LSPARS04   X'04' Invalid authorization for System Management Facility (SMF) flag.
LSPARS05   X'05' Invalid message or data return area storage key.
LSPARS06   X'06' Invalid format-4 DSCB return area storage key.
LSPARS07   X'07' Invalid UCB address.
LSPARS08   X'08' Invalid virtual UCB address.
LSPARS09   X'09' Invalid VTOC pointer (UCBVTOC). Either UCBVTOC is zero, or it does not match the volume label.
LSPARS0B   X'0B' ESTAE return code nonzero
LSPAUCB 12(X'0C') 4 UCB address.
LSPAFRSP 16(X'10') 4 Address of message or data return area.
LSPAFMT4 20(X'14') 4 Address of format-4 DSCB.
LSPAEXPL 24 (X'18') 24 Expanded parm list area
LSPAFLAG2 1 Parameter flag byte 2
LSPAXMSG 1... .... Extended expanded message area requested (XEXPMSG)
LSPAEDAT .1.. .... Expanded output data area requested (EXPDATA)
* ..x. .... Unused
The next five flags pertain to the DATATYPE keyword values.:
LSPAFRSI ...1 .... Volume is specified. the return of volume free space information is requested
LSPAFRVT .... 1... Vtoc is specified. the return of vtoc free space information is requested
LSPAFRVX .... .1.. Index is specified. the return of index free space information is requested
LSPAFRFI .... ..1. Fragindex is specified. the return of the fragmentation index is requested
LSPAFALL .... ...1 All is specified or defaulted. the return of all free space information is requested, including the frag index
LSPARES2 25 (X'19') 3 Reserved
LSPARES3 26 (X'1A') 20 Reserved

Go to the previous page Go to the next page




Copyright IBM Corporation 1990, 2014