Z-Drive R4 and 4500 Linux Device Driver

Transcription

1 User Guide Driver Version 4.2

2 Contents Introduction New features of driver version Linux distributions and installation packages Standard installation Checking PCIe slot performance Unloading the driver Installing on a boot drive Red Hat, CentOS, Oracle 6.n Red Hat, CentOS, Oracle 7.n SLES 11 and Drive access Migrating from the OCZ SCSI driver Hints and tips Toshiba Corporation. All Rights Reserved. No part of this document may be reproduced in any form or by any means, and may not be used to make any derivative work (such as translation, transformation, or adaptation) without written permission from Toshiba Corporation. Notice The information contained in this guide, including but not limited to any product specifications, is subject to change without notice. TOSHIBA CORPORATION AND ITS AFFILIATES ( TOSHIBA ) PROVIDE NO WARRANTY WITH REGARD TO THIS MANUAL OR ANY OTHER INFORMATION CONTAINED HEREIN AND HEREBY EXPRESSLY DISCLAIM ANY IMPLIED WARRANTIES OF MERCHANTABILITY OR FITNESS FOR ANY PARTICULAR PURPOSE WITH REGARD TO ANY OF THE FOREGOING. TOSHIBA ASSUMES NO LIABILITY FOR ANY DAMAGES INCURRED DIRECTLY OR INDIRECTLY FROM ANY TECHNICAL OR TYPOGRAPHICAL ERRORS OR OMISSIONS CONTAINED HEREIN OR FOR DISCREPANCIES BETWEEN THE PRODUCT AND THE GUIDE. IN NO EVENT SHALL TOSHIBA BE LIABLE FOR ANY INCIDENTAL, CONSEQUENTIAL, SPECIAL, OR EXEMPLARY DAMAGES, WHETHER BASED ON TORT, CONTRACT OR OTHERWISE, ARISING OUT OF OR IN CONNECTION WITH THIS GUIDE OR ANY OTHER INFORMATION CONTAINED HEREIN OR THE USE THEREOF. Disclaimer We assume no responsibility whatsoever for any damage or loss resulting from the use of this application. THIS APPLICATION IS PROVIDED "AS IS" WITHOUT WARRANTIES OF ANY KIND. WITHOUT LIMITING THE FOREGOING, TOSHIBA DISCLAIMS ALL WARRANTIES AND REPRESENTATIONS OF ANY KIND RELATING TO THE APPLICATION, WHETHER EXPRESS, IMPLIED, OR STATUTORY, INCLUDING WITHOUT LIMITATION THE IMPLIED WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, ACCURACY, OR NONINFRINGEMENT OF THIRD PARTY RIGHTS. TOSHIBA DOES NOT WARRANT THAT THE OPERATION OF THE APPLICATION WILL BE UNINTERRUPTED, ERROR-FREE, OR SECURE. ANY INSTALLATION AND/OR USE OF THE APPLICATION SHALL BE AT YOUR OWN RISK. About Trademarks OCZ is a trademark or registered trademark of Toshiba Corporation and/or its affiliates. PCIe is a registered trademark of PCI-SIG. Linux is the registered trademark of Linus Torvalds in the U.S. and other countries. Red Hat is a registered trademark of Red Hat Inc. in the U.S. and other countries. Oracle is a registered trademark of Oracle and/or its affiliates. All other marks are the property of their respective owners. Installation Technical Support Toshiba Corporation products include free technical support for direct, expert advice. For installation technical support, you can contact us at Document identifier: UG-ZDR4-LINUX-DRVR, Revision 7, July 2016 Software version: 4.2 2

3 Introduction Version 4.2 of the OCZ oczpcie Linux device driver for the Z-Drive R4 or 4500 is a block mode driver. It replaces driver versions 4.1 and 4.0. You can use this version to replace the OCZ ocz10xx SCSI driver version 3.x. This guide covers the following: Linux distributions and installation packages lists the installation package needed for each type of supported Linux distribution Standard installation describes how to install the driver when using the Z-Drive R4 or 4500 as a storage device, how to check PCIe slot performance and how to unload the driver Installing on a boot drive describes how to install the driver when you want to use the Z-Drive R4 or 4500 as a system boot disk Drive access describes the SSD naming conventions Migrating from the OCZ SCSI driver summarizes changes from the previous OCZ SCSI driver Hints and tips on how to optimize the use of this device driver, including BIOS and firmware requirements New features of driver version 4.2 Changes since version are: discard now consistently discards the last sector added support for Red Hat Enterprise Linux 6.6, 6.7 and 7.1, CentOS 6.6, 6.7 and 7.1, Oracle 6.6, 6.7 and 7.1, Ubuntu and SLES 11.4 and 12 removed support for Oracle Unbreakable 5.8, SLES 11.1 and 11.2, Ubuntu 10 and 13 Changes since version are: introduced iostat support for drive sector count, drive IO request count and in-flight request counts added support for Red Hat Enterprise Linux 7.0, CentOS 7.0, Oracle 7.0, Ubuntu Oracle packages now support updates across ABI compatible kernel updates SLES driver packages now automatically handle kernel upgrades as part of SLES updates Changes since version are: added support for RHEL 6.5, CentOS 6.5, Oracle 6.5 and Ubuntu unified Ubuntu and into a single installer improved handling of power management events UG-ZDR4-LINUX-DRVR, Revision 7 3

4 Linux distributions and installation packages The driver is packaged for standard installation and for installation as a system boot drive. The following table lists the package files to use for each supported Linux distribution and kernel version. Version Kernel Standard installation Boot installation Red Hat Enterprise Linux oczpcie-centos_rhel_oracle6.x oczpcie-boot-centos_rhel6.x oczpcie-centos_rhel_oracle6.x oczpcie-boot-centos_rhel6.x oczpcie-centos_rhel_oracle6.x oczpcie-boot-centos_rhel6.x oczpcie-centos_rhel_oracle6.x oczpcie-boot-centos_rhel6.x oczpcie-centos_rhel_oracle6.x oczpcie-boot-centos_rhel6.x oczpcie-centos_rhel_oracle6.x oczpcie-boot-centos_rhel6.x oczpcie-centos_rhel_oracle6.x oczpcie-boot-centos_rhel6.x oczpcie-centos_rhel_oracle6.x oczpcie-boot-centos_rhel6.x oczpcie-centos_rhel_oracle7.x oczpcie-boot-centos_rhel7.x oczpcie-centos_rhel_oracle7.x oczpcie-boot-centos_rhel7.x Toshiba Corporation

5 Version Kernel Standard installation Boot installation CentOS oczpcie-centos_rhel_oracle6.x oczpcie-boot-centos_rhel6.x oczpcie-centos_rhel_oracle6.x oczpcie-boot-centos_rhel6.x oczpcie-centos_rhel_oracle6.x oczpcie-boot-centos_rhel6.x oczpcie-centos_rhel_oracle6.x oczpcie-boot-centos_rhel6.x oczpcie-centos_rhel_oracle6.x oczpcie-boot-centos_rhel6.x oczpcie-centos_rhel_oracle6.x oczpcie-boot-centos_rhel6.x oczpcie-centos_rhel_oracle6.x oczpcie-boot-centos_rhel6.x oczpcie-centos_rhel_oracle6.x oczpcie-boot-centos_rhel6.x oczpcie-centos_rhel_oracle7.x oczpcie-boot-centos_rhel7.x oczpcie-centos_rhel_oracle7.x oczpcie-boot-centos_rhel7.x UG-ZDR4-LINUX-DRVR, Revision 7 5

6 Version Kernel Standard installation Boot installation Oracle Linux oczpcie-centos_rhel_oracle6.x oczpcie-boot-oracle oczpcie-centos_rhel_oracle6.x oczpcie-boot-oracle oczpcie-centos_rhel_oracle6.x oczpcie-boot-oracle oczpcie-centos_rhel_oracle6.x oczpcie-boot-oracle el6 oczpcie-centos_rhel_oracle6.x oczpcie-boot-oracle el6 oczpcie-centos_rhel_oracle6.x oczpcie-boot-oracle oczpcie-centos_rhel_oracle6.x oczpcie-boot-oracle oczpcie-centos_rhel_oracle6.x oczpcie-boot-oracle oczpcie-centos_rhel_oracle7.x oczpcie-boot-oracle oczpcie-centos_rhel_oracle7.x oczpcie-boot-oracle7.1- Oracle Linux (unbreakable) oczpcie-oracleunbreakable oczpcie-oracleunbreakable oczpcie-oracleunbreakable oczpcie-oracleunbreakable el6 oczpcie-oracleunbreakable el6 oczpcie-oracleunbreakable el6uek oczpcie-oracleunbreakable el6uek oczpcie-oracleunbreakable el7uek oczpcie-oracleunbreakable el7uek oczpcie-oracleunbreakable7.1- oczpcie-boot-oracle6.0- oczpcie-boot-oracle6.1- oczpcie-boot-oracle6.2- oczpcie-boot-oracle6.3- oczpcie-boot-oracle6.4- oczpcie-boot-oracle6.5- oczpcie-boot-oracle6.6- oczpcie-boot-oracle6.7- oczpcie-boot-oracle7.0- oczpcie-boot-oracle Toshiba Corporation

7 Version Kernel Standard installation Boot installation SUSE Linux Enterprise Server 11, SP oczpcie-sles11.3-kmp-default v4.2.nnn.kernel.x86_64.rpm 11, SP oczpcie-sles11.4-kmp-default v4.2.nnn.kernel.x86_64.rpm oczpcie-sles12.0-kmp-default v4.2.nnn.kernel.x86_64.rpm oczpcie-boot-sles11.3- oczpcie-boot-sles11.4- oczpcie-boot-sles12.0- Ubuntu Server LTS oczpcie-ubuntu12- v4.2.nnn.x86_64.deb oczpcie-ubuntu14- v4.2.nnn.x86_64.deb oczpcie-ubuntu15- v4.2.nnn.x86_64.deb N/A N/A N/A UG-ZDR4-LINUX-DRVR, Revision 7 7

8 Standard installation There is no upgrade path from: the OCZ SCSI driver (ocz10xx). You must first uninstall the previous driver before installing the new driver earlier 4.0 driver versions on a SLES system. You must first uninstall the previous driver before installing the new driver. To uninstall, use sudo rpm -e previous_driver.rpm, and install the new driver package without rebooting Any data on the SSD is preserved. Before installing, consider the following: Distribution Linux, kernel V3.2 or later Oracle SLES Notes if you installed the Z-Drive R4 or 4500 before installing the device driver, you may find that the standard mvsas driver is loaded against the card. A symptom of having the mvsas driver loaded is being presented with multiple SSDs of lower performance, rather than a single drive. In this case, to start using the OCZ oczpcie driver after installing it, you must reboot the system or manually rebind the driver if you want to use the Z-Drive R4 or 4500 in both the standard kernel and the unbreakable kernel, then you must install separate rpm files for each of these into the appropriate kernel you must do one of the following before installing the driver: in /etc/modprobe.d/unsupported-modules, set allow_unsupported_modules to 1 to manually load modules, use modprobe oczvca --allow-unsupported If you are running any OCZ SLES driver prior to V4.1, you must first uninstall the previous driver before installing the new driver. To uninstall, use sudo rpm -e previous_driver.rpm, and install the new driver package without rebooting Ubuntu to ensure seamless operation after Ubuntu updates, you must install the build-essential and dkms packages although the driver automatically supports operation after Ubuntu LTS updates (for example, from to ), it does not support version upgrades (for example, to 12.04). You must uninstall the existing driver and install the correct driver package for the upgraded distribution version To install the OCZ Z-Drive R4 and 4500 Linux driver: 1 Copy the appropriate rpm or deb package file to a local drive on your system. For details of the correct file for your distribution, see Linux distributions and installation packages on page 4. 2 Enter one of the following commands, where filename is the name of the package file that you copied: to install an rpm file: sudo rpm U filename.rpm to install a deb file: sudo dpkg i filename.deb The following kernel objects are installed: oczpcie.ko provides the core driver support, as a GPL module oczvca.ko provides the Virtualized Controller Architecture (VCA) functionality, as a proprietary module For information on getting the most out of the driver, including further items you may need to install, see Hints and tips on page Toshiba Corporation

9 Checking PCIe slot performance For optimal performance, install the Z-Drive in, or move the Z-Drive to, a PCIe 8-lane Gen 2 slot or better. To check the performance of the slot, let the driver load then look in the system message log for a message similar to: oczpcie: PCI-E x8, Bandwidth Usage: 5.0 Gbps If this does not show PCI-E x8 or a bandwidth of 5.0 Gbps, then move it to a slot that meets these requirements. Unloading the driver To unload the driver, remove all references to the driver, then use the following commands in the order given: rmmod oczvca rmmod oczpcie Installing on a boot drive To use the Z-Drive R4 or 4500 as the system boot disk, you must install the Linux device driver as part of the Linux distribution installation process. For details of the correct tar.gz file to use for your distribution, see the table in Linux distributions and installation packages on page 4. Before you start the installation process, extract the tar.gz file and place the contents on a USB flash drive. We strongly recommend that these files are the only contents on this USB flash drive, as additional files can cause some installations to fail. Ensure the USB flash drive is inserted when you start your system setup, and follow the instructions below for the relevant distribution. For information on getting the most out of the driver, including further items you may need to install, see Hints and tips on page 12. Red Hat, CentOS, Oracle 6.n 1 At the start of the standard installation process, add dd updates blacklist=mvsas to the boot command line. 2 When the installer asks for a driver disk, choose the device corresponding to the USB flash drive and select the dd file. 3 When the installer asks for an update disk, choose the device corresponding to the USB flash drive. 4 When the package selection screen is shown, choose the customize now option. Under Uncategorized, ensure that the OCZ oczpcie driver package is selected for installation. 5 Continue with the standard installation, ensuring that you install the boot loader to the Z-Drive R4 or When selecting the Z-Drive R4 or 4500 that you want to install the boot loader on, the drive name starts with oczpcie. Ignore any drives starting with.oczctl. UG-ZDR4-LINUX-DRVR, Revision 7 9

10 Text or Kickstart installation When performing a text or Kickstart installation, you must: ensure that you install the boot loader to the Z-Drive R4 or 4500 include the oczpcie package(s) in the list of packages to be installed, otherwise you cannot reboot at the end of the installation. You must include both the normal and unbreakable kernel (if applicable). An example package list is: core oczpcie-centos_rhel_oracleversion oczpcie-oracleunbreakableversion %end version is the version of software you want. For more information, see the Kickstart documentation. Red Hat, CentOS, Oracle 7.n 1 At the start of the boot installation process, press Tab then add modprobe.blacklist=mvsas dd inst.updates=hd:sdapartition_number:/updates.img inst.ks=hd:sdapartition_number:/oczpcie.ks to the boot command line. 2 When the installer asks for the a driver disk, select the pendrive partition which has the driver disk selected, followed by oczpcie.iso and finally oczpcie_redhat_centos7.x_driver_version_86_64.rpm. 3 On the main installation screen, choose the device with the name starting with /dev/oczpcie as the installation device. This installation includes a kickstart file (oczpcie.ks). If you already have a kickstart file, change the inst.ks=hd:sda1:/oczpcie.ks option to point to your kickstart file and add the following lines to the postinstall script: #!/bin/bash for i in /for i in /dev/ocz*ssd do grub2-install --modules="part_msdos part_gpt xfs ext2 fat lvm" \$i done SLES 11 and 12 1 To load additional drivers, at the start of the standard installation process, press F6 to show the driver menu then click Yes. 2 Continue with the standard installation until you reach the Installation Setting window: click the expert tab and click booting click the boot loader installation tab click Boot Loader Installation Details, and ensure that the device with the name starting with /dev/ oczpcie is the first device in the disk order list To perform a network PXE installation, you must create a driver disk: 1 Extract the tar.gz file into an empty directory, with a command prompt set to that directory. 2 Enter the command: find linux/ cpio -ov -H newc > sles.dud 3 Use driver disk sles.dud as part of the network installation, by appending the boot parameter: dud= Toshiba Corporation

11 Drive access Once the driver is installed, the Z-Drive R4 or 4500 is listed with a name based on the following naming conventions: /dev/oczpcie_b_n_ssd or /dev/oczpcie_d_b_n_ssd if there are PCIe domains, where: D is the domain number B is the bus number N is the slot number This naming convention gives consistent results, regardless of the order in which the drives are enumerated. If you move the Z-Drive R4 or 4500 to a different slot, the name is changed accordingly. You can mount file systems by the UUID or label, which is independent of the device name. Migrating from the OCZ SCSI driver If you are familiar with the previous OCZ SCSI based driver, ocz10xx, the following information may help you change to using the current block mode driver: utilities designed for SCSI devices no longer work, but there are usually alternatives as this is not a SCSI driver, SCSI Generic Ioctl is not supported devices do not appear when using lsscsi. Use lsblk instead some standard system tools can specify SCSI to ATA translation. For example: smartctl -d sat -a /dev/oczpcie_b_n_ssd SSDs do not require an elevator, and any elevator has a negative impact on performance. Since the driver does not use an elevator, there is no scheduler option to set for this driver as the driver has no elevator, no iostat elevator statistics are available. However, other iostat statistics are available UG-ZDR4-LINUX-DRVR, Revision 7 11

12 Hints and tips BIOS and firmware versions For all features to operate correctly, this driver requires BIOS version or higher. If you are running an older BIOS, upgrade to at least this version. To use TRIM/discard, the firmware on the SSD must be: C series: 2.25 or higher R series: 3.20E or higher If you are running older versions of the firmware, upgrade to at least these versions and reboot. To obtain firmware and BIOS updates, sign up at the OCZ Enterprise Communication & Download Center at By registering you can gain access to OCZ support tools, resources and updates, as well as receive notifications of new downloads and documentation. TRIM/Discard support TRIM/Discard is fully supported by this driver. However, if you have a busy file-system, consider deferring TRIM/ discard until a quiet time to improve performance. To do so, mount the file system without the discard option and instead run fstrim at a suitable time, for example by using a cron script. An example fstrim command line is: nice ionice -c idle fstrim -m 1M mount_point Maximum number of partitions You may create a maximum of 15 partitions on each device. iostat support This release supports iostat statistics. Collection of these statistics may impact performance on large systems. If required, you can disable these using: echo 0 >/sys/block/device_name/queue/iostats To ensure that no in-flight statistics remain, disable statistics collection when the card is in idle state. Some Linux distributions mask devices from iostat by default. If you are not seeing iostat entries for the drive, this may be the cause. To fix this, find the major numbers for your cards using: grep oczpcie_vca /proc/devices The numbers in the first column are the major numbers in use. In /etc/sysstat/sysstat.ioconf, comment out any entries that start with any of these numbers, by prefixing the line with a # character. Oracle 6.0 installation and uninstallation If you are installing the drivers for both the standard and unbreakable kernels in Oracle 6.0, you must install the standard package first, followed by the unbreakable one. If you have both drivers installed and wish to uninstall them, you must uninstall the unbreakable package first, followed by the standard one. If you have both drivers installed and only wish to uninstall the standard driver but retain the unbreakable one, you must still uninstall both packages as above, and then reinstall the unbreakable one. The order of installation and uninstallation is unimportant on all Oracle releases after Toshiba Corporation