2012-02-24 18:53:53 +04:00
/* -------------------------------------------------------------------------- */
2017-05-25 17:07:35 +03:00
/* Copyright 2002-2017, OpenNebula Project, OpenNebula Systems */
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_POOL_H_
# define CLUSTER_POOL_H_
# include "Cluster.h"
# include "SqlDB.h"
using namespace std ;
class ClusterPool : public PoolSQL
{
public :
2016-04-05 13:47:21 +03:00
ClusterPool ( SqlDB * db , const VectorAttribute * vnc_conf ) ;
2012-02-24 18:53:53 +04:00
~ ClusterPool ( ) { } ;
/* ---------------------------------------------------------------------- */
/* Constants for DB management */
/* ---------------------------------------------------------------------- */
2012-03-01 20:14:52 +04:00
/**
* Name for the " none " cluster
*/
static const string NONE_CLUSTER_NAME ;
/**
* Identifier for the " none " cluster
*/
static const int NONE_CLUSTER_ID ;
2016-03-16 13:34:45 +03:00
/**
* Name for the default cluster
*/
static const string DEFAULT_CLUSTER_NAME ;
/**
* Identifier for the default cluster
*/
static const int DEFAULT_CLUSTER_ID ;
2016-04-05 13:47:21 +03:00
/* ---------------------------------------------------------------------- */
/* Cluster Resources */
/* ---------------------------------------------------------------------- */
/**
* Get a free VNC port in the cluster . It will try first base_port + id
* @ param oid of the cluster
* @ param vm_id of the ID requesting the port
* @ param port to free
*/
int get_vnc_port ( int oid , int vm_id , unsigned int & port )
{
int rc = - 1 ;
Cluster * cluster = get ( oid , true ) ;
if ( cluster ! = 0 )
{
rc = cluster - > get_vnc_port ( vm_id , port ) ;
update ( cluster ) ;
cluster - > unlock ( ) ;
}
return rc ;
} ;
/**
* Release a previously allocated VNC port in the cluster
* @ param oid of the cluster
* @ param port to free
*/
void release_vnc_port ( int oid , unsigned int port )
{
Cluster * cluster = get ( oid , true ) ;
if ( cluster ! = 0 )
{
cluster - > release_vnc_port ( port ) ;
update ( cluster ) ;
cluster - > unlock ( ) ;
}
}
/**
* Mark a VNC port as in - use in the cluster .
* @ param oid of the cluster
* @ param port to set
*
* @ return 0 on success , - 1 if the port was in - use .
*/
int set_vnc_port ( int oid , unsigned int port )
{
int rc = - 1 ;
Cluster * cluster = get ( oid , true ) ;
if ( cluster ! = 0 )
{
rc = cluster - > set_vnc_port ( port ) ;
update ( cluster ) ;
cluster - > unlock ( ) ;
}
return rc ;
}
2012-02-24 18:53:53 +04:00
/* ---------------------------------------------------------------------- */
/* Methods for DB management */
/* ---------------------------------------------------------------------- */
/**
* Allocates a new cluster , writting it in the pool database . No memory is
* allocated for the object .
* @ param name Cluster name
* @ param oid the id assigned to the Cluster
* @ param error_str Returns the error reason , if any
*
* @ return the oid assigned to the object , - 1 in case of failure
*/
2016-04-05 13:47:21 +03:00
int allocate ( string name , int * oid , string & error_str ) ;
2012-02-24 18:53:53 +04:00
/**
* Function to get a cluster from the pool , if the object is not in memory
* it is loaded from the DB
* @ param oid cluster unique id
* @ param lock locks the cluster mutex
* @ return a pointer to the cluster , 0 if the cluster could not be loaded
*/
Cluster * get ( int oid , bool lock )
{
return static_cast < Cluster * > ( PoolSQL : : get ( oid , lock ) ) ;
} ;
/**
* Gets an object from the pool ( if needed the object is loaded from the
* database ) .
* @ param name of the object
* @ param lock locks the object if true
*
* @ return a pointer to the object , 0 in case of failure
*/
Cluster * get ( const string & name , bool lock )
{
// The owner is set to -1, because it is not used in the key() method
return static_cast < Cluster * > ( PoolSQL : : get ( name , - 1 , lock ) ) ;
} ;
/**
* 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 Clusters can't repeat names.
return name ;
} ;
/**
* Drops the Cluster from the data base . The object mutex SHOULD be
* locked .
* @ param objsql a pointer to a Cluster object
* @ param error_msg Error reason , if any
* @ return 0 on success ,
* - 1 DB error ,
* - 2 object is a system cluster ( ID < 100 )
* - 3 Cluster ' s User IDs set is not empty
*/
int drop ( PoolObjectSQL * objsql , string & error_msg ) ;
/**
* Bootstraps the database table ( s ) associated to the Cluster pool
* @ return 0 on success
*/
static int bootstrap ( SqlDB * _db )
{
2016-04-05 13:47:21 +03:00
ostringstream oss_bitmap ;
int rc ;
rc = Cluster : : bootstrap ( _db ) ;
2017-04-21 20:16:45 +03:00
rc + = _db - > exec_local_wr (
2017-04-18 17:32:23 +03:00
BitMap < 0 > : : bootstrap ( Cluster : : bitmap_table , oss_bitmap ) ) ;
2016-04-05 13:47:21 +03:00
return rc ;
2012-02-24 18:53:53 +04:00
} ;
/**
* Dumps the Cluster 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
2014-01-13 19:30:43 +04:00
* @ param limit parameters used for pagination
2012-02-24 18:53:53 +04:00
*
* @ return 0 on success
*/
2014-01-13 19:30:43 +04:00
int dump ( ostringstream & oss , const string & where , const string & limit )
2012-02-24 18:53:53 +04:00
{
2014-01-13 19:30:43 +04:00
return PoolSQL : : dump ( oss , " CLUSTER_POOL " , Cluster : : table , where ,
limit ) ;
2012-02-24 18:53:53 +04:00
} ;
2016-03-20 01:13:10 +03:00
/**
* Generates the cluster part of the ACL filter to look for objects . This
* filter is generated for objects that can be part of a cluster
* @ param acl_filter stream to write the filter
* @ param auth_object to generate the filter for
* @ param cids vector of cluster ids
*/
static void cluster_acl_filter ( ostringstream & filter ,
PoolObjectSQL : : ObjectType auth_object , const vector < int > & cids ) ;
2016-08-30 19:32:29 +03:00
/**
* Returns the Datastore Clusters performing a DB query
* @ param oid Datastore ID
* @ param cluster_ids Will contain the Cluster IDs
* @ return 0 on success
*/
int query_datastore_clusters ( int oid , set < int > & cluster_ids ) ;
/**
* Returns the VNet Clusters performing a DB query
* @ param oid VNet ID
* @ param cluster_ids Will contain the Cluster IDs
* @ return 0 on success
*/
int query_vnet_clusters ( int oid , set < int > & cluster_ids ) ;
2012-02-24 18:53:53 +04:00
private :
2016-04-05 13:47:21 +03:00
/**
* VNC configuration for clusters
*/
const VectorAttribute vnc_conf ;
2012-02-24 18:53:53 +04:00
/**
* Factory method to produce objects
* @ return a pointer to the new object
*/
PoolObjectSQL * create ( )
{
2016-04-05 13:47:21 +03:00
return new Cluster ( - 1 , " " , 0 , & vnc_conf ) ;
2012-02-24 18:53:53 +04:00
} ;
2016-08-30 19:32:29 +03:00
int get_clusters_cb (
void * _cluster_ids , int num , char * * values , char * * names ) ;
2012-02-24 18:53:53 +04:00
} ;
# endif /*CLUSTER_POOL_H_*/