[mirror_smartmontools-debian.git] / dev_interface.cpp

/*
 * dev_interface.cpp
 *
 * Home page of code is: http://smartmontools.sourceforge.net
 *
 * Copyright (C) 2008-9 Christian Franke <smartmontools-support@lists.sourceforge.net>
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2, or (at your option)
 * any later version.
 *
 * You should have received a copy of the GNU General Public License
 * (for example COPYING); If not, see <http://www.gnu.org/licenses/>.
 *
 */

#include "config.h"
#include "int64.h"
#include "atacmds.h"
#include "scsicmds.h"
#include "dev_interface.h"
#include "dev_tunnelled.h"
#include "utility.h"

#include <stdexcept>

const char * dev_interface_cpp_cvsid = "$Id: dev_interface.cpp 2971 2009-10-26 22:05:54Z chrfranke $"
  DEV_INTERFACE_H_CVSID;

/////////////////////////////////////////////////////////////////////////////
// smart_device

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)
{
}

smart_device::smart_device(do_not_use_in_implementation_classes)
: m_intf(0), m_ata_ptr(0), m_scsi_ptr(0)
{
  throw std::logic_error("smart_device: wrong constructor called in implementation class");
}

smart_device::~smart_device() throw()
{
}

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)
{
  smi()->set_err_var(&m_err, no);
  return false;
}

smart_device * smart_device::autodetect_open()
{
  open();
  return this;
}

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)
{
}

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)
{
}

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_ok(const ata_cmd_in & in,
  bool data_out_support /*= false*/,
  bool multi_sector_support /*= false*/,
  bool ata_48bit_support /*= false*/)
{
  // 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
  if (in.direction == ata_cmd_in::data_out && !data_out_support)
    return set_err(ENOSYS, "DATA OUT ATA commands not supported");
  if (!(in.size == 0 || in.size == 512) && !multi_sector_support)
    return set_err(ENOSYS, "Multi-sector ATA commands not supported");
  if (in.in_regs.is_48bit_cmd() && !ata_48bit_support)
    return set_err(ENOSYS, "48-bit ATA commands not supported");
  return true;
}

bool ata_device::ata_identify_is_cached() const
{
  return false;
}


/////////////////////////////////////////////////////////////////////////////
// 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() throw()
{
  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, sat[,N][+TYPE], usbcypress[,X], usbjmicron[,x][,N], usbsunplus";
  // 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 "";
}

void smart_interface::set_err(int no, const char * msg, ...)
{
  if (!msg) {
    set_err(no); return;
  }
  m_err.no = no;
  va_list ap; va_start(ap, msg);
  m_err.msg = vstrprintf(msg, ap);
  va_end(ap);
}

void smart_interface::set_err(int no)
{
  set_err_var(&m_err, no);
}

void 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);
}

const char * smart_interface::get_msg_for_errno(int no)
{
  return strerror(no);
}


/////////////////////////////////////////////////////////////////////////////
// Default device factory

smart_device * smart_interface::get_smart_device(const char * name, const char * type)
{
  clear_err();
  if (!type || !*type) {
    smart_device * dev = autodetect_smart_device(name);
    if (!dev && !get_errno())
      set_err(EINVAL, "Unable to detect device type");
    return dev;
  }

  smart_device * 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 (  ((!strncmp(type, "sat", 3) && (!type[3] || strchr(",+", type[3])))
           || (!strncmp(type, "usb", 3)))) {
    // 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) {
      set_err(EINVAL, "Type '%s+...': %s", sattype.c_str(), get_errmsg());
      return 0;
    }
    // Result must be SCSI
    if (!basedev->is_scsi()) {
      set_err(EINVAL, "Type '%s+...': Device type '%s' is not SCSI", sattype.c_str(), basetype);
      return 0;
    }
    // Attach SAT tunnel
    ata_device * satdev = get_sat_device(sattype.c_str(), basedev->to_scsi());
    if (!satdev)
      return 0;
    basedev.release();
    return satdev;
  }

  else {
    set_err(EINVAL, "Unknown device type '%s'", type);
    return 0;
  }
  if (!dev && !get_errno())
    set_err(EINVAL, "Not a device of type '%s'", type);
  return dev;
}

smart_device * smart_interface::get_custom_smart_device(const char * /*name*/, const char * /*type*/)
{
  return 0;
}

std::string smart_interface::get_valid_custom_dev_types_str()
{
  return "";
}
Commit	Line	Data
2127e193 GI	1	/*
	2	* dev_interface.cpp
	3	*
	4	* Home page of code is: http://smartmontools.sourceforge.net
	5	*
54965743	6	* Copyright (C) 2008-9 Christian Franke <smartmontools-support@lists.sourceforge.net>
2127e193 GI	7	*
	8	* This program is free software; you can redistribute it and/or modify
	9	* it under the terms of the GNU General Public License as published by
	10	* the Free Software Foundation; either version 2, or (at your option)
	11	* any later version.
	12	*
	13	* You should have received a copy of the GNU General Public License
	14	* (for example COPYING); If not, see <http://www.gnu.org/licenses/>.
	15	*
	16	*/
	17
	18	#include "config.h"
	19	#include "int64.h"
	20	#include "atacmds.h"
	21	#include "scsicmds.h"
	22	#include "dev_interface.h"
	23	#include "dev_tunnelled.h"
	24	#include "utility.h"
	25
	26	#include <stdexcept>
	27
bed94269	28	const char * dev_interface_cpp_cvsid = "$Id: dev_interface.cpp 2971 2009-10-26 22:05:54Z chrfranke $"
2127e193 GI	29	DEV_INTERFACE_H_CVSID;
	30
	31	/////////////////////////////////////////////////////////////////////////////
	32	// smart_device
	33
	34	smart_device::smart_device(smart_interface * intf, const char * dev_name,
	35	const char * dev_type, const char * req_type)
	36	: m_intf(intf), m_info(dev_name, dev_type, req_type),
	37	m_ata_ptr(0), m_scsi_ptr(0)
	38	{
	39	}
	40
	41	smart_device::smart_device(do_not_use_in_implementation_classes)
	42	: m_intf(0), m_ata_ptr(0), m_scsi_ptr(0)
	43	{
	44	throw std::logic_error("smart_device: wrong constructor called in implementation class");
	45	}
	46
	47	smart_device::~smart_device() throw()
	48	{
	49	}
	50
	51	bool smart_device::set_err(int no, const char * msg, ...)
	52	{
	53	if (!msg)
	54	return set_err(no);
	55	m_err.no = no;
	56	va_list ap; va_start(ap, msg);
	57	m_err.msg = vstrprintf(msg, ap);
	58	va_end(ap);
	59	return false;
	60	}
	61
	62	bool smart_device::set_err(int no)
	63	{
	64	smi()->set_err_var(&m_err, no);
	65	return false;
	66	}
	67
	68	smart_device * smart_device::autodetect_open()
	69	{
	70	open();
	71	return this;
	72	}
	73
	74	bool smart_device::owns(const smart_device * /dev/) const
	75	{
	76	return false;
	77	}
	78
	79	void smart_device::release(const smart_device * /dev/)
	80	{
	81	}
	82
	83
	84	/////////////////////////////////////////////////////////////////////////////
	85	// ata_device
	86
	87	ata_in_regs_48bit::ata_in_regs_48bit()
	88	: features_16(features, prev.features),
	89	sector_count_16(sector_count, prev.sector_count),
	90	lba_low_16(lba_low, prev.lba_low),
	91	lba_mid_16(lba_mid, prev.lba_mid),
	92	lba_high_16(lba_high, prev.lba_high)
93	{
94	}
95
96	ata_out_regs_48bit::ata_out_regs_48bit()
97	: sector_count_16(sector_count, prev.sector_count),
98	lba_low_16(lba_low, prev.lba_low),
99	lba_mid_16(lba_mid, prev.lba_mid),
100	lba_high_16(lba_high, prev.lba_high)
101	{
102	}
103
104	ata_cmd_in::ata_cmd_in()
105	: direction(no_data),
106	buffer(0),
107	size(0)
108	{
109	}
110
111	ata_cmd_out::ata_cmd_out()
112	{
113	}
114
115	bool ata_device::ata_pass_through(const ata_cmd_in & in)
116	{
117	ata_cmd_out dummy;
118	return ata_pass_through(in, dummy);
119	}
120
121	bool ata_device::ata_cmd_is_ok(const ata_cmd_in & in,
122	bool data_out_support /= false/,
123	bool multi_sector_support /= false/,
124	bool ata_48bit_support /= false/)
125	{
126	// Check DATA IN/OUT
127	switch (in.direction) {
128	case ata_cmd_in::no_data: break;
129	case ata_cmd_in::data_in: break;
130	case ata_cmd_in::data_out: break;
131	default:
132	return set_err(EINVAL, "Invalid data direction %d", (int)in.direction);
133	}
134
135	// Check buffer size
136	if (in.direction == ata_cmd_in::no_data) {
137	if (in.size)
138	return set_err(EINVAL, "Buffer size %u > 0 for NO DATA command", in.size);
139	}
140	else {
141	if (!in.buffer)
142	return set_err(EINVAL, "Buffer not set for DATA IN/OUT command");
143	unsigned count = (in.in_regs.prev.sector_count<<16)\|in.in_regs.sector_count;
144	// TODO: Add check for sector count == 0
145	if (count * 512 != in.size)
146	return set_err(EINVAL, "Sector count %u does not match buffer size %u", count, in.size);
147	}
148
149	// Check features
150	if (in.direction == ata_cmd_in::data_out && !data_out_support)
151	return set_err(ENOSYS, "DATA OUT ATA commands not supported");
152	if (!(in.size == 0 \|\| in.size == 512) && !multi_sector_support)
153	return set_err(ENOSYS, "Multi-sector ATA commands not supported");
154	if (in.in_regs.is_48bit_cmd() && !ata_48bit_support)
155	return set_err(ENOSYS, "48-bit ATA commands not supported");
156	return true;
157	}
158
159	bool ata_device::ata_identify_is_cached() const
160	{
161	return false;
162	}
163
164
165	/////////////////////////////////////////////////////////////////////////////
166	// tunnelled_device_base
167
168	tunnelled_device_base::tunnelled_device_base(smart_device * tunnel_dev)
169	: smart_device(never_called),
170	m_tunnel_base_dev(tunnel_dev)
171	{
172	}
173
174	tunnelled_device_base::~tunnelled_device_base() throw()
175	{
176	delete m_tunnel_base_dev;
177	}
178
179	bool tunnelled_device_base::is_open() const
180	{
181	return (m_tunnel_base_dev && m_tunnel_base_dev->is_open());
182	}
183
184	bool tunnelled_device_base::open()
185	{
186	if (!m_tunnel_base_dev)
187	return set_err(ENOSYS);
188	if (!m_tunnel_base_dev->open())
189	return set_err(m_tunnel_base_dev->get_err());
190	return true;
191	}
192
193	bool tunnelled_device_base::close()
194	{
195	if (!m_tunnel_base_dev)
196	return true;
197	if (!m_tunnel_base_dev->close())
198	return set_err(m_tunnel_base_dev->get_err());
199	return true;
200	}
201
202	bool tunnelled_device_base::owns(const smart_device * dev) const
203	{
204	return (m_tunnel_base_dev && (m_tunnel_base_dev == dev));
205	}
206
207	void tunnelled_device_base::release(const smart_device * dev)
208	{
209	if (m_tunnel_base_dev == dev)
210	m_tunnel_base_dev = 0;
211	}
212
213
214	/////////////////////////////////////////////////////////////////////////////
215	// smart_interface
216
217	// Pointer to (usually singleton) interface object returned by ::smi()
218	smart_interface * smart_interface::s_instance;
219
54965743	220	std::string smart_interface::get_os_version_str()
2127e193 GI	221	{
	222	return SMARTMONTOOLS_BUILD_HOST;
	223	}
	224
54965743	225	std::string smart_interface::get_valid_dev_types_str()
2127e193	226	{
2127e193	227	// default
54965743 GI	228	std::string s =
54965743 GI	229	"ata, scsi, sat[,N][+TYPE], usbcypress[,X], usbjmicron[,x][,N], usbsunplus";
2127e193	230	// append custom
54965743 GI	231	std::string s2 = get_valid_custom_dev_types_str();
	232	if (!s2.empty()) {
	233	s += ", "; s += s2;
	234	}
	235	return s;
2127e193 GI	236	}
2127e193 GI	237
54965743	238	std::string smart_interface::get_app_examples(const char * /appname/)
2127e193	239	{
54965743	240	return "";
2127e193 GI	241	}
	242
	243	void smart_interface::set_err(int no, const char * msg, ...)
	244	{
	245	if (!msg) {
	246	set_err(no); return;
	247	}
	248	m_err.no = no;
	249	va_list ap; va_start(ap, msg);
	250	m_err.msg = vstrprintf(msg, ap);
	251	va_end(ap);
	252	}
	253
	254	void smart_interface::set_err(int no)
	255	{
	256	set_err_var(&m_err, no);
	257	}
	258
	259	void smart_interface::set_err_var(smart_device::error_info * err, int no)
	260	{
	261	err->no = no;
	262	err->msg = get_msg_for_errno(no);
	263	if (err->msg.empty() && no != 0)
	264	err->msg = strprintf("Unknown error %d", no);
	265	}
	266
	267	const char * smart_interface::get_msg_for_errno(int no)
	268	{
	269	return strerror(no);
	270	}
	271
	272
	273	/////////////////////////////////////////////////////////////////////////////
	274	// Default device factory
	275
	276	smart_device * smart_interface::get_smart_device(const char * name, const char * type)
	277	{
	278	clear_err();
	279	if (!type \|\| !*type) {
	280	smart_device * dev = autodetect_smart_device(name);
	281	if (!dev && !get_errno())
	282	set_err(EINVAL, "Unable to detect device type");
	283	return dev;
	284	}
	285
	286	smart_device * dev = get_custom_smart_device(name, type);
	287	if (dev \|\| get_errno())
	288	return dev;
	289
	290	if (!strcmp(type, "ata"))
	291	dev = get_ata_device(name, type);
	292	else if (!strcmp(type, "scsi"))
	293	dev = get_scsi_device(name, type);
	294
	295	else if ( ((!strncmp(type, "sat", 3) && (!type[3] \|\| strchr(",+", type[3])))
	296	\|\| (!strncmp(type, "usb", 3)))) {
	297	// Split "sat...+base..." -> ("sat...", "base...")
	298	unsigned satlen = strcspn(type, "+");
	299	std::string sattype(type, satlen);
	300	const char * basetype = (type[satlen] ? type+satlen+1 : "");
	301	// Recurse to allocate base device, default is standard SCSI
	302	if (!*basetype)
	303	basetype = "scsi";
bed94269 GI	304	smart_device_auto_ptr basedev( get_smart_device(name, basetype) );
bed94269 GI	305	if (!basedev) {
2127e193 GI	306	set_err(EINVAL, "Type '%s+...': %s", sattype.c_str(), get_errmsg());
	307	return 0;
	308	}
	309	// Result must be SCSI
bed94269	310	if (!basedev->is_scsi()) {
2127e193 GI	311	set_err(EINVAL, "Type '%s+...': Device type '%s' is not SCSI", sattype.c_str(), basetype);
	312	return 0;
	313	}
	314	// Attach SAT tunnel
bed94269 GI	315	ata_device * satdev = get_sat_device(sattype.c_str(), basedev->to_scsi());
	316	if (!satdev)
	317	return 0;
	318	basedev.release();
	319	return satdev;
2127e193 GI	320	}
	321
	322	else {
	323	set_err(EINVAL, "Unknown device type '%s'", type);
	324	return 0;
	325	}
	326	if (!dev && !get_errno())
	327	set_err(EINVAL, "Not a device of type '%s'", type);
	328	return dev;
	329	}
	330
	331	smart_device * smart_interface::get_custom_smart_device(const char * /name/, const char * /type/)
	332	{
	333	return 0;
	334	}
	335
54965743	336	std::string smart_interface::get_valid_custom_dev_types_str()
2127e193	337	{
54965743	338	return "";
2127e193	339	}