HPVOLINFO (cont.) [ Intrinsic HPVOLINFO Technical Addendum ] MPE/iX 5.0 Documentation
Intrinsic HPVOLINFO Technical Addendum
HPVOLINFO (cont.)
Operation Notes
* For volspecifiernum of 3 or 4, the volume set name and the volume
class or volume name must be separated by a colon:
%SET:CLASS0%
A colon cannot be used as a delimiter.
* Since a volume set or class can be fully qualified on MPE V, periods
are allowed in the name. Because periods and underscores are allowed
in an MPE XL name, these characters cannot be used as delimiters.
* For volspecifiernum of 2 or 3 on MPE V (private volumes), a volume
set/class name may be partially or fully qualified:
VSETNAME.GROUP.ACCT
CLASSNAM.GROUP.ACCT
Each field of the name must consist of one to eight alphanumeric
characters. The first character must be a letter. The name may have
up to 55 characters:
%SETxxxxx.GROUPxxx.ACCOUNTx:CLASSxxx.GROUPxxx.ACCOUNTx%
This name has six 8-character fields, four periods, a colon, and two
delimiters. When the volume set or class name is not fully
qualified, it refers to the volume set or class in the logon
group/account.
* On MPE XL, a valid volume set or class name may contain as many as 32
characters. The first character must be a letter. The rest may be
any combination of alphanumeric characters, including the underscore
"_" and the period ".".
* On MPE XL, the name of the system volume set is
MPEXL_SYSTEM_VOLUME_SET. The system volume set on MPE V does not have
a predefined name; thus, the name MPEXL_SYSTEM_VOLUME_SET is used for
compatibility with MPE XL.
On both systems, this is the volume set name returned for items #3
and #12.
* When the system volume set name is used on MPE V, it must not be
followed by a class name (refer to the discussion for volspecifiernum
5, below).
On MPE V, group and account names cannot be used to partially or
fully qualify the set or volume name when the system volume set name
is specified.
* For volspecifiernum 4 on MPE V, a volume name consists of as many as
eight alphanumeric characters. The first character must be a letter.
For private volumes, names may be partially or fully qualified
(VNAME.GROUP.ACCT). Each field of the name must be one to eight
alphanumeric characters, the first of which must be a letter. The
maximum number of characters allowed is 55.
%SETxxxxx.GROUPxxx.ACCOUNTx:NAMExxxx.GROUPxxx.ACCOUNTx%
This name has six 8-character fields, four periods, a colon, and two
delimiters.
When the volume name is not fully qualified, it refers to the volume
name in the logon group and/or account.
* For volspecifiernum 4 on MPE XL, the volume name consists of any
string of one to 16 alphanumeric characters, including the underscore
and the period. The first character must be a letter.
* On MPE V, there is no volume class for the system volume set. In
order to access a subset of the system volume set, devices classes
are used.
* On MPE XL, volume classes exist for both system and nonsystem volume
sets. Volume classes take the place of device classes.
* The volspecifiernum 5, for items #6 and #7, provides compatibility
between MPE XL and MPE V. Specifier 5 passes the device class of a
group of volumes as they apply to the I/O configuration. The maximum
number of characters allowed in the string is 8. On MPE V, specifier
5 must refer to a device class that is configured to a group of
volumes.
* ON MPE XL, when a device class name is specified, a configured and
mounted volume class with the same name must exist in the system
volume set. Data will be returned based on this volume class in the
system volume set if it exists. Otherwise an error will result.
itemnum 16-bit signed integer by value (optional).
This is the cardinal number of the item desired. It
specifies which item value is to be returned. See 0000
ref table 2-2 00000.
item Type varies (optional).
On MPE V, the item must be declared as a byte array.
The actual type of the item is specified by the
corresponding itemnum. See 0000 ref table 2-2 00000.
Special Considerations
* You do not need special capabilities to use the HPVOLINFO intrinsic.
* Split-stack calls are illegal.
* When an error is returned, the values in the item parameters are all
undefined. It is not guaranteed that the data returned in an item is
meaningful if any negative status value is returned.
* On MPE V, real values are accepted from the caller and returned to
the caller in 64-bit HP 3000 format. This is the default format for
MPE V.
* On MPE XL, real values are accepted from the caller and returned to
the caller in the format that is the default mode of the caller.
If the intrinsic is called from compatibility mode, any real values
specified to HPVOLINFO must be in 64-bit HP 3000 format, and any real
values returned by HPVOLINFO will be in that format.
If the intrinsic is called from native mode, any real values
specified to HPVOLINFO must be in 64-bit IEEE format, and any real
values returned by HPVOLINFO will be returned in that format.
* If the system is highly active while this intrinsic is called, some
of the item values returned may not reflect the expected results.
For example, when HPVOLINFO is called to return the disk space used
by permanent files, a value is returned. But if immediately after
the value is returned, a process on the system purges a file (FCLOSE
a file with a disposition of 4), the value will not reflect this
difference.
* ON MPE V, a set or class is considered to be logically mounted if all
of its members are logically mounted (that is, the LMOUNT or MOUNT
command was used).
* On MPE XL, if the volume specifier is a set or class then at least
the master volume must be logically mounted (that is, the volume must
be in a master or member state). If the volume specifier is a
logical device number, or a volume name, both the volume specified
and the master volume (of the set enclosing the volume specified)
must be logically mounted.
* If the volume specifier is a logical device number, it must be a
member of a set or class that is logically mounted. If the volume
specifier is a volume set name, the set must be logically mounted.
If the volume specifier is a volume class name, the class must be
logically mounted. If the volume specifier is a volume name, that
volume must be a member of a set or class that is logically mounted.
When the volume specifier is a device class, all of the logical
device numbers in the specified device class must be members of
logically mounted sets/classes. All the volumes on the system,
whether they are logically mounted or not, may be specified by using
volspecifiernum 0 (zero).
* If the volumes for volspecifiernum 1, 2, 3, 4, 5 are not logically
mounted as specified above, the HPVOLINFO intrinsic will return a
"volume not mounted" error.
If the caller chooses to continue with the same specifier, the LMOUNT
command (MPE V) or the VSOPEN command (MPE XL) can be used with the
COMMAND or HPCICOMMAND intrinsic to logically mount the appropriate
volume sets/classes.
If a volume is taken offline while the intrinsic is accessing it, the
process will hang until the volume is back on line. I/Os cannot
complete to the disk when a volume is offline.
* On MPE XL, mirrored disks maintain identical copies of the same
information on two disks. Consequently, the values returned by this
intrinsic reflect information from only one of the volumes in a
mirror disk pair. When retrieving an Ldev number (item #13) using a
volume name that is associated with a mirrored disk pair, only one of
the Ldev numbers of the mirrored pair will be returned. Which one is
returned is random. Be aware that in this situation, the Ldev number
returned may be different across system startups. Later use of the
Ldev numbers returned for mirrored disks are guaranteed to provide
accurate information for the mirrored volume set.
* On MPE XL, if information is requested for the split backup volume
set, the information returned will be for the split user volume.
Information Returned
INFORMATION RETURNED ITEM#
---------------------------------------------------------------------------------------
Disk space used by permanent files, in sectors 32, 33
Disk space used by temporary files, in sectors (reserved: 34, 35)
Drive type 8
File label overhead, in sectors MPE XL 26, 27
Free space area, largest contiguous, in sectors 42, 43
Free space distribution array 36, 37
Free space distribution, in sectors per range 38, 39
Free space, total, in sectors 40, 41
Logical device number 13
Member volume names, list 7
Member volumes, number of 6
Overhead, directory space, in sectors 24, 25
Overhead, MPE total, in sectors 16, 17
Overhead, transaction management MPE XL 28, 29
Overhead, transient space, in sectors MPE XL 18, 19
Sector size, in bytes 9
Spool file disk space usage, in sectors 30, 31
Transient space, configured maximum, MPE XL, in sectors 20, 21
Virtual memory overhead, in sectors MPE V 22, 23
Volume capacity, in sectors 14, 15
Volume class names, list 5
Volume class names, number of 4
Volume name 11
Volume sets, list 3
Volume sets, number of 2
Volume set name 12
Volume type 10
MPE/iX 5.0 Documentation