mirror of
https://github.com/OpenNebula/one.git
synced 2024-12-22 13:33:52 +03:00
282 lines
9.0 KiB
C++
282 lines
9.0 KiB
C++
/* -------------------------------------------------------------------------- */
|
|
/* Copyright 2002-2013, 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_MANAGER_H_
|
|
#define IMAGE_MANAGER_H_
|
|
|
|
#include "MadManager.h"
|
|
#include "ActionManager.h"
|
|
#include "ImageManagerDriver.h"
|
|
|
|
using namespace std;
|
|
|
|
extern "C" void * image_action_loop(void *arg);
|
|
|
|
class Image;
|
|
class Template;
|
|
|
|
class ImageManager : public MadManager, public ActionListener
|
|
{
|
|
public:
|
|
|
|
ImageManager(time_t _timer_period,
|
|
time_t _monitor_period,
|
|
ImagePool * _ipool,
|
|
DatastorePool * _dspool,
|
|
vector<const Attribute*>& _mads):
|
|
MadManager(_mads),
|
|
timer_period(_timer_period),
|
|
monitor_period(_monitor_period),
|
|
ipool(_ipool),
|
|
dspool(_dspool)
|
|
{
|
|
am.addListener(this);
|
|
};
|
|
|
|
~ImageManager(){};
|
|
|
|
/**
|
|
* This functions starts the associated listener thread, and creates a
|
|
* new thread for the Information Manager. This thread will wait in
|
|
* an action loop till it receives ACTION_FINALIZE.
|
|
* @return 0 on success.
|
|
*/
|
|
int start();
|
|
|
|
/**
|
|
* Loads the Image Driver defined in configuration file
|
|
* @param uid of the user executing the driver. When uid is 0 the nebula
|
|
* identity will be used. Otherwise the Mad will be loaded through the
|
|
* sudo application.
|
|
*/
|
|
void load_mads(int uid=0);
|
|
|
|
/**
|
|
* Gets the thread identification.
|
|
* @return pthread_t for the manager thread (that in the action loop).
|
|
*/
|
|
pthread_t get_thread_id() const
|
|
{
|
|
return imagem_thread;
|
|
};
|
|
|
|
/**
|
|
* Finalizes the Image Manager
|
|
*/
|
|
void finalize()
|
|
{
|
|
am.trigger(ACTION_FINALIZE,0);
|
|
};
|
|
|
|
/**************************************************************************/
|
|
/* Image Manager Actions */
|
|
/* Operates in a semi-sinchronous mode. Operations will be granted or not */
|
|
/* , when needed the image repository drivers will be used to perform FS */
|
|
/* operations in the background. */
|
|
/**************************************************************************/
|
|
|
|
/**
|
|
* Try to acquire an image from the repository for a VM.
|
|
* @param image_id id of image
|
|
* @param error string describing the error
|
|
* @return pointer to the image or 0 if could not be acquired
|
|
*/
|
|
Image * acquire_image(int vm_id, int image_id, string& error);
|
|
|
|
/**
|
|
* Try to acquire an image from the repository for a VM.
|
|
* @param name of the image
|
|
* @param id of owner
|
|
* @param error string describing the error
|
|
* @return pointer to the image or 0 if could not be acquired
|
|
*/
|
|
Image * acquire_image(int vm_id, const string& name, int uid, string& error);
|
|
|
|
/**
|
|
* Releases an image and triggers any needed operations in the repo
|
|
* @param iid image id of the image to be released
|
|
* @param failed the associated VM releasing the images is FAILED
|
|
*/
|
|
void release_image(int vm_id, int iid, bool failed);
|
|
|
|
/**
|
|
* Closes any cloning operation on the image, updating the state if needed
|
|
* @param iid image id of the image to be released
|
|
* @param clone_img_id image id of the image that was being cloned
|
|
*/
|
|
void release_cloning_image(int iid, int clone_img_id);
|
|
|
|
/**
|
|
* Enables the image
|
|
* @param iid Image id
|
|
* @param to_enable true will enable the image.
|
|
* @param error_str Error reason, if any
|
|
* @return 0 on success
|
|
*/
|
|
int enable_image(int iid, bool to_enable, string& error_str);
|
|
|
|
/**
|
|
* Adds a new image to the repository copying or creating it as needed
|
|
* @param img pointer to the image
|
|
* @param ds_data data of the associated datastore in XML format
|
|
* @param error Error reason
|
|
*
|
|
* @return 0 on success
|
|
*/
|
|
int register_image(int iid, const string& ds_data, string& error);
|
|
|
|
/**
|
|
* Checks if an image is ready to be cloned
|
|
*
|
|
* @param cloning_id ID of the image to be cloned
|
|
* @param oss_error Error reason, if any
|
|
*
|
|
* @return 0 if the image can be cloned, -1 otherwise
|
|
*/
|
|
int can_clone_image(int cloning_id,
|
|
ostringstream& oss_error);
|
|
|
|
/**
|
|
* Clone an existing image to the repository
|
|
* @param new_id of the new image
|
|
* @param cloning_id of the image to be cloned
|
|
* @param ds_data data of the associated datastore in XML format
|
|
* @param error describing the error
|
|
* @return 0 on success
|
|
*/
|
|
int clone_image(int new_id,
|
|
int cloning_id,
|
|
const string& ds_data,
|
|
string& error);
|
|
|
|
/**
|
|
* Deletes an image from the repository and the DB
|
|
* @param iid id of image
|
|
* @param error_str Error reason, if any
|
|
* @return 0 on success
|
|
*/
|
|
int delete_image(int iid, const string& ds_data, string& error_str);
|
|
|
|
/**
|
|
* Gets the size of an image by calling the STAT action of the associated
|
|
* datastore driver.
|
|
*
|
|
* @param img_tmpl the template for the image
|
|
* @param ds_tmpl the template for the datastore
|
|
* @oaram result with a string representation of the size or if an error
|
|
* occurred describing the error.
|
|
* @result 0 on success
|
|
*/
|
|
int stat_image(Template* img_tmpl, const string& ds_tmpl, string& res);
|
|
|
|
/**
|
|
* Trigger a monitor action for the datastore.
|
|
* @param ds_id id of the datastore to monitor
|
|
*/
|
|
void monitor_datastore(int ds_id);
|
|
|
|
private:
|
|
/**
|
|
* Generic name for the Image driver
|
|
*/
|
|
static const char * image_driver_name;
|
|
|
|
/**
|
|
* Thread id for the Image Manager
|
|
*/
|
|
pthread_t imagem_thread;
|
|
|
|
/**
|
|
* Timer period for the Image Manager.
|
|
*/
|
|
time_t timer_period;
|
|
|
|
/**
|
|
* Datastore Monitor Interval
|
|
*/
|
|
time_t monitor_period;
|
|
|
|
/**
|
|
* Pointer to the Image Pool to access VMs
|
|
*/
|
|
ImagePool * ipool;
|
|
|
|
/**
|
|
* Pointer to the DS Pool
|
|
*/
|
|
DatastorePool * dspool;
|
|
|
|
/**
|
|
* Action engine for the Manager
|
|
*/
|
|
ActionManager am;
|
|
|
|
/**
|
|
* Returns a pointer to the Image Manager Driver used for the Repository
|
|
* @return the Image Manager driver or 0 in not found
|
|
*/
|
|
const ImageManagerDriver * get()
|
|
{
|
|
string name("NAME");
|
|
|
|
return static_cast<const ImageManagerDriver *>
|
|
(MadManager::get(0,name,image_driver_name));
|
|
};
|
|
|
|
/**
|
|
* Function to execute the Manager action loop method within a new pthread
|
|
* (requires C linkage)
|
|
*/
|
|
friend void * image_action_loop(void *arg);
|
|
|
|
/**
|
|
* The action function executed when an action is triggered.
|
|
* @param action the name of the action
|
|
* @param arg arguments for the action function
|
|
*/
|
|
void do_action(const string& action, void * arg);
|
|
|
|
/**
|
|
* Acquires an image updating its state.
|
|
* @param image pointer to image, it should be locked
|
|
* @return 0 on success
|
|
*/
|
|
int acquire_image(int vm_id, Image *img, string& error);
|
|
|
|
/**
|
|
* Moves a file to an image in the repository
|
|
* @param image to be updated (it's source attribute)
|
|
* @param source path of the disk file
|
|
*/
|
|
void move_image(Image *img, const string& source);
|
|
|
|
/**
|
|
* Formats an XML message for the MAD
|
|
*
|
|
* @param img_data Image XML representation
|
|
* @param ds_data Datastore XML representation
|
|
* @return the XML message
|
|
*/
|
|
static string * format_message(const string& img_data, const string& ds_data);
|
|
|
|
/**
|
|
* This function is executed periodically to monitor Datastores.
|
|
*/
|
|
void timer_action();
|
|
};
|
|
|
|
#endif /*IMAGE_MANAGER_H*/
|