/* ------------------------------------------------------------------------ */ /* Copyright 2002-2014, OpenNebula Project (OpenNebula.org), C12G Labs */ /* */ /* 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" #include "ObjectCollection.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 */ KERNEL = 3, /** < Kernel files */ RAMDISK = 4, /** < Initrd files */ CONTEXT = 5 /** < Context files */ }; /** * Return the string representation of an ImageType * @param ob the type * @return the string */ static string type_to_str(ImageType ob) { switch (ob) { case OS: return "OS" ; break; case CDROM: return "CDROM" ; break; case DATABLOCK: return "DATABLOCK" ; break; case KERNEL: return "KERNEL" ; break; case RAMDISK: return "RAMDISK" ; break; case CONTEXT: return "CONTEXT" ; break; default: return ""; } }; /** * Return the string representation of an ImageType * @param ob the type * @return the string */ static ImageType str_to_type(string& str_type); /** * Type of Disks (used by the VMM_MAD). Values: BLOCK, CDROM or * FILE */ enum DiskType { FILE = 0, /** < File-based disk */ CD_ROM = 1, /** < An ISO9660 disk */ BLOCK = 2, /** < Block-device disk */ RBD = 3, /** < CEPH RBD disk */ RBD_CDROM = 4, /** < CEPH RBD CDROM disk */ GLUSTER = 5, /** < Gluster Block Device */ GLUSTER_CDROM = 6, /** < Gluster CDROM Device Device */ NONE = 255 /** < No disk type, error situation */ }; /** * Return the string representation of a DiskType * @param ob the type * @return the string */ static string disk_type_to_str(DiskType ob) { switch (ob) { case FILE: return "FILE" ; break; case CD_ROM: return "CDROM" ; break; case BLOCK: return "BLOCK" ; break; case RBD: return "RBD" ; break; case RBD_CDROM: return "RBD_CDROM" ; break; case GLUSTER: return "GLUSTER" ; break; case GLUSTER_CDROM: return "GLUSTER_CDROM" ; break; default: return ""; } }; /** * Return the string representation of a DiskType * @param s_disk_type string representing the DiskTypr * @return the DiskType (defaults to FILE) */ static DiskType str_to_disk_type(string& s_disk_type); /** * 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 */ LOCKED = 4, /** < FS operation for the Image in process */ ERROR = 5, /** < Error state the operation FAILED*/ CLONE = 6, /** < Image is being cloned */ DELETE = 7, /** < DS is deleting the image */ USED_PERS = 8 /** < Image is in use and persistent */ }; /** * Returns the string representation of an ImageState * @param state The state * @return the string representation */ static string state_to_str(ImageState state) { switch(state) { case INIT: return "INIT"; break; case READY: return "READY"; break; case USED: return "USED"; break; case DISABLED: return "DISABLED"; break; case LOCKED: return "LOCKED"; break; case ERROR: return "ERROR"; break; case CLONE: return "CLONE"; break; case DELETE: return "DELETE"; break; case USED_PERS: return "USED"; break; default: return ""; } }; // ************************************************************************* // Image Public Methods // ************************************************************************* /** * 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; /** * 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); /** * Returns true if the image is persistent * @return true if the image is persistent */ bool isPersistent() const { return (persistent_img == 1); }; /** * Returns the source path of the image * @return source of image */ const string& get_source() const { return source; } /** * Returns the original path of the image * @return path of image */ const string& get_path() const { return path; } /** * Returns the fs_type for the image (defined for datablocks) * @return fs_type */ const string& get_fstype() const { return fs_type; } /** * Returns the size of the image * @return size in MB */ long long get_size() const { return size_mb; } /** * Sets the source path of the image */ void set_source(const string& _source) { source = _source; } /** * Sets the size for the image */ void set_size(long long _size_mb) { size_mb = _size_mb; } /** * Returns the type of the image * @return type */ ImageType get_type() const { return type; } /** * Returns the image state * @return state of image */ ImageState get_state() const { return state; } /** * Sets the image state * @param state of image */ void set_state(ImageState _state) { state = _state; } /** * Return the ID of the image we are cloning this one from (if any) */ int get_cloning_id() const { return cloning_id; } /** * Sets the ID of the image we are cloning this one from (if any) */ void set_cloning_id(int id) { cloning_id = id; } /** * Clear the cloning state of the image */ void clear_cloning_id() { cloning_id = -1; } /* ---------------------------------------------------------------------- */ /* Access Image Counters (running vms and cloning operations ) */ /* ---------------------------------------------------------------------- */ int dec_running (int vm_id) { if ( vm_collection.del_collection_id(vm_id) == 0 ) { running_vms--; } return running_vms; } int inc_running(int vm_id) { if ( vm_collection.add_collection_id(vm_id) == 0 ) { running_vms++; } return running_vms; } int get_running() const { return running_vms; } int get_cloning() const { return cloning_ops; } int dec_cloning(int img_id) { if ( img_clone_collection.del_collection_id(img_id) == 0 ) { cloning_ops--; } return cloning_ops; } int inc_cloning(int img_id) { if ( img_clone_collection.add_collection_id(img_id) == 0 ) { cloning_ops++; } return cloning_ops; } /** * Sets the Image type. * * @param _type the new type. It will be transformed to upper case * @return 0 on success, -1 otherwise */ int set_type(string& _type); /** * Check if the image can be used by other users * @return true if group or others can access the image */ bool isPublic() { return (group_u == 1 || other_u == 1); } /** * Check if the image is used for saving_as a current one * @return true if the image will be used to save an existing image. */ bool isSaving() { ImageTemplate * it = static_cast(obj_template); return it->is_saving(); } /** * Check if the image is a hot snapshot * @return true if image is a hot snapshot */ bool isHot() { ImageTemplate * it = static_cast(obj_template); return it->is_saving_hot(); } /** * Set permissions for the Image. Extends the PoolSQLObject method * by checking the persistent state of the image. */ int set_permissions(int _owner_u, int _owner_m, int _owner_a, int _group_u, int _group_m, int _group_a, int _other_u, int _other_m, int _other_a, string& error_str) { if ( isPersistent() && (_group_u == 1 || _other_u == 1) ) { error_str = "Image cannot be public and persistent."; return -1; } return PoolObjectSQL::set_permissions(_owner_u, _owner_m, _owner_a, _group_u, _group_m, _group_a, _other_u, _other_m, _other_a, error_str); }; /** * Set/Unset an image as persistent * @param persistent true to make an image persistent * @param error_str Returns the error reason, if any * * @return 0 on success */ int persistent(bool persis, string& error_str) { ostringstream oss; switch(state) { case USED: case CLONE: case USED_PERS: goto error_state; break; case INIT: case READY: case DISABLED: case LOCKED: case ERROR: case DELETE: if (persis == true) { if ( isPublic() ) { goto error_public; } persistent_img = 1; } else { persistent_img = 0; } break; } return 0; error_state: oss << "Image cannot be in state " << state_to_str(state) << "."; error_str = oss.str(); goto error_common; error_public: error_str = "Image cannot be public and persistent."; goto error_common; error_common: return -1; } /** * Modifies the given disk attribute adding the following attributes: * * SOURCE: the file-path. * * TARGET: will only be set if the Image's definition includes it. * * @param disk attribute for the VM template * @param img_type will be set to the used image's type * @param dev_prefix will be set to the defined dev_prefix, * or the default one * @param inherit_attrs Attributes to be inherited from the image template * into the disk * * @return 0 on success, -1 otherwise */ int disk_attribute( VectorAttribute * disk, ImageType& img_type, string& dev_prefix, const vector& inherit_attrs); /** * Factory method for image templates */ Template * get_new_template() const { return new ImageTemplate; } /** * Returns the Datastore ID */ int get_ds_id() const { return ds_id; }; /** * Returns the Datastore name */ const string& get_ds_name() const { return ds_name; }; /** * Updates the Datastore name */ void set_ds_name(const string& name) { ds_name = name; }; /** * Clones this image template including image specific attributes: NAME, * TYPE, PATH, FSTYPE, SIZE and PERSISTENT * @param new_name Value for the NAME attribute * @return Pointer to the new tempalte 0 in case of success */ ImageTemplate * clone_template(const string& new_name) const; private: // ------------------------------------------------------------------------- // Friends // ------------------------------------------------------------------------- friend class ImagePool; // ------------------------------------------------------------------------- // Image Description // ------------------------------------------------------------------------- /** * Type of the Image */ ImageType type; /** * Type for the Disk */ DiskType disk_type; /** * Persistency of the Image */ int persistent_img; /** * Registration time */ time_t regtime; /** * Path to the image */ string source; /** * Original Path to the image (optional if source is given or datablock) */ string path; /** * File system type for the image (mandatory for datablocks) */ string fs_type; /** * Size of the image in MB */ long long size_mb; /** * Image state */ ImageState state; /** * Number of VMs using the image */ int running_vms; /** * Number of pending cloning operations */ int cloning_ops; /** * Indicates if this Image is a clone of another one. * Once the clone process is complete, it should be set to -1 */ int cloning_id; /** * Datastore ID */ int ds_id; /** * Datastore name */ string ds_name; /** * Stores a collection with the VMs using the image */ ObjectCollection vm_collection; /** * Stores a collection with the Images cloning this image */ ObjectCollection img_clone_collection; // ************************************************************************* // DataBase implementation (Private) // ************************************************************************* /** * 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 on success */ int insert_replace(SqlDB *db, bool replace, string& error_str); /** * Bootstraps the database table(s) associated to the Image * @return 0 on success */ static int bootstrap(SqlDB * db) { ostringstream oss_image(Image::db_bootstrap); return db->exec(oss_image); }; /** * "Encrypts" the password with SHA1 digest * @param password * @return sha1 encrypted password */ static string sha1_digest(const string& pass); protected: // ************************************************************************* // Constructor // ************************************************************************* Image(int uid, int gid, const string& uname, const string& gname, int umask, ImageTemplate* img_template); virtual ~Image(); // ************************************************************************* // DataBase implementation // ************************************************************************* static const char * db_names; static const char * db_bootstrap; static const char * table; /** * Writes the Image in the database. * @param db pointer to the db * @return 0 on success */ virtual int insert(SqlDB *db, string& error_str); /** * Writes/updates the Images data fields in the database. * @param db pointer to the db * @return 0 on success */ virtual int update(SqlDB *db); }; #endif /*IMAGE_H_*/