libsmartctl.h

/*
 * libsmartctl.h
 *
 * Home page of code is: http://www.smartmontools.org
 *
 * Copyright (C) 2002-10 Bruce Allen
 * <smartmontools-support@lists.sourceforge.net>
 * Copyright (C) 2008-10 Christian Franke
 * <smartmontools-support@lists.sourceforge.net>
 * Copyright (C) 2000 Michael Cornwell <cornwell@acm.org>
 *
 * 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, write to the Free Software Foundation,
 * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
 *
 * This code was originally developed as a Senior Thesis by Michael Cornwell
 * at the Concurrent Systems Laboratory (now part of the Storage Systems
 * Research Center), Jack Baskin School of Engineering, University of
 * California, Santa Cruz. http://ssrc.soe.ucsc.edu/
 *
 */

#ifndef LIBSMARTCTL_H_
#define LIBSMARTCTL_H_

#define LIBSMARTCTL_H_CVSID "$Id$\n"

#include <map>
#include <string>
#include <vector>

#include "smartctl_errs.h"

namespace libsmartctl {

struct DevInfoResp {
  std::map<std::string, std::string> content;
  ctlerr_t err;

  DevInfoResp() : err(NOERR) {}
};

struct DevVendorAttrsResp {
  std::vector<std::map<std::string, std::string>> content;
  ctlerr_t err;

  DevVendorAttrsResp() : err(NOERR) {}
};

struct CantIdDevResp {
  bool content;
  ctlerr_t err;

  CantIdDevResp() : err(NOERR) {}
};

class ClientInterface {
public:
  /**
   * @brief Checks if device name of the param type can be identified.
   * Gaurantees if true, the device is not identifiable, but if true, it still
   * necessarily mean device is identifiable.
   *
   * @param String of full path device name.
   *
   * @param String of device type, if left blank, auto device type detection
   * will be used.
   *
   * @return struct containing an err type and a boolean indicating if the the
   * device can't be IDed, meaning if it can't -> return true.
   */
  virtual CantIdDevResp cantIdDev(std::string const &devname,
                                  std::string const &type) = 0;

  /**
   *@brief Retrieves drive information.
   *
   * @param String of full path device name.
   *
   * @param String of device type, if left blank, auto device type detection
   * will be used.
   *
   * @return Map of information type and value, both strings.
   */
  virtual DevInfoResp getDevInfo(std::string const &devname,
                                 std::string const &type = "") = 0;

  /**
   *@brief Retrieves drive vendor attributes
   *
   * @param string of full path device name
   *
   * @param String of device type, if left blank, auto device type detection
   * will be used.
   *
   * @return a vector maps containing string key and values of vendor attribute
   *type name and attribute type values
   */
  virtual DevVendorAttrsResp
  getDevVendorAttrs(std::string const &devname,
                    std::string const &type = "") = 0;

public:
  virtual ~ClientInterface() {}
};

class Client : public ClientInterface {
public:
  /**
   * @brief Checks if device name of the param type can be identified.
   * Gaurantees if true, the device is not identifiable, but if true, it still
   * necessarily mean device is identifiable.
   *
   * @param String of full path device name.
   *
   * @param String of device type, if left blank, auto device type detection
   * will be used.
   *
   * @return struct containing an err type and a boolean indicating if the the
   * device can't be IDed, meaning if it can't -> return true.
   */
  virtual CantIdDevResp cantIdDev(std::string const &devname,
                                  std::string const &type) override;

  /**
   *@brief Retrieves drive information.
   *
   * @param String of full path device name.
   *
   * @param String of device type, if left blank, auto device type detection
   * will be used.
   *
   * @return Map of information type and value, both strings.
   */
  virtual DevInfoResp getDevInfo(std::string const &devname,
                                 std::string const &type = "") override;

  /**
   *@brief Retrieves drive vendor attributes
   *
   * @param string of full path device name
   *
   * @param String of device type, if left blank, auto device type detection
   * will be used.
   *
   * @return a vector maps containing string key and values of vendor attribute
   *type name and attribute type values
   */
  virtual DevVendorAttrsResp
  getDevVendorAttrs(std::string const &devname,
                    std::string const &type = "") override;

public:
  Client();
  virtual ~Client() {}

private:
  class Impl;

  Impl &impl_;
};
} // namespace libsmartctl
#endif