/
Image.h
735 lines (630 loc) 路 18.8 KB
/
Image.h
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
/* ------------------------------------------------------------------------ */
/* Copyright 2002-2016, OpenNebula Project, OpenNebula Systems */
/* */
/* 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"
#include "Snapshots.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 */
SHEEPDOG = 7, /** < Sheepdog Block Device */
SHEEPDOG_CDROM = 8, /** < Sheepdog CDROM Device Device */
ISCSI = 9, /** < iSCSI Volume (Devices Datastore) */
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;
case SHEEPDOG: return "SHEEPDOG" ; break;
case SHEEPDOG_CDROM: return "SHEEPDOG_CDROM" ; break;
case ISCSI: return "ISCSI" ; 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 */
LOCKED_USED = 9, /** < FS operation in progress, VMs waiting */
LOCKED_USED_PERS = 10 /** < FS operation in progress, VMs waiting. 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;
case LOCKED_USED: return "LOCKED_USED"; break;
case LOCKED_USED_PERS: return "LOCKED_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 is_persistent() 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);
/**
* Moves the image from the locked* states to ready, used, used_persistent
*/
void set_state_unlock();
/**
* 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(vm_id) == 0 )
{
running_vms--;
}
return running_vms;
}
int inc_running(int vm_id)
{
if ( vm_collection.add(vm_id) == 0 )
{
running_vms++;
}
return running_vms;
}
int get_running() const
{
return running_vms;
}
set<int> get_running_ids() const
{
return vm_collection.clone();
}
int get_cloning() const
{
return cloning_ops;
}
int dec_cloning(PoolObjectSQL::ObjectType ot, int oid)
{
int rc = -1;
if (ot == PoolObjectSQL::IMAGE)
{
rc = img_clone_collection.del(oid);
}
else //if (ot == PoolObjectSQL::MARKETPLACEAPP)
{
rc = app_clone_collection.del(oid);
}
if ( rc == 0 )
{
cloning_ops--;
}
return cloning_ops;
}
int inc_cloning(PoolObjectSQL::ObjectType ot, int oid)
{
int rc = -1;
if (ot == PoolObjectSQL::IMAGE)
{
rc = img_clone_collection.add(oid);
}
else //if (ot == PoolObjectSQL::MARKETPLACEAPP)
{
rc = app_clone_collection.add(oid);
}
if ( rc == 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, string& error);
/**
* 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 is_saving()
{
return (static_cast<ImageTemplate *>(obj_template))->is_saving();
}
/**
* 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;
if ((snapshots.size() > 0) && !persis)
{
error_str = "Image has snapshots.";
return -1;
}
switch(state)
{
case USED:
case CLONE:
case USED_PERS:
case LOCKED_USED:
case LOCKED_USED_PERS:
oss << "Image cannot be in state " << state_to_str(state) <<".";
error_str = oss.str();
return -1;
case INIT:
case READY:
case DISABLED:
case LOCKED:
case ERROR:
case DELETE:
if (persis == true)
{
persistent_img = 1;
}
else
{
persistent_img = 0;
}
break;
}
return 0;
}
/**
* 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
*
*/
void disk_attribute(VectorAttribute * disk,
ImageType& img_type,
string& dev_prefix,
const vector<string>& 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;
/* ---------------------------------------------------------------------- */
/* Snapshots functions */
/* ---------------------------------------------------------------------- */
/**
* Return the snapshot list of this image
*/
const Snapshots& get_snapshots() const
{
return snapshots;
};
/**
* Clear all the snapshots in the list
*/
void clear_snapshots()
{
snapshots.clear();
}
/**
* Set the snapshots for this image
* @param snapshot list
*/
void set_snapshots(const Snapshots& s)
{
snapshots = s;
snapshots.clear_disk_id();
};
void delete_snapshot(int snap_id)
{
snapshots.delete_snapshot(snap_id);
};
void revert_snapshot(int snap_id)
{
snapshots.active_snapshot(snap_id);
};
void set_target_snapshot(int snap_id)
{
target_snapshot = snap_id;
};
int get_target_snapshot()
{
return target_snapshot;
};
void clear_target_snapshot()
{
target_snapshot = -1;
};
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, for both images and apps
*/
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;
/**
* Stores a collection with the Marketplace apps cloning this image
*/
ObjectCollection app_clone_collection;
/**
* Snapshot list for this image
*/
Snapshots snapshots;
/**
* ID of the snapshot being processed (if any)
*/
int target_snapshot;
// *************************************************************************
// 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_*/