1
0
mirror of https://github.com/OpenNebula/one.git synced 2024-12-22 13:33:52 +03:00
one/include/Host.h
2015-09-23 16:51:10 +02:00

664 lines
18 KiB
C++

/* ------------------------------------------------------------------------ */
/* Copyright 2002-2015, 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_H_
#define HOST_H_
#include "PoolSQL.h"
#include "HostTemplate.h"
#include "HostShare.h"
#include "Clusterable.h"
#include "ObjectCollection.h"
#include "NebulaLog.h"
#include "NebulaUtil.h"
using namespace std;
/**
* The Host class.
*/
class Host : public PoolObjectSQL, public Clusterable
{
public:
// ----------------------------------------------------------------------
// Host States
// ----------------------------------------------------------------------
enum HostState
{
INIT = 0, /**< Initial state for enabled hosts. */
MONITORING_MONITORED = 1, /**< Monitoring the host (from monitored). */
MONITORED = 2, /**< The host has been successfully monitored. */
ERROR = 3, /**< An error ocurrer while monitoring the host. */
DISABLED = 4, /**< The host is disabled won't be monitored. */
MONITORING_ERROR = 5, /**< Monitoring the host (from error). */
MONITORING_INIT = 6, /**< Monitoring the host (from init). */
MONITORING_DISABLED = 7 /**< Monitoring the host (from disabled). */
};
/**
* Function to print the Host object into a string in XML format
* @param xml the resulting XML string
* @return a reference to the generated string
*/
string& to_xml(string& xml) const;
/**
* Rebuilds the object from an xml formatted string
* @param xml_str The xml-formatted string
*
* @return 0 on success, -1 otherwise
*/
int from_xml(const string &xml_str);
/**
* Check if the host is enabled
* @return true if the host is enabled
*/
bool isEnabled() const
{
return state != DISABLED && state != MONITORING_DISABLED;
}
/**
* Check if the host is being monitored
* @return true if the host is enabled
*/
bool isMonitoring() const
{
return ((state == MONITORING_ERROR) ||
(state == MONITORING_MONITORED)||
(state == MONITORING_INIT)||
(state == MONITORING_DISABLED));
}
/**
* Checks if the host is a remote public cloud
* @return true if the host is a remote public cloud
*/
bool is_public_cloud() const;
/**
* Disables the current host, it will not be monitored nor used by the
* scheduler
*/
void disable();
/**
* Enables the current host, it will be monitored and could be used by
* the scheduler
*/
void enable()
{
state = INIT;
};
/**
* Sets the host in error
*/
void set_error()
{
state = ERROR;
}
/**
* Updates the Host's last_monitored time stamp.
* @param success if the monitored action was successfully performed
*/
void touch(bool success)
{
last_monitored = time(0);
switch (state)
{
case DISABLED:
case MONITORING_DISABLED:
state = DISABLED;
break;
case INIT:
case ERROR:
case MONITORED:
case MONITORING_ERROR:
case MONITORING_INIT:
case MONITORING_MONITORED:
if (success == true)
{
state = MONITORED;
}
else
{
state = ERROR;
}
break;
default:
break;
}
};
/**
* Update host after a successful monitor. It modifies counters, state
* and template attributes
* @param parse_str string with values to be parsed
* @param with_vm_info if monitoring contains VM information
* @param lost set of VMs that should be in the host and were not found
* @param found VMs running in the host (as expected) and info.
* @param reserved_cpu from cluster defaults
* @param reserved_mem from cluster defaults
* @return 0 on success
**/
int update_info(Template &tmpl,
bool &with_vm_info,
set<int> &lost,
map<int,string> &found,
const set<int> &non_shared_ds,
long long reserved_cpu,
long long reserved_mem);
/**
* Extracts the DS attributes from the given template
* @param parse_str string with values to be parsed
* @param ds map of DS monitoring information
* @param template object parsed from parse_str
*
* @return 0 on success
*/
int extract_ds_info(
string &parse_str,
Template &tmpl,
map<int, const VectorAttribute*> &ds);
/**
* Update host after a failed monitor. It state
* and template attributes
* @param message from the driver
* @param vm_ids running on the host
*/
void error_info(const string& message, set<int> &vm_ids);
/**
* Inserts the last monitoring, and deletes old monitoring entries.
*
* @param db pointer to the db
* @return 0 on success
*/
int update_monitoring(SqlDB * db);
/**
* Retrieves host state
* @return HostState code number
*/
HostState get_state() const
{
return state;
};
/**
* Retrieves VMM mad name
* @return string vmm mad name
*/
const string& get_vmm_mad() const
{
return vmm_mad_name;
};
/**
* Retrieves VNM mad name
* @return string vnm mad name
*/
const string& get_vnm_mad() const
{
return vnm_mad_name;
};
/**
* Retrieves IM mad name
* @return string im mad name
*/
const string& get_im_mad() const
{
return im_mad_name;
};
/**
* Sets the corresponding monitoring state based on the actual host state
*/
void set_monitoring_state()
{
last_monitored = time(0); //Needed to expire this monitor action
switch (state)
{
case ERROR:
state = MONITORING_ERROR;
break;
case MONITORED:
state = MONITORING_MONITORED;
break;
case INIT:
state = MONITORING_INIT;
break;
case DISABLED:
state = MONITORING_DISABLED;
break;
default:
break;
}
};
/**
* Retrieves last time the host was monitored
* @return time_t last monitored time
*/
time_t get_last_monitored() const
{
return last_monitored;
};
/**
* Get the reserved capacity for this host. Parameters will be only updated
* if values are defined in the host. Reserved capacity will be subtracted
* from the Host total capacity.
* @param cpu reserved cpu (in percentage)
* @param mem reserved mem (in KB)
*/
void get_reserved_capacity(long long &cpu, long long& mem)
{
long long tcpu;
long long tmem;
if (get_template_attribute("RESERVED_CPU", tcpu))
{
cpu = tcpu;
}
else
{
replace_template_attribute("RESERVED_CPU", "");
}
if (get_template_attribute("RESERVED_MEM", tmem))
{
mem = tmem;
}
else
{
replace_template_attribute("RESERVED_MEM", "");
}
}
// -------------------------------------------------------------------------
// Share functions. Returns the value associated with each host share
// metric
// -------------------------------------------------------------------------
long long get_share_running_vms()
{
return host_share.running_vms;
}
long long get_share_disk_usage()
{
return host_share.disk_usage;
}
long long get_share_mem_usage()
{
return host_share.mem_usage;
}
long long get_share_cpu_usage()
{
return host_share.cpu_usage;
}
long long get_share_max_disk()
{
return host_share.max_disk;
}
long long get_share_max_mem()
{
return host_share.max_mem;
}
long long get_share_max_cpu()
{
return host_share.max_cpu;
}
long long get_share_free_disk()
{
return host_share.free_disk;
}
long long get_share_free_mem()
{
return host_share.free_mem;
}
long long get_share_free_cpu()
{
return host_share.free_cpu;
}
long long get_share_used_disk()
{
return host_share.used_disk;
}
long long get_share_used_mem()
{
return host_share.used_mem;
}
long long get_share_used_cpu()
{
return host_share.used_cpu;
}
/**
* Adds a new VM to the given share by incrementing the cpu, mem and disk
* counters
* @param vm_id id of the vm to add to the host
* @param cpu needed by the VM (percentage)
* @param mem needed by the VM (in KB)
* @param disk needed by the VM
* @param pci devices needed by th VM
* @return 0 on success
*/
void add_capacity(int vm_id, long long cpu, long long mem, long long disk,
vector<Attribute *> pci)
{
if ( vm_collection.add_collection_id(vm_id) == 0 )
{
host_share.add(vm_id, cpu, mem, disk, pci);
}
else
{
ostringstream oss;
oss << "Trying to add VM " << vm_id
<< ", that it is already associated to host " << oid << ".";
NebulaLog::log("ONE", Log::ERROR, oss);
}
};
/**
* Deletes a new VM from the given share by decrementing the cpu,mem and
* disk counters
* @param vm_id id of the vm to delete from the host
* @param cpu used by the VM (percentage)
* @param mem used by the VM (in KB)
* @param disk used by the VM
* @param pci devices needed by th VM
* @return 0 on success
*/
void del_capacity(int vm_id, long long cpu, long long mem, long long disk,
vector<Attribute *> pci)
{
if ( vm_collection.del_collection_id(vm_id) == 0 )
{
host_share.del(cpu, mem, disk, pci);
}
else
{
ostringstream oss;
oss << "Trying to remove VM " << vm_id
<< ", that it is not associated to host " << oid << ".";
NebulaLog::log("ONE", Log::ERROR, oss);
}
};
/**
* Updates the capacity used in a host when a VM is resized
* counters
* @param cpu increment of cpu requested by the VM
* @param mem increment of memory requested by the VM
* @param disk not used
* @return 0 on success
*/
void update_capacity(int cpu, int mem, int disk)
{
host_share.update(cpu,mem,disk);
};
/**
* Tests whether a new VM can be hosted by the host or not
* @param cpu needed by the VM (percentage)
* @param mem needed by the VM (in Kb)
* @param disk needed by the VM
* @param pci devices needed by the VM
* @param error Returns the error reason, if any
* @return true if the share can host the VM
*/
bool test_capacity(long long cpu, long long mem, long long disk,
vector<Attribute *> &pci, string& error) const
{
return host_share.test(cpu, mem, disk, pci, error);
}
/**
* Tests whether a new VM can be hosted by the host or not, checking the
* PCI devices only.
* @param pci devices needed by the VM
* @param error Returns the error reason, if any
* @return true if the share can host the VM
*/
bool test_capacity(vector<Attribute *> &pci, string& error) const
{
return host_share.test(pci, error);
}
/**
* Returns a copy of the VM IDs set
*/
set<int> get_vm_ids()
{
return vm_collection.get_collection_copy();
}
/**
* Factory method for host templates
*/
Template * get_new_template() const
{
return new HostTemplate;
}
/**
* Executed after an update operation to process the new template
* - encrypt VCENTER_PASSWORD attribute.
*/
int post_update_template(string& error);
/**
* Returns the rediscovered VMs (from poff to running) in the previous
* monitorization cycle
* @return the previous rediscovered VMs (from poff to running)
*/
const set<int>& get_prev_rediscovered_vms() const
{
return prev_rediscovered_vms;
}
/**
* Sets the previous rediscovered VMs (from poff to running). This set
* is not stored in the DB, the pool update method is not needed
* @param rediscovered_vms the previous rediscovered VMs (from poff to running)
*/
void set_prev_rediscovered_vms(const set<int>& rediscovered_vms)
{
prev_rediscovered_vms = rediscovered_vms;
}
private:
// -------------------------------------------------------------------------
// Friends
// -------------------------------------------------------------------------
friend class HostPool;
// -------------------------------------------------------------------------
// Host Description
// -------------------------------------------------------------------------
/**
* The state of the Host
*/
HostState state;
/**
* Name of the IM driver used to monitor this host
*/
string im_mad_name;
/**
* Name of the VM driver used to execute VMs in this host
*/
string vmm_mad_name;
/**
* Name of the VN driver used to manage networking in this host
*/
string vnm_mad_name;
/**
* If Host State = MONITORED last time it got fully monitored or 1 Jan 1970
* Host State = MONITORING* last time it got a signal to be monitored
*/
time_t last_monitored;
// -------------------------------------------------------------------------
// Host Attributes
// -------------------------------------------------------------------------
/**
* The Share represents the logical capacity associated with the host
*/
HostShare host_share;
/**
* Tmp set of lost VM IDs. Used to give lost VMs one grace cycle, in case
* they reappear.
*/
set<int> tmp_lost_vms;
/**
* Tmp set of zombie VM IDs. Used to give zombie VMs one grace cycle, in
* case they are cleaned.
*/
set<int> tmp_zombie_vms;
/**
* Set that stores the VMs reported as found from the poweroff state. This
* is managed from outside the host to avoid deadlocks, as the current
* VM state is needed
*/
set<int> prev_rediscovered_vms;
// -------------------------------------------------------------------------
// VM Collection
// -------------------------------------------------------------------------
/**
* Stores a collection with the VMs running in the host
*/
ObjectCollection vm_collection;
// *************************************************************************
// Constructor
// *************************************************************************
Host(int id,
const string& hostname,
const string& im_mad_name,
const string& vmm_mad_name,
const string& vnm_mad_name,
int cluster_id,
const string& cluster_name);
virtual ~Host();
// *************************************************************************
// DataBase implementation (Private)
// *************************************************************************
static const char * db_names;
static const char * db_bootstrap;
static const char * table;
static const char * monit_db_names;
static const char * monit_db_bootstrap;
static const char * monit_table;
/**
* Execute an INSERT or REPLACE Sql query.
* @param db The SQL DB
* @param replace Execute an INSERT or a REPLACE
* @param error_str Returns the error reason, if any
* @return 0 one success
*/
int insert_replace(SqlDB *db, bool replace, string& error_str);
/**
* Bootstraps the database table(s) associated to the Host
* @return 0 on success
*/
static int bootstrap(SqlDB * db)
{
int rc;
ostringstream oss_host(Host::db_bootstrap);
ostringstream oss_monit(Host::monit_db_bootstrap);
rc = db->exec(oss_host);
rc += db->exec(oss_monit);
return rc;
};
/**
* Writes the Host and its associated HostShares in the database.
* @param db pointer to the db
* @return 0 on success
*/
int insert(SqlDB *db, string& error_str)
{
return insert_replace(db, false, error_str);
};
/**
* Writes/updates the Hosts data fields in the database.
* @param db pointer to the db
* @return 0 on success
*/
int update(SqlDB *db)
{
string error_str;
return insert_replace(db, true, error_str);
};
};
#endif /*HOST_H_*/