Syntax
SEGDATA File Syntax shows the syntax of the SEGDATA file.
The tags and data in the SEGDATA file are defined as follows:
- :OBJNAME.
- indicates the start of a saved segment definition.
- segname
- is the name of the saved segment.
- :DEFPARMS.
- indicates the storage range and other information that the VMFBLD
EXEC specifies on the DEFSEG command to define the saved segment to
CP.
- hexpage
- is the hexadecimal address of a page in storage.
- type
- is a page descriptor code that indicates the type of virtual machine access that is permitted to the page range.
- defseg_parms
- are optional DEFSEG command operands. The following operands are
permitted: LOADNSHR, RSTD, and SECURE. Note: The SPACE operand is not specified on this tag. Segment spaces are identified on the :SPACE tag.
- DELETED
- indicates the saved segment is to be deleted. No DEFSEG command
is issued. Note: If any DEFSEG data is specified in this field, it is saved in the SEGDATA file following the DELETED keyword.
- :SPACE.
- lists the segment spaces in which the saved segment is a member.
Note: The VMFBLD EXEC uses the first name listed on this tag as the primary segment space when issuing the DEFSEG command for the member.
- spacename
- is the name of a segment space.
- :TYPE.
- indicates whether the saved segment contains CMS logical saved
segments.
- SEG
- indicates the saved segment does not contain logical saved segments. One set of build parameters is allowed on the :BLDPARMS tag.
- PSEG
- indicates the saved segment is a physical saved segment that contains logical saved segments. Multiple sets of build parameters are allowed on the :BLDPARMS tag, each set defining one or more logical saved segments.
- :OBJDESC.
- provides a description of the saved segment.
- objdesc
- is free-format text that describes the saved segment.
- :OBJINFO.
- provides special installation information.
- objinfo
- is free-format text that describes any special requirements for installing the saved segment. This field is informational; its content does not affect the generation of the saved segment.
- :GT_16MB.
- indicates whether the saved segment can be loaded above the 16MB
line.
- YES
- the saved segment can be loaded above 16MB. Note: This does not mean that the range specified on the :DEFPARMS tag actually defines the saved segment above 16MB, only that it can.
- NO
- the saved segment cannot be loaded above 16MB. The range specified on the :DEFPARMS tag must be less than 16MB.
- :DISKS.
- lists the minidisks and SFS directories to be accessed by the
VMFBLD EXEC when building the saved segment. Note: If 'PPF' is specified on the :BLDPARMS tag, the minidisks and directories specified on this tag are accessed before the minidisks and directories defined in the product parameter file. If 'UNKNOWN' is specified on the :BLDPARMS tag, the minidisks and directories specified on this tag are not accessed.
- vdev
- is a minidisk virtual device number.
- dirname
- is a fully qualified SFS directory name.
- :SEGREQ.
- lists the saved segments that must be built before this saved
segment is built. Note: All requisite saved segments must be defined in the same system saved segment build list and SEGDATA file as this saved segment.
- reqsegname
- is the name of a requisite saved segment.
- :PRODID.
- identifies the PRODPART file that contains the default definition
for the saved segment.
- prodid
- is the 7-8 character alphanumeric identifier assigned to the product.
- compname
- is the 1-16 character component name. The component name is necessary only if the PRODPART file contains saved segment definitions for more than one component.
- :BLDPARMS.
- identifies the parameters the VMFBLD EXEC uses to build the saved
segment.
If 'PSEG' is specified on the :TYPE tag, the VMFBLD EXEC creates a physical segment definition file (segname PSEG) that contains the logical segment records, then issues the SEGGEN command to build the physical and logical saved segments. Multiple sets of build parameters (for VMSES/E and non-VMSES/E products) can be specified on this tag to identify the logical saved segments to include in the physical saved segment.
- UNKNOWN
- indicates a build function for this saved segment cannot be issued by the VMFBLD EXEC. This forces VMFBLD to issue only the DEFSEG command to define the saved segment to CP. After VMFBLD has completed, the user must issue the function that actually loads and saves the saved segment. This is the default.
- PPF
- indicates the build parameters are defined in the specified product parameter file and build list. Depending on the build list option specified (ACCESS, LINK, or NOACCESS), VMFSETUP might be called to link and access the disks specified in the product parameter file for the product when the segment is built.
- ppfname
- is the name of the product parameter file.
- compname
- is the name of the component section in the product parameter file.
- bldlist
- is the name of the product saved segment build list.
- PROD
- indicates the build parameters are not specified in a product parameter file. The VMFBLD EXEC uses the parameters specified on this tag to build the saved segment (after issuing the DEFSEG command to define the saved segment to CP).
- LSEGment
- identifies a logical segment definition file, which defines a
CMS logical saved segment to include in the physical saved segment.
Note: 'PSEG' must be specified on the :TYPE tag.
- lfn
- is the file name of the logical segment definition file.
- lft
- is the file type of the logical segment definition file. If the
file type is not specified here, the SEGGEN command uses a default
of LSEG. Note: PROFILE and EPIFILE are not valid as the file type of the logical segment definition file.
- lfm
- is the file mode of the logical segment definition file. If the file mode is not specified here, the SEGGEN command uses a default of *.
- PROFILE
- indicates a routine is to be run before information is loaded into the logical saved segment.
- profn
- is the file name of the profile routine.
- EPIFILE
- indicates a routine is to be run after information is loaded into the logical saved segment.
- epifn
- is the file name of the epifile routine.
- loadfunc
- is the name of the routine the VMFBLD EXEC calls to load and save the saved segment.
- loadparm
- is a parameter to be passed to the loadfunc routine.
The following built-in variables are also available to indicate data to be passed to the loadfunc routine. When the saved segment is built, the VMFBLD EXEC resolves the variables as indicated:
- &RANGE
- Gets the hexadecimal page ranges, page descriptor codes, and optional DEFSEG operands from the :DEFPARMS tag
- &SPACE
- Gets the primary segment space name from the :SPACE tag
- &ORIGIN
- Gets the starting load address from the :DEFPARMS tag
- &SEGNAME
- Gets the name from the :OBJNAME tag
- LOADSAVE
- indicates the VMFBLD EXEC calls the built-in LOADSAVE function, which issues the LOADMOD command to load a specified relocatable module. LOADSAVE then issues the SAVESEG command to save the module as a saved segment.
- modfn
- is the file name of the relocatable module. The file type must be MODULE.
- SAVEONLY
- indicates the VMFBLD EXEC calls the built-in SAVEONLY function, which issues only the SAVESEG command.
- ORIGIN
- specifies a load address for the module.
- hexloc
- is the hexadecimal storage address where the module is to be loaded.
Note: If the built-in variable &ORIGIN is specified, the VMFBLD EXEC resolves the variable to get the load address from the :DEFPARMS tag. If an actual load address is specified, it must be within the range defined on the :DEFPARMS tag.