VIRTUTECH CONFIDENTIAL    Previous - Up - Next

scsi-disk

Provided by
scsi-disk
Class Hierarchy
conf-objectlog-objectscsi-disk
Interfaces Implemented
log_object, event_poster
Description
Generic disk with SCSI interface.

Attributes

Attributes inherited from class conf-object
attributes, classname, component, iface, name, object_id, queue
Attributes inherited from class log-object
access_count, log_buffer, log_buffer_last, log_buffer_size, log_group_mask, log_groups, log_level, log_type_mask
Attribute List
buf_len
Optional attribute; read/write access; type: unknown type.

Length left to transfer to host.

cmd_bytes
Optional attribute; read/write access; type: unknown type.

The command bytes received so far.

cmd_len
Optional attribute; read/write access; type: unknown type.

Length of the command received from the host.

command
Optional attribute; read/write access; type: unknown type.

The current SCSI command.

data_buffer
Optional attribute; read/write access; type: unknown type.

Buffer with data to transfer.

data_len
Optional attribute; read/write access; type: unknown type.

The length of data to transfer.

geometry
Required attribute; read/write access; type: unknown type.

The geometry of the disk. ()

image
Required attribute; read/write access; type: unknown type.

Name of the image object holding the actual data of the disk. This object must implement the 'image' interface.

lun
Optional attribute; read/write access; type: unknown type.

The currently selected LUN (logical unit).

max_data_width
Optional attribute; read/write access; type: unknown type.

The maximum supported data transfer width in bytes.

may_disc
Optional attribute; read/write access; type: unknown type.

Set to 1 if the disk may disconnect from the current session.

memory
Optional attribute; read/write access; type: unknown type.

Backdoor access: Name of a memory space object, that implements the 'lookup' interface.

mesg_buffer
Optional attribute; read/write access; type: unknown type.

Buffer with SCSI message to transfer.

mesg_bytes
Optional attribute; read/write access; type: unknown type.

The message bytes received so far.

mesg_len
Optional attribute; read/write access; type: unknown type.

Length of the message received from the host.

mode_pages
Optional attribute; read/write access; type: unknown type.

Mode pages for the disk.

model
Optional attribute; read/write access; type: unknown type.

Model name of the disk.

ns_per_transfer
Optional attribute; read/write access; type: Integer.

The constant delay, in nanoseconds, for a disk transfer. This delay will be added to the size-dependent delay set by the 'ns_per_unit' attribute. Note that this is not the same as average seek time for random accesses. (This attribute will be replaced by a more detailed timing model in the future.)

ns_per_unit
Optional attribute; read/write access; type: Integer.

The number of nanoseconds it takes to transfer data of the size set in the 'timing_unit_size' attribute. This delay will be added to the constant delay set in the 'ns_per_transfer' attribute. (This attribute will be replaced by a more detailed timing model in the future.)

queue_length
Optional attribute; read/write access; type: unknown type.

Length of SCSI command queue (not implemented).

req_size
Optional attribute; read/write access; type: unknown type.

Length of data requested from host.

reselect_id
Optional attribute; read/write access; type: unknown type.

SCSI ID of controller to reselect.

reselect_op
Optional attribute; read/write access; type: unknown type.

Operation that will continue after reselection.

reselection_support
Optional attribute; read/write access; type: unknown type.

Set to 1 if the disk supports reselection (not functional).

reserved_flag
Optional attribute; read/write access; type: unknown type.

Set if the device is reserved.

reserved_id
Optional attribute; read/write access; type: unknown type.

SCSI ID of the initiator that is allowed to use the reserved device. Only valid if the 'reserved_flag' attribute is 1.

reserved_initiator
Optional attribute; read/write access; type: unknown type.

SCSI ID of the initiator that performed the reservation of the device. Only valid if the 'reserved_flag' attribute is 1.

revision
Optional attribute; read/write access; type: unknown type.

Revision string of the disk.

scsi_bus
Required attribute; read/write access; type: unknown type.

Name of the SCSI bus the disk is connected to. This object must implement the 'scsi-bus' interface.

scsi_commands
Pseudo attribute; read-only access; ; integer indexed; indexed type: String.

Pseudo attribute returning the SCSI command name (as a string) given an integer index representing the command.

scsi_target
Required attribute; read/write access; type: unknown type.

Target ID on the SCSI bus for the disk.

sector_data
Pseudo attribute; read/write access; ; integer indexed; indexed type: Data.

Can be used to access a sector (512 bytes) on the disk.

sectors_read
Session attribute; read-only access; type: Integer.

Number of sectors read in the current simulation session.

sectors_written
Session attribute; read-only access; type: Integer.

Number of sectors written in the current simulation session.

selection_time
Optional attribute; read/write access; type: Float.

The selection time on the SCSI bus in seconds.

sense_key
Optional attribute; read/write access; type: unknown type.

Current Sense Key code.

stat_buffer
Optional attribute; read/write access; type: unknown type.

Buffer with Status to transfer.

stat_len
Optional attribute; read/write access; type: unknown type.

The length of the status field to transfer.

synchronous_support
Optional attribute; read/write access; type: unknown type.

Set to 1 if the disk supports synchronous transfers (no-op).

timing_unit_size
Optional attribute; read/write access; type: Integer.

The amount of data (in bytes) that the is used to calculate disk delays together with the 'ns_per_unit' attribute. (This attribute will be replaced by a more detailed timing model in the future.)

transfer
Optional attribute; read/write access; type: unknown type.

List of active transfer buffers for data message and status.

vendor
Optional attribute; read/write access; type: unknown type.

Vendor name of the disk.

vendor_specific_id
Optional attribute; read/write access; type: unknown type.

Vendor Specific string for the disk - often used as serial id.

vpd_pages
Optional attribute; read/write access; type: unknown type.

VPD pages for the disk.

Command List

Commands defined by interface log_object
log, log-group, log-level, log-size, log-type
Commands
add-diff-fileadd a diff file to the image
add-diff-partial-fileadd a partial diff file to the image
add-sun-partitionadd partition from a file
create-partitionadd a partition to disk
create-sun-vtoc-headerwrite a new VTOC to a Sun disk
create-sun-vtoc-partitionwrite partition data in the VTOC on a Sun disk
delete-sun-vtoc-partitiondelete partition data from the VTOC on a Sun disk
dump-sun-partitionwrite partition as a file
infoprint information about the device
print-partition-infoprint info about a pc-style partition
print-partition-tableprint the disk's pc-style partition table
print-sun-vtocprint the VTOC for a Sun disk
save-diff-filesave diff file to disk
statusprint status of the device

Command Descriptions

<scsi-disk>.add-diff-file
Synopsis
<scsi-disk>.add-diff-file filename
Description
Add a diff file to the list of files for an disk. The diff file was typically created with the 'save-diff-file' command, or by a saved configuration. This is basically the same command as <image>.add-diff-file.
See Also
<scsi-disk>.save-diff-file, <image>.add-diff-file
<scsi-disk>.add-diff-partial-file
Synopsis
<scsi-disk>.add-diff-partial-file filename start size
Description
Add a diff file to the list of files for an disk. The diff file was typically created with the 'save-diff-file' command, by one of the dump-*-partition commands, or by a saved configuration. This is basically the same command as <image>.add-diff-file.
See Also
<scsi-disk>.save-diff-file, <image>.add-diff-file
<scsi-disk>.add-sun-partition
Synopsis
<scsi-disk>.add-sun-partition number file
Description
Adds an image or diff as a sun partition to the current disk.
See Also
<scsi-disk>.dump-sun-partition
<scsi-disk>.create-partition
Synopsis
<scsi-disk>.create-partition partition start_cylinder start_head start_sector end_cylinder end_head end_sector (type_id|"type_name") start_lba size_in_sectors [-boot-indication]
Description
Add a partition to a disk's partition table. Will create a primary PC-style partition with number partition. Any existing partition will be overwritten. The start location of the partition is given both in CHS format with start_cylinder, start_head, start_sector, and in linear format with start_lba. The partition endpoint is specified in CHS format with end_cylinder, end_head, and end_sector. The size in 512-byte sectors is size_in_sectors.

The slight overspecification of the parameters is there because they depend on how the BIOS translates the disk geometry to the BIOS geometry. All CHS coordinates given to this command should be in the translated BIOS geometry.

The partition boot bit is enabled with the -boot-indication flag (default off).

The partition type can either raw numerical code, or a symbolic name. The following symbolic names are understood by the command: "unused" (0x0), "DOS 12-bit FAT" (0x1), "DOS 3.0+ 16-bit FAT" (0x4), "DOS 3.3+ extended" (0x5), "DOS 3.31+ 16-bit FAT" (0x6), "OS/2 IFS" (0x7), "OS/2 boot manager" (0xa), "Win95 32-bit FAT" (0xb), "Win95 32-bit FAT, LBA" (0xc), "Win95 16-bit FAT, LBA" (0xe), "Win95 extended, LBA" (0xf), "Linux swap" (0x82), "Linux native" (0x83), "Linux extended" (0x85), "Linux LVM" (0x8e), "BSD/386" (0xa5), "OpenBSD" (0xa6), "NetBSD" (0xa9), and "BeOS" (0xeb).

See Also
<scsi-disk>.print-partition-table
<scsi-disk>.create-sun-vtoc-header
Synopsis
<scsi-disk>.create-sun-vtoc-header [C] [H] [S] [-quiet]
Description
Create and write a new VTOC to a Sun disk. The geometry information written is taken from the configuration attribute 'geometry' of the disk, unless specified with the C, H and S parameters. A new empty partition table is also created, with only the standard 'backup' partition as number 2. -quiet makes the command silent in case of success.
See Also
<scsi-disk>.print-sun-vtoc, <scsi-disk>.create-sun-vtoc-partition, <scsi-disk>.delete-sun-vtoc-partition
<scsi-disk>.create-sun-vtoc-partition
Synopsis
<scsi-disk>.create-sun-vtoc-partition number "tag" "flag" start-block num-blocks [-quiet]
Description
Write partition information to the VTOC on a Sun disk. This command does not change the format of the disk, and it does not create any file system on the partition. Only the 'Volume Table Of Contents' is modified. No checking is performed to make sure that partitions do not overlap, or that they do not exceed the disk size. -quiet makes the command silent in case of success.
See Also
<scsi-disk>.print-sun-vtoc, <scsi-disk>.create-sun-vtoc-header, <scsi-disk>.delete-sun-vtoc-partition
<scsi-disk>.delete-sun-vtoc-partition
Synopsis
<scsi-disk>.delete-sun-vtoc-partition number [-quiet]
Description
Delete the information in the VTOC on a Sun disk for the specified partition. No other modification on the disk is performed. -quiet makes the command silent in case of success.
See Also
<scsi-disk>.print-sun-vtoc, <scsi-disk>.create-sun-vtoc-header, <scsi-disk>.create-sun-vtoc-partition
<scsi-disk>.dump-sun-partition
Synopsis
<scsi-disk>.dump-sun-partition number file
Description
Write all data from a Sun disk partition to the specified file in raw format.
See Also
<scsi-disk>.print-sun-vtoc, <scsi-disk>.add-sun-partition
<scsi-disk>.info
Synopsis
<scsi-disk>.info
Description
Print detailed information about the configuration of the device.
<scsi-disk>.print-partition-info
Synopsis
<scsi-disk>.print-partition-info num ["filename"]
Description
Print information about a partition. If a filename is given, then suitable partition parameters for use with image aware e2tools will be written to that file.
<scsi-disk>.print-partition-table
Synopsis
<scsi-disk>.print-partition-table
Description
Print the PC-style partition table for a disk.
See Also
<scsi-disk>.create-partition
<scsi-disk>.print-sun-vtoc
Synopsis
<scsi-disk>.print-sun-vtoc
Description
Print the contents of the VTOC (volume table of contents) for a Sun disk. This is similar to the Solaris 'prtvtoc' command.
See Also
<scsi-disk>.create-sun-vtoc-header, <scsi-disk>.create-sun-vtoc-partition, <scsi-disk>.delete-sun-vtoc-partition
<scsi-disk>.save-diff-file
Synopsis
<scsi-disk>.save-diff-file filename
Description
Writes changes to the image as a diff file in craff format. This is basically the same command as <image>.safe-diff-file.
See Also
<scsi-disk>.add-diff-file, <image>.save-diff-file
<scsi-disk>.status
Synopsis
<scsi-disk>.status
Description
Print detailed information about the current status of the device.

VIRTUTECH CONFIDENTIAL    Previous - Up - Next