Built-in number for MATBPGM is 109.
MATBPGM (
         materialization_request_template         : address
         bound_program_or_bound_service_program   : address of system pointer
)

Number of bytes provided

This is the size in bytes of the materialization request template. If this size does not correspond to the actual number of bytes in the materialization request template, then a template value invalid  (hex 3801) exception will be signaled. This does not include any storage for returned data. That storage is pointed to by the receiver values.

Number of materialization requests

The number of requests in the array of materialization requests is specified by this value. If this number is greater than the actual number of materialization requests provided, then a template value invalid  (hex 3801) exception will be signaled.

Materialization requests

This is an array of materialization requests. A materialization request consists of one or more bits, and an optional module number specified to be materialized into the corresponding receiver. Each materialization request consists of the following fields.

Bytes provided

This is the number of bytes the user is providing to hold the materialized data. It must be greater than or equal to eight. If it is equal to eight, then no data will actually be materialized, and the number of bytes required to materialize the requested data will be placed in bytes available. If the value provided is greater than eight, but less than the number of bytes required to hold the requested data, the data will be truncated and no exception will be signaled. Note that a value greater than eight, but less than 16 will result in no data being materialized, since bytes 9-16 are reserved.

If the receiver is smaller than the size indicated by bytes provided, and the materialized data is larger than the space provided in receiver, the space addressing violation  (hex 0601) exception will be signaled unless receiver is an automatically extendable space object. If receiver is an automatically extendable space object, the space will be extended, up to its maximum size.

Bytes available

If bytes provided is greater than eight, this contains the number of bytes that have been used for the materialization, including any reserved bytes or bytes used for padding. If bytes provided is equal to eight, this contains the total size of the receiver needed to hold the requested materialization. A value of zero is returned if there is no data to materialize.

Materialized data

For each bit on in the bound program materialization options and bound module materialization options, this will contain the associated data. Each entry will be preceded by a common header which identifies the type of data and the offset to the next entry. When multiple bits are on in the same request, the data is returned in the order defined by the bound program materialization options and the bound module materialization options.

No exception is signaled when the size of the receiver, as specified by bytes provided is not large enough to hold data for all requested bound program materialization options and bound module materialization options. Instead, the data is truncated and bytes provided only reflects the actual amount of data returned. One of several conditions may arise, each with a different result.

If the receiver is not large enough to hold the materialization header, no data is returned for that bound program materialization option or bound module materialization option. The offset to next entry field in the previous materialization header, if one exists, is set to 0, and the bytes available field is set to reflect the amount of data actually materialized for the bound program materialization options or bound module materialization options that have already been processed. Bytes available will be set to 8, or bytes provided ; whichever is less, if the receiver is not big enough to hold the first materialization header.

If the receiver is big enough to hold the materialization header, but not big enough to hold all of the data requested by the bound program materialization option or bound module materialization option, the partial data flag will be set in the materialization header and as much data will be returned for which there is room. For data which consists of one continuous stream(2) the receiver will be filled and bytes available will equal bytes provided. For data which consists of an option specific header followed by an array of homogenous elements(3) data will be returned in such a way that no partial option specific header or array element will be returned. If there is not enough room to hold the entire option specific header, none of it will be returned. If there is room for the option specific header, but not all of the entries, only those entries that will fit will be returned. The number of entries in the option specific header will reflect the number of entries returned rather than the actual number of entries available in the module. Bytes available will reflect the actual amount of data returned and may not equal bytes provided. Note that because many option specific headers and entries are larger than the common materialization header, there may be more than one option for which partial data is returned.

Offset to next entry

This contains the offset from the beginning of this entry to the beginning of the next entry. It will contain zero if this is the last entry.

Bound program materialization identifier

This indicates which portion of the bound program is contained in this entry. It is the bit which was on in bound program materialization options that resulted in this data being materialized. Either no bits, or a single bit of this field will be on. If no bits of this field are on, then the data contained in this entry is indicated by the bound module materialization identifier field.

Bound module materialization identifier

This indicates which portion of the module, indicated by the bound module materialization number identifier field, is contained in this entry. It is the bit which was on in the bound module materialization options field that resulted in this data being materialized. Either a single bit or no bit of this field will be on. If no bit is on, then the data contained in this entry is indicated by the bound program materialization identifier field. If a bit is set on, then that type of information will be returned in the entry.

Bound module materialization number identifier

If a bit of the bound module materialization identifier field is on, then this is the number of the module for which information has been materialized in this entry, and this field will not be 0.

If no bits of the bound module materialization identifier field are on, then this field will be 0.

Flags

This field specifies information about the item being materialized.

The entry presence field specifies whether there is data available for the requested item. Some items may not be encapsulated into the object, so no data will be returned when their materialization is requested.

The partial data field specifies that only a portion of the data was returned because sufficient space was not present in the receiver to hold all of the data for the requested materialization option.

The valid materialization field specifies whether the requested information is valid to be materialized for the type of bound program that is being materialized. For example, specific bound program information is not valid for a bound service program. Even if data may be present for the type of bound program being materialized does not mean that it actually is. Refer to the entry present field to see if it is.

0 = Executable portion is not compressed

1 = Executable portion is compressed

0 = Observable portion is not compressed

1 = Observable portion is compressed

If the compression status of the observable portion of the program is uncompressed, it is not a guarantee that the observable portion exists. The observable portion status should be checked to ensure that the observable portion exists before attempting to access the observable portion of the program.

0 = Extended observability storage area does not exist

1 = Extended observability storage area exists

Note that a value of zero in this field just means that no observable data exists separate from the portion that is encapsulated in the executable portion of the program. For more information see the Observability Provided and Encapsulated Observability Attributes in the materialized general bound program information.

0 = The program creation data does not exist

1 = The program creation data does exist

0 = Program is not procedure order profiled

1 = Program is procedure order profiled

0 = No modules bound in the program have been basic block reordered

1 = Basic block reordering was attempted for one or more of the modules bound in the program

0 = No modules bound in the program are hooked for application profiling

1 = One or more of the modules bound in the program are hooked for application profiling

0 = No modules bound in the program are teraspace capable

1 = One or more modules bound in the program are teraspace capable

0 = Program entry procedure is not teraspace capable

1 = Program entry procedure is teraspace capable

0 = One or more modules in the bound program are not teraspace capable

1 = All modules in the bound program are teraspace capable

00 = Automatic and static storage are allocated from single level store

01 = Automatic and static storage are allocated from teraspace

10 = Automatic and static storage are allocated from either single level store or teraspace, depending upon the activation

11 = Reserved

Length in bytes of materialization

This is the number of bytes materialized. For the general bound program information this will always be a constant 512.

Number of secondary associated spaces

This is the number of secondary associated spaces currently associated with the object.

Activation group attributes

The activation group attributes specify characteristics of the activation group into which the program will be activated.

Activation group name

This is the activation group name specified when the bound program or bound service program was created.

Coded character set identifier

This is the CCSID value of the bound program or bound service program.

Composite language version

This is the earliest version of the operating system on which the languages used for the bound modules will allow the bound program object to be saved. This is a composite(4) of all of the language versions of the modules bound into this program.

Composite machine version for modules

This is the earliest version of the operating system on which all of the modules bound into the program can be re-created, assuming the required module creation templates are encapsulated in the program.

Earliest version

This is the earliest version of the operating system for which the machine will allow the bound program to be saved.

Creation target version

This is the version of the operating system for which the bound program object was created.

Version on which creation occurred

This is the version of the operating system on which the bound program object was created.

Bound program identifier

This field identifies the type of bound program being materialized.

Compression status

This field identifies whether the executable or the observable portions of the bound program or bound service program are compressed.

Composite low optimization level

This field reflects the lowest level of optimization of all the modules bound into the program. Some modules of the program may have a higher optimization level than indicated by this field.

Composite high optimization level

This field reflects the highest level of optimization of all the modules bound into the program. Some modules of the program may have a lower optimization level than indicated by this field.

Observable portion status

This field describes the status of the observability data of the program. It includes the following flag fields

In order for a program to be eligible for retranslation, the program creation data existence bit must be set. If the module creation data existence bit is also set, this is an indication that the program has the required observability for retranslation. If the module creation data existence field is not set, the observable status of each of the modules can be found.

Program application profiling attributes

These attributes identify application profiling attributes of the program object.

Number of modules with application profiling attributes

This is the number of modules bound into the program that are either hooked for application profiling data collection or have been basic block reordered. To determine to which attributes this number applies, use the program ready for application profiling collection and the program basic block reordering attempted bits of the program application profiling attributes. They are mutually exclusive.

Teraspace attributes

These attributes identify teraspace attributes of the program object.

Length in bytes of materialization

This is the number of bytes materialized.

Version of copyright creation extension

This is the version of the copyrights when the module was created.

Number of copyright strings in the pool

This is the number of copyright strings that follow.

Copyright string pool

This is the data for all of the copyright strings. Each copyright string consists of a 4 byte length followed by the text of the string. The length reflects the actual length in bytes of the copyright string and does not include the length of the length field. All copyright strings along with their lengths are placed contiguously in the buffer with no intervening padding.

Length in bytes of materialization

The number of bytes materialized. This will be 16 + (N * 48) where N is the number of bound service programs- those programs that contain exports that resolve imports in the bound program.

Number of service programs bound to this program

This is the number of bound service programs bound to the bound program.

Array of bound service program records

This array contains one record for each bound service program bound to the bound program. Each record contains the following information

Length in bytes of materialization

The number of bytes materialized. This will be 16 + (N * 80) where N is the number of modules bound into the bound program.

Number of modules bound into this program

This is the number of modules bound into the bound program.

Array of bound module records

This array contains one record for each module bound into the bound program. Each record contains the following information

Length in bytes of materialization

The number of bytes materialized. This will be 16 + the length of the string pool.

String pool

A memory area containing the strings defined for this program. It can be of any length addressable by a UBin(4). It contains a series of strings and lengths. String IDs specified in other materialized components can be used as indexes into this string pool.

Length of string

The length of the next string. This field contains the length of the string only, and does not include the length of either the length or the CCSID field. The length field of a string is not subject to alignment considerations.

CCSID of string

The character code set identifier of this string. This string is encoded in the given CCSID, which is the CCSID of the module object from which this string is originally declared. The CCSID field of a string is not subject to alignment considerations.

String

Character buffer which contains one string. Its length is defined by the length field.

Length in bytes of materialization

The number of bytes materialized. This will always be a constant 256.

Current size of bound program

This is the current size, in machine-dependent units, of the bound program being materialized.

Maximum number of associated spaces

This is the maximum number of associated spaces allowed for the bound program being materialized.

Current number of associated spaces

This is the current number of associated spaces allocated to the bound program being materialized.

Maximum number of modules bindable into program

This is the maximum number of modules that can be bound into a bound program.

Current number of modules bound into program

This is the current number of modules bound into the bound program being materialized.

Maximum number of service programs bindable to program

This is the maximum number of bound service programs that can be bound to a bound program. These bound service programs contain exports to which imports from a bound program resolve.

Current number of service programs bound to program

This is the current number of bound service programs bound to the bound program being materialized.

Maximum size of bound program string directory

This is the maximum size, in bytes, of the bound program string directory.

Current size of bound program string directory

This is the current size, in bytes, of the bound program string directory.

Maximum size of bound program copyright strings

This is the maximum size, in bytes, of the bound program copyright strings.

Current size of bound program copyright strings

This is the current size, in bytes, of the bound program copyright strings.

Maximum number of auxiliary storage segments

This is the maximum number of auxiliary storage segments allowed for a bound program.

Current number of auxiliary storage segments

This is the current number of auxiliary storage segments in the bound program being materialized.

Maximum number of static storage frames

This is the maximum number of static storage frames allowed for a bound program.

Current number of static storage frames

This is the current number of static storage frames required by the bound program being materialized.

Maximum number of procedure exports

This is the maximum number of procedures that are allowed to be exported from a bound program. If the bound program being materialized is not a bound service program, then this value will be zero.

Current number of procedure exports

This is the current number of procedures exported from the bound program being materialized. If the bound program being materialized is not a bound service program, then this value will be zero.

Maximum number of data exports

This is the maximum number of data items that are allowed to be exported from a bound program. If the bound program being materialized is not a bound service program, then this value will be zero.

Current number of data exports

This is the current number of data items exported from the bound program being materialized. If the bound program being materialized is not a bound service program, then this value will be zero.

Maximum number of signatures

This is the maximum number of signatures allowed for a bound program. If the bound program being materialized is not a bound service program, then this value will be zero.

Current number of signatures

This is the current number of signatures contained in the bound program being materialized. If the bound program being materialized is not a bound service program, then this value will be zero.

Minimum amount of static storage required.

This is the smallest amount of static storage that is required for the bound program or service program. This measure is in bytes. The actual amount of static storage that is used may be anywhere between the minimum and the maximum amounts of required static storage, inclusive. If the size is 4 gigabytes (4,294,967,296) or more, a value of 4,294,967,295 will be returned in the field. In this case, the eight byte version of minimum amount of static storage required field should be used to get the size in bytes.

Maximum amount of static storage required.

This is the largest amount of static storage that may be required for the bound program or service program. This measure is in bytes. The actual amount of static storage that is used may be anywhere between the minimum and the maximum amounts of required static storage, inclusive. If the size is 4 gigabytes (4,294,967,296) or more, a value of 4,294,967,295 will be returned in the field. In this case, the eight byte version of maximum amount of static storage required field should be used to get the size in bytes.

Eight byte version of minimum amount of static storage required

This is the smallest amount of static storage that is required for the bound program or service program. This measure is in bytes. The actual amount of static storage that is used may be anywhere between the minimum and the maximum amounts of required static storage, inclusive.

Eight byte version of maximum amount of static storage required

This is the largest amount of static storage that may be required for the bound program or service program. This measure is in bytes. The actual amount of static storage that is used may be anywhere between the minimum and the maximum amounts of required static storage, inclusive.

Length in bytes of materialization

The number of bytes materialized. This will be (N+1)*16, where N is the number of activation group data imports contained in the bound program or bound service program.

Number of activation group data imports

The number of activation group data imports contained in the bound program or bound service program.

Array of activation group data imports

This array contains one record for each data item contained in the program or bound service program. Each record contains the following information:

0 = Reserved

1 = Export Strongly

2 = Export Weakly

3-255 = Reserved

Length in bytes of materialization

The number of bytes materialized. This will be (N+1)*16, where N is the number of activation group data exports contained in the bound program or bound service program.

Number of activation group data exports

The number of activation group data exports contained in the bound program or bound service program.

Array of activation group data exports

This array contains one record for each data item contained in the program or bound service program. Each record contains the following information:

Length in bytes of materialization

The number of bytes materialized. This will always be a constant 64.

Module number containing program entry procedure

This is the number, in the bound modules information, of the module which contains the program entry procedure for this bound program.

Program entry procedure string ID

This is the string ID for the name of this program entry procedure.

Minimum parameters

This is the minimum number of parameters that the program entry procedure can accept.

Maximum parameters

This is the maximum number of parameters that the program entry procedure can accept.

Length in bytes of materialization

The number of bytes materialized. This will be (N+1)*16, where N is the number of signatures contained in the program.

Number of signatures contained in the program

This is the number of signatures contained in the program.

Array of signatures

This array contains one record for each signature contained in the program. Each record contains the following information. The first record contains the current signature.

Length in bytes of materialization

The number of bytes materialized. This will be (N+1)*16, where N is the number of exported procedures.

Number of exported procedures

This is the number of procedures exported from the service program.

Array of program exports

This array contains one record for each procedure exported from the service program. Each record contains the following information:

Length in bytes of materialization

The number of bytes materialized. This will be (N+1)*16, where N is the number of exported data items.

Number of exported data items

This is the number of data items exported from the service program.

Array of data exports

This array contains one record for each data item exported from the service program. Each record contains the following information:

Length in bytes of materialization

This is the number of bytes materialized. For the general module information this will always be a constant 512.

Coded character set identifier

The CCSID defines the code page of the symbols in the string directory.

Creation target version

This is the version of the operating system for which the module object was created.

Data required for machine retranslation

This indicates whether the data required for machine retranslation is present. This data can be present even if the encapsulated observability attributes indicated the component is not present.

Language version

This is the earliest version of the operating system on which language used will allow the module object to be saved.

Version on which creation occurred

This is the version of the operating system that was running on the system where the module object was created.

Earliest version

This is the earliest version of the operating system for which the machine will allow the module object to be saved.

Number of secondary associated spaces

This is the number of secondary associated spaces currently associated with the object.

Module state

This is the state of the module object.

Compiler name

This identifies the compiler which translated the user's source language.

Program entry procedure

This identifies the program entry procedure if one is present in the module.

Module application profiling attributes

This bit mapped field identifies the application profiling attributes of the module.

The hooks for application profiling are present field specifies whether the module is ready for application profiling data collection when it is bound into a program.

The basic block reordering attempted field specifies whether reordering of the basic blocks within the procedures of this module has been attempted. To determine which procedures have basic blocks reordered see the procedure basic block attributes under the procedure definitions.

Module teraspace attributes

This bit mapped field identifies the teraspace attributes of the module.

The module teraspace capable field specifies whether or not the module is allowed to use teraspace at run time.

The module automatic and static storage location field indicates where the automatic and static storage for this module will be allocated at run time, when the module is bound into a program. The possible values are single level store, teraspace, or either single level store or teraspace, depending upon the activation group into which the program is activated.

Length in bytes of materialization

The number of bytes materialized. This will be 16 + the length of the string pool.

String pool

A memory area containing the strings defined for this module. It can be of any length addressable by a UBin(4). It contains a series of strings and lengths. String IDs specified in other materialized components can be used as indexes into this string pool.

Length of string

The length of the next string. This field contains the length of the string only, and does not include the length of the length field, itself. The length field of a string is not subject to alignment considerations.

String

Character buffer which contains one string. Its length is defined by the length field.