2012-10-16 16:39:32 +01:00
|
|
|
// Copyright (C) 2012 Internet Systems Consortium, Inc. ("ISC")
|
|
|
|
//
|
|
|
|
// Permission to use, copy, modify, and/or distribute this software for any
|
|
|
|
// purpose with or without fee is hereby granted, provided that the above
|
|
|
|
// copyright notice and this permission notice appear in all copies.
|
|
|
|
//
|
|
|
|
// THE SOFTWARE IS PROVIDED "AS IS" AND ISC DISCLAIMS ALL WARRANTIES WITH
|
|
|
|
// REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
|
|
|
|
// AND FITNESS. IN NO EVENT SHALL ISC BE LIABLE FOR ANY SPECIAL, DIRECT,
|
|
|
|
// INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
|
|
|
|
// LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE
|
|
|
|
// OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
|
|
|
|
// PERFORMANCE OF THIS SOFTWARE.
|
|
|
|
|
|
|
|
#include <config.h>
|
2012-10-22 16:07:34 +01:00
|
|
|
|
2012-10-20 22:52:25 +01:00
|
|
|
#include <asiolink/io_address.h>
|
2012-11-16 11:19:19 +00:00
|
|
|
#include <dhcpsrv/mysql_lease_mgr.h>
|
2012-10-16 16:39:32 +01:00
|
|
|
|
2012-11-08 12:14:10 +00:00
|
|
|
#include <mysql/mysqld_error.h>
|
|
|
|
|
|
|
|
#include <iostream>
|
|
|
|
#include <iomanip>
|
|
|
|
#include <string>
|
|
|
|
#include <time.h>
|
|
|
|
|
2012-10-24 19:18:33 +01:00
|
|
|
using namespace isc;
|
2012-11-04 20:20:21 +00:00
|
|
|
using namespace isc::dhcp;
|
2012-10-17 18:37:22 +01:00
|
|
|
using namespace std;
|
|
|
|
|
2012-10-24 14:12:06 +01:00
|
|
|
namespace {
|
|
|
|
///@{
|
|
|
|
/// @brief Maximum Size of Database Fields
|
|
|
|
///
|
|
|
|
/// The following constants define buffer sizes for variable length database
|
|
|
|
/// fields. The values should be greater than or equal to the length set in
|
|
|
|
/// the schema definition.
|
|
|
|
///
|
|
|
|
/// The exception is the length of any VARCHAR fields: these should be set
|
|
|
|
/// greater than or equal to the length of the field plus 2: this allows for
|
|
|
|
/// the insertion of a trailing null regardless of whether the data returned
|
|
|
|
/// contains a trailing null (the documentation is not clear on this point).
|
|
|
|
|
2012-11-21 12:44:18 +00:00
|
|
|
const size_t ADDRESS6_TEXT_MAX_LEN = 42; ///< Max size of a IPv6 text buffer
|
|
|
|
const size_t DUID_MAX_LEN = 128; ///< Max size of a DUID
|
|
|
|
const size_t HWADDR_MAX_LEN = 128; ///< Max size of a hardware address
|
|
|
|
const size_t CLIENT_ID_MAX_LEN = 128; ///< Max size of a client ID
|
2012-10-24 14:12:06 +01:00
|
|
|
///@}
|
2012-11-04 20:20:21 +00:00
|
|
|
|
|
|
|
/// @brief MySQL Selection Statements
|
|
|
|
///
|
|
|
|
/// Each statement is associated with the index, used by the various methods
|
|
|
|
/// to access the prepared statement.
|
|
|
|
struct TaggedStatement {
|
|
|
|
MySqlLeaseMgr::StatementIndex index;
|
|
|
|
const char* text;
|
|
|
|
};
|
|
|
|
|
|
|
|
TaggedStatement tagged_statements[] = {
|
2012-11-21 12:44:18 +00:00
|
|
|
{MySqlLeaseMgr::DELETE_LEASE4,
|
|
|
|
"DELETE FROM lease4 WHERE address = ?"},
|
2012-11-04 20:20:21 +00:00
|
|
|
{MySqlLeaseMgr::DELETE_LEASE6,
|
|
|
|
"DELETE FROM lease6 WHERE address = ?"},
|
2012-11-21 12:44:18 +00:00
|
|
|
{MySqlLeaseMgr::GET_LEASE4_ADDR,
|
|
|
|
"SELECT address, hwaddr, client_id, "
|
|
|
|
"valid_lifetime, expire, subnet_id "
|
|
|
|
"FROM lease4 "
|
|
|
|
"WHERE address = ?"},
|
2012-11-04 20:20:21 +00:00
|
|
|
{MySqlLeaseMgr::GET_LEASE6_ADDR,
|
|
|
|
"SELECT address, duid, valid_lifetime, "
|
|
|
|
"expire, subnet_id, pref_lifetime, "
|
|
|
|
"lease_type, iaid, prefix_len "
|
|
|
|
"FROM lease6 "
|
|
|
|
"WHERE address = ?"},
|
|
|
|
{MySqlLeaseMgr::GET_LEASE6_DUID_IAID,
|
|
|
|
"SELECT address, duid, valid_lifetime, "
|
|
|
|
"expire, subnet_id, pref_lifetime, "
|
|
|
|
"lease_type, iaid, prefix_len "
|
|
|
|
"FROM lease6 "
|
|
|
|
"WHERE duid = ? AND iaid = ?"},
|
|
|
|
{MySqlLeaseMgr::GET_LEASE6_DUID_IAID_SUBID,
|
|
|
|
"SELECT address, duid, valid_lifetime, "
|
|
|
|
"expire, subnet_id, pref_lifetime, "
|
|
|
|
"lease_type, iaid, prefix_len "
|
|
|
|
"FROM lease6 "
|
|
|
|
"WHERE duid = ? AND iaid = ? AND subnet_id = ?"},
|
|
|
|
{MySqlLeaseMgr::GET_VERSION,
|
|
|
|
"SELECT version, minor FROM schema_version"},
|
2012-11-21 12:44:18 +00:00
|
|
|
{MySqlLeaseMgr::INSERT_LEASE4,
|
|
|
|
"INSERT INTO lease4(address, hwaddr, client_id, "
|
|
|
|
"valid_lifetime, expire, subnet_id) "
|
|
|
|
"VALUES (?, ?, ?, ?, ?, ?)"},
|
2012-11-04 20:20:21 +00:00
|
|
|
{MySqlLeaseMgr::INSERT_LEASE6,
|
|
|
|
"INSERT INTO lease6(address, duid, valid_lifetime, "
|
|
|
|
"expire, subnet_id, pref_lifetime, "
|
|
|
|
"lease_type, iaid, prefix_len) "
|
|
|
|
"VALUES (?, ?, ?, ?, ?, ?, ?, ?, ?)"},
|
|
|
|
{MySqlLeaseMgr::UPDATE_LEASE6,
|
|
|
|
"UPDATE lease6 SET address = ?, duid = ?, "
|
|
|
|
"valid_lifetime = ?, expire = ?, subnet_id = ?, "
|
|
|
|
"pref_lifetime = ?, lease_type = ?, iaid = ?, "
|
|
|
|
"prefix_len = ? "
|
|
|
|
"WHERE address = ?"},
|
|
|
|
// End of list sentinel
|
|
|
|
{MySqlLeaseMgr::NUM_STATEMENTS, NULL}
|
2012-10-24 14:12:06 +01:00
|
|
|
};
|
|
|
|
|
2012-11-04 20:20:21 +00:00
|
|
|
}; // Anonymous namespace
|
|
|
|
|
2012-10-16 16:39:32 +01:00
|
|
|
namespace isc {
|
|
|
|
namespace dhcp {
|
|
|
|
|
2012-11-06 12:58:10 +00:00
|
|
|
|
|
|
|
|
2012-11-21 12:44:18 +00:00
|
|
|
/// @brief Exchange MySQL and Lease4 Data
|
|
|
|
///
|
|
|
|
/// On any MySQL operation, arrays of MYSQL_BIND structures must be built to
|
|
|
|
/// describe the parameters in the prepared statements. Where information is
|
|
|
|
/// inserted or retrieved - INSERT, UPDATE, SELECT - a large amount of that
|
|
|
|
/// structure is identical - it defines data values in the Lease4 structure.
|
|
|
|
/// This class handles the creation of that array.
|
|
|
|
///
|
|
|
|
/// Owing to the MySQL API, the process requires some intermediate variables
|
|
|
|
/// to hold things like length etc. This object holds the intermediate
|
|
|
|
/// variables as well.
|
|
|
|
///
|
|
|
|
/// @note There are no unit tests for this class. It is tested indirectly
|
|
|
|
/// in all MySqlLeaseMgr::xxx4() calls where it is used.
|
|
|
|
|
|
|
|
class MySqlLease4Exchange {
|
|
|
|
public:
|
|
|
|
/// @brief Constructor
|
|
|
|
///
|
|
|
|
/// Apart from the initialization of false_ and true_, the initialization
|
|
|
|
/// of addr4_, hwaddr_length_, hwaddr_buffer_, client_id_length_ and
|
|
|
|
/// client_id_buffer_ are to satisfy cppcheck: none are really needed, as
|
|
|
|
/// all variables are initialized/set in the methods.
|
|
|
|
MySqlLease4Exchange() : addr4_(0), hwaddr_length_(0), client_id_length_(0),
|
|
|
|
false_(0), true_(1) {
|
|
|
|
memset(hwaddr_buffer_, 0, sizeof(hwaddr_buffer_));
|
|
|
|
memset(client_id_buffer_, 0, sizeof(client_id_buffer_));
|
|
|
|
}
|
|
|
|
|
|
|
|
/// @brief Create MYSQL_BIND objects for Lease4 Pointer
|
|
|
|
///
|
|
|
|
/// Fills in the MYSQL_BIND objects for the Lease4 passed to it.
|
|
|
|
///
|
|
|
|
/// @param lease Lease object to be added to the database.
|
|
|
|
///
|
|
|
|
/// @return Vector of MySQL BIND objects representing the data to be added.
|
|
|
|
std::vector<MYSQL_BIND> createBindForSend(const Lease4Ptr& lease) {
|
|
|
|
// Store lease object to ensure it remains valid.
|
|
|
|
lease_ = lease;
|
|
|
|
|
|
|
|
// Ensure bind_ array clear for constructing the MYSQL_BIND structures
|
|
|
|
// for this lease.
|
|
|
|
memset(bind_, 0, sizeof(bind_));
|
|
|
|
|
|
|
|
// Address: uint32_t
|
|
|
|
// Address in the Lease structre is an IOAddress object. Convert to
|
|
|
|
// an integer for storage.
|
|
|
|
addr4_ = static_cast<uint32_t>(lease_->addr_);
|
|
|
|
bind_[0].buffer_type = MYSQL_TYPE_LONG;
|
|
|
|
bind_[0].buffer = reinterpret_cast<char*>(&addr4_);
|
|
|
|
bind_[0].is_unsigned = true_;
|
|
|
|
|
|
|
|
// hwaddr: varbinary
|
|
|
|
// For speed, we avoid copying the data into temporary storage and
|
|
|
|
// instead extract it from the lease structure directly.
|
|
|
|
hwaddr_length_ = lease_->hwaddr_.size();
|
|
|
|
bind_[1].buffer_type = MYSQL_TYPE_BLOB;
|
|
|
|
bind_[1].buffer = reinterpret_cast<char*>(&(lease_->hwaddr_[0]));
|
|
|
|
bind_[1].buffer_length = hwaddr_length_;
|
|
|
|
bind_[1].length = &hwaddr_length_;
|
|
|
|
|
|
|
|
// client_id: varbinary
|
|
|
|
client_id_ = lease_->client_id_->getClientId();
|
|
|
|
client_id_length_ = client_id_.size();
|
|
|
|
bind_[2].buffer_type = MYSQL_TYPE_BLOB;
|
|
|
|
bind_[2].buffer = reinterpret_cast<char*>(&client_id_[0]);
|
|
|
|
bind_[2].buffer_length = client_id_length_;
|
|
|
|
bind_[2].length = &client_id_length_;
|
|
|
|
|
|
|
|
// valid lifetime: unsigned int
|
|
|
|
bind_[3].buffer_type = MYSQL_TYPE_LONG;
|
|
|
|
bind_[3].buffer = reinterpret_cast<char*>(&lease_->valid_lft_);
|
|
|
|
bind_[3].is_unsigned = true_;
|
|
|
|
|
|
|
|
// expire: timestamp
|
|
|
|
// The lease structure holds the client last transmission time (cltt_)
|
|
|
|
// For convenience for external tools, this is converted to lease
|
|
|
|
/// expiry time (expire). The relationship is given by:
|
|
|
|
//
|
|
|
|
// expire = cltt_ + valid_lft_
|
|
|
|
//
|
|
|
|
// @TODO Handle overflows
|
|
|
|
MySqlLeaseMgr::convertToDatabaseTime(lease_->cltt_, lease_->valid_lft_,
|
|
|
|
expire_);
|
|
|
|
bind_[4].buffer_type = MYSQL_TYPE_TIMESTAMP;
|
|
|
|
bind_[4].buffer = reinterpret_cast<char*>(&expire_);
|
|
|
|
bind_[4].buffer_length = sizeof(expire_);
|
|
|
|
|
|
|
|
// subnet_id: unsigned int
|
|
|
|
// Can use lease_->subnet_id_ directly as it is of type uint32_t.
|
|
|
|
bind_[5].buffer_type = MYSQL_TYPE_LONG;
|
|
|
|
bind_[5].buffer = reinterpret_cast<char*>(&lease_->subnet_id_);
|
|
|
|
bind_[5].is_unsigned = true_;
|
|
|
|
|
|
|
|
// Add the data to the vector. Note the end element is one after the
|
|
|
|
// end of the array.
|
|
|
|
return (std::vector<MYSQL_BIND>(&bind_[0], &bind_[6]));
|
|
|
|
}
|
|
|
|
|
|
|
|
/// @brief Create BIND array to receive data
|
|
|
|
///
|
|
|
|
/// Creates a MYSQL_BIND array to receive Lease4 data from the database.
|
|
|
|
/// After data is successfully received, getLeaseData() is used to copy
|
|
|
|
/// it to a Lease6 object.
|
|
|
|
///
|
|
|
|
/// @return Vector of MySQL BIND objects.
|
|
|
|
std::vector<MYSQL_BIND> createBindForReceive() {
|
|
|
|
|
|
|
|
// Ensure both the array of MYSQL_BIND structures and the error array
|
|
|
|
// are clear.
|
|
|
|
memset(bind_, 0, sizeof(bind_));
|
|
|
|
memset(error_, 0, sizeof(error_));
|
|
|
|
|
|
|
|
// address: uint32_t
|
|
|
|
bind_[0].buffer_type = MYSQL_TYPE_LONG;
|
|
|
|
bind_[0].buffer = reinterpret_cast<char*>(&addr4_);
|
|
|
|
bind_[0].is_unsigned = true_;
|
|
|
|
bind_[0].error = &error_[0];
|
|
|
|
|
|
|
|
// hwaddr: varbinary(20)
|
|
|
|
hwaddr_length_ = sizeof(hwaddr_buffer_);
|
|
|
|
bind_[1].buffer_type = MYSQL_TYPE_BLOB;
|
|
|
|
bind_[1].buffer = reinterpret_cast<char*>(hwaddr_buffer_);
|
|
|
|
bind_[1].buffer_length = hwaddr_length_;
|
|
|
|
bind_[1].length = &hwaddr_length_;
|
|
|
|
bind_[1].error = &error_[1];
|
|
|
|
|
|
|
|
// client_id: varbinary(128)
|
|
|
|
client_id_length_ = sizeof(client_id_buffer_);
|
|
|
|
bind_[2].buffer_type = MYSQL_TYPE_BLOB;
|
|
|
|
bind_[2].buffer = reinterpret_cast<char*>(client_id_buffer_);
|
|
|
|
bind_[2].buffer_length = client_id_length_;
|
|
|
|
bind_[2].length = &client_id_length_;
|
|
|
|
bind_[2].error = &error_[2];
|
|
|
|
|
|
|
|
// lease_time: unsigned int
|
|
|
|
bind_[3].buffer_type = MYSQL_TYPE_LONG;
|
|
|
|
bind_[3].buffer = reinterpret_cast<char*>(&valid_lifetime_);
|
|
|
|
bind_[3].is_unsigned = true_;
|
|
|
|
bind_[3].error = &error_[3];
|
|
|
|
|
|
|
|
// expire: timestamp
|
|
|
|
bind_[4].buffer_type = MYSQL_TYPE_TIMESTAMP;
|
|
|
|
bind_[4].buffer = reinterpret_cast<char*>(&expire_);
|
|
|
|
bind_[4].buffer_length = sizeof(expire_);
|
|
|
|
bind_[4].error = &error_[4];
|
|
|
|
|
|
|
|
// subnet_id: unsigned int
|
|
|
|
bind_[5].buffer_type = MYSQL_TYPE_LONG;
|
|
|
|
bind_[5].buffer = reinterpret_cast<char*>(&subnet_id_);
|
|
|
|
bind_[5].is_unsigned = true_;
|
|
|
|
bind_[5].error = &error_[5];
|
|
|
|
|
|
|
|
// Add the data to the vector. Note the end element is one after the
|
|
|
|
// end of the array.
|
|
|
|
return(std::vector<MYSQL_BIND>(&bind_[0], &bind_[6]));
|
|
|
|
}
|
|
|
|
|
|
|
|
/// @brief Copy Received Data into Lease6 Object
|
|
|
|
///
|
|
|
|
/// Called after the MYSQL_BIND array created by createBindForReceive()
|
|
|
|
/// has been used, this copies data from the internal member vairables
|
|
|
|
/// into a Lease4 object.
|
|
|
|
///
|
|
|
|
/// @return Lease6Ptr Pointer to a Lease6 object holding the relevant
|
|
|
|
/// data.
|
|
|
|
///
|
|
|
|
/// @throw isc::BadValue Unable to convert Lease Type value in database
|
|
|
|
Lease4Ptr getLeaseData() {
|
|
|
|
// Convert times to units for the lease structure
|
|
|
|
time_t cltt = 0;
|
|
|
|
MySqlLeaseMgr::convertFromDatabaseTime(expire_, valid_lifetime_, cltt);
|
|
|
|
|
|
|
|
return (Lease4Ptr(new Lease4(addr4_, hwaddr_buffer_, hwaddr_length_,
|
|
|
|
client_id_buffer_, client_id_length_,
|
|
|
|
valid_lifetime_, cltt, subnet_id_)));
|
|
|
|
}
|
|
|
|
|
|
|
|
private:
|
|
|
|
// Note: All array lengths are equal to the corresponding variable in the
|
|
|
|
// schema.
|
|
|
|
// Note: arrays are declared fixed length for speed of creation
|
|
|
|
uint32_t addr4_; ///< IPv4 address
|
|
|
|
MYSQL_BIND bind_[9]; ///< Bind array
|
|
|
|
std::vector<uint8_t> hwaddr_; ///< Hardware address
|
|
|
|
uint8_t hwaddr_buffer_[HWADDR_MAX_LEN]; ///< Hardware address buffer
|
|
|
|
unsigned long hwaddr_length_; ///< Hardware address length
|
|
|
|
std::vector<uint8_t> client_id_; ///< Client identification
|
|
|
|
uint8_t client_id_buffer_[CLIENT_ID_MAX_LEN]; ///< Client ID buffer
|
|
|
|
unsigned long client_id_length_; ///< Client ID address length
|
|
|
|
my_bool error_[6]; ///< For error reporting
|
|
|
|
MYSQL_TIME expire_; ///< Lease expiry time
|
|
|
|
const my_bool false_; ///< "false" for MySql
|
|
|
|
Lease4Ptr lease_; ///< Pointer to lease object
|
|
|
|
uint32_t valid_lifetime_; ///< Lease time
|
|
|
|
uint32_t subnet_id_; ///< Subnet identification
|
|
|
|
const my_bool true_; ///< "true_" for MySql
|
|
|
|
};
|
|
|
|
|
|
|
|
|
|
|
|
|
2012-10-22 13:01:40 +01:00
|
|
|
/// @brief Exchange MySQL and Lease6 Data
|
2012-10-22 10:49:51 +01:00
|
|
|
///
|
2012-10-24 19:18:33 +01:00
|
|
|
/// On any MySQL operation, arrays of MYSQL_BIND structures must be built to
|
|
|
|
/// describe the parameters in the prepared statements. Where information is
|
2012-10-29 19:19:36 +00:00
|
|
|
/// inserted or retrieved - INSERT, UPDATE, SELECT - a large amount of that
|
|
|
|
/// structure is identical - it defines data values in the Lease6 structure.
|
2012-11-06 12:58:10 +00:00
|
|
|
/// This class handles the creation of that array.
|
2012-10-22 10:49:51 +01:00
|
|
|
///
|
2012-10-22 13:01:40 +01:00
|
|
|
/// Owing to the MySQL API, the process requires some intermediate variables
|
2012-10-22 10:49:51 +01:00
|
|
|
/// to hold things like length etc. This object holds the intermediate
|
2012-10-29 19:19:36 +00:00
|
|
|
/// variables as well.
|
2012-11-08 12:14:10 +00:00
|
|
|
///
|
|
|
|
/// @note There are no unit tests for this class. It is tested indirectly
|
|
|
|
/// in all MySqlLeaseMgr::xxx6() calls where it is used.
|
2012-11-06 12:58:10 +00:00
|
|
|
|
2012-10-22 10:49:51 +01:00
|
|
|
class MySqlLease6Exchange {
|
|
|
|
public:
|
|
|
|
/// @brief Constructor
|
2012-11-03 18:26:57 +00:00
|
|
|
///
|
2012-11-08 12:14:10 +00:00
|
|
|
/// Apart from the initialization of false_ and true_, the initialization
|
|
|
|
/// of addr6_length_, duid_length_, addr6_buffer_ and duid_buffer_ are
|
|
|
|
/// to satisfy cppcheck: none are really needed, as all variables are
|
|
|
|
/// initialized/set in the methods.
|
2012-11-06 12:58:10 +00:00
|
|
|
MySqlLease6Exchange() : addr6_length_(0), duid_length_(0),
|
|
|
|
false_(0), true_(1) {
|
2012-11-03 18:26:57 +00:00
|
|
|
memset(addr6_buffer_, 0, sizeof(addr6_buffer_));
|
|
|
|
memset(duid_buffer_, 0, sizeof(duid_buffer_));
|
2012-10-22 10:49:51 +01:00
|
|
|
}
|
|
|
|
|
|
|
|
/// @brief Create MYSQL_BIND objects for Lease6 Pointer
|
|
|
|
///
|
2012-10-24 19:18:33 +01:00
|
|
|
/// Fills in the MYSQL_BIND objects for the Lease6 passed to it.
|
2012-10-22 10:49:51 +01:00
|
|
|
///
|
2012-11-06 12:58:10 +00:00
|
|
|
/// @param lease Lease object to be added to the database.
|
|
|
|
///
|
|
|
|
/// @return Vector of MySQL BIND objects representing the data to be added.
|
|
|
|
std::vector<MYSQL_BIND> createBindForSend(const Lease6Ptr& lease) {
|
2012-10-22 10:49:51 +01:00
|
|
|
// Store lease object to ensure it remains valid.
|
|
|
|
lease_ = lease;
|
|
|
|
|
2012-10-29 19:19:36 +00:00
|
|
|
// Ensure bind_ array clear for constructing the MYSQL_BIND structures
|
|
|
|
// for this lease.
|
2012-10-22 10:49:51 +01:00
|
|
|
memset(bind_, 0, sizeof(bind_));
|
|
|
|
|
|
|
|
// address: varchar(40)
|
|
|
|
addr6_ = lease_->addr_.toText();
|
|
|
|
addr6_length_ = addr6_.size();
|
|
|
|
|
2012-11-08 12:14:10 +00:00
|
|
|
// In the following statement, the string is being read. However, the
|
|
|
|
// MySQL C interface does not use "const", so the "buffer" element
|
|
|
|
// is declared as "char*" instead of "const char*". To resolve this,
|
2012-11-09 16:11:24 +00:00
|
|
|
// the "const" is discarded. (Note that the address of addr6_.c_str()
|
2012-11-08 12:14:10 +00:00
|
|
|
// is guaranteed to be valid until the next non-const operation on
|
2012-11-09 16:11:24 +00:00
|
|
|
// addr6_.)
|
|
|
|
//
|
|
|
|
// Note that the const_cast could be avoided by copying the string to
|
|
|
|
// a writeable buffer and storing the address of that in the "buffer"
|
|
|
|
// element. However, this introduces a copy operation (with additional
|
|
|
|
// overhead) purely to get round the strictures introduced by design of
|
|
|
|
// the MySQL interface (which uses the area pointed to by "buffer" as
|
|
|
|
// input when specifying query parameters and as output when retrieving
|
|
|
|
// data). For that reason, "const_cast" has been used.
|
2012-10-22 10:49:51 +01:00
|
|
|
bind_[0].buffer_type = MYSQL_TYPE_STRING;
|
|
|
|
bind_[0].buffer = const_cast<char*>(addr6_.c_str());
|
|
|
|
bind_[0].buffer_length = addr6_length_;
|
|
|
|
bind_[0].length = &addr6_length_;
|
|
|
|
|
2012-10-24 14:27:43 +01:00
|
|
|
// duid: varchar(128)
|
|
|
|
duid_ = lease_->duid_->getDuid();
|
|
|
|
duid_length_ = duid_.size();
|
2012-10-22 10:49:51 +01:00
|
|
|
|
2012-10-24 21:28:24 +01:00
|
|
|
bind_[1].buffer_type = MYSQL_TYPE_BLOB;
|
|
|
|
bind_[1].buffer = reinterpret_cast<char*>(&(duid_[0]));
|
|
|
|
bind_[1].buffer_length = duid_length_;
|
|
|
|
bind_[1].length = &duid_length_;
|
2012-10-22 10:49:51 +01:00
|
|
|
|
2012-10-29 19:19:36 +00:00
|
|
|
// valid lifetime: unsigned int
|
2012-10-24 21:28:24 +01:00
|
|
|
bind_[2].buffer_type = MYSQL_TYPE_LONG;
|
2012-11-21 12:44:18 +00:00
|
|
|
bind_[2].buffer = reinterpret_cast<char*>(&lease_->valid_lft_);
|
2012-10-24 21:28:24 +01:00
|
|
|
bind_[2].is_unsigned = true_;
|
2012-10-22 10:49:51 +01:00
|
|
|
|
|
|
|
// expire: timestamp
|
2012-10-24 15:36:54 +01:00
|
|
|
// The lease structure holds the client last transmission time (cltt_)
|
|
|
|
// For convenience for external tools, this is converted to lease
|
|
|
|
/// expiry time (expire). The relationship is given by:
|
|
|
|
//
|
|
|
|
// expire = cltt_ + valid_lft_
|
2012-10-29 19:19:36 +00:00
|
|
|
//
|
|
|
|
// @TODO Handle overflows
|
2012-10-24 15:36:54 +01:00
|
|
|
MySqlLeaseMgr::convertToDatabaseTime(lease_->cltt_, lease_->valid_lft_,
|
|
|
|
expire_);
|
2012-10-24 21:28:24 +01:00
|
|
|
bind_[3].buffer_type = MYSQL_TYPE_TIMESTAMP;
|
|
|
|
bind_[3].buffer = reinterpret_cast<char*>(&expire_);
|
|
|
|
bind_[3].buffer_length = sizeof(expire_);
|
2012-10-22 10:49:51 +01:00
|
|
|
|
|
|
|
// subnet_id: unsigned int
|
|
|
|
// Can use lease_->subnet_id_ directly as it is of type uint32_t.
|
2012-10-24 21:28:24 +01:00
|
|
|
bind_[4].buffer_type = MYSQL_TYPE_LONG;
|
|
|
|
bind_[4].buffer = reinterpret_cast<char*>(&lease_->subnet_id_);
|
|
|
|
bind_[4].is_unsigned = true_;
|
2012-10-22 10:49:51 +01:00
|
|
|
|
|
|
|
// pref_lifetime: unsigned int
|
|
|
|
// Can use lease_->preferred_lft_ directly as it is of type uint32_t.
|
2012-10-24 21:28:24 +01:00
|
|
|
bind_[5].buffer_type = MYSQL_TYPE_LONG;
|
|
|
|
bind_[5].buffer = reinterpret_cast<char*>(&lease_->preferred_lft_);
|
|
|
|
bind_[5].is_unsigned = true_;
|
2012-10-22 10:49:51 +01:00
|
|
|
|
|
|
|
// lease_type: tinyint
|
|
|
|
// Must convert to uint8_t as lease_->type_ is a LeaseType variable
|
|
|
|
lease_type_ = lease_->type_;
|
2012-10-24 21:28:24 +01:00
|
|
|
bind_[6].buffer_type = MYSQL_TYPE_TINY;
|
|
|
|
bind_[6].buffer = reinterpret_cast<char*>(&lease_type_);
|
|
|
|
bind_[6].is_unsigned = true_;
|
2012-10-22 10:49:51 +01:00
|
|
|
|
|
|
|
// iaid: unsigned int
|
|
|
|
// Can use lease_->iaid_ directly as it is of type uint32_t.
|
2012-10-24 21:28:24 +01:00
|
|
|
bind_[7].buffer_type = MYSQL_TYPE_LONG;
|
|
|
|
bind_[7].buffer = reinterpret_cast<char*>(&lease_->iaid_);
|
|
|
|
bind_[7].is_unsigned = true_;
|
2012-10-22 10:49:51 +01:00
|
|
|
|
|
|
|
// prefix_len: unsigned tinyint
|
|
|
|
// Can use lease_->prefixlen_ directly as it is uint32_t.
|
2012-10-24 21:28:24 +01:00
|
|
|
bind_[8].buffer_type = MYSQL_TYPE_TINY;
|
|
|
|
bind_[8].buffer = reinterpret_cast<char*>(&lease_->prefixlen_);
|
|
|
|
bind_[8].is_unsigned = true_;
|
2012-10-22 10:49:51 +01:00
|
|
|
|
2012-10-29 19:19:36 +00:00
|
|
|
// Add the data to the vector. Note the end element is one after the
|
|
|
|
// end of the array.
|
2012-11-06 12:58:10 +00:00
|
|
|
return (std::vector<MYSQL_BIND>(&bind_[0], &bind_[9]));
|
2012-10-22 10:49:51 +01:00
|
|
|
}
|
|
|
|
|
2012-10-22 13:01:40 +01:00
|
|
|
/// @brief Create BIND array to receive data
|
|
|
|
///
|
|
|
|
/// Creates a MYSQL_BIND array to receive Lease6 data from the database.
|
|
|
|
/// After data is successfully received, getLeaseData() is used to copy
|
|
|
|
/// it to a Lease6 object.
|
|
|
|
///
|
2012-11-06 12:58:10 +00:00
|
|
|
/// @return Vector of MySQL BIND objects.
|
|
|
|
std::vector<MYSQL_BIND> createBindForReceive() {
|
2012-10-29 19:19:36 +00:00
|
|
|
|
|
|
|
// Ensure both the array of MYSQL_BIND structures and the error array
|
|
|
|
// are clear.
|
2012-10-22 13:01:40 +01:00
|
|
|
memset(bind_, 0, sizeof(bind_));
|
|
|
|
memset(error_, 0, sizeof(error_));
|
|
|
|
|
|
|
|
// address: varchar
|
|
|
|
// A Lease6_ address has a maximum of 39 characters. The array is
|
|
|
|
// a few bites longer than this to guarantee that we can always null
|
|
|
|
// terminate it.
|
|
|
|
addr6_length_ = sizeof(addr6_buffer_) - 1;
|
|
|
|
bind_[0].buffer_type = MYSQL_TYPE_STRING;
|
|
|
|
bind_[0].buffer = addr6_buffer_;
|
|
|
|
bind_[0].buffer_length = addr6_length_;
|
|
|
|
bind_[0].length = &addr6_length_;
|
|
|
|
bind_[0].error = &error_[0];
|
|
|
|
|
|
|
|
// client_id: varbinary(128)
|
2012-10-24 14:27:43 +01:00
|
|
|
duid_length_ = sizeof(duid_buffer_);
|
2012-10-24 21:28:24 +01:00
|
|
|
bind_[1].buffer_type = MYSQL_TYPE_BLOB;
|
|
|
|
bind_[1].buffer = reinterpret_cast<char*>(duid_buffer_);
|
|
|
|
bind_[1].buffer_length = duid_length_;
|
|
|
|
bind_[1].length = &duid_length_;
|
|
|
|
bind_[1].error = &error_[1];
|
2012-10-22 13:01:40 +01:00
|
|
|
|
|
|
|
// lease_time: unsigned int
|
2012-10-24 21:28:24 +01:00
|
|
|
bind_[2].buffer_type = MYSQL_TYPE_LONG;
|
|
|
|
bind_[2].buffer = reinterpret_cast<char*>(&valid_lifetime_);
|
|
|
|
bind_[2].is_unsigned = true_;
|
|
|
|
bind_[2].error = &error_[2];
|
2012-10-22 13:01:40 +01:00
|
|
|
|
|
|
|
// expire: timestamp
|
2012-10-24 21:28:24 +01:00
|
|
|
bind_[3].buffer_type = MYSQL_TYPE_TIMESTAMP;
|
|
|
|
bind_[3].buffer = reinterpret_cast<char*>(&expire_);
|
|
|
|
bind_[3].buffer_length = sizeof(expire_);
|
|
|
|
bind_[3].error = &error_[3];
|
2012-10-22 13:01:40 +01:00
|
|
|
|
|
|
|
// subnet_id: unsigned int
|
2012-10-24 21:28:24 +01:00
|
|
|
bind_[4].buffer_type = MYSQL_TYPE_LONG;
|
|
|
|
bind_[4].buffer = reinterpret_cast<char*>(&subnet_id_);
|
|
|
|
bind_[4].is_unsigned = true_;
|
|
|
|
bind_[4].error = &error_[4];
|
|
|
|
|
|
|
|
// pref_lifetime: unsigned int
|
2012-10-22 13:01:40 +01:00
|
|
|
bind_[5].buffer_type = MYSQL_TYPE_LONG;
|
2012-10-24 21:28:24 +01:00
|
|
|
bind_[5].buffer = reinterpret_cast<char*>(&pref_lifetime_);
|
2012-10-22 13:01:40 +01:00
|
|
|
bind_[5].is_unsigned = true_;
|
|
|
|
bind_[5].error = &error_[5];
|
|
|
|
|
2012-10-24 21:28:24 +01:00
|
|
|
// lease_type: tinyint
|
|
|
|
bind_[6].buffer_type = MYSQL_TYPE_TINY;
|
|
|
|
bind_[6].buffer = reinterpret_cast<char*>(&lease_type_);
|
2012-10-22 13:01:40 +01:00
|
|
|
bind_[6].is_unsigned = true_;
|
|
|
|
bind_[6].error = &error_[6];
|
|
|
|
|
2012-10-24 21:28:24 +01:00
|
|
|
// iaid: unsigned int
|
|
|
|
bind_[7].buffer_type = MYSQL_TYPE_LONG;
|
|
|
|
bind_[7].buffer = reinterpret_cast<char*>(&iaid_);
|
2012-10-22 13:01:40 +01:00
|
|
|
bind_[7].is_unsigned = true_;
|
|
|
|
bind_[7].error = &error_[7];
|
2012-11-06 12:58:10 +00:00
|
|
|
|
2012-10-22 13:01:40 +01:00
|
|
|
// prefix_len: unsigned tinyint
|
2012-10-24 21:28:24 +01:00
|
|
|
bind_[8].buffer_type = MYSQL_TYPE_TINY;
|
|
|
|
bind_[8].buffer = reinterpret_cast<char*>(&prefixlen_);
|
|
|
|
bind_[8].is_unsigned = true_;
|
|
|
|
bind_[8].error = &error_[8];
|
2012-10-22 13:01:40 +01:00
|
|
|
|
2012-10-29 19:19:36 +00:00
|
|
|
// Add the data to the vector. Note the end element is one after the
|
|
|
|
// end of the array.
|
2012-11-06 12:58:10 +00:00
|
|
|
return(std::vector<MYSQL_BIND>(&bind_[0], &bind_[9]));
|
2012-10-22 13:01:40 +01:00
|
|
|
}
|
|
|
|
|
|
|
|
/// @brief Copy Received Data into Lease6 Object
|
|
|
|
///
|
|
|
|
/// Called after the MYSQL_BIND array created by createBindForReceive()
|
|
|
|
/// has been used, this copies data from the internal member vairables
|
|
|
|
/// into a Lease6 object.
|
|
|
|
///
|
|
|
|
/// @return Lease6Ptr Pointer to a Lease6 object holding the relevant
|
|
|
|
/// data.
|
|
|
|
///
|
2012-11-08 12:14:10 +00:00
|
|
|
/// @throw isc::BadValue Unable to convert Lease Type value in database
|
2012-10-22 13:01:40 +01:00
|
|
|
Lease6Ptr getLeaseData() {
|
|
|
|
|
|
|
|
// Create the object to be returned.
|
|
|
|
Lease6Ptr result(new Lease6());
|
|
|
|
|
2012-10-29 19:19:36 +00:00
|
|
|
// Put the data in the lease object
|
2012-10-24 15:36:54 +01:00
|
|
|
|
|
|
|
// The address buffer is declared larger than the buffer size passed
|
|
|
|
// to the access function so that we can always append a null byte.
|
2012-10-22 13:01:40 +01:00
|
|
|
addr6_buffer_[addr6_length_] = '\0';
|
|
|
|
std::string address = addr6_buffer_;
|
|
|
|
|
2012-10-24 15:36:54 +01:00
|
|
|
// Set the other data, converting time as needed.
|
|
|
|
result->addr_ = isc::asiolink::IOAddress(address);
|
2012-10-24 14:27:43 +01:00
|
|
|
result->duid_.reset(new DUID(duid_buffer_, duid_length_));
|
2012-10-24 15:36:54 +01:00
|
|
|
MySqlLeaseMgr::convertFromDatabaseTime(expire_, valid_lifetime_,
|
|
|
|
result->cltt_);
|
|
|
|
result->valid_lft_ = valid_lifetime_;
|
2012-10-22 13:01:40 +01:00
|
|
|
result->subnet_id_ = subnet_id_;
|
|
|
|
result->preferred_lft_ = pref_lifetime_;
|
|
|
|
|
|
|
|
// We can't convert from a numeric value to an enum, hence:
|
|
|
|
switch (lease_type_) {
|
|
|
|
case Lease6::LEASE_IA_NA:
|
|
|
|
result->type_ = Lease6::LEASE_IA_NA;
|
|
|
|
break;
|
|
|
|
|
|
|
|
case Lease6::LEASE_IA_TA:
|
|
|
|
result->type_ = Lease6::LEASE_IA_TA;
|
|
|
|
break;
|
|
|
|
|
|
|
|
case Lease6::LEASE_IA_PD:
|
|
|
|
result->type_ = Lease6::LEASE_IA_PD;
|
|
|
|
break;
|
|
|
|
|
|
|
|
default:
|
2012-10-24 19:18:33 +01:00
|
|
|
isc_throw(BadValue, "invalid lease type returned (" <<
|
|
|
|
lease_type_ << ") for lease with address " <<
|
|
|
|
result->addr_.toText() << ". Only 0, 1, or 2 "
|
|
|
|
"are allowed.");
|
2012-10-22 13:01:40 +01:00
|
|
|
}
|
|
|
|
result->iaid_ = iaid_;
|
|
|
|
result->prefixlen_ = prefixlen_;
|
|
|
|
|
|
|
|
return (result);
|
|
|
|
}
|
|
|
|
|
2012-10-22 10:49:51 +01:00
|
|
|
private:
|
2012-11-06 12:58:10 +00:00
|
|
|
// Note: All array lengths are equal to the corresponding variable in the
|
2012-10-22 13:01:40 +01:00
|
|
|
// schema.
|
2012-11-21 12:44:18 +00:00
|
|
|
// Note: arrays are declared fixed length for speed of creation
|
2012-10-22 10:49:51 +01:00
|
|
|
std::string addr6_; ///< String form of address
|
2012-10-24 14:12:06 +01:00
|
|
|
char addr6_buffer_[ADDRESS6_TEXT_MAX_LEN]; ///< Character
|
|
|
|
///< array form of V6 address
|
2012-10-22 10:49:51 +01:00
|
|
|
unsigned long addr6_length_; ///< Length of the address
|
2012-11-21 12:44:18 +00:00
|
|
|
MYSQL_BIND bind_[9]; ///< Bind array
|
2012-10-24 14:27:43 +01:00
|
|
|
std::vector<uint8_t> duid_; ///< Client identification
|
|
|
|
uint8_t duid_buffer_[DUID_MAX_LEN]; ///< Buffer form of DUID
|
|
|
|
unsigned long duid_length_; ///< Length of the DUID
|
2012-10-24 21:28:24 +01:00
|
|
|
my_bool error_[9]; ///< For error reporting
|
2012-10-22 10:49:51 +01:00
|
|
|
MYSQL_TIME expire_; ///< Lease expiry time
|
|
|
|
const my_bool false_; ///< "false" for MySql
|
2012-10-22 13:01:40 +01:00
|
|
|
uint32_t iaid_; ///< Identity association ID
|
2012-10-22 10:49:51 +01:00
|
|
|
Lease6Ptr lease_; ///< Pointer to lease object
|
2012-10-24 15:36:54 +01:00
|
|
|
uint32_t valid_lifetime_; ///< Lease time
|
2012-10-22 10:49:51 +01:00
|
|
|
uint8_t lease_type_; ///< Lease type
|
2012-10-22 13:01:40 +01:00
|
|
|
uint8_t prefixlen_; ///< Prefix length
|
|
|
|
uint32_t pref_lifetime_; ///< Preferred lifetime
|
|
|
|
uint32_t subnet_id_; ///< Subnet identification
|
2012-10-22 10:49:51 +01:00
|
|
|
const my_bool true_; ///< "true_" for MySql
|
|
|
|
};
|
|
|
|
|
|
|
|
|
2012-11-08 12:14:10 +00:00
|
|
|
/// @brief Fetch and Release MySQL Results
|
|
|
|
///
|
|
|
|
/// When a MySQL statement is exected, to fetch the results the function
|
|
|
|
/// mysql_stmt_fetch() must be called. As well as getting data, this
|
|
|
|
/// allocated internal state. Subsequent calls to mysql_stmt_fetch
|
|
|
|
/// can be made, but when all the data is retrieved, mysql_stmt_free_result
|
|
|
|
/// must be called to free up the resources allocated.
|
|
|
|
///
|
2012-11-08 12:50:34 +00:00
|
|
|
/// Created prior to the first fetch, this class's destructor calls
|
|
|
|
/// mysql_stmt_free_result, so eliminating the need for an explicit release
|
|
|
|
/// in the method using mysql_stmt_free_result. In this way, it guarantees
|
|
|
|
/// that the resources are released even if the MySqlLeaseMgr method concerned
|
|
|
|
/// exits via an exception.
|
|
|
|
class MySqlFreeResult {
|
|
|
|
public:
|
|
|
|
|
|
|
|
/// @brief Constructor
|
|
|
|
///
|
|
|
|
/// Store the pointer to the statement for which data is being fetched.
|
|
|
|
///
|
|
|
|
/// Note that according to the MySQL documentation, mysql_stmt_free_result
|
|
|
|
/// only releases resources if a cursor has been allocated for the
|
|
|
|
/// statement. This implies that it is a no-op if none have been. Either
|
|
|
|
/// way, any error from mysql_stmt_free_result is ignored. (Generating
|
|
|
|
/// an exception is not much help, as it will only confuse things if the
|
|
|
|
/// method calling mysql_stmt_fetch is exiting via an exception.)
|
|
|
|
MySqlFreeResult(MYSQL_STMT* statement) : statement_(statement)
|
|
|
|
{}
|
|
|
|
|
|
|
|
/// @brief Destructor
|
|
|
|
///
|
|
|
|
/// Frees up fetch context if a fetch has been successfully executed.
|
|
|
|
~MySqlFreeResult() {
|
|
|
|
(void) mysql_stmt_free_result(statement_);
|
|
|
|
}
|
|
|
|
|
|
|
|
private:
|
|
|
|
MYSQL_STMT* statement_; ///< Statement for which results are freed
|
|
|
|
};
|
2012-11-08 12:14:10 +00:00
|
|
|
|
|
|
|
|
2012-11-06 12:58:10 +00:00
|
|
|
// MySqlLeaseMgr Methods
|
|
|
|
|
2012-10-24 19:18:33 +01:00
|
|
|
MySqlLeaseMgr::MySqlLeaseMgr(const LeaseMgr::ParameterMap& parameters)
|
|
|
|
: LeaseMgr(parameters), mysql_(NULL) {
|
|
|
|
|
|
|
|
// Allocate context for MySQL - it is destroyed in the destructor.
|
|
|
|
mysql_ = mysql_init(NULL);
|
|
|
|
if (mysql_ == NULL) {
|
|
|
|
isc_throw(DbOpenError, "unable to initialize MySQL");
|
|
|
|
}
|
|
|
|
|
|
|
|
// Open the database
|
|
|
|
openDatabase();
|
|
|
|
|
2012-11-13 12:06:48 +00:00
|
|
|
// Enable autocommit. For maximum speed, the global parameter
|
|
|
|
// innodb_flush_log_at_trx_commit should be set to 2.
|
|
|
|
my_bool result = mysql_autocommit(mysql_, 1);
|
2012-10-24 19:18:33 +01:00
|
|
|
if (result != 0) {
|
|
|
|
isc_throw(DbOperationError, mysql_error(mysql_));
|
|
|
|
}
|
|
|
|
|
|
|
|
// Prepare all statements likely to be used.
|
|
|
|
prepareStatements();
|
2012-11-06 12:58:10 +00:00
|
|
|
|
2012-11-21 12:44:18 +00:00
|
|
|
// Create the exchange objects for use in exchanging data between the
|
2012-11-06 12:58:10 +00:00
|
|
|
// program and the database.
|
2012-11-21 12:44:18 +00:00
|
|
|
exchange4_.reset(new MySqlLease4Exchange());
|
2012-11-06 12:58:10 +00:00
|
|
|
exchange6_.reset(new MySqlLease6Exchange());
|
2012-10-24 19:18:33 +01:00
|
|
|
}
|
|
|
|
|
2012-11-06 12:58:10 +00:00
|
|
|
|
2012-10-24 19:18:33 +01:00
|
|
|
MySqlLeaseMgr::~MySqlLeaseMgr() {
|
|
|
|
// Free up the prepared statements, ignoring errors. (What would we do
|
|
|
|
// about them - we're destroying this object and are not really concerned
|
|
|
|
// with errors on a database connection that it about to go away.)
|
|
|
|
for (int i = 0; i < statements_.size(); ++i) {
|
|
|
|
if (statements_[i] != NULL) {
|
|
|
|
(void) mysql_stmt_close(statements_[i]);
|
|
|
|
statements_[i] = NULL;
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
// Close the database
|
|
|
|
mysql_close(mysql_);
|
|
|
|
mysql_ = NULL;
|
|
|
|
}
|
|
|
|
|
2012-10-22 10:49:51 +01:00
|
|
|
|
2012-10-20 22:52:25 +01:00
|
|
|
// Time conversion methods.
|
|
|
|
//
|
|
|
|
// Note that the MySQL TIMESTAMP data type (used for "expire") converts data
|
|
|
|
// from the current timezone to UTC for storage, and from UTC to the current
|
2012-10-24 15:36:54 +01:00
|
|
|
// timezone for retrieval.
|
|
|
|
//
|
|
|
|
// This causes no problems providing that:
|
|
|
|
// a) cltt is given in local time
|
|
|
|
// b) We let the system take care of timezone conversion when converting
|
|
|
|
// from a time read from the database into a local time.
|
2012-10-20 22:52:25 +01:00
|
|
|
|
|
|
|
void
|
2012-10-24 15:36:54 +01:00
|
|
|
MySqlLeaseMgr::convertToDatabaseTime(time_t cltt, uint32_t valid_lifetime,
|
|
|
|
MYSQL_TIME& expire) {
|
2012-10-20 22:52:25 +01:00
|
|
|
|
|
|
|
// Calculate expiry time and convert to various date/time fields.
|
2012-10-29 13:43:31 +00:00
|
|
|
// @TODO: handle overflows
|
2012-10-24 15:36:54 +01:00
|
|
|
time_t expire_time = cltt + valid_lifetime;
|
|
|
|
|
|
|
|
// Convert to broken-out time
|
2012-10-20 22:52:25 +01:00
|
|
|
struct tm expire_tm;
|
|
|
|
(void) localtime_r(&expire_time, &expire_tm);
|
|
|
|
|
|
|
|
// Place in output expire structure.
|
|
|
|
expire.year = expire_tm.tm_year + 1900;
|
|
|
|
expire.month = expire_tm.tm_mon + 1; // Note different base
|
|
|
|
expire.day = expire_tm.tm_mday;
|
|
|
|
expire.hour = expire_tm.tm_hour;
|
|
|
|
expire.minute = expire_tm.tm_min;
|
|
|
|
expire.second = expire_tm.tm_sec;
|
|
|
|
expire.second_part = 0; // No fractional seconds
|
|
|
|
expire.neg = static_cast<my_bool>(0); // Not negative
|
|
|
|
}
|
|
|
|
|
|
|
|
void
|
2012-10-22 16:07:34 +01:00
|
|
|
MySqlLeaseMgr::convertFromDatabaseTime(const MYSQL_TIME& expire,
|
2012-10-24 15:36:54 +01:00
|
|
|
uint32_t valid_lifetime, time_t& cltt) {
|
2012-10-20 22:52:25 +01:00
|
|
|
|
|
|
|
// Copy across fields from MYSQL_TIME structure.
|
|
|
|
struct tm expire_tm;
|
2012-10-24 15:36:54 +01:00
|
|
|
memset(&expire_tm, 0, sizeof(expire_tm));
|
2012-10-20 22:52:25 +01:00
|
|
|
|
|
|
|
expire_tm.tm_year = expire.year - 1900;
|
|
|
|
expire_tm.tm_mon = expire.month - 1;
|
|
|
|
expire_tm.tm_mday = expire.day;
|
|
|
|
expire_tm.tm_hour = expire.hour;
|
|
|
|
expire_tm.tm_min = expire.minute;
|
|
|
|
expire_tm.tm_sec = expire.second;
|
2012-10-24 15:36:54 +01:00
|
|
|
expire_tm.tm_isdst = -1; // Let the system work out about DST
|
2012-10-20 22:52:25 +01:00
|
|
|
|
|
|
|
// Convert to local time
|
2012-10-24 15:36:54 +01:00
|
|
|
cltt = mktime(&expire_tm) - valid_lifetime;
|
2012-10-20 22:52:25 +01:00
|
|
|
}
|
|
|
|
|
2012-11-06 12:58:10 +00:00
|
|
|
|
2012-10-17 18:37:22 +01:00
|
|
|
void
|
|
|
|
MySqlLeaseMgr::openDatabase() {
|
|
|
|
|
|
|
|
// Set up the values of the parameters
|
2012-10-24 19:18:33 +01:00
|
|
|
const char* host = "localhost";
|
2012-10-17 18:37:22 +01:00
|
|
|
string shost;
|
|
|
|
try {
|
|
|
|
shost = getParameter("host");
|
|
|
|
host = shost.c_str();
|
|
|
|
} catch (...) {
|
2012-10-24 19:18:33 +01:00
|
|
|
// No host. Fine, we'll use "localhost"
|
2012-10-17 18:37:22 +01:00
|
|
|
}
|
|
|
|
|
|
|
|
const char* user = NULL;
|
|
|
|
string suser;
|
|
|
|
try {
|
|
|
|
suser = getParameter("user");
|
|
|
|
user = suser.c_str();
|
|
|
|
} catch (...) {
|
|
|
|
// No user. Fine, we'll use NULL
|
|
|
|
;
|
|
|
|
}
|
|
|
|
|
|
|
|
const char* password = NULL;
|
|
|
|
string spassword;
|
|
|
|
try {
|
|
|
|
spassword = getParameter("password");
|
|
|
|
password = spassword.c_str();
|
|
|
|
} catch (...) {
|
|
|
|
// No password. Fine, we'll use NULL
|
|
|
|
;
|
|
|
|
}
|
|
|
|
|
|
|
|
const char* name = NULL;
|
|
|
|
string sname;
|
|
|
|
try {
|
|
|
|
sname = getParameter("name");
|
|
|
|
name = sname.c_str();
|
|
|
|
} catch (...) {
|
2012-10-24 19:34:38 +01:00
|
|
|
// No database name. Throw a "NoName" exception
|
|
|
|
isc_throw(NoDatabaseName, "must specified a name for the database");
|
2012-10-17 18:37:22 +01:00
|
|
|
}
|
|
|
|
|
2012-10-24 21:18:13 +01:00
|
|
|
// Set options for the connection:
|
|
|
|
// - automatic reconnection
|
|
|
|
my_bool auto_reconnect = 1;
|
|
|
|
int result = mysql_options(mysql_, MYSQL_OPT_RECONNECT, &auto_reconnect);
|
|
|
|
if (result != 0) {
|
|
|
|
isc_throw(DbOpenError, "unable to set auto-reconnect option: " <<
|
|
|
|
mysql_error(mysql_));
|
|
|
|
}
|
|
|
|
|
2012-10-29 19:19:36 +00:00
|
|
|
// Open the database.
|
|
|
|
//
|
|
|
|
// The option CLIENT_FOUND_ROWS is specified so that in an UPDATE,
|
|
|
|
// the affected rows are the number of rows found that match the
|
|
|
|
// WHERE clause of the SQL statement, not the rows changed. The reason
|
|
|
|
// here is that MySQL apparently does not update a row if data has not
|
|
|
|
// changed and so the "affected rows" (retrievable from MySQL) is zero.
|
|
|
|
// This makes it hard to distinguish whether the UPDATE changed no rows
|
|
|
|
// because no row matching the WHERE clause was found, or because a
|
|
|
|
// row was found by no data was altered.
|
2012-10-17 18:37:22 +01:00
|
|
|
MYSQL* status = mysql_real_connect(mysql_, host, user, password, name,
|
2012-10-29 19:19:36 +00:00
|
|
|
0, NULL, CLIENT_FOUND_ROWS);
|
2012-10-17 18:37:22 +01:00
|
|
|
if (status != mysql_) {
|
|
|
|
isc_throw(DbOpenError, mysql_error(mysql_));
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
2012-11-06 12:58:10 +00:00
|
|
|
|
2012-10-18 11:33:51 +01:00
|
|
|
void
|
|
|
|
MySqlLeaseMgr::prepareStatement(StatementIndex index, const char* text) {
|
|
|
|
// Validate that there is space for the statement in the statements array
|
|
|
|
// and that nothing has been placed there before.
|
|
|
|
if ((index >= statements_.size()) || (statements_[index] != NULL)) {
|
2012-10-24 19:18:33 +01:00
|
|
|
isc_throw(InvalidParameter, "invalid prepared statement index (" <<
|
|
|
|
static_cast<int>(index) << ") or indexed prepared " <<
|
|
|
|
"statement is not null");
|
2012-10-18 11:33:51 +01:00
|
|
|
}
|
|
|
|
|
|
|
|
// All OK, so prepare the statement
|
2012-10-24 19:18:33 +01:00
|
|
|
text_statements_[index] = std::string(text);
|
2012-10-18 11:33:51 +01:00
|
|
|
|
|
|
|
statements_[index] = mysql_stmt_init(mysql_);
|
|
|
|
if (statements_[index] == NULL) {
|
|
|
|
isc_throw(DbOperationError, "unable to allocate MySQL prepared "
|
|
|
|
"statement structure" << mysql_error(mysql_));
|
|
|
|
}
|
|
|
|
|
|
|
|
int status = mysql_stmt_prepare(statements_[index], text, strlen(text));
|
|
|
|
if (status != 0) {
|
|
|
|
isc_throw(DbOperationError, "unable to prepare MySQL statement <" <<
|
|
|
|
text << ">, reason: " << mysql_error(mysql_));
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
2012-11-06 12:58:10 +00:00
|
|
|
|
2012-10-18 11:33:51 +01:00
|
|
|
void
|
|
|
|
MySqlLeaseMgr::prepareStatements() {
|
|
|
|
// Allocate space for all statements
|
|
|
|
statements_.clear();
|
|
|
|
statements_.resize(NUM_STATEMENTS, NULL);
|
|
|
|
|
2012-10-24 19:18:33 +01:00
|
|
|
text_statements_.clear();
|
|
|
|
text_statements_.resize(NUM_STATEMENTS, std::string(""));
|
2012-10-18 11:33:51 +01:00
|
|
|
|
2012-11-04 20:20:21 +00:00
|
|
|
// Created the MySQL prepared statements for each DML statement.
|
|
|
|
for (int i = 0; tagged_statements[i].text != NULL; ++i) {
|
|
|
|
prepareStatement(tagged_statements[i].index,
|
|
|
|
tagged_statements[i].text);
|
|
|
|
}
|
2012-10-18 11:33:51 +01:00
|
|
|
}
|
|
|
|
|
2012-11-06 12:58:10 +00:00
|
|
|
|
2012-11-21 12:44:18 +00:00
|
|
|
// Common add lease code
|
2012-11-06 12:58:10 +00:00
|
|
|
|
2012-10-16 16:39:32 +01:00
|
|
|
bool
|
2012-11-21 12:44:18 +00:00
|
|
|
MySqlLeaseMgr::addLease(StatementIndex stindex, std::vector<MYSQL_BIND>& bind) {
|
2012-10-20 22:52:25 +01:00
|
|
|
|
|
|
|
// Bind the parameters to the statement
|
2012-11-04 20:20:21 +00:00
|
|
|
int status = mysql_stmt_bind_param(statements_[stindex], &bind[0]);
|
|
|
|
checkError(status, stindex, "unable to bind parameters");
|
2012-10-20 22:52:25 +01:00
|
|
|
|
|
|
|
// Execute the statement
|
2012-11-04 20:20:21 +00:00
|
|
|
status = mysql_stmt_execute(statements_[stindex]);
|
2012-10-22 16:07:34 +01:00
|
|
|
if (status != 0) {
|
|
|
|
|
|
|
|
// Failure: check for the special case of duplicate entry. If this is
|
|
|
|
// the case, we return false to indicate that the row was not added.
|
|
|
|
// Otherwise we throw an exception.
|
|
|
|
if (mysql_errno(mysql_) == ER_DUP_ENTRY) {
|
|
|
|
return (false);
|
|
|
|
}
|
2012-11-04 20:20:21 +00:00
|
|
|
checkError(status, stindex, "unable to execute");
|
2012-10-22 16:07:34 +01:00
|
|
|
}
|
2012-10-20 22:52:25 +01:00
|
|
|
|
2012-10-22 16:07:34 +01:00
|
|
|
// Insert succeeded
|
|
|
|
return (true);
|
2012-10-16 16:39:32 +01:00
|
|
|
}
|
|
|
|
|
2012-11-21 12:44:18 +00:00
|
|
|
bool
|
|
|
|
MySqlLeaseMgr::addLease(const Lease4Ptr& lease) {
|
|
|
|
// Create the MYSQL_BIND array for the lease
|
|
|
|
std::vector<MYSQL_BIND> bind = exchange4_->createBindForSend(lease);
|
|
|
|
|
|
|
|
// ... and drop to common code.
|
|
|
|
return (addLease(INSERT_LEASE4, bind));
|
|
|
|
}
|
|
|
|
|
|
|
|
bool
|
|
|
|
MySqlLeaseMgr::addLease(const Lease6Ptr& lease) {
|
|
|
|
// Create the MYSQL_BIND array for the lease
|
|
|
|
std::vector<MYSQL_BIND> bind = exchange6_->createBindForSend(lease);
|
|
|
|
|
|
|
|
// ... and drop to common code.
|
|
|
|
return (addLease(INSERT_LEASE6, bind));
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
|
|
template <typename Exchange, typename LeasePtr>
|
|
|
|
void MySqlLeaseMgr::getLease(StatementIndex stindex, MYSQL_BIND* inbind,
|
|
|
|
Exchange& exchange, LeasePtr& result) const {
|
|
|
|
|
|
|
|
// Bind the input parameters to the statement and bind the output
|
|
|
|
// to fields in the exchange object, then execute the prepared statement.
|
|
|
|
bindAndExecute(stindex, exchange, inbind);
|
|
|
|
|
|
|
|
// Fetch the data and set up the "release" object to release associated
|
|
|
|
// resources when this method exits.
|
|
|
|
MySqlFreeResult fetch_release(statements_[stindex]);
|
|
|
|
int status = mysql_stmt_fetch(statements_[stindex]);
|
|
|
|
|
|
|
|
if (status == 0) {
|
|
|
|
try {
|
|
|
|
result = exchange->getLeaseData();
|
|
|
|
} catch (const isc::BadValue& ex) {
|
|
|
|
// Lease type is returned, to rethrow the exception with a bit
|
|
|
|
// more data.
|
|
|
|
isc_throw(BadValue, ex.what() << ". Statement is <" <<
|
|
|
|
text_statements_[stindex] << ">");
|
|
|
|
}
|
|
|
|
|
|
|
|
// As the address is the primary key in the table, we can't return
|
|
|
|
// two rows, so we don't bother checking whether multiple rows have
|
|
|
|
// been returned.
|
|
|
|
|
|
|
|
} else if (status == 1) {
|
|
|
|
checkError(status, stindex, "unable to fetch results");
|
|
|
|
|
|
|
|
} else {
|
|
|
|
// @TODO Handle truncation
|
|
|
|
// We are ignoring truncation for now, so the only other result is
|
|
|
|
// no data was found. In that case, we return a null Lease6 structure.
|
|
|
|
// This has already been set, so no action is needed.
|
|
|
|
}
|
|
|
|
}
|
2012-11-06 12:58:10 +00:00
|
|
|
|
2012-10-16 16:39:32 +01:00
|
|
|
Lease4Ptr
|
2012-11-21 12:44:18 +00:00
|
|
|
MySqlLeaseMgr::getLease4(const isc::asiolink::IOAddress& addr) const {
|
|
|
|
// Set up the WHERE clause value
|
|
|
|
MYSQL_BIND inbind[1];
|
|
|
|
memset(inbind, 0, sizeof(inbind));
|
|
|
|
|
|
|
|
uint32_t addr4 = static_cast<uint32_t>(addr);
|
|
|
|
inbind[0].buffer_type = MYSQL_TYPE_LONG;
|
|
|
|
inbind[0].buffer = reinterpret_cast<char*>(&addr4);
|
|
|
|
inbind[0].is_unsigned = static_cast<my_bool>(1);
|
|
|
|
|
|
|
|
Lease4Ptr result;
|
|
|
|
getLease(GET_LEASE4_ADDR, inbind, exchange4_, result);
|
|
|
|
|
|
|
|
return (result);
|
2012-10-16 16:39:32 +01:00
|
|
|
}
|
|
|
|
|
2012-11-06 12:58:10 +00:00
|
|
|
|
2012-10-16 16:39:32 +01:00
|
|
|
Lease4Ptr
|
2012-11-21 12:44:18 +00:00
|
|
|
MySqlLeaseMgr::getLease4(const isc::asiolink::IOAddress& /* addr */,
|
|
|
|
SubnetID /* subnet_id */) const {
|
|
|
|
isc_throw(NotImplemented, "MySqlLeaseMgr::getLease4(const IOAddress&, SubnetID) "
|
2012-10-24 19:18:33 +01:00
|
|
|
"not implemented yet");
|
2012-10-16 16:39:32 +01:00
|
|
|
return (Lease4Ptr());
|
|
|
|
}
|
|
|
|
|
2012-11-06 12:58:10 +00:00
|
|
|
|
2012-10-16 16:39:32 +01:00
|
|
|
Lease4Collection
|
|
|
|
MySqlLeaseMgr::getLease4(const HWAddr& /* hwaddr */) const {
|
2012-10-24 19:18:33 +01:00
|
|
|
isc_throw(NotImplemented, "MySqlLeaseMgr::getLease4(const HWAddr&) "
|
|
|
|
"not implemented yet");
|
2012-10-16 16:39:32 +01:00
|
|
|
return (Lease4Collection());
|
|
|
|
}
|
|
|
|
|
2012-11-06 12:58:10 +00:00
|
|
|
|
2012-10-16 16:39:32 +01:00
|
|
|
Lease4Ptr
|
|
|
|
MySqlLeaseMgr::getLease4(const HWAddr& /* hwaddr */,
|
|
|
|
SubnetID /* subnet_id */) const {
|
2012-10-24 19:18:33 +01:00
|
|
|
isc_throw(NotImplemented, "MySqlLeaseMgr::getLease4(const HWAddr&, SubnetID) "
|
|
|
|
"not implemented yet");
|
2012-10-16 16:39:32 +01:00
|
|
|
return (Lease4Ptr());
|
|
|
|
}
|
|
|
|
|
2012-11-06 12:58:10 +00:00
|
|
|
|
2012-10-16 16:39:32 +01:00
|
|
|
Lease4Collection
|
|
|
|
MySqlLeaseMgr::getLease4(const ClientId& /* clientid */) const {
|
2012-10-24 19:18:33 +01:00
|
|
|
isc_throw(NotImplemented, "MySqlLeaseMgr::getLease4(const ClientID&) "
|
|
|
|
"not implemented yet");
|
2012-10-16 16:39:32 +01:00
|
|
|
return (Lease4Collection());
|
|
|
|
}
|
|
|
|
|
2012-11-06 12:58:10 +00:00
|
|
|
|
2012-10-16 16:39:32 +01:00
|
|
|
Lease4Ptr
|
|
|
|
MySqlLeaseMgr::getLease4(const ClientId& /* clientid */,
|
|
|
|
SubnetID /* subnet_id */) const {
|
2012-10-24 19:18:33 +01:00
|
|
|
isc_throw(NotImplemented, "MySqlLeaseMgr::getLease4(const ClientID&, SubnetID) "
|
|
|
|
"not implemented yet");
|
2012-10-16 16:39:32 +01:00
|
|
|
return (Lease4Ptr());
|
|
|
|
}
|
|
|
|
|
2012-11-06 12:58:10 +00:00
|
|
|
|
2012-11-21 12:44:18 +00:00
|
|
|
// A convenience function used in the various getLease() methods. It binds
|
2012-11-06 12:58:10 +00:00
|
|
|
// the selection parameters to the prepared statement, and binds the variables
|
|
|
|
// that will receive the data. These are stored in the MySqlLease6Exchange
|
|
|
|
// object associated with the lease manager and converted to a Lease6 object
|
|
|
|
// when retrieved.
|
2012-11-21 12:44:18 +00:00
|
|
|
template <typename Exchange>
|
2012-11-06 12:58:10 +00:00
|
|
|
void
|
2012-11-21 12:44:18 +00:00
|
|
|
MySqlLeaseMgr::bindAndExecute(StatementIndex stindex, Exchange& exchange,
|
|
|
|
MYSQL_BIND* inbind) const {
|
2012-11-06 12:58:10 +00:00
|
|
|
|
|
|
|
// Bind the input parameters to the statement
|
|
|
|
int status = mysql_stmt_bind_param(statements_[stindex], inbind);
|
|
|
|
checkError(status, stindex, "unable to bind WHERE clause parameter");
|
|
|
|
|
|
|
|
// Set up the SELECT clause
|
2012-11-21 12:44:18 +00:00
|
|
|
std::vector<MYSQL_BIND> outbind = exchange->createBindForReceive();
|
2012-11-06 12:58:10 +00:00
|
|
|
|
|
|
|
// Bind the output parameters to the statement
|
|
|
|
status = mysql_stmt_bind_result(statements_[stindex], &outbind[0]);
|
|
|
|
checkError(status, stindex, "unable to bind SELECT caluse parameters");
|
|
|
|
|
|
|
|
// Execute the statement
|
|
|
|
status = mysql_stmt_execute(statements_[stindex]);
|
|
|
|
checkError(status, stindex, "unable to execute");
|
|
|
|
}
|
|
|
|
|
|
|
|
|
2012-10-16 16:39:32 +01:00
|
|
|
Lease6Ptr
|
2012-10-20 22:52:25 +01:00
|
|
|
MySqlLeaseMgr::getLease6(const isc::asiolink::IOAddress& addr) const {
|
|
|
|
// Set up the WHERE clause value
|
|
|
|
MYSQL_BIND inbind[1];
|
|
|
|
memset(inbind, 0, sizeof(inbind));
|
|
|
|
|
|
|
|
std::string addr6 = addr.toText();
|
|
|
|
unsigned long addr6_length = addr6.size();
|
|
|
|
|
2012-11-08 12:14:10 +00:00
|
|
|
// See the earlier description of the use of "const_cast" when accessing
|
|
|
|
// the address for an explanation of the reason.
|
2012-10-20 22:52:25 +01:00
|
|
|
inbind[0].buffer_type = MYSQL_TYPE_STRING;
|
|
|
|
inbind[0].buffer = const_cast<char*>(addr6.c_str());
|
|
|
|
inbind[0].buffer_length = addr6_length;
|
|
|
|
inbind[0].length = &addr6_length;
|
|
|
|
|
2012-10-22 13:01:40 +01:00
|
|
|
Lease6Ptr result;
|
2012-11-21 12:44:18 +00:00
|
|
|
getLease(GET_LEASE6_ADDR, inbind, exchange6_, result);
|
2012-10-20 22:52:25 +01:00
|
|
|
|
|
|
|
return (result);
|
2012-10-16 16:39:32 +01:00
|
|
|
}
|
|
|
|
|
2012-11-06 12:58:10 +00:00
|
|
|
|
2012-10-16 16:39:32 +01:00
|
|
|
Lease6Collection
|
2012-11-03 18:26:57 +00:00
|
|
|
MySqlLeaseMgr::getLease6(const DUID& duid, uint32_t iaid) const {
|
2012-11-04 20:20:21 +00:00
|
|
|
const StatementIndex stindex = GET_LEASE6_DUID_IAID;
|
|
|
|
|
2012-11-03 18:26:57 +00:00
|
|
|
// Set up the WHERE clause value
|
|
|
|
MYSQL_BIND inbind[2];
|
|
|
|
memset(inbind, 0, sizeof(inbind));
|
|
|
|
|
2012-11-08 12:14:10 +00:00
|
|
|
// In the following statement, the DUID is being read. However, the
|
|
|
|
// MySQL C interface does not use "const", so the "buffer" element
|
|
|
|
// is declared as "char*" instead of "const char*". To resolve this,
|
|
|
|
// the "const" is discarded before the uint8_t* is cast to char*.
|
2012-11-09 16:11:24 +00:00
|
|
|
//
|
|
|
|
// Note that the const_cast could be avoided by copying the DUID to
|
|
|
|
// a writeable buffer and storing the address of that in the "buffer"
|
|
|
|
// element. However, this introduces a copy operation (with additional
|
|
|
|
// overhead) purely to get round the strictures introduced by design of
|
|
|
|
// the MySQL interface (which uses the area pointed to by "buffer" as
|
|
|
|
// input when specifying query parameters and as output when retrieving
|
|
|
|
// data). For that reason, "const_cast" has been used.
|
2012-11-03 18:26:57 +00:00
|
|
|
const vector<uint8_t>& duid_vector = duid.getDuid();
|
|
|
|
unsigned long duid_length = duid_vector.size();
|
|
|
|
inbind[0].buffer_type = MYSQL_TYPE_BLOB;
|
|
|
|
inbind[0].buffer = reinterpret_cast<char*>(
|
|
|
|
const_cast<uint8_t*>(&duid_vector[0]));
|
|
|
|
inbind[0].buffer_length = duid_length;
|
|
|
|
inbind[0].length = &duid_length;
|
|
|
|
|
|
|
|
// IAID
|
|
|
|
inbind[1].buffer_type = MYSQL_TYPE_LONG;
|
|
|
|
inbind[1].buffer = reinterpret_cast<char*>(&iaid);
|
|
|
|
inbind[1].is_unsigned = static_cast<my_bool>(1);
|
|
|
|
|
2012-11-06 12:58:10 +00:00
|
|
|
// Bind the input parameters to the statement and bind the output
|
|
|
|
// to fields in the exchange object, then execute the prepared statement.
|
2012-11-21 12:44:18 +00:00
|
|
|
bindAndExecute(stindex, exchange6_, inbind);
|
2012-11-03 18:26:57 +00:00
|
|
|
|
2012-11-06 12:58:10 +00:00
|
|
|
// Ensure that all the lease information is retrieved in one go to avoid
|
|
|
|
// overhead of going back and forth between client and server.
|
|
|
|
int status = mysql_stmt_store_result(statements_[stindex]);
|
2012-11-04 20:20:21 +00:00
|
|
|
checkError(status, stindex, "unable to set up for storing all results");
|
2012-11-03 18:26:57 +00:00
|
|
|
|
|
|
|
// Fetch the data. There could be multiple rows, so we need to iterate
|
|
|
|
// until all data has been retrieved.
|
|
|
|
Lease6Collection result;
|
2012-11-08 12:50:34 +00:00
|
|
|
|
|
|
|
// Set up the fetch "release" object to release resources associated
|
|
|
|
// with the call to mysql_stmt_fetch when this method exits, then
|
|
|
|
// retrieve the data.
|
|
|
|
MySqlFreeResult fetch_release(statements_[stindex]);
|
2012-11-04 20:20:21 +00:00
|
|
|
while ((status = mysql_stmt_fetch(statements_[stindex])) == 0) {
|
2012-11-03 18:26:57 +00:00
|
|
|
try {
|
2012-11-06 12:58:10 +00:00
|
|
|
Lease6Ptr lease = exchange6_->getLeaseData();
|
2012-11-03 18:26:57 +00:00
|
|
|
result.push_back(lease);
|
|
|
|
|
|
|
|
} catch (const isc::BadValue& ex) {
|
|
|
|
// Rethrow the exception with a bit more data.
|
|
|
|
isc_throw(BadValue, ex.what() << ". Statement is <" <<
|
2012-11-04 20:20:21 +00:00
|
|
|
text_statements_[stindex] << ">");
|
2012-11-03 18:26:57 +00:00
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
// How did the fetch end?
|
|
|
|
if (status == 1) {
|
|
|
|
// Error - unable to fecth results
|
2012-11-04 20:20:21 +00:00
|
|
|
checkError(status, stindex, "unable to fetch results");
|
2012-11-03 18:26:57 +00:00
|
|
|
} else if (status == MYSQL_DATA_TRUNCATED) {
|
|
|
|
// @TODO Handle truncation
|
|
|
|
;
|
|
|
|
}
|
|
|
|
|
|
|
|
return (result);
|
2012-10-16 16:39:32 +01:00
|
|
|
}
|
|
|
|
|
2012-11-06 12:58:10 +00:00
|
|
|
|
2012-10-16 16:39:32 +01:00
|
|
|
Lease6Ptr
|
2012-11-04 19:57:05 +00:00
|
|
|
MySqlLeaseMgr::getLease6(const DUID& duid, uint32_t iaid,
|
|
|
|
SubnetID subnet_id) const {
|
2012-11-04 20:20:21 +00:00
|
|
|
const StatementIndex stindex = GET_LEASE6_DUID_IAID_SUBID;
|
|
|
|
|
2012-11-04 19:57:05 +00:00
|
|
|
// Set up the WHERE clause value
|
|
|
|
MYSQL_BIND inbind[3];
|
|
|
|
memset(inbind, 0, sizeof(inbind));
|
|
|
|
|
2012-11-08 12:14:10 +00:00
|
|
|
// See the earlier description of the use of "const_cast" when accessing
|
|
|
|
// the DUID for an explanation of the reason.
|
2012-11-04 19:57:05 +00:00
|
|
|
const vector<uint8_t>& duid_vector = duid.getDuid();
|
|
|
|
unsigned long duid_length = duid_vector.size();
|
|
|
|
inbind[0].buffer_type = MYSQL_TYPE_BLOB;
|
|
|
|
inbind[0].buffer = reinterpret_cast<char*>(
|
|
|
|
const_cast<uint8_t*>(&duid_vector[0]));
|
|
|
|
inbind[0].buffer_length = duid_length;
|
|
|
|
inbind[0].length = &duid_length;
|
|
|
|
|
|
|
|
// IAID
|
|
|
|
inbind[1].buffer_type = MYSQL_TYPE_LONG;
|
|
|
|
inbind[1].buffer = reinterpret_cast<char*>(&iaid);
|
|
|
|
inbind[1].is_unsigned = static_cast<my_bool>(1);
|
|
|
|
|
|
|
|
// Subnet ID
|
|
|
|
inbind[2].buffer_type = MYSQL_TYPE_LONG;
|
|
|
|
inbind[2].buffer = reinterpret_cast<char*>(&subnet_id);
|
|
|
|
inbind[2].is_unsigned = static_cast<my_bool>(1);
|
|
|
|
|
2012-11-06 12:58:10 +00:00
|
|
|
// Bind the input parameters to the statement and bind the output
|
|
|
|
// to fields in the exchange object, then execute the prepared statement.
|
2012-11-21 12:44:18 +00:00
|
|
|
bindAndExecute(stindex, exchange6_, inbind);
|
2012-11-04 19:57:05 +00:00
|
|
|
|
2012-11-08 12:50:34 +00:00
|
|
|
// Fetch the data and set up the "release" object to release associated
|
|
|
|
// resources when this method exits then retrieve the data.
|
2012-11-04 19:57:05 +00:00
|
|
|
Lease6Ptr result;
|
2012-11-08 12:50:34 +00:00
|
|
|
MySqlFreeResult fetch_release(statements_[stindex]);
|
2012-11-06 12:58:10 +00:00
|
|
|
int status = mysql_stmt_fetch(statements_[stindex]);
|
2012-11-04 19:57:05 +00:00
|
|
|
if (status == 0) {
|
|
|
|
try {
|
2012-11-06 12:58:10 +00:00
|
|
|
result = exchange6_->getLeaseData();
|
2012-11-04 19:57:05 +00:00
|
|
|
|
2012-11-06 12:58:10 +00:00
|
|
|
// TODO: check for more than one row returned. At present, just
|
|
|
|
// ignore the excess and take the first.
|
2012-11-04 19:57:05 +00:00
|
|
|
|
|
|
|
} catch (const isc::BadValue& ex) {
|
|
|
|
// Lease type is returned, to rethrow the exception with a bit
|
|
|
|
// more data.
|
|
|
|
isc_throw(BadValue, ex.what() << ". Statement is <" <<
|
2012-11-04 20:20:21 +00:00
|
|
|
text_statements_[stindex] << ">");
|
2012-11-04 19:57:05 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
// As the address is the primary key in the table, we can't return
|
|
|
|
// two rows, so we don't bother checking whether multiple rows have
|
|
|
|
// been returned.
|
|
|
|
|
|
|
|
} else if (status == 1) {
|
2012-11-04 20:20:21 +00:00
|
|
|
checkError(status, stindex, "unable to fetch results");
|
2012-11-04 19:57:05 +00:00
|
|
|
|
|
|
|
} else {
|
|
|
|
// @TODO Handle truncation
|
|
|
|
// We are ignoring truncation for now, so the only other result is
|
|
|
|
// no data was found. In that case, we return a null Lease6 structure.
|
|
|
|
// This has already been set, so the action is a no-op.
|
|
|
|
}
|
|
|
|
|
|
|
|
return (result);
|
2012-10-16 16:39:32 +01:00
|
|
|
}
|
|
|
|
|
2012-11-06 12:58:10 +00:00
|
|
|
|
2012-10-16 16:39:32 +01:00
|
|
|
void
|
2012-10-20 22:52:25 +01:00
|
|
|
MySqlLeaseMgr::updateLease4(const Lease4Ptr& /* lease4 */) {
|
2012-10-24 19:18:33 +01:00
|
|
|
isc_throw(NotImplemented, "MySqlLeaseMgr::updateLease4(const Lease4Ptr&) "
|
|
|
|
"not implemented yet");
|
2012-10-16 16:39:32 +01:00
|
|
|
}
|
|
|
|
|
2012-11-06 12:58:10 +00:00
|
|
|
|
2012-10-16 16:39:32 +01:00
|
|
|
void
|
2012-10-29 19:19:36 +00:00
|
|
|
MySqlLeaseMgr::updateLease6(const Lease6Ptr& lease) {
|
2012-11-04 20:20:21 +00:00
|
|
|
const StatementIndex stindex = UPDATE_LEASE6;
|
|
|
|
|
2012-10-29 19:19:36 +00:00
|
|
|
// Create the MYSQL_BIND array for the data being updated
|
2012-11-06 12:58:10 +00:00
|
|
|
std::vector<MYSQL_BIND> bind = exchange6_->createBindForSend(lease);
|
2012-10-29 19:19:36 +00:00
|
|
|
|
|
|
|
// Set up the WHERE clause value
|
|
|
|
MYSQL_BIND where;
|
|
|
|
memset(&where, 0, sizeof(where));
|
|
|
|
|
|
|
|
std::string addr6 = lease->addr_.toText();
|
|
|
|
unsigned long addr6_length = addr6.size();
|
|
|
|
|
2012-11-08 12:14:10 +00:00
|
|
|
// See the earlier description of the use of "const_cast" when accessing
|
|
|
|
// the address for an explanation of the reason.
|
2012-10-29 19:19:36 +00:00
|
|
|
where.buffer_type = MYSQL_TYPE_STRING;
|
|
|
|
where.buffer = const_cast<char*>(addr6.c_str());
|
|
|
|
where.buffer_length = addr6_length;
|
|
|
|
where.length = &addr6_length;
|
|
|
|
bind.push_back(where);
|
|
|
|
|
|
|
|
// Bind the parameters to the statement
|
2012-11-04 20:20:21 +00:00
|
|
|
int status = mysql_stmt_bind_param(statements_[stindex], &bind[0]);
|
|
|
|
checkError(status, stindex, "unable to bind parameters");
|
2012-10-29 19:19:36 +00:00
|
|
|
|
|
|
|
// Execute
|
2012-11-04 20:20:21 +00:00
|
|
|
status = mysql_stmt_execute(statements_[stindex]);
|
|
|
|
checkError(status, stindex, "unable to execute");
|
2012-10-29 19:19:36 +00:00
|
|
|
|
|
|
|
// See how many rows were affected. The statement should only delete a
|
|
|
|
// single row.
|
2012-11-04 20:20:21 +00:00
|
|
|
int affected_rows = mysql_stmt_affected_rows(statements_[stindex]);
|
2012-10-29 19:19:36 +00:00
|
|
|
if (affected_rows == 0) {
|
|
|
|
isc_throw(NoSuchLease, "unable to update lease for address " <<
|
|
|
|
addr6 << " as it does not exist");
|
|
|
|
} else if (affected_rows > 1) {
|
|
|
|
// Should not happen - primary key constraint should only have selected
|
|
|
|
// one row.
|
|
|
|
isc_throw(DbOperationError, "apparently updated more than one lease "
|
|
|
|
"that had the address " << addr6);
|
|
|
|
}
|
2012-10-16 16:39:32 +01:00
|
|
|
}
|
|
|
|
|
2012-11-21 12:44:18 +00:00
|
|
|
// TODO: Replace by deleteLease
|
2012-10-16 16:39:32 +01:00
|
|
|
bool
|
2012-11-21 12:44:18 +00:00
|
|
|
MySqlLeaseMgr::deleteLease4(const isc::asiolink::IOAddress& addr) {
|
|
|
|
const StatementIndex stindex = DELETE_LEASE4;
|
|
|
|
|
|
|
|
// Set up the WHERE clause value
|
|
|
|
MYSQL_BIND inbind[1];
|
|
|
|
memset(inbind, 0, sizeof(inbind));
|
|
|
|
|
|
|
|
uint32_t addr4 = static_cast<uint32_t>(addr);
|
|
|
|
|
|
|
|
// See the earlier description of the use of "const_cast" when accessing
|
|
|
|
// the address for an explanation of the reason.
|
|
|
|
inbind[0].buffer_type = MYSQL_TYPE_LONG;
|
|
|
|
inbind[0].buffer = reinterpret_cast<char*>(&addr4);
|
|
|
|
inbind[0].is_unsigned = my_bool(1);
|
|
|
|
|
|
|
|
// Bind the input parameters to the statement
|
|
|
|
int status = mysql_stmt_bind_param(statements_[stindex], inbind);
|
|
|
|
checkError(status, stindex, "unable to bind WHERE clause parameter");
|
|
|
|
|
|
|
|
// Execute
|
|
|
|
status = mysql_stmt_execute(statements_[stindex]);
|
|
|
|
checkError(status, stindex, "unable to execute");
|
|
|
|
|
|
|
|
// See how many rows were affected. Note that the statement may delete
|
|
|
|
// multiple rows.
|
|
|
|
return (mysql_stmt_affected_rows(statements_[stindex]) > 0);
|
2012-10-24 19:18:33 +01:00
|
|
|
isc_throw(NotImplemented, "MySqlLeaseMgr::deleteLease4(const IOAddress&) "
|
|
|
|
"not implemented yet");
|
2012-10-16 16:39:32 +01:00
|
|
|
return (false);
|
|
|
|
}
|
|
|
|
|
2012-11-06 12:58:10 +00:00
|
|
|
|
2012-10-16 16:39:32 +01:00
|
|
|
bool
|
2012-10-22 16:07:34 +01:00
|
|
|
MySqlLeaseMgr::deleteLease6(const isc::asiolink::IOAddress& addr) {
|
2012-11-04 20:20:21 +00:00
|
|
|
const StatementIndex stindex = DELETE_LEASE6;
|
2012-10-22 16:07:34 +01:00
|
|
|
|
|
|
|
// Set up the WHERE clause value
|
|
|
|
MYSQL_BIND inbind[1];
|
|
|
|
memset(inbind, 0, sizeof(inbind));
|
|
|
|
|
|
|
|
std::string addr6 = addr.toText();
|
|
|
|
unsigned long addr6_length = addr6.size();
|
|
|
|
|
2012-11-08 12:14:10 +00:00
|
|
|
// See the earlier description of the use of "const_cast" when accessing
|
|
|
|
// the address for an explanation of the reason.
|
2012-10-22 16:07:34 +01:00
|
|
|
inbind[0].buffer_type = MYSQL_TYPE_STRING;
|
|
|
|
inbind[0].buffer = const_cast<char*>(addr6.c_str());
|
|
|
|
inbind[0].buffer_length = addr6_length;
|
|
|
|
inbind[0].length = &addr6_length;
|
|
|
|
|
|
|
|
// Bind the input parameters to the statement
|
2012-11-04 20:20:21 +00:00
|
|
|
int status = mysql_stmt_bind_param(statements_[stindex], inbind);
|
|
|
|
checkError(status, stindex, "unable to bind WHERE clause parameter");
|
2012-10-22 16:07:34 +01:00
|
|
|
|
|
|
|
// Execute
|
2012-11-04 20:20:21 +00:00
|
|
|
status = mysql_stmt_execute(statements_[stindex]);
|
|
|
|
checkError(status, stindex, "unable to execute");
|
2012-10-22 16:07:34 +01:00
|
|
|
|
|
|
|
// See how many rows were affected. Note that the statement may delete
|
|
|
|
// multiple rows.
|
2012-11-04 20:20:21 +00:00
|
|
|
return (mysql_stmt_affected_rows(statements_[stindex]) > 0);
|
2012-10-16 16:39:32 +01:00
|
|
|
}
|
|
|
|
|
2012-11-06 12:58:10 +00:00
|
|
|
|
2012-10-16 16:39:32 +01:00
|
|
|
std::string
|
|
|
|
MySqlLeaseMgr::getName() const {
|
2012-10-24 19:18:33 +01:00
|
|
|
std::string name = "";
|
|
|
|
try {
|
|
|
|
name = getParameter("name");
|
|
|
|
} catch (...) {
|
|
|
|
;
|
|
|
|
}
|
|
|
|
return (name);
|
2012-10-16 16:39:32 +01:00
|
|
|
}
|
|
|
|
|
2012-11-06 12:58:10 +00:00
|
|
|
|
2012-10-16 16:39:32 +01:00
|
|
|
std::string
|
|
|
|
MySqlLeaseMgr::getDescription() const {
|
2012-11-06 12:58:10 +00:00
|
|
|
return (std::string("MySQL Database"));
|
2012-10-16 16:39:32 +01:00
|
|
|
}
|
|
|
|
|
2012-11-06 12:58:10 +00:00
|
|
|
|
2012-10-16 16:39:32 +01:00
|
|
|
std::pair<uint32_t, uint32_t>
|
|
|
|
MySqlLeaseMgr::getVersion() const {
|
2012-11-04 20:20:21 +00:00
|
|
|
const StatementIndex stindex = GET_VERSION;
|
|
|
|
|
2012-10-18 11:33:51 +01:00
|
|
|
uint32_t major; // Major version number
|
|
|
|
uint32_t minor; // Minor version number
|
|
|
|
|
|
|
|
// Execute the prepared statement
|
2012-11-04 20:20:21 +00:00
|
|
|
int status = mysql_stmt_execute(statements_[stindex]);
|
2012-10-18 11:33:51 +01:00
|
|
|
if (status != 0) {
|
|
|
|
isc_throw(DbOperationError, "unable to execute <"
|
2012-11-04 20:20:21 +00:00
|
|
|
<< text_statements_[stindex] << "> - reason: " <<
|
2012-10-18 11:33:51 +01:00
|
|
|
mysql_error(mysql_));
|
|
|
|
}
|
|
|
|
|
|
|
|
// Bind the output of the statement to the appropriate variables.
|
|
|
|
MYSQL_BIND bind[2];
|
|
|
|
memset(bind, 0, sizeof(bind));
|
|
|
|
|
|
|
|
bind[0].buffer_type = MYSQL_TYPE_LONG;
|
|
|
|
bind[0].is_unsigned = 1;
|
|
|
|
bind[0].buffer = &major;
|
|
|
|
bind[0].buffer_length = sizeof(major);
|
|
|
|
|
|
|
|
bind[1].buffer_type = MYSQL_TYPE_LONG;
|
|
|
|
bind[1].is_unsigned = 1;
|
|
|
|
bind[1].buffer = &minor;
|
|
|
|
bind[1].buffer_length = sizeof(minor);
|
|
|
|
|
2012-11-04 20:20:21 +00:00
|
|
|
status = mysql_stmt_bind_result(statements_[stindex], bind);
|
2012-10-18 11:33:51 +01:00
|
|
|
if (status != 0) {
|
|
|
|
isc_throw(DbOperationError, "unable to bind result set: " <<
|
|
|
|
mysql_error(mysql_));
|
|
|
|
}
|
|
|
|
|
2012-11-08 12:50:34 +00:00
|
|
|
// Fetch the data and set up the "release" object to release associated
|
|
|
|
// resources when this method exits then retrieve the data.
|
|
|
|
MySqlFreeResult fetch_release(statements_[stindex]);
|
2012-11-04 20:20:21 +00:00
|
|
|
status = mysql_stmt_fetch(statements_[stindex]);
|
2012-10-18 11:33:51 +01:00
|
|
|
if (status != 0) {
|
|
|
|
isc_throw(DbOperationError, "unable to obtain result set: " <<
|
|
|
|
mysql_error(mysql_));
|
|
|
|
}
|
|
|
|
|
|
|
|
return (std::make_pair(major, minor));
|
2012-10-16 16:39:32 +01:00
|
|
|
}
|
|
|
|
|
2012-11-06 12:58:10 +00:00
|
|
|
|
2012-10-20 22:52:25 +01:00
|
|
|
void
|
|
|
|
MySqlLeaseMgr::commit() {
|
|
|
|
if (mysql_commit(mysql_) != 0) {
|
|
|
|
isc_throw(DbOperationError, "commit failed: " << mysql_error(mysql_));
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
2012-11-06 12:58:10 +00:00
|
|
|
|
2012-10-20 22:52:25 +01:00
|
|
|
void
|
|
|
|
MySqlLeaseMgr::rollback() {
|
|
|
|
if (mysql_rollback(mysql_) != 0) {
|
|
|
|
isc_throw(DbOperationError, "rollback failed: " << mysql_error(mysql_));
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
2012-10-16 16:39:32 +01:00
|
|
|
}; // end of isc::dhcp namespace
|
|
|
|
}; // end of isc namespace
|