1 {-# LANGUAGE TemplateHaskell #-}
3 {-| Implementation of the opcodes.
9 Copyright (C) 2009, 2010, 2011, 2012, 2013 Google Inc.
11 This program is free software; you can redistribute it and/or modify
12 it under the terms of the GNU General Public License as published by
13 the Free Software Foundation; either version 2 of the License, or
14 (at your option) any later version.
16 This program is distributed in the hope that it will be useful, but
17 WITHOUT ANY WARRANTY; without even the implied warranty of
18 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
19 General Public License for more details.
21 You should have received a copy of the GNU General Public License
22 along with this program; if not, write to the Free Software
23 Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
34 , ReplaceDisksMode(..)
50 import Data.Maybe (fromMaybe)
51 import Text.JSON (readJSON, JSON, JSValue, makeObj)
52 import qualified Text.JSON
56 import Ganeti.OpParams
57 import Ganeti.Types (OpSubmitPriority(..), fromNonEmpty)
58 import Ganeti.Query.Language (queryTypeOpToRaw)
60 -- | OpCode representation.
62 -- We only implement a subset of Ganeti opcodes: those which are actually used
63 -- in the htools codebase.
71 , ("OpInstanceReplaceDisks",
80 , ("OpInstanceFailover",
84 , pMigrationTargetNode
89 , ("OpInstanceMigrate",
93 , pMigrationTargetNode
105 [ pTagSearchPattern ])
114 , ("OpClusterPostInit", [])
115 , ("OpClusterDestroy", [])
116 , ("OpClusterQuery", [])
117 , ("OpClusterVerify",
118 [ pDebugSimulateErrors
125 , ("OpClusterVerifyConfig",
126 [ pDebugSimulateErrors
131 , ("OpClusterVerifyGroup",
133 , pDebugSimulateErrors
139 , ("OpClusterVerifyDisks", [])
140 , ("OpGroupVerifyDisks",
143 , ("OpClusterRepairDiskSizes",
146 , ("OpClusterConfigQuery",
149 , ("OpClusterRename",
152 , ("OpClusterSetParams",
157 , pEnabledHypervisors
167 , pMaintainNodeHealth
179 , pUseExternalMipScript
180 , pEnabledDiskTemplates
183 , ("OpClusterRedistConf", [])
184 , ("OpClusterActivateMasterIp", [])
185 , ("OpClusterDeactivateMasterIp", [])
203 , ("OpNodeRemove", [ pNodeName ])
216 , ("OpNodeQuery", dOldQuery)
217 , ("OpNodeQueryvols",
221 , ("OpNodeQueryStorage",
227 , ("OpNodeModifyStorage",
233 , ("OpRepairNodeStorage",
239 , ("OpNodeSetParams",
254 , ("OpNodePowercycle",
262 , pMigrationTargetNode
274 , ("OpInstanceCreate",
300 , pSourceShutdownTimeout
305 , pOpportunisticLocking
308 , ("OpInstanceMultiAlloc",
310 , pMultiAllocInstances
311 , pOpportunisticLocking
313 , ("OpInstanceReinstall",
319 , ("OpInstanceRemove",
324 , ("OpInstanceRename",
330 , ("OpInstanceStartup",
333 , pIgnoreOfflineNodes
339 , ("OpInstanceShutdown",
342 , pIgnoreOfflineNodes
346 , ("OpInstanceReboot",
359 , ("OpInstanceConsole",
361 , ("OpInstanceActivateDisks",
366 , ("OpInstanceDeactivateDisks",
370 , ("OpInstanceRecreateDisks",
376 , ("OpInstanceQuery", dOldQuery)
377 , ("OpInstanceQueryData",
382 , ("OpInstanceSetParams",
387 , pInstParamsNicChanges
388 , pInstParamsDiskChanges
401 , ("OpInstanceGrowDisk",
408 , ("OpInstanceChangeGroup",
416 , pNodeGroupAllocPolicy
423 , ("OpGroupAssignNodes",
428 , ("OpGroupQuery", dOldQueryNoLocking)
429 , ("OpGroupSetParams",
431 , pNodeGroupAllocPolicy
444 , ("OpGroupEvacuate",
453 , ("OpExtStorageDiagnose",
460 , ("OpBackupPrepare",
470 , pIgnoreRemoveFailures
477 , ("OpTestAllocator",
478 [ pIAllocatorDirection
490 , pIAllocatorInstances
491 , pIAllocatorEvacMode
493 , pIAllocatorSpindleUse
497 [ pJQueueNotifyWaitLock
506 , pTestDummySubmitJobs
519 , ("OpNetworkRemove",
523 , ("OpNetworkSetParams",
530 , pNetworkRemoveRsvdIps
532 , ("OpNetworkConnect",
539 , ("OpNetworkDisconnect",
543 , ("OpNetworkQuery", dOldQuery)
544 , ("OpRestrictedCommand",
551 -- | Returns the OP_ID for a given opcode value.
552 $(genOpID ''OpCode "opID")
554 -- | A list of all defined/supported opcode IDs.
555 $(genAllOpIDs ''OpCode "allOpIDs")
557 instance JSON OpCode where
558 readJSON = loadOpCode
559 showJSON = saveOpCode
561 -- | Generates the summary value for an opcode.
562 opSummaryVal :: OpCode -> Maybe String
563 opSummaryVal OpClusterVerifyGroup { opGroupName = s } = Just (fromNonEmpty s)
564 opSummaryVal OpGroupVerifyDisks { opGroupName = s } = Just (fromNonEmpty s)
565 opSummaryVal OpClusterRename { opName = s } = Just (fromNonEmpty s)
566 opSummaryVal OpQuery { opWhat = s } = Just (queryTypeOpToRaw s)
567 opSummaryVal OpQueryFields { opWhat = s } = Just (queryTypeOpToRaw s)
568 opSummaryVal OpNodeRemove { opNodeName = s } = Just (fromNonEmpty s)
569 opSummaryVal OpNodeAdd { opNodeName = s } = Just (fromNonEmpty s)
570 opSummaryVal OpNodeModifyStorage { opNodeName = s } = Just (fromNonEmpty s)
571 opSummaryVal OpRepairNodeStorage { opNodeName = s } = Just (fromNonEmpty s)
572 opSummaryVal OpNodeSetParams { opNodeName = s } = Just (fromNonEmpty s)
573 opSummaryVal OpNodePowercycle { opNodeName = s } = Just (fromNonEmpty s)
574 opSummaryVal OpNodeMigrate { opNodeName = s } = Just (fromNonEmpty s)
575 opSummaryVal OpNodeEvacuate { opNodeName = s } = Just (fromNonEmpty s)
576 opSummaryVal OpInstanceCreate { opInstanceName = s } = Just s
577 opSummaryVal OpInstanceReinstall { opInstanceName = s } = Just s
578 opSummaryVal OpInstanceRemove { opInstanceName = s } = Just s
579 -- FIXME: instance rename should show both names; currently it shows none
580 -- opSummaryVal OpInstanceRename { opInstanceName = s } = Just s
581 opSummaryVal OpInstanceStartup { opInstanceName = s } = Just s
582 opSummaryVal OpInstanceShutdown { opInstanceName = s } = Just s
583 opSummaryVal OpInstanceReboot { opInstanceName = s } = Just s
584 opSummaryVal OpInstanceReplaceDisks { opInstanceName = s } = Just s
585 opSummaryVal OpInstanceFailover { opInstanceName = s } = Just s
586 opSummaryVal OpInstanceMigrate { opInstanceName = s } = Just s
587 opSummaryVal OpInstanceMove { opInstanceName = s } = Just s
588 opSummaryVal OpInstanceConsole { opInstanceName = s } = Just s
589 opSummaryVal OpInstanceActivateDisks { opInstanceName = s } = Just s
590 opSummaryVal OpInstanceDeactivateDisks { opInstanceName = s } = Just s
591 opSummaryVal OpInstanceRecreateDisks { opInstanceName = s } = Just s
592 opSummaryVal OpInstanceSetParams { opInstanceName = s } = Just s
593 opSummaryVal OpInstanceGrowDisk { opInstanceName = s } = Just s
594 opSummaryVal OpInstanceChangeGroup { opInstanceName = s } = Just s
595 opSummaryVal OpGroupAdd { opGroupName = s } = Just (fromNonEmpty s)
596 opSummaryVal OpGroupAssignNodes { opGroupName = s } = Just (fromNonEmpty s)
597 opSummaryVal OpGroupSetParams { opGroupName = s } = Just (fromNonEmpty s)
598 opSummaryVal OpGroupRemove { opGroupName = s } = Just (fromNonEmpty s)
599 opSummaryVal OpGroupEvacuate { opGroupName = s } = Just (fromNonEmpty s)
600 opSummaryVal OpBackupPrepare { opInstanceName = s } = Just s
601 opSummaryVal OpBackupExport { opInstanceName = s } = Just s
602 opSummaryVal OpBackupRemove { opInstanceName = s } = Just s
603 opSummaryVal OpTagsGet { opKind = k } =
604 Just . fromMaybe "None" $ tagNameOf k
605 opSummaryVal OpTagsSearch { opTagSearchPattern = s } = Just (fromNonEmpty s)
606 opSummaryVal OpTestDelay { opDelayDuration = d } = Just (show d)
607 opSummaryVal OpTestAllocator { opIallocator = s } =
608 -- FIXME: Python doesn't handle None fields well, so we have behave the same
609 Just $ maybe "None" fromNonEmpty s
610 opSummaryVal OpNetworkAdd { opNetworkName = s} = Just (fromNonEmpty s)
611 opSummaryVal OpNetworkRemove { opNetworkName = s} = Just (fromNonEmpty s)
612 opSummaryVal OpNetworkSetParams { opNetworkName = s} = Just (fromNonEmpty s)
613 opSummaryVal OpNetworkConnect { opNetworkName = s} = Just (fromNonEmpty s)
614 opSummaryVal OpNetworkDisconnect { opNetworkName = s} = Just (fromNonEmpty s)
615 opSummaryVal _ = Nothing
617 -- | Computes the summary of the opcode.
618 opSummary :: OpCode -> String
620 case opSummaryVal op of
622 Just s -> op_suffix ++ "(" ++ s ++ ")"
623 where op_suffix = drop 3 $ opID op
625 -- | Generic\/common opcode parameters.
626 $(buildObject "CommonOpParams" "op"
635 -- | Default common parameter values.
636 defOpParams :: CommonOpParams
638 CommonOpParams { opDryRun = Nothing
639 , opDebugLevel = Nothing
640 , opPriority = OpPrioNormal
641 , opDepends = Nothing
642 , opComment = Nothing
646 -- | The top-level opcode type.
647 data MetaOpCode = MetaOpCode { metaParams :: CommonOpParams
648 , metaOpCode :: OpCode
649 } deriving (Show, Eq)
651 -- | JSON serialisation for 'MetaOpCode'.
652 showMeta :: MetaOpCode -> JSValue
653 showMeta (MetaOpCode params op) =
654 let objparams = toDictCommonOpParams params
655 objop = toDictOpCode op
656 in makeObj (objparams ++ objop)
658 -- | JSON deserialisation for 'MetaOpCode'
659 readMeta :: JSValue -> Text.JSON.Result MetaOpCode
663 return $ MetaOpCode meta op
665 instance JSON MetaOpCode where
669 -- | Wraps an 'OpCode' with the default parameters to build a
671 wrapOpCode :: OpCode -> MetaOpCode
672 wrapOpCode = MetaOpCode defOpParams
674 -- | Sets the comment on a meta opcode.
675 setOpComment :: String -> MetaOpCode -> MetaOpCode
676 setOpComment comment (MetaOpCode common op) =
677 MetaOpCode (common { opComment = Just comment}) op
679 -- | Sets the priority on a meta opcode.
680 setOpPriority :: OpSubmitPriority -> MetaOpCode -> MetaOpCode
681 setOpPriority prio (MetaOpCode common op) =
682 MetaOpCode (common { opPriority = prio }) op