diff options
Diffstat (limited to '')
| -rw-r--r-- | dev_interface.cpp | 555 |
1 files changed, 555 insertions, 0 deletions
diff --git a/dev_interface.cpp b/dev_interface.cpp new file mode 100644 index 0000000..2f4646f --- /dev/null +++ b/dev_interface.cpp @@ -0,0 +1,555 @@ +/* + * dev_interface.cpp + * + * Home page of code is: https://www.smartmontools.org + * + * Copyright (C) 2008-23 Christian Franke + * + * SPDX-License-Identifier: GPL-2.0-or-later + */ + +#include "config.h" + +#include "dev_interface.h" +#include "dev_tunnelled.h" +#include "atacmds.h" // ATA_SMART_CMD/STATUS +#include "scsicmds.h" // scsi_cmnd_io +#include "nvmecmds.h" // nvme_status_*() +#include "utility.h" + +#include <errno.h> +#include <stdarg.h> +#include <stdlib.h> // realpath() +#include <stdexcept> + +const char * dev_interface_cpp_cvsid = "$Id: dev_interface.cpp 5496 2023-07-10 13:37:25Z chrfranke $" + DEV_INTERFACE_H_CVSID; + +///////////////////////////////////////////////////////////////////////////// +// smart_device + +int smart_device::s_num_objects = 0; + +smart_device::smart_device(smart_interface * intf, const char * dev_name, + const char * dev_type, const char * req_type) +: m_intf(intf), m_info(dev_name, dev_type, req_type), + m_ata_ptr(0), m_scsi_ptr(0), m_nvme_ptr(0) +{ + s_num_objects++; +} + +smart_device::smart_device(do_not_use_in_implementation_classes) +: m_intf(0), m_ata_ptr(0), m_scsi_ptr(0), m_nvme_ptr(0) +{ + throw std::logic_error("smart_device: wrong constructor called in implementation class"); +} + +smart_device::~smart_device() +{ + s_num_objects--; +} + +bool smart_device::is_syscall_unsup() const +{ + if (get_errno() == ENOSYS) + return true; +#ifdef ENOTSUP + if (get_errno() == ENOTSUP) + return true; +#endif + return false; +} + +bool smart_device::set_err(int no, const char * msg, ...) +{ + if (!msg) + return set_err(no); + m_err.no = no; + va_list ap; va_start(ap, msg); + m_err.msg = vstrprintf(msg, ap); + va_end(ap); + return false; +} + +bool smart_device::set_err(int no) +{ + return smi()->set_err_var(&m_err, no); +} + +smart_device * smart_device::autodetect_open() +{ + open(); + return this; +} + +bool smart_device::is_powered_down() +{ + return false; +} + +bool smart_device::owns(const smart_device * /*dev*/) const +{ + return false; +} + +void smart_device::release(const smart_device * /*dev*/) +{ +} + + +///////////////////////////////////////////////////////////////////////////// +// ata_device + +ata_in_regs_48bit::ata_in_regs_48bit() +: features_16(features, prev.features), + sector_count_16(sector_count, prev.sector_count), + lba_low_16(lba_low, prev.lba_low), + lba_mid_16(lba_mid, prev.lba_mid), + lba_high_16(lba_high, prev.lba_high), + lba_48( lba_low, lba_mid, lba_high, + prev.lba_low, prev.lba_mid, prev.lba_high) +{ +} + +ata_out_regs_48bit::ata_out_regs_48bit() +: sector_count_16(sector_count, prev.sector_count), + lba_low_16(lba_low, prev.lba_low), + lba_mid_16(lba_mid, prev.lba_mid), + lba_high_16(lba_high, prev.lba_high), + lba_48( lba_low, lba_mid, lba_high, + prev.lba_low, prev.lba_mid, prev.lba_high) +{ +} + +ata_cmd_in::ata_cmd_in() +: direction(no_data), + buffer(0), + size(0) +{ +} + +ata_cmd_out::ata_cmd_out() +{ +} + +bool ata_device::ata_pass_through(const ata_cmd_in & in) +{ + ata_cmd_out dummy; + return ata_pass_through(in, dummy); +} + +bool ata_device::ata_cmd_is_supported(const ata_cmd_in & in, + unsigned flags, const char * type /* = 0 */) +{ + // Check DATA IN/OUT + switch (in.direction) { + case ata_cmd_in::no_data: break; + case ata_cmd_in::data_in: break; + case ata_cmd_in::data_out: break; + default: + return set_err(EINVAL, "Invalid data direction %d", (int)in.direction); + } + + // Check buffer size + if (in.direction == ata_cmd_in::no_data) { + if (in.size) + return set_err(EINVAL, "Buffer size %u > 0 for NO DATA command", in.size); + } + else { + if (!in.buffer) + return set_err(EINVAL, "Buffer not set for DATA IN/OUT command"); + unsigned count = (in.in_regs.prev.sector_count<<16)|in.in_regs.sector_count; + // TODO: Add check for sector count == 0 + if (count * 512 != in.size) + return set_err(EINVAL, "Sector count %u does not match buffer size %u", count, in.size); + } + + // Check features + const char * errmsg = 0; + if (in.direction == ata_cmd_in::data_out && !(flags & supports_data_out)) + errmsg = "DATA OUT ATA commands not implemented"; + else if ( in.out_needed.is_set() && !(flags & supports_output_regs) + && !( in.in_regs.command == ATA_SMART_CMD + && in.in_regs.features == ATA_SMART_STATUS + && (flags & supports_smart_status))) + errmsg = "Read of ATA output registers not implemented"; + else if (!(in.size == 0 || in.size == 512) && !(flags & supports_multi_sector)) + errmsg = "Multi-sector ATA commands not implemented"; + else if (in.in_regs.is_48bit_cmd() && !(flags & (supports_48bit_hi_null|supports_48bit))) + errmsg = "48-bit ATA commands not implemented"; + else if (in.in_regs.is_real_48bit_cmd() && !(flags & supports_48bit)) + errmsg = "48-bit ATA commands not fully implemented"; + + if (errmsg) + return set_err(ENOSYS, "%s%s%s%s", errmsg, + (type ? " [" : ""), (type ? type : ""), (type ? "]" : "")); + + return true; +} + +bool ata_device::ata_identify_is_cached() const +{ + return false; +} + +///////////////////////////////////////////////////////////////////////////// +// scsi_device + +bool scsi_device::scsi_pass_through_and_check(scsi_cmnd_io * iop, + const char * msg) +{ + // Provide sense buffer + unsigned char sense[32] = {0, }; + iop->sensep = sense; + iop->max_sense_len = sizeof(sense); + iop->timeout = SCSI_TIMEOUT_DEFAULT; + + // Run cmd + if (!scsi_pass_through(iop)) { + if (scsi_debugmode > 0) + pout("%sscsi_pass_through() failed, errno=%d [%s]\n", + msg, get_errno(), get_errmsg()); + iop->sensep = nullptr; + return false; + } + + // Check sense + scsi_sense_disect sinfo; + scsi_do_sense_disect(iop, &sinfo); + int err = scsiSimpleSenseFilter(&sinfo); + iop->sensep = nullptr; + if (err) { + if (scsi_debugmode > 0) + pout("%sscsi error: %s\n", msg, scsiErrString(err)); + return set_err(EIO, "scsi error %s", scsiErrString(err)); + } + + return true; +} + +///////////////////////////////////////////////////////////////////////////// +// nvme_device + +bool nvme_device::set_nvme_err(nvme_cmd_out & out, unsigned status, const char * msg /* = 0 */) +{ + out.status = status; + out.status_valid = true; + char buf[64]; + return set_err(nvme_status_to_errno(status), "%s%s (0x%03x)", (msg ? msg : ""), + nvme_status_to_info_str(buf, status), status); +} + + +///////////////////////////////////////////////////////////////////////////// +// tunnelled_device_base + +tunnelled_device_base::tunnelled_device_base(smart_device * tunnel_dev) +: smart_device(never_called), + m_tunnel_base_dev(tunnel_dev) +{ +} + +tunnelled_device_base::~tunnelled_device_base() +{ + delete m_tunnel_base_dev; +} + +bool tunnelled_device_base::is_open() const +{ + return (m_tunnel_base_dev && m_tunnel_base_dev->is_open()); +} + +bool tunnelled_device_base::open() +{ + if (!m_tunnel_base_dev) + return set_err(ENOSYS); + if (!m_tunnel_base_dev->open()) + return set_err(m_tunnel_base_dev->get_err()); + return true; +} + +bool tunnelled_device_base::close() +{ + if (!m_tunnel_base_dev) + return true; + if (!m_tunnel_base_dev->close()) + return set_err(m_tunnel_base_dev->get_err()); + return true; +} + +bool tunnelled_device_base::owns(const smart_device * dev) const +{ + return (m_tunnel_base_dev && (m_tunnel_base_dev == dev)); +} + +void tunnelled_device_base::release(const smart_device * dev) +{ + if (m_tunnel_base_dev == dev) + m_tunnel_base_dev = 0; +} + + +///////////////////////////////////////////////////////////////////////////// +// smart_interface + +// Pointer to (usually singleton) interface object returned by ::smi() +smart_interface * smart_interface::s_instance; + +std::string smart_interface::get_os_version_str() +{ + return SMARTMONTOOLS_BUILD_HOST; +} + +std::string smart_interface::get_valid_dev_types_str() +{ + // default + std::string s = + "ata, scsi[+TYPE], nvme[,NSID], sat[,auto][,N][+TYPE], usbasm1352r,N, usbcypress[,X], " + "usbjmicron[,p][,x][,N], usbprolific, usbsunplus, sntasmedia, sntjmicron[,NSID], " + "sntrealtek, jmb39x[-q],N[,sLBA][,force][+TYPE], " + "jms56x,N[,sLBA][,force][+TYPE]"; + // append custom + std::string s2 = get_valid_custom_dev_types_str(); + if (!s2.empty()) { + s += ", "; s += s2; + } + return s; +} + +std::string smart_interface::get_app_examples(const char * /*appname*/) +{ + return ""; +} + +bool smart_interface::disable_system_auto_standby(bool /*disable*/) +{ + return set_err(ENOSYS); +} + +bool smart_interface::set_err(int no, const char * msg, ...) +{ + if (!msg) + return set_err(no); + m_err.no = no; + va_list ap; va_start(ap, msg); + m_err.msg = vstrprintf(msg, ap); + va_end(ap); + return false; +} + +decltype(nullptr) smart_interface::set_err_np(int no, const char * msg, ...) +{ + if (!msg) { + set_err(no); + return nullptr; + } + m_err.no = no; + va_list ap; va_start(ap, msg); + m_err.msg = vstrprintf(msg, ap); + va_end(ap); + return nullptr; +} + +bool smart_interface::set_err(int no) +{ + return set_err_var(&m_err, no); +} + +bool smart_interface::set_err_var(smart_device::error_info * err, int no) +{ + err->no = no; + err->msg = get_msg_for_errno(no); + if (err->msg.empty() && no != 0) + err->msg = strprintf("Unknown error %d", no); + return false; +} + +const char * smart_interface::get_msg_for_errno(int no) +{ + return strerror(no); +} + +std::string smart_interface::get_unique_dev_name(const char * name, const char * type) const +{ + std::string unique_name; +#if defined(HAVE_UNISTD_H) && !defined(_WIN32) && !defined(__OS2__) + char * p = realpath(name, (char *)0); // nullptr requires POSIX.1.2008 compatibility + if (p) { + unique_name = p; + free(p); + } + else +#endif + unique_name = name; + + if (*type && is_raid_dev_type(type)) { + // -d TYPE options must match if RAID drive number is specified + unique_name += " ["; unique_name += type; unique_name += ']'; + } + return unique_name; +} + +bool smart_interface::is_raid_dev_type(const char * type) const +{ + if (!strchr(type, ',')) + return false; + if (str_starts_with(type, "sat,")) + return false; + int i; + if (sscanf(type, "%*[^,],%d", &i) != 1) + return false; + return true; +} + + +///////////////////////////////////////////////////////////////////////////// +// Default device factory + +smart_device * smart_interface::get_smart_device(const char * name, const char * type) +{ + clear_err(); + + // Call platform specific autodetection if no device type specified + smart_device * dev; + if (!type || !*type) { + dev = autodetect_smart_device(name); + if (!dev && !get_errno()) + set_err(EINVAL, "Unable to detect device type"); + return dev; + } + + // First check for platform specific device types + dev = get_custom_smart_device(name, type); + if (dev || get_errno()) + return dev; + + if (!strcmp(type, "ata")) + dev = get_ata_device(name, type); + else if (!strcmp(type, "scsi")) + dev = get_scsi_device(name, type); + + else if (str_starts_with(type, "nvme")) { + int n1 = -1, n2 = -1, len = strlen(type); + unsigned nsid = 0; // invalid namespace id -> use default + sscanf(type, "nvme%n,0x%x%n", &n1, &nsid, &n2); + if (!(n1 == len || n2 == len)) + return set_err_np(EINVAL, "Invalid NVMe namespace id in '%s'", type); + dev = get_nvme_device(name, type, nsid); + } + // TODO: Unify handling of '-d TYPE...+BASETYPE...' + else if ( (str_starts_with(type, "sat") && (!type[3] || strchr(",+", type[3]))) + || str_starts_with(type, "scsi+") + || str_starts_with(type, "usb") ) { + // Split "sat...+base..." -> ("sat...", "base...") + unsigned satlen = strcspn(type, "+"); + std::string sattype(type, satlen); + const char * basetype = (type[satlen] ? type+satlen+1 : ""); + // Recurse to allocate base device, default is standard SCSI + if (!*basetype) + basetype = "scsi"; + smart_device_auto_ptr basedev( get_smart_device(name, basetype) ); + if (!basedev) + return set_err_np(EINVAL, "Type '%s+...': %s", sattype.c_str(), get_errmsg()); + // Result must be SCSI + if (!basedev->is_scsi()) + return set_err_np(EINVAL, "Type '%s+...': Device type '%s' is not SCSI", sattype.c_str(), basetype); + // Attach SAT tunnel + return get_sat_device(sattype.c_str(), basedev.release()->to_scsi()); + } + + else if (str_starts_with(type, "snt")) { + smart_device_auto_ptr basedev( get_smart_device(name, "scsi") ); + if (!basedev) + return set_err_np(EINVAL, "Type '%s': %s", type, get_errmsg()); + + return get_snt_device(type, basedev.release()->to_scsi()); + } + + else if (str_starts_with(type, "jmb39x") || str_starts_with(type, "jms56x")) { + // Split "jmb39x...+base..." -> ("jmb39x...", "base...") + unsigned jmblen = strcspn(type, "+"); + std::string jmbtype(type, jmblen); + const char * basetype = (type[jmblen] ? type+jmblen+1 : ""); + // Recurse to allocate base device, default is standard SCSI + if (!*basetype) + basetype = "scsi"; + smart_device_auto_ptr basedev( get_smart_device(name, basetype) ); + if (!basedev) + return set_err_np(EINVAL, "Type '%s+...': %s", jmbtype.c_str(), get_errmsg()); + // Attach JMB39x tunnel + return get_jmb39x_device(jmbtype.c_str(), basedev.release()); + } + + else if (str_starts_with(type, "intelliprop")) { + // Split "intelliprop...+base..." -> ("intelliprop...", "base...") + unsigned itllen = strcspn(type, "+"); + std::string itltype(type, itllen); + const char * basetype = (type[itllen] ? type+itllen+1 : ""); + // Recurse to allocate base device, default is standard ATA + if (!*basetype) + basetype = "ata"; + smart_device_auto_ptr basedev( get_smart_device(name, basetype) ); + if (!basedev) + return set_err_np(EINVAL, "Type '%s': %s", type, get_errmsg()); + // Result must be ATA + if (!basedev->is_ata()) + return set_err_np(EINVAL, "Type '%s': Device type '%s' is not ATA", type, basetype); + return get_intelliprop_device(itltype.c_str(), basedev.release()->to_ata()); + } + + else { + return set_err_np(EINVAL, "Unknown device type '%s'", type); + } + if (!dev && !get_errno()) + set_err(EINVAL, "Not a device of type '%s'", type); + return dev; +} + +bool smart_interface::scan_smart_devices(smart_device_list & /*devlist*/, + const char * /*type*/, const char * /*pattern*/ /* = 0 */) +{ + return set_err(ENOSYS); +} + +bool smart_interface::scan_smart_devices(smart_device_list & devlist, + const smart_devtype_list & types, const char * pattern /* = 0 */) +{ + unsigned n = types.size(); + if (n == 0) + return scan_smart_devices(devlist, (const char *)0, pattern); + if (n == 1) + return scan_smart_devices(devlist, types.front().c_str(), pattern); + + for (unsigned i = 0; i < n; i++) { + smart_device_list tmplist; + if (!scan_smart_devices(tmplist, types[i].c_str(), pattern)) + return false; + devlist.append(tmplist); + } + + return true; +} + +nvme_device * smart_interface::get_nvme_device(const char * /*name*/, const char * /*type*/, unsigned /*nsid*/) +{ + return set_err_np(ENOSYS, "NVMe devices are not supported in this version of smartmontools"); +} + +smart_device * smart_interface::get_custom_smart_device(const char * /*name*/, const char * /*type*/) +{ + return nullptr; +} + +std::string smart_interface::get_valid_custom_dev_types_str() +{ + return ""; +} + +smart_device * smart_interface::get_scsi_passthrough_device(const char * type, scsi_device * scsidev) +{ + if (!strncmp(type, "snt", 3)) { + return get_snt_device(type, scsidev); + } + + return get_sat_device(type, scsidev); +} |