1
0
mirror of https://github.com/OpenNebula/one.git synced 2024-12-22 13:33:52 +03:00
one/include/VirtualMachinePool.h

169 lines
5.6 KiB
C
Raw Normal View History

/* -------------------------------------------------------------------------- */
2011-02-25 16:34:44 +03:00
/* Copyright 2002-2011, OpenNebula Project Leads (OpenNebula.org) */
/* */
/* 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 VIRTUAL_MACHINE_POOL_H_
#define VIRTUAL_MACHINE_POOL_H_
#include "PoolSQL.h"
#include "VirtualMachine.h"
#include <time.h>
using namespace std;
/**
* The Virtual Machine Pool class. ...
*/
class VirtualMachinePool : public PoolSQL
{
public:
VirtualMachinePool(SqlDB * db,
vector<const Attribute *> hook_mads,
const string& hook_location);
~VirtualMachinePool(){};
/**
* Function to allocate a new VM object
* @param uid user id (the owner of the VM)
* @param user_name Owner's user name
* @param vm_template a VM Template object describing the VM
* @param oid the id assigned to the VM (output)
* @param error_str Returns the error reason, if any
* @param on_hold flag to submit on hold
* @return oid on success, -1 error inserting in DB or -2 error parsing
* the template
*/
int allocate (
int uid,
string user_name,
VirtualMachineTemplate * vm_template,
int * oid,
string& error_str,
bool on_hold = false);
/**
* Function to get a VM from the pool, if the object is not in memory
* it is loade from the DB
* @param oid VM unique id
* @param lock locks the VM mutex
* @return a pointer to the VM, 0 if the VM could not be loaded
*/
VirtualMachine * get(
int oid,
bool lock)
{
return static_cast<VirtualMachine *>(PoolSQL::get(oid,lock));
};
/**
* Function to get the IDs of running VMs
* @param oids a vector that contains the IDs
* @param vm_limit Max. number of VMs returned
* @param last_poll Return only VMs which last_poll is less than or equal
* to this value.
* @return 0 on success
*/
int get_running(
vector<int>& oids,
int vm_limit,
time_t last_poll);
/**
* Function to get the IDs of pending VMs
* @param oids a vector that contains the IDs
* @return 0 on success
*/
int get_pending(
vector<int>& oids);
//--------------------------------------------------------------------------
// Virtual Machine DB access functions
//--------------------------------------------------------------------------
/**
* Updates the history record of a VM, the vm's mutex SHOULD be locked
* @param vm pointer to the virtual machine object
* @return 0 on success
*/
int update_history(
VirtualMachine * vm)
{
return vm->update_history(db);
}
/**
* Updates the previous history record, the vm's mutex SHOULD be locked
* @param vm pointer to the virtual machine object
* @return 0 on success
*/
int update_previous_history(
VirtualMachine * vm)
{
return vm->update_previous_history(db);
}
/**
* Bootstraps the database table(s) associated to the VirtualMachine pool
*/
static void bootstrap(SqlDB * _db)
{
VirtualMachine::bootstrap(_db);
};
/**
* Dumps the VM pool in XML format. A filter can be also added to the query
* Also the hostname where the VirtualMachine is running is added to the
* pool
* @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(ostringstream& oss, const string& where)
{
return dump(oss, -1, where);
}
/**
* Dumps the VM pool in XML format. A filter can be also added to the query
* Also the hostname where the VirtualMachine is running is added to the
* pool
* @param oss the output stream to dump the pool contents
* @param where filter for the objects, defaults to all
* @param extended condition to include history and username data
* @param state include only VMs in this state. -1 means any state,
* except DONE
*
* @return 0 on success
*/
int dump(ostringstream& oss, int state, const string& where);
private:
/**
* Factory method to produce VM objects
* @return a pointer to the new VM
*/
PoolObjectSQL * create()
{
return new VirtualMachine(-1,-1,"", 0);
};
};
#endif /*VIRTUAL_MACHINE_POOL_H_*/