2012-02-24 18:53:53 +04:00
/* ------------------------------------------------------------------------ */
2014-01-09 14:51:20 +04:00
/* Copyright 2002-2014, OpenNebula Project (OpenNebula.org), C12G Labs */
2012-02-24 18:53:53 +04:00
/* */
/* 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 CLUSTER_H_
# define CLUSTER_H_
# include "PoolSQL.h"
# include "ObjectCollection.h"
2012-03-22 18:56:09 +04:00
# include "DatastorePool.h"
2012-06-28 19:51:21 +04:00
# include "ClusterTemplate.h"
2012-02-24 18:53:53 +04:00
using namespace std ;
/**
* The Cluster class .
*/
2012-02-27 17:55:43 +04:00
class Cluster : public PoolObjectSQL
2012-02-24 18:53:53 +04:00
{
public :
2012-10-05 15:23:44 +04:00
/**
* Returns the DATASTORE_LOCATION for the hosts of the cluster . If not
* defined that in oned . conf is returned .
*
* @ param ds_location string to copy the DATASTORE_LOCATION to
* @ return DATASTORE_LOCATION
*/
string & get_ds_location ( string & ds_location ) ;
2012-02-27 19:08:34 +04:00
// *************************************************************************
// Object Collections (Public)
// *************************************************************************
2012-02-24 18:53:53 +04:00
/**
2012-02-27 19:08:34 +04:00
* Adds this host ID to the set .
* @ param id to be added to the cluster
* @ param error_msg Error message , if any
* @ return 0 on success
2012-02-24 18:53:53 +04:00
*/
2012-02-27 19:08:34 +04:00
int add_host ( int id , string & error_msg )
{
int rc = hosts . add_collection_id ( id ) ;
if ( rc < 0 )
{
2012-02-29 19:30:52 +04:00
error_msg = " Host ID is already in the cluster set. " ;
2012-02-27 19:08:34 +04:00
}
return rc ;
}
2012-02-24 18:53:53 +04:00
/**
2012-02-27 19:08:34 +04:00
* Deletes this host ID from the set .
* @ param id to be deleted from the cluster
* @ param error_msg Error message , if any
* @ return 0 on success
2012-02-24 18:53:53 +04:00
*/
2012-02-27 19:08:34 +04:00
int del_host ( int id , string & error_msg )
{
int rc = hosts . del_collection_id ( id ) ;
if ( rc < 0 )
{
2012-02-29 19:30:52 +04:00
error_msg = " Host ID is not part of the cluster set. " ;
2012-02-27 19:08:34 +04:00
}
return rc ;
}
2012-02-24 18:53:53 +04:00
2012-02-27 17:55:43 +04:00
/**
2012-02-27 19:08:34 +04:00
* Adds this datastore ID to the set .
* @ param id to be added to the cluster
2012-12-17 19:54:17 +04:00
* @ param ds_type Datastore type
2012-02-27 19:08:34 +04:00
* @ param error_msg Error message , if any
* @ return 0 on success
2012-02-27 17:55:43 +04:00
*/
2012-12-17 19:54:17 +04:00
int add_datastore ( int id , Datastore : : DatastoreType ds_type , string & error_msg ) ;
2012-02-27 19:08:34 +04:00
/**
* Deletes this datastore ID from the set .
* @ param id to be deleted from the cluster
* @ param error_msg Error message , if any
* @ return 0 on success
*/
2012-12-17 19:23:16 +04:00
int del_datastore ( int id , string & error_msg ) ;
2012-02-27 17:55:43 +04:00
2013-09-10 15:43:50 +04:00
/**
* Returns a copy of the datastore IDs set
*/
set < int > get_datastores ( )
{
return datastores . get_collection_copy ( ) ;
} ;
2013-09-16 14:00:34 +04:00
/**
* Returns a system DS for the cluster when none is set at the API level
* @ return the ID of the System
*/
static int get_default_sysetm_ds ( const set < int > & ds_collection ) ;
2012-02-24 18:53:53 +04:00
/**
2012-02-27 19:08:34 +04:00
* Adds this vnet ID to the set .
* @ param id to be added to the cluster
* @ param error_msg Error message , if any
2012-02-24 18:53:53 +04:00
* @ return 0 on success
*/
2012-02-27 19:08:34 +04:00
int add_vnet ( int id , string & error_msg )
2012-02-24 18:53:53 +04:00
{
2012-02-27 19:08:34 +04:00
int rc = vnets . add_collection_id ( id ) ;
if ( rc < 0 )
{
2012-02-29 19:30:52 +04:00
error_msg = " Network ID is already in the cluster set. " ;
2012-02-27 19:08:34 +04:00
}
return rc ;
2012-02-24 18:53:53 +04:00
}
/**
2012-02-27 19:08:34 +04:00
* Deletes this vnet ID from the set .
* @ param id to be deleted from the cluster
* @ param error_msg Error message , if any
2012-02-24 18:53:53 +04:00
* @ return 0 on success
*/
2012-02-27 19:08:34 +04:00
int del_vnet ( int id , string & error_msg )
2012-02-24 18:53:53 +04:00
{
2012-02-27 19:08:34 +04:00
int rc = vnets . del_collection_id ( id ) ;
if ( rc < 0 )
{
2012-02-29 19:30:52 +04:00
error_msg = " Network ID is not part of the cluster set. " ;
2012-02-27 19:08:34 +04:00
}
return rc ;
2012-02-24 18:53:53 +04:00
}
2013-09-02 14:53:54 +04:00
/**
* Returns a copy of the host IDs set
*/
set < int > get_host_ids ( )
{
return hosts . get_collection_copy ( ) ;
}
/**
* Returns a copy of the datastore IDs set
*/
set < int > get_datastore_ids ( )
{
return datastores . get_collection_copy ( ) ;
}
/**
* Returns a copy of the vnet IDs set
*/
set < int > get_vnet_ids ( )
{
return vnets . get_collection_copy ( ) ;
}
2014-03-04 14:42:44 +04:00
/**
* Get the default reserved capacity for hosts in the cluster . It can be
* overridden if defined in the host template .
* @ param cpu reserved cpu ( in percentage )
* @ param mem reserved mem ( in KB )
*/
void get_reserved_capacity ( long long & cpu , long long & mem )
{
get_template_attribute ( " RESERVED_CPU " , cpu ) ;
get_template_attribute ( " RESERVED_MEM " , mem ) ;
}
2012-02-27 19:08:34 +04:00
// *************************************************************************
// DataBase implementation (Public)
// *************************************************************************
/**
* Function to print the Cluster 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 ) ;
2012-02-24 18:53:53 +04:00
private :
// -------------------------------------------------------------------------
// Friends
// -------------------------------------------------------------------------
friend class ClusterPool ;
// *************************************************************************
// Constructor
// *************************************************************************
2012-06-28 19:51:21 +04:00
Cluster ( int id ,
const string & name ,
ClusterTemplate * cl_template ) ;
2012-02-24 18:53:53 +04:00
virtual ~ Cluster ( ) { } ;
2012-02-27 17:55:43 +04:00
// *************************************************************************
2012-12-17 19:23:16 +04:00
// Attributes (Private)
2012-02-27 17:55:43 +04:00
// *************************************************************************
ObjectCollection hosts ;
2012-02-27 19:08:34 +04:00
ObjectCollection datastores ;
2012-02-27 17:55:43 +04:00
ObjectCollection vnets ;
2012-02-24 18:53:53 +04:00
// *************************************************************************
// DataBase implementation (Private)
// *************************************************************************
static const char * db_names ;
static const char * db_bootstrap ;
static const char * 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 Cluster
* @ return 0 on success
*/
static int bootstrap ( SqlDB * db )
{
ostringstream oss ( Cluster : : db_bootstrap ) ;
return db - > exec ( oss ) ;
} ;
/**
* Writes the Cluster 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 Cluster ' s 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 ) ;
}
2012-02-27 19:08:34 +04:00
/**
* Checks if all the collections are empty , and therefore this cluster
* can be dropped .
*
* @ param error_msg Error message , if any .
* @ return 0 if cluster can be dropped , - 1 otherwise
*/
int check_drop ( string & error_msg ) ;
2012-06-28 19:51:21 +04:00
/**
* Factory method for cluster templates
*/
Template * get_new_template ( ) const
{
return new ClusterTemplate ;
}
2012-02-24 18:53:53 +04:00
} ;
# endif /*CLUSTER_H_*/