HPVOLINFO (cont.) [ Intrinsic HPVOLINFO Technical Addendum ] MPE/iX 5.0 Documentation
Intrinsic HPVOLINFO Technical Addendum
HPVOLINFO (cont.)
Item and Itemnum Pairs
All item parameters are passed by reference.
2 Number of volume sets
Function = MPE XL, MPE V: DSTAT
Returns the number of system and non-system volume sets
that are configured on the system. It returns a 32-bit
signed integer containing the number of volumes sets.
Zero (0) is the only valid volspecifiernum.
May be used with Item=3.
3 List of volume set names
Function = MPE XL, MPE V: DSTAT
Returns a list of all system and non-system volume set
names mounted on the system. The item must be a
character array where the list of set names will be
returned. The first four bytes of the array are
interpreted as a 32-bit integer describing the length of
the array. The caller must set this value equal to the
maximum number of names that will fit into the array
being passed. On return, the value will have been
modified to reflect the actual number of names returned.
The remaining bytes will be mapped to a list of 32-byte
names.
May be used with Item=2 to determine the maximum number
of names that could be returned.
4 Number of volume classes
Function = MPE XL: VOLUTIL command
Returns the number of volume classes that a volume or
volume set is associated with. Returns a 32-bit signed
integer containing the number of volume classes. On MPE
XL, this number includes only classes whose members are
logically mounted.
A volume can be associated with more than one volume
class. So, when the specifier is 1 or 4, the number
returned is the number of volume classes that the volume
is a member of. When the specifier is 2, the number
returned is the number of volume classes that are a
subset of the volume set.
May be used with Item=5
5 List of volume class names
Function = MPE XL: VOLUTIL
Returns a list of volume class names. On MPE XL, the
list includes only the names of classes whose members
are all logically mounted.
The item must be a character array where the list of
class names will be returned. The first four bytes of
the array are interpreted as a 32-bit integer describing
the length of the array. The caller must set this value
equal to the maximum number of names that will fit into
the array being passed. The remaining bytes will be
mapped to a list of 32-byte names. On return, the value
will have been modified to reflect the actual number of
names returned.
A volume can be associated with more than one volume
class. So when the specifier is 1 or 4, the list
returned is a list of volume classes that the volume is
a member of. When the specifier is 2, the list returned
is a list of volume classes that are a subset of the
volume set.
May be used with Item=4 to determine the maximum number
of names that could be returned.
6 Number of member volumes
Function = MPE V: LISTVS MPE XL: VOLUTIL
Returns the number of member volumes in the specified
volume set/class or device class. This item returns a
32-bit signed integer containing the number of member
volumes.
When the specifier is 2 or 3, the number of member
volumes that make up the volume set or class is
returned, including the master volume in the total
count. When the specifier is 5, the number of member
volumes configured with the passed device class is
returned.
For example, if a volume set consists of a master
volume, MASTER, and two member volumes, MEMBER1 and
MEMBER2, and if the specifier used is a volume set name,
the number returned is 3.
On MPE XL you can remove some or all of the volumes in a
volume set (excluding the master volume). Therefore,
this number will depend on the number of volumes you
have mounted at the time the intrinsic call is made.
Mirrored disks maintain identical copies of the same
information on two disks. Therefore, the number
returned will reflect only one of the volumes in a
mirrored disk pair. Which volume is chosen is random.
On MPE V, the concept of master and member volumes
refers only to private volumes. Therefore, if the
system volume set is specified, the count will consist
of the number of volumes that are designated as system
volumes.
May be used with Item=7.
7 List of member volume names
Function = MPE XL: VOLUTIL MPE V: LISTVS
Returns the list of names of the member volumes in the
specified volume set/class or device class.
The Item must be a character array where the list of
member volumes will be returned. The first four bytes
of the array are interpreted as a 32-bit integer
describing the length of the array. The caller must set
this value equal to the maximum number of names that
will fit into the array being passed. On return, the
value will have been modified to reflect the actual
number of names returned. The remaining bytes will be
mapped to a list of 32-byte names.
Item 6 may be used to determine the maximum number of
names that could be returned.
When the specifier is 2 or 3, the list of member volumes
that make up the set or class is returned. When the
specifier is 5, the list of member volumes configured
with the passed device class is returned.
On MPE XL, you can remove some or all of the volumes in
a volume set (excluding the master volume). Therefore,
this list will depend on the number of volumes you have
mounted at the time the intrinsic call is made.
On MPE XL, a volume class need not include the master
volume. As a result, specifier 3 may return a list that
does not include the master volume.
On MPE V, the concept of master and member volumes
refers only to private volumes. Therefore, if the
system volume set is specified, the count will consist
of the number of volumes that are designated as system
volumes.
8 Drive type
Function = MPE XL, MPE V: DSTAT
Returns the type of the drive specified. The drive type
refers to the name of the drive (for example: HP7935,
HP7937). The character array that is used must be large
enough to contain the longest type string, currently 13
characters.
9 Drive sector size
Returns the logical sector size of the specified drive.
This item returns a 32-bit signed integer containing the
drive's local sector size in bytes.
Currently, this logical size is 256 bytes. In the
future, however, disks may have different physical
sector sizes. MPE will map them to system-wide logical
sector sizes.
10 Volume type
This item returns a 32-bit integer specifying the volume
type. Valid types are:
1 - System volume 2 - Non-system volume
On MPE, there are two types of volume sets: the system
volume set and non-system volume sets. A volume from
the system volume set is considered a system volume; a
volume from the non-system set is considered a
non-system volume. A non-system set on MPE XL is
equivalent to a private volume set on MPE V.
11 Volume name
Function = MPE V: VINIT with PLABEL
Returns the volume name of the specified Ldev. This
item is a character array and must be specified with a
length of 32 bytes.
12 Volume set name
Function = MPE XL, MPE V: DSTAT
Returns the volume set name corresponding to the passed
Ldev. An Ldev can be associated with only one volume
set. This item is a character array and must be
specified with a length of 32 bytes.
13 Logical device number
Returns the logical device number of the specified
volume. This item returns a 16-bit signed integer
containing the logical device number.
On MPE XL, mirrored discs maintain identical copies of
the same information on two disks. Information is
returned for only one of the disks. Which is returned
is random.
14 & 15 Volume capacity
Function = MPE XL: VOLUTIL command
Returns the volume capacity.
Item 14 returns a 64-bit signed integer containing the
volume capacity in sectors. Item 15 returns the
capacity as a 64-bit real.
When the specifier is 1 or 4, the volume capacity
consists of the capacity of the volume whose Ldev or
volume name was specified.
When the specifier is 2 or 3, the capacity of the
volumes that make up the volume set or class are
totalled. This total value is returned.
16 & 17 Total MPE overhead
Returns the total MPE overhead, which consists of
everything on a volume that is not set aside for file
space use. This is the volume space used for operating
system purposes.
Item 16 returns a 64-bit signed integer containing the
total MPE overhead. Item 17 returns the overhead as a
64-bit real.
Files that compose the code for the operating system are
not included in this overhead. Some of the space that
is considered overhead includes:
MPE V - volume label, virtual memory, directory,
defective tracks/sectors table, initial segments, disk
cold load information table, volume table, free space
map, and channel programs.
MPE XL - volume label, file label table, directory,
volume set information table, free space map, transient
space, and transaction management overhead.
A subset of the overhead is returned through itemnums 18
through 29:
18 & 19 - MPE transient space
20 & 21 - MPE XL configured transient space
22 & 23 - MPE V virtual memory
24 & 25 - Directory
26 & 27 - MPE XL file label tables
28 & 29 - MPE XL transaction management
When the specifier is 1 or 4, the total MPE overhead
consists of the MPE overhead on the volume whose Ldev or
volume name was specified. These are subsets of items
16 and 17.
When the specifier is 2 or 3, the MPE overhead on the
volumes that make up the set or class is returned.
18 & 19 MPE XL transient space overhead
Returns the MPE XL transient space overhead. This item
is valid only on MPE XL.
These are subsets of items 16 and 17.
Item 18 returns a 64-bit signed integer containing the
transient space overhead in sectors. Item 19 returns
this overhead as a 64-bit real.
Transient space overhead consists of volume space that
is used for temporary processes, such as stacks, heaps,
and the operating system data structure.
When the specifier is 1 or 4, the transient space
consists of the transient space on the volume whose Ldev
or volume name was specified.
When the specifier is 2 or 3, the transient space on the
volumes that make up the set or class is returned.
20 & 21 Configured maximum MPE XL transient space
Function = MPE XL: VOLUTIL command
Returns the configured maximum MPE XL transient space.
These are subsets of items 16 and 17.
Item 20 returns a 64-bit signed integer containing the
maximum transient space overhead in sectors. Item 21
returns this overhead as a 64-bit real.
This is volume overhead that is configured for transient
space use. It is not necessarily used. This is space
configured for stacks, heaps, and operating system
structures.
Refer to Items 18 and 19 above.
When the specifier is 1 or 4, the configured maximum
transient space consists of the configured transient
space on the volume whose Ldev or volume name was
specified.
When the specifier is 2 or 3, the configured transient
space on the volumes that make up the volume set or
class is returned.
22 & 23 MPE V virtual memory overhead
Function = MPE V: SYSDUMP virtual memory device
allocation portion (SM capability required to use
SYSDUMP).
Returns the MPE virtual memory overhead. This is valid
only on MPE V.
These are subsets of items 16 and 17.
Item 22 returns a 64-bit signed integer containing the
virtual memory overhead in sectors. Item 23 returns
this overhead as a 64-bit real.
MPE V virtual memory overhead is the volume space that
is allocated for saving segments of main memory
temporarily. This amount of configured virtual memory
space is equivalent to the amount of used virtual memory
space. Virtual memory on MPE V is allocated only on
system volumes. There is no virtual memory on private
volumes.
When the specifier is 1 or 4, the virtual memory
overhead consists of the virtual memory on the volume
whose Ldev or volume name was specified.
When the specifier is 2, the only valid specifier is
MPEXL_SYSTEM_VOLUME_SET. This is because virtual memory
is allocated only on system volumes.
Specifier 3 is invalid. This is because virtual memory
is valid only on the MPE V system volume set, and
because the concept of volume classes does not hold for
MPE V system volumes.
MPE/iX 5.0 Documentation