mirror of
https://github.com/OpenNebula/one.git
synced 2025-01-10 01:17:40 +03:00
459 lines
12 KiB
C++
459 lines
12 KiB
C++
/* ------------------------------------------------------------------------ */
|
|
/* Copyright 2002-2010, 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 IMAGE_H_
|
|
#define IMAGE_H_
|
|
|
|
#include "PoolSQL.h"
|
|
#include "ImageTemplate.h"
|
|
#include "NebulaLog.h"
|
|
|
|
using namespace std;
|
|
|
|
/**
|
|
* The Image class.
|
|
*/
|
|
class Image : public PoolObjectSQL
|
|
{
|
|
public:
|
|
/**
|
|
* Type of Images
|
|
*/
|
|
enum ImageType
|
|
{
|
|
OS = 0, /** < Base OS image */
|
|
CDROM = 1, /** < An ISO9660 image */
|
|
DATABLOCK = 2 /** < User persistent data device */
|
|
};
|
|
|
|
/**
|
|
* Image State
|
|
*/
|
|
enum ImageState
|
|
{
|
|
INIT = 0, /** < Initialization state */
|
|
READY = 1, /** < Image ready to use */
|
|
USED = 2, /** < Image in use */
|
|
DISABLED = 3 /** < Image can not be instantiated by a VM */
|
|
};
|
|
|
|
/**
|
|
* Function to write an Image on an output stream
|
|
*/
|
|
friend ostream& operator<<(ostream& os, Image& i);
|
|
|
|
// *************************************************************************
|
|
// Image Public Methods
|
|
// *************************************************************************
|
|
|
|
/**
|
|
* Function to print the Image object into a string in plain text
|
|
* @param str the resulting string
|
|
* @return a reference to the generated string
|
|
*/
|
|
string& to_str(string& str) const;
|
|
|
|
/**
|
|
* Function to print the Image 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;
|
|
|
|
/**
|
|
* Get the Image unique identifier IID, that matches the OID of the object
|
|
* @return IID Image identifier
|
|
*/
|
|
int get_iid() const
|
|
{
|
|
return oid;
|
|
};
|
|
|
|
/**
|
|
* Gets the uid of the owner of the Image
|
|
* @return uid
|
|
**/
|
|
int get_uid()
|
|
{
|
|
return uid;
|
|
}
|
|
|
|
/**
|
|
* Returns Image's name
|
|
* @return name Image's name
|
|
*/
|
|
const string& get_name() const
|
|
{
|
|
return name;
|
|
};
|
|
|
|
/**
|
|
* Returns true if the image is public
|
|
* @return true if the image is public
|
|
*/
|
|
bool isPublic()
|
|
{
|
|
return (public_img == 1);
|
|
};
|
|
|
|
/**
|
|
* Set enum type
|
|
* @return 0 on success, -1 otherwise
|
|
*/
|
|
int set_type(const string& _type)
|
|
{
|
|
int rc = 0;
|
|
|
|
if ( _type == "OS" )
|
|
{
|
|
type = OS;
|
|
}
|
|
else if ( _type == "CDROM" )
|
|
{
|
|
type = CDROM;
|
|
}
|
|
else if ( _type == "DATABLOCK" )
|
|
{
|
|
type = DATABLOCK;
|
|
}
|
|
else
|
|
{
|
|
rc = -1;
|
|
}
|
|
|
|
return rc;
|
|
}
|
|
|
|
/**
|
|
* Get an image to be used in a VM, and updates its state.
|
|
* @return 0 if success
|
|
*/
|
|
int acquire_image();
|
|
|
|
|
|
/**
|
|
* Releases an image being used by a VM
|
|
* @return true if the image needs to be updated
|
|
*/
|
|
bool release_image();
|
|
|
|
/**
|
|
* Enables the image
|
|
* @param to_enable true will enable the image.
|
|
* @return 0 on success
|
|
*/
|
|
int enable(bool to_enable)
|
|
{
|
|
int rc = 0;
|
|
|
|
if ( to_enable == true )
|
|
{
|
|
if(state == DISABLED)
|
|
{
|
|
state = READY;
|
|
}
|
|
}
|
|
else if (state != USED) // to_enable == false
|
|
{
|
|
state = DISABLED;
|
|
}
|
|
else
|
|
{
|
|
rc = -1;
|
|
}
|
|
|
|
return rc;
|
|
}
|
|
|
|
/**
|
|
* Publish or unpublish an image
|
|
* @param pub true to publish the image
|
|
* @return 0 on success
|
|
*/
|
|
void publish(bool pub)
|
|
{
|
|
if (pub == true)
|
|
{
|
|
public_img = 1;
|
|
}
|
|
else
|
|
{
|
|
public_img = 0;
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Modifies the given disk attribute adding the following attributes:
|
|
* * SOURCE: the file-path.
|
|
* * BUS: will only be set if the Image's definition includes it.
|
|
* * TARGET: the value set depends on:
|
|
* - OS images will be mounted at prefix + a: hda, sda.
|
|
* - Prefix + b is reserved for the contex cdrom.
|
|
* - CDROM images will be at prefix + c: hdc, sdc.
|
|
* - Several DATABLOCK images can be mounted, they will be set to
|
|
* prefix + (d + index) : hdd, hde, hdf...
|
|
* @param disk attribute for the VM template
|
|
* @param index number of datablock images used by the same VM. Will be
|
|
* automatically increased.
|
|
* @param img_type will be set to the used image's type
|
|
*/
|
|
int disk_attribute(VectorAttribute * disk, int* index, ImageType* img_type);
|
|
|
|
// ------------------------------------------------------------------------
|
|
// Template
|
|
// ------------------------------------------------------------------------
|
|
|
|
/**
|
|
* Gets the values of a template attribute
|
|
* @param name of the attribute
|
|
* @param values of the attribute
|
|
* @return the number of values
|
|
*/
|
|
int get_template_attribute(
|
|
string& name,
|
|
vector<const Attribute*>& values) const
|
|
{
|
|
return image_template->get(name,values);
|
|
};
|
|
|
|
/**
|
|
* Gets the values of a template attribute
|
|
* @param name of the attribute
|
|
* @param values of the attribute
|
|
* @return the number of values
|
|
*/
|
|
int get_template_attribute(
|
|
const char *name,
|
|
vector<const Attribute*>& values) const
|
|
{
|
|
string str=name;
|
|
return image_template->get(str,values);
|
|
};
|
|
|
|
/**
|
|
* Gets a string based Image attribute
|
|
* @param name of the attribute
|
|
* @param value of the attribute (a string), will be "" if not defined
|
|
*/
|
|
void get_template_attribute(
|
|
const char * name,
|
|
string& value) const
|
|
{
|
|
string str=name;
|
|
image_template->get(str,value);
|
|
}
|
|
|
|
/**
|
|
* Gets a string based Image attribute
|
|
* @param name of the attribute
|
|
* @param value of the attribute (an int), will be 0 if not defined
|
|
*/
|
|
void get_template_attribute(
|
|
const char * name,
|
|
int& value) const
|
|
{
|
|
string str=name;
|
|
image_template->get(str,value);
|
|
}
|
|
|
|
/**
|
|
* Removes an Image attribute
|
|
* @param name of the attribute
|
|
*/
|
|
int remove_template_attribute(SqlDB * db, const string& name)
|
|
{
|
|
return image_template->remove_attribute(db, name);
|
|
}
|
|
|
|
private:
|
|
|
|
// -------------------------------------------------------------------------
|
|
// Friends
|
|
// -------------------------------------------------------------------------
|
|
|
|
friend class ImagePool;
|
|
|
|
// -------------------------------------------------------------------------
|
|
// Image Description
|
|
// -------------------------------------------------------------------------
|
|
|
|
/**
|
|
* Owner if the image
|
|
*/
|
|
int uid;
|
|
|
|
/**
|
|
* The name of the Image
|
|
*/
|
|
string name;
|
|
|
|
/**
|
|
* Type of the Image
|
|
*/
|
|
ImageType type;
|
|
|
|
/**
|
|
* Public scope of the Image
|
|
*/
|
|
int public_img;
|
|
|
|
/**
|
|
* Registration time
|
|
*/
|
|
time_t regtime;
|
|
|
|
/**
|
|
* Path to the image
|
|
*/
|
|
string source;
|
|
|
|
/**
|
|
* Image state
|
|
*/
|
|
ImageState state;
|
|
|
|
/**
|
|
* Number of VMs using the image
|
|
*/
|
|
int running_vms;
|
|
|
|
// -------------------------------------------------------------------------
|
|
// Image Attributes
|
|
// -------------------------------------------------------------------------
|
|
|
|
/**
|
|
* The Image template, holds the Image attributes.
|
|
*/
|
|
ImageTemplate * image_template;
|
|
|
|
|
|
// *************************************************************************
|
|
// DataBase implementation (Private)
|
|
// *************************************************************************
|
|
|
|
/**
|
|
* Execute an INSERT or REPLACE Sql query.
|
|
* @param db The SQL DB
|
|
* @param replace Execute an INSERT or a REPLACE
|
|
* @return 0 on success
|
|
*/
|
|
int insert_replace(SqlDB *db, bool replace);
|
|
|
|
/**
|
|
* Callback function to unmarshall a Image object (Image::select)
|
|
* @param num the number of columns read from the DB
|
|
* @param names the column names
|
|
* @param values the column values
|
|
* @return 0 on success
|
|
*/
|
|
int select_cb(void *nil, int num, char **values, char **names);
|
|
|
|
/**
|
|
* Bootstraps the database table(s) associated to the Image
|
|
*/
|
|
static void bootstrap(SqlDB * db)
|
|
{
|
|
ostringstream oss_image(Image::db_bootstrap);
|
|
ostringstream oss_templ(ImageTemplate::db_bootstrap);
|
|
|
|
db->exec(oss_image);
|
|
db->exec(oss_templ);
|
|
};
|
|
|
|
|
|
/**
|
|
* "Encrypts" the password with SHA1 digest
|
|
* @param password
|
|
* @return sha1 encrypted password
|
|
*/
|
|
string sha1_digest(const string& pass);
|
|
|
|
protected:
|
|
|
|
// *************************************************************************
|
|
// Constructor
|
|
// *************************************************************************
|
|
|
|
Image(int uid=-1, ImageTemplate *img_template = 0);
|
|
|
|
virtual ~Image();
|
|
|
|
// *************************************************************************
|
|
// DataBase implementation
|
|
// *************************************************************************
|
|
|
|
enum ColNames
|
|
{
|
|
OID = 0, /* Image identifier (IID) */
|
|
UID = 1, /* Image owner id */
|
|
NAME = 2, /* Image name */
|
|
TYPE = 3, /* 0) OS 1) CDROM 2) DATABLOCK */
|
|
PUBLIC = 4, /* Public scope (YES OR NO) */
|
|
REGTIME = 5, /* Time of registration */
|
|
SOURCE = 6, /* Path to the image */
|
|
STATE = 7, /* 0) INIT 1) ALLOCATED */
|
|
/* 2) READY 3) USED */
|
|
RUNNING_VMS = 8, /* Number of VMs using the img */
|
|
LIMIT = 9
|
|
};
|
|
|
|
static const char * db_names;
|
|
|
|
static const char * db_bootstrap;
|
|
|
|
static const char * table;
|
|
|
|
/**
|
|
* Reads the Image (identified with its OID=IID) from the database.
|
|
* @param db pointer to the db
|
|
* @return 0 on success
|
|
*/
|
|
virtual int select(SqlDB *db);
|
|
|
|
/**
|
|
* Writes the Image in the database.
|
|
* @param db pointer to the db
|
|
* @return 0 on success
|
|
*/
|
|
virtual int insert(SqlDB *db);
|
|
|
|
/**
|
|
* Writes/updates the Images data fields in the database.
|
|
* @param db pointer to the db
|
|
* @return 0 on success
|
|
*/
|
|
virtual int update(SqlDB *db);
|
|
|
|
/**
|
|
* Drops Image and associated template from the database
|
|
* @param db pointer to the db
|
|
* @return 0 on success
|
|
*/
|
|
virtual int drop(SqlDB *db);
|
|
|
|
/**
|
|
* Function to output an Image object in to an stream in XML format
|
|
* @param oss the output stream
|
|
* @param num the number of columns read from the DB
|
|
* @param names the column names
|
|
* @param vaues the column values
|
|
* @return 0 on success
|
|
*/
|
|
static int dump(ostringstream& oss, int num, char **values, char **names);
|
|
};
|
|
|
|
#endif /*IMAGE_H_*/
|