HPVOLINFO (cont.)
Item and Itemnum Pairs (cont.)
24 & 25 Directory space overhead
Returns the directory space overhead.
Item 24 returns a 64-bit signed integer containing the
directory space overhead in sectors. Item 25 returns
this overhead as a 64-bit real.
These are subsets of items 16 and 17.
Directory space is area on system and non-system volumes
reserved for accounting information. It consists of the
directory space used for permanent files.
When the specifier is 1 or 4, the directory space
overhead consists of the directory space on the volume
whose Ldev or volume name was specified.
When the specifier is 2 or 3, the directory space
overhead on the volumes that make up the volume set or
class is returned.
On MPE V, the system directory is allocated on Ldev 1,
and for private volumes, the directory is allocated on
the master volume of the volume set or class.
Specifying a volume set or class will give the same
results as specifying the master volume of the set or
class.
26 & 27 MPE XL file label overhead
Returns the MPE XL file label overhead. This item is
valid only on MPE XL.
Item 26 returns a 64-bit signed integer containing the
file label overhead in sectors. Item 27 returns this
overhead as a 64-bit real.
These are subsets of items 16 and 17.
On MPE XL, each volume has its own label table, which
contains file labels and extent descriptors for files
that begin on that volume.
When the specifier is 1 or 4, the file label overhead
consists of the overhead on the volume whose Ldev or
volume name was specified.
When the specifier is 2 or 3, the file label overhead on
the volumes that make up the set or class is returned.
28 & 29 MPE XL transaction management overhead
Returns the MPE XL transaction management overhead.
This item is valid only on MPE XL.
Item 28 returns a 64-bit signed integer containing the
transaction management overhead in sectors. Item 29
returns this overhead as a 64-bit real.
These are subsets of items 16 and 17.
Transaction management overhead consists of any logging
information that is maintained in order to provide file
consistence and file recovery.
When the specifier is 1 or 4, the transaction management
overhead consists of any logging information kept on the
volume whose Ldev or volume name was specified.
When the specifier is 2 or 3, the transaction management
overhead on the volumes that make up the set or volume
class is returned.
30 & 31 Spool file disk space usage
Function = MPE XL, MPE V: SHOWOUT
Returns the MPE spool file disk space usage.
Item 31 returns a 64-bit signed integer containing the
spool file disk space usage in sectors. Item 32 returns
this usage as a 64-bit real.
Spool file space consists of the volume space that is
used by hidden spool files. Hidden spool files are not
part of the permanent file space. This space can be
found only on system volumes that are configured with
the device class SPOOL. Spool file space is not
allocated on non-system volumes.
When the specifier is 1 or 4, the spool file space
consists of the space used on the volume whose Ldev or
volume name was specified.
When the specifier is 2 the volume set name must refer
to the system volume set name.
Specifier 3 is valid only on MPE XL.
32 & 33 Disk space used by permanent files
Function = MPE XL, MPE V:REPORT @.@
Returns the disk space used by permanent files.
Item 32 returns a 64-bit signed integer containing the
disk space used by files in sectors. Item 33 returns
this space as a 64-bit real.
When the specifier is 1 or 4, the disk space used by
files consists of the space used by permanent files on
the volume whose Ldev or volume name was specified.
When the specifier is 2 or 3, the disk space used by
permanent files on the volumes that make up the volume
set or class is returned.
34 & 35 Reserved for disk space used by temporary files.
36 & 37 Free space distribution array
Function = MPE XL: DISCFREE MPE V: FREE5
Returns the free space distribution array. The caller
passes an array that specifies a series of ranges. The
intrinsic returns the number of free areas whose size is
within each of the specified ranges. The array must
consist of 64-bit values.
The item passed must be a variable length array of
64-bit numbers (maximum array length of 16 elements).
For item 36, the values must be in integer format. It
returns an array of 64-bit integers containing the free
space distribution.
For item 37, the values must be in real format. Real
values will be rounded off. It returns an array of
64-bit reals.
On MPE V, the largest value that may be specified in
either format is 2,147,483,646.
The first value is the number of ranges (minimum 2,
maximum 16). The remaining values are the lower bounds
for the ranges, in ascending order. On return the first
element will be the number of free areas whose size is
smaller than the smallest bound specified. Each
remaining element will be the number of free space areas
whose size is greater than or equal to the bound, and
less than the next larger bound. The following example
shows a return in 6 ranges:
Array Values Free Area Size Ranges
Index Passed In
1 6 1 - 9 contiguous sectors
2 10 10 - 99 contiguous sectors
3 100 100 - 999 contiguous sectors
4 1000 1000 - 9999 contiguous sectors
5 10000 10,000 - 99,999 contiguous sectors
6 100000 100,000+ contiguous sectors
For example, if there are 4 areas of free space that are
between the size of 100 and 999, the third value of the
free space distribution array would contain 4 on return.
Notice that the number of ranges specified in the first
element of the array example is 6, but only 5 lower
bounds are specified, because the smallest lower bound
is assumed to be 1 (one).
When the specifier is 1 or 4, the free space
distribution array consists of the contiguous free space
areas on the volume whose Ldev or volume name was
specified.
When the specifier is 2 or 3, the free space
distribution array returns the total values from the
volumes that make up the volume set or class.
38 & 39 Free space distribution sectors per range
Function = MPE XL: DISCUTIL, MPE V: FREE5
Returns the free space distribution sectors per range.
The caller passes an array that specifies a series of
ranges. For each range specified in the array, the
intrinsic returns the total free space for free areas
found in that range.
Refer to Items 36 and 37 for the format of the free
space distribution array passed to the intrinsic and for
the format of the returned array.
40 & 41 Total free space
Function = MPE XL: DISCUTIL, MPE V: FREE5
Returns the total free space on a volume or a group of
volumes.
Item 40 returns a 64-bit signed integer containing the
total free space in sectors.
Item 41 returns a 64-bit real.
When the specifier is 1 or 4, the total free space
consists of the total free space on the volume whose
Ldev or volume name was specified.
When the specifier is 2 or 3, the total free space on
the volumes that make up the volume set or class is
returned.
42 & 43 Largest contiguous free space area
Function = MPE XL: DISCUTIL, MPE V: FREE5
Returns the largest contiguous free space area on a
volume or a group of volumes.
Item 42 returns a 64-bit signed integer containing the
largest contiguous free space area in sectors.
Item 43 returns a 64-bit real.
When the specifier is 1 or 4, the largest contiguous
free space consists of the largest contiguous free space
on the volume whose Ldev or volume name was specified.
When the specifier is 2 or 3, the largest contiguous
free space on the volumes that make up the volume set or
class is returned.
For example, for specifiers 2 or 3, if a volume set is
composed of Ldevs 2, 3, and 4, and the largest
contiguous free space on these volumes are 37785, 56528,
and 56171, respectively, the value returned is 56528.
Variable Conventions
------------------------------------------------------------------------------------------
| |
| Convention Meaning |
| |
------------------------------------------------------------------------------------------
| |
| I16 16-bit signed integer |
| |
| I32 32-bit signed integer |
| |
| I64 64-bit signed integer |
| |
| R64 64-bit signed real |
| |
| CA Character array |
| |
| I64A 64-bit signed integer array |
| |
| R64A 64-bit signed real array |
| |
------------------------------------------------------------------------------------------
--------------------------------------------------------------------------------------------
| |
| ITEM# ITEM TYPE APPLICABLE |
| VOLUME |
| SPECIFIERS |
| |
--------------------------------------------------------------------------------------------
| |
| 2 Number of volume sets I32 0 |
| |
| 3 List of volume set names CA 0 |
| |
| 4 Number of volume classnames I32 1, 2, 4 |
| |
| 5 List of volume class names CA 1, 2, 4 |
| |
| 6 Number of member volumes I32 2, 3, 5 |
| |
| 7 List of member volume names CA 2, 3, 5 |
| |
| 8 Drive type CA 1, 4 |
| |
| 9 Sector size in bytes I32 1, 4 |
| |
| 10 Volume type I32 1, 4 |
| |
| 11 Volume name CA 1 |
| |
| 12 Volume set name CA 1 |
| |
| 13 Logical device number I16 4 |
| |
| 14 Volume capacity in sectors I64 1, 2, 3, 4 |
| |
| 15 Volume capacity in sectors R64 1, 2, 3, 4 |
| |
| 16 Total MPE overhead in sectors I64 1, 2, 3, 4 |
| |
| 17 Total MPE overhead in sectors R64 1, 2, 3, 4 |
| |
| 18 MPE XL transient space overhead in I64 1, 2, 3, 4 |
| sectors |
| |
--------------------------------------------------------------------------------------------
--------------------------------------------------------------------------------------------
| |
| ITEM# ITEM TYPE APPLICABLE |
| VOLUME |
| SPECIFIERS |
| |
--------------------------------------------------------------------------------------------
| |
| 19 MPE XL transient space overhead in R64 1, 2, 3, 4 |
| sectors |
| |
| 20 Configured maximum MPE XL transient I64 1, 2, 3, 4 |
| space in sectors |
| |
| 21 Configured maximum MPE XL transient R64 1, 2, 3, 4 |
| space in sectors |
| |
| 22 MPE V virtual memory overhead in I64 1, 2, 4 |
| sectors |
| |
| 23 MPE V virtual memory overhead in R64 1, 2, 4 |
| sectors |
| |
| 24 Directory space overhead in sectors I64 1, 2, 3, 4 |
| |
| 25 Directory space overhead in sectors R64 1, 2, 3, 4 |
| |
| 26 MPE XL file label overhead in I64 1, 2, 3, 4 |
| sectors |
| |
| 27 MPE XL file label overhead in R64 1, 2, 3, 4 |
| sectors |
| |
| 28 MPE XL transaction management I64 1, 2, 3, 4 |
| overhead |
| |
| 29 MPE XL transaction management R64 1, 2, 3, 4 |
| overhead |
| |
| 30 Spool file disk space usage in I64 1, 2, 3, 4 |
| sectors |
| |
| 31 Spool file disk space usage in R64 1, 2, 3, 4 |
| sectors |
| |
| 32 Disk space used by permanent files I64 1, 2, 3, 4 |
| in sectors |
| |
| 33 Disk space used by permanent files R64 1, 2, 3, 4 |
| in sectors |
| |
| 34 (Reserved for) Disk space used by I64 1, 2, 3, 4 |
| temporary files in sectors |
| |
| 35 (Reserved for) Disk space used by R64 1, 2, 3, 4 |
| temporary files in sectors |
| |
| 36 Free space distribution array I64A 1, 2, 3, 4 |
| |
| 37 Free space distribution array R64A 1, 2, 3, 4 |
| |
| 38 Free space distribution sectors per I64A 1, 2, 3, 4 |
| range |
| |
--------------------------------------------------------------------------------------------
--------------------------------------------------------------------------------------------
| |
| ITEM# ITEM TYPE APPLICABLE |
| VOLUME |
| SPECIFIERS |
| |
--------------------------------------------------------------------------------------------
| |
| 39 Free space distribution sectors per R64A 1, 2, 3, 4 |
| range |
| |
| 40 Total free space in sectors I64 1, 2, 3, 4 |
| |
| 41 Total free space in sectors R64 1, 2, 3, 4 |
| |
| 42 Largest contiguous free space area I64 1, 2, 3, 4 |
| in sectors |
| |
| 43 Largest contiguous free space area R64 1, 2, 3, 4 |
| in sectors |
| |
--------------------------------------------------------------------------------------------