1
0
mirror of https://github.com/OpenNebula/one.git synced 2024-12-23 17:33:56 +03:00
one/include/HostPool.h
2020-04-30 15:00:02 +02:00

287 lines
8.3 KiB
C++

/* -------------------------------------------------------------------------- */
/* Copyright 2002-2020, OpenNebula Project, OpenNebula Systems */
/* */
/* Licensed under the Apache License, Version 2.0 (the "License"); you may */
/* not use this file except in compliance with the License. You may obtain */
/* a copy of the License at */
/* */
/* http://www.apache.org/licenses/LICENSE-2.0 */
/* */
/* Unless required by applicable law or agreed to in writing, software */
/* distributed under the License is distributed on an "AS IS" BASIS, */
/* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. */
/* See the License for the specific language governing permissions and */
/* limitations under the License. */
/* -------------------------------------------------------------------------- */
#ifndef HOST_POOL_H_
#define HOST_POOL_H_
#include "PoolSQL.h"
#include "Host.h"
#include "HostMonitoringTemplate.h"
#include "OneDB.h"
#include <time.h>
#include <sstream>
#include <vector>
/**
* The Host Pool class.
*/
class HostPool : public PoolSQL
{
public:
HostPool(SqlDB * db, std::vector<const SingleAttribute *>& secrets);
~HostPool() = default;
/**
* Function to allocate a new Host object
* @param oid the id assigned to the Host
* @return the oid assigned to the object or -1 in case of failure
*/
int allocate (
int * oid,
const string& hostname,
const string& im_mad_name,
const string& vmm_mad_name,
int cluster_id,
const string& cluster_name,
string& error_str);
/**
* Updates a Host in the data base. It also updates the previous state
* after executing the hooks.
* @param objsql a pointer to the Host
*
* @return 0 on success.
*/
virtual int update(PoolObjectSQL * objsql);
/**
* Function to get a Host from the pool, if the object is not in memory
* it is loaded from the DB
* @param oid Host unique id
* @param lock locks the Host mutex
* @return a pointer to the Host, 0 if the Host could not be loaded
*/
Host * get(int oid)
{
return static_cast<Host *>(PoolSQL::get(oid));
};
/**
* Function to get a read only Host from the pool, if the object is not in memory
* it is loaded from the DB
* @param oid Host unique id
* @return a pointer to the Host, 0 if the Host could not be loaded
*/
Host * get_ro(int oid)
{
return static_cast<Host *>(PoolSQL::get_ro(oid));
};
/**
* Function to get a Host from the pool, if the object is not in memory
* it is loaded from the DB
* @param hostname
* @param lock locks the Host mutex
* @return a pointer to the Host, 0 if the Host could not be loaded
*/
Host * get(string name)
{
// The owner is set to -1, because it is not used in the key() method
return static_cast<Host *>(PoolSQL::get(name,-1));
};
/**
* Function to get a Host from the pool, if the object is not in memory
* it is loaded from the DB
* @param hostname
* @param lock locks the Host mutex
* @return a pointer to the Host, 0 if the Host could not be loaded
*/
Host * get_ro(string name)
{
// The owner is set to -1, because it is not used in the key() method
return static_cast<Host *>(PoolSQL::get_ro(name,-1));
};
/**
* Generate an index key for the object
* @param name of the object
* @param uid owner of the object, only used if needed
*
* @return the key, a string
*/
string key(const string& name, int uid)
{
// Name is enough key because Hosts can't repeat names.
return name;
};
/**
* Bootstraps the database table(s) associated to the Host pool
* @return 0 on success
*/
static int bootstrap(SqlDB *_db)
{
int rc;
ostringstream oss_host(one_db::host_db_bootstrap);
ostringstream oss_monitor(one_db::host_monitor_db_bootstrap);
rc = _db->exec_local_wr(oss_host);
rc += _db->exec_local_wr(oss_monitor);
return rc;
};
/**
* Allocates a given capacity to the host
* @param oid the id of the host to allocate the capacity
* @param vm_id id of the vm to add to the host
* @param cpu amount of CPU, in percentage
* @param mem amount of main memory, in KB
* @param disk amount of disk
* @param pci devices requested by the VM
*
* @return 0 on success -1 in case of failure
*/
int add_capacity(int oid, HostShareCapacity &sr)
{
int rc = 0;
Host * host = get(oid);
if ( host != 0 )
{
host->add_capacity(sr);
update(host);
host->unlock();
}
else
{
rc = -1;
}
return rc;
};
/**
* De-Allocates a given capacity to the host
* @param oid the id of the host to allocate the capacity
* @param vm_id id of the vm to add to the host
* @param cpu amount of CPU
* @param mem amount of main memory
* @param disk amount of disk
* @param pci devices requested by the VM
*/
void del_capacity(int oid, HostShareCapacity &sr)
{
Host * host = get(oid);
if ( host != 0 )
{
host->del_capacity(sr);
update(host);
host->unlock();
}
};
int drop(PoolObjectSQL * objsql, string& error_msg)
{
Host * host = static_cast<Host *>(objsql);
if ( host->get_share_running_vms() > 0 )
{
error_msg = "Can not remove a host with running VMs";
return -1;
}
return PoolSQL::drop(objsql, error_msg);
};
/**
* Dumps the HOST pool in XML format. A filter can be also added to the
* query
* @param oss the output stream to dump the pool contents
* @param where filter for the objects, defaults to all
* @param sid first element used for pagination
* @param eid last element used for pagination, -1 to disable
* @param desc descending order of pool elements
*
* @return 0 on success
*/
int dump(std::string& oss, const std::string& where, int sid, int eid,
bool desc)
{
return PoolSQL::dump(oss, "HOST_POOL", "body", one_db::host_table,
where, sid, eid, desc);
};
/**
* Finds a set objects that satisfies a given condition
* @param oids a vector with the oids of the objects.
* @param the name of the DB table.
* @param where condition in SQL format.
*
* @return 0 on success
*/
int search(vector<int>& oids, const string& where)
{
return PoolSQL::search(oids, one_db::host_table, where);
};
/**
* Dumps the host monitoring information entries in XML format. A filter
* can be also added to the query.
*
* @param oss the output stream to dump the pool contents
* @param where filter for the objects, defaults to all
*
* @return 0 on success
*/
int dump_monitoring(string& oss, const string& where);
/**
* Dumps the HOST monitoring information for a single HOST
*
* @param oss the output stream to dump the pool contents
* @param hostid id of the target HOST
*
* @return 0 on success
*/
int dump_monitoring(string& oss, int hostid)
{
ostringstream filter;
filter << "oid = " << hostid;
return dump_monitoring(oss, filter.str());
}
/**
* Returns last monitoring info for a host
* @param hid host id
*/
HostMonitoringTemplate get_monitoring(int hid);
private:
/**
* Factory method to produce Host objects
* @return a pointer to the new Host
*/
PoolObjectSQL * create()
{
return new Host(-1,"","","",-1,"");
};
};
#endif /*HOST_POOL_H_*/