code.grnet.gr Git - ganeti-local/blob - htools/Ganeti/HTools/Group.hs

   1 {-| Module describing a node group.
   2
   3 -}
   4
   5 {-
   6
   7 Copyright (C) 2010, 2011 Google Inc.
   8
   9 This program is free software; you can redistribute it and/or modify
  10 it under the terms of the GNU General Public License as published by
  11 the Free Software Foundation; either version 2 of the License, or
  12 (at your option) any later version.
  13
  14 This program is distributed in the hope that it will be useful, but
  15 WITHOUT ANY WARRANTY; without even the implied warranty of
  16 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  17 General Public License for more details.
  18
  19 You should have received a copy of the GNU General Public License
  20 along with this program; if not, write to the Free Software
  21 Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
  22 02110-1301, USA.
  23
  24 -}
  25
  26 module Ganeti.HTools.Group
  27     ( Group(..)
  28     , List
  29     , AssocList
  30     -- * Constructor
  31     , create
  32     , setIdx
  33     , isAllocable
  34     ) where
  35
  36 import qualified Ganeti.HTools.Container as Container
  37
  38 import qualified Ganeti.HTools.Types as T
  39
  40 -- * Type declarations
  41
  42 -- | The node group type.
  43 data Group = Group
  44     { name        :: String        -- ^ The node name
  45     , uuid        :: T.GroupID     -- ^ The UUID of the group
  46     , idx         :: T.Gdx         -- ^ Internal index for book-keeping
  47     , allocPolicy :: T.AllocPolicy -- ^ The allocation policy for this group
  48     } deriving (Show, Read, Eq)
  49
  50 -- Note: we use the name as the alias, and the UUID as the official
  51 -- name
  52 instance T.Element Group where
  53     nameOf     = uuid
  54     idxOf      = idx
  55     setAlias   = setName
  56     setIdx     = setIdx
  57     allNames n = [name n, uuid n]
  58
  59 -- | A simple name for the int, node association list.
  60 type AssocList = [(T.Gdx, Group)]
  61
  62 -- | A simple name for a node map.
  63 type List = Container.Container Group
  64
  65 -- * Initialization functions
  66
  67 -- | Create a new group.
  68 create :: String -> T.GroupID -> T.AllocPolicy -> Group
  69 create name_init id_init apol_init =
  70     Group { name        = name_init
  71           , uuid        = id_init
  72           , allocPolicy = apol_init
  73           , idx         = -1
  74           }
  75
  76 -- This is used only during the building of the data structures.
  77 setIdx :: Group -> T.Gdx -> Group
  78 setIdx t i = t {idx = i}
  79
  80 -- | Changes the alias.
  81 --
  82 -- This is used only during the building of the data structures.
  83 setName :: Group -> String -> Group
  84 setName t s = t { name = s }
  85
  86 -- | Checks if a group is allocable.
  87 isAllocable :: Group -> Bool
  88 isAllocable = (/= T.AllocUnallocable) . allocPolicy