CR47: Give the possibility to restrict the checkpoint feature in experimental settings

Signed-off-by: Thomas Gazagnaire <[email protected]>

Author: samoht

ocaml/license/restrictions.ml

@@ -53,6 +53,7 @@ type restrictions = {
 	enable_wlb : bool;
 	enable_rbac : bool;
 	enable_dmc : bool;
+	enable_checkpoint : bool;
 	enable_vswitch_controller : bool;
 	restrict_connection : bool;
 	platform_filter : bool;
@@ -76,6 +77,7 @@ let to_compact_string (x: restrictions) =
 		"RBAC"    ,     x.enable_rbac          ;
 		"DMC"     ,     x.enable_dmc           ;
 		"DVSC"    ,     x.enable_vswitch_controller;
+		"chpt"    ,     x.enable_checkpoint    ;
 		"Cnx"     , not x.restrict_connection  ;
 		"Plat"    , not x.platform_filter      ;
 		"nag"     ,     x.regular_nag_dialog   ;
@@ -99,6 +101,7 @@ let most_permissive = {
 	enable_wlb            = true;
 	enable_rbac           = true;
 	enable_dmc            = true;
+	enable_checkpoint     = true;
 	enable_vswitch_controller = true;
 	restrict_connection   = false;
 	platform_filter       = false;
@@ -121,6 +124,7 @@ let least_permissive (a: restrictions) (b: restrictions) = {
 	enable_wlb            = a.enable_wlb            && b.enable_wlb;
 	enable_rbac           = a.enable_rbac           && b.enable_rbac;
 	enable_dmc            = a.enable_dmc            && b.enable_dmc;
+	enable_checkpoint     = a.enable_checkpoint     && b.enable_checkpoint;
 	enable_vswitch_controller = a.enable_vswitch_controller && b.enable_vswitch_controller;
 	restrict_connection   = a.restrict_connection   || b.restrict_connection;
 	platform_filter       = a.platform_filter       || b.platform_filter;
@@ -151,6 +155,7 @@ let _restrict_historical_performance = "restrict_historical_performance"
 let _restrict_wlb = "restrict_wlb"
 let _restrict_rbac = "restrict_rbac"
 let _restrict_dmc = "restrict_dmc"
+let _restrict_checkpoint = "restrict_checkpoint"
 let _restrict_vswitch_controller = "restrict_vswitch_controller"
 let _regular_nag_dialog = "regular_nag_dialog"
 
@@ -170,6 +175,7 @@ let to_assoc_list (x: restrictions) =
     (_restrict_wlb, string_of_bool (not x.enable_wlb));
     (_restrict_rbac, string_of_bool (not x.enable_rbac));
     (_restrict_dmc,                    string_of_bool (not x.enable_dmc           ));
+    (_restrict_checkpoint,             string_of_bool (not x.enable_checkpoint    ));
     (_restrict_vswitch_controller,     string_of_bool (not x.enable_vswitch_controller ));
     (_regular_nag_dialog, string_of_bool x.regular_nag_dialog);
   ]
@@ -194,7 +200,8 @@ let of_assoc_list x =
     enable_wlb            = Opt.default most_permissive.enable_wlb            (Opt.map not (find bool_of_string _restrict_wlb));
     enable_rbac           = Opt.default most_permissive.enable_rbac           (Opt.map not (find bool_of_string _restrict_rbac));
     enable_dmc            = Opt.default most_permissive.enable_dmc            (Opt.map not (find bool_of_string _restrict_dmc));
-	enable_vswitch_controller = Opt.default most_permissive.enable_dmc            (Opt.map not (find bool_of_string _restrict_vswitch_controller));
+    enable_checkpoint     = Opt.default most_permissive.enable_checkpoint     (Opt.map not (find bool_of_string _restrict_dmc));
+    enable_vswitch_controller = Opt.default most_permissive.enable_dmc            (Opt.map not (find bool_of_string _restrict_vswitch_controller));
     regular_nag_dialog    = Opt.default most_permissive.regular_nag_dialog                 (find bool_of_string _regular_nag_dialog);
   }
 
@@ -216,7 +223,8 @@ let common_to_all_skus =
     enable_performance = false;
     enable_wlb = false;
     enable_rbac = false;
-	enable_dmc = false;
+    enable_dmc = false;
+    enable_checkpoint     = false;
     enable_vswitch_controller = false;
     regular_nag_dialog = true;
   }
@@ -239,7 +247,8 @@ let rec restrictions_of_sku = function
 		enable_wlb = true;
 		enable_rbac = true;
 		enable_dmc = true;
-        enable_vswitch_controller = true;
+		enable_checkpoint  = true;
+		enable_vswitch_controller = true;
 		regular_nag_dialog = false;
 	}
 
@@ -273,5 +282,8 @@ let license_ok_for_rbac ~__context =
 let context_ok_for_dmc ~__context = 
   (get_pool()).enable_dmc
 
+let ok_for_checkpoint () =
+	(get_pool()).enable_checkpoint
+
 let license_ok_for_dmc ~__context = 
   (get_pool()).enable_vswitch_controller

ocaml/license/restrictions.mli

@@ -46,6 +46,7 @@ type restrictions = {
 	enable_wlb            : bool; (** enable Workload Balancing (WLB) *)
 	enable_rbac           : bool; (** enable Role-Based Access Control (RBAC) *)
 	enable_dmc            : bool; (** enable Dynamic Memory Control (DMC) *)
+	enable_checkpoint     : bool; (** enable Checkpoint *)
 	enable_vswitch_controller : bool; (** enable use of a Distributed VSwitch (DVS) Controller *)
 	restrict_connection   : bool; (** not used anymore; perhaps XenCenter does? *)
 	platform_filter       : bool; (** filter platform data on domain create? *)
@@ -87,3 +88,6 @@ val license_ok_for_rbac : __context:'a -> bool
 (** Checks whether we are entitled to enable Dynamic Memory Control (DMC)
   * in the pool. *)
 val context_ok_for_dmc : __context:'a -> bool
+
+(** Checks whether we are entitled to enable checkpoint *)
+val ok_for_checkpoint : unit -> bool

ocaml/xapi/xapi_vm.ml

@@ -981,14 +981,18 @@ let revert ~__context ~snapshot =
 (* As the checkpoint operation modify the domain state, we take the vm_lock to do not let the event *)
 (* thread mess around with that. *)
 let checkpoint ~__context ~vm ~new_name =
-	Local_work_queue.wait_in_line Local_work_queue.long_running_queue 
-    (Printf.sprintf "VM.checkpoint %s" (Context.string_of_task __context))
-	  (fun () ->
-		TaskHelper.set_cancellable ~__context;
-		Locking_helpers.with_lock vm 
-			(fun token () -> Xapi_vm_snapshot.checkpoint ~__context ~vm ~new_name)
-			()
-	)
+	if not (Restrictions.ok_for_checkpoint ()) then
+		raise (Api_errors.Server_error(Api_errors.license_restriction, []))
+	else begin
+		Local_work_queue.wait_in_line Local_work_queue.long_running_queue 
+			(Printf.sprintf "VM.checkpoint %s" (Context.string_of_task __context))
+			(fun () ->
+				TaskHelper.set_cancellable ~__context;
+				Locking_helpers.with_lock vm 
+					(fun token () -> Xapi_vm_snapshot.checkpoint ~__context ~vm ~new_name)
+					()
+			)
+	end
 
 let copy ~__context ~vm ~new_name ~sr =
 	(* See if the supplied SR is suitable: it must exist and be a non-ISO SR *)