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

   1 {-| Module abstracting the node and instance container implementation.
   2
   3 This is currently implemented on top of an 'IntMap', which seems to
   4 give the best performance for our workload.
   5
   6 -}
   7
   8 {-
   9
  10 Copyright (C) 2009 Google Inc.
  11
  12 This program is free software; you can redistribute it and/or modify
  13 it under the terms of the GNU General Public License as published by
  14 the Free Software Foundation; either version 2 of the License, or
  15 (at your option) any later version.
  16
  17 This program is distributed in the hope that it will be useful, but
  18 WITHOUT ANY WARRANTY; without even the implied warranty of
  19 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  20 General Public License for more details.
  21
  22 You should have received a copy of the GNU General Public License
  23 along with this program; if not, write to the Free Software
  24 Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
  25 02110-1301, USA.
  26
  27 -}
  28
  29 module Ganeti.HTools.Container
  30     (
  31      -- * Types
  32      Container
  33     , Key
  34      -- * Creation
  35     , empty
  36     , fromAssocList
  37      -- * Query
  38     , size
  39     , find
  40      -- * Update
  41     , add
  42     , addTwo
  43     , remove
  44     , IntMap.map
  45     , IntMap.mapAccum
  46     -- * Conversion
  47     , elems
  48     , keys
  49     -- * Element functions
  50     , nameOf
  51     , maxNameLen
  52     , findByName
  53     ) where
  54
  55 import qualified Data.IntMap as IntMap
  56
  57 import qualified Ganeti.HTools.Types as T
  58
  59 type Key = IntMap.Key
  60 type Container = IntMap.IntMap
  61
  62 -- | Create an empty container.
  63 empty :: Container a
  64 empty = IntMap.empty
  65
  66 -- | Returns the number of elements in the map.
  67 size :: Container a -> Int
  68 size = IntMap.size
  69
  70 -- | Locate a key in the map (must exist).
  71 find :: Key -> Container a -> a
  72 find k c = c IntMap.! k
  73
  74 -- | Locate a keyin the map returning a default value if not existing.
  75 findWithDefault :: a -> Key -> Container a -> a
  76 findWithDefault = IntMap.findWithDefault
  77
  78 -- | Add or update one element to the map.
  79 add :: Key -> a -> Container a -> Container a
  80 add k v c = IntMap.insert k v c
  81
  82 -- | Remove an element from the map.
  83 remove :: Key -> Container a -> Container a
  84 remove = IntMap.delete
  85
  86 -- | Return the list of values in the map.
  87 elems :: Container a -> [a]
  88 elems = IntMap.elems
  89
  90 -- | Return the list of keys in the map.
  91 keys :: Container a -> [Key]
  92 keys = IntMap.keys
  93
  94 -- | Create a map from an association list.
  95 fromAssocList :: [(Key, a)] -> Container a
  96 fromAssocList = IntMap.fromList
  97
  98 -- | Create a map from an association list with a combining function.
  99 fromListWith :: (a -> a -> a) -> [(Key, a)] -> Container a
 100 fromListWith = IntMap.fromListWith
 101
 102 -- | Fold over the values of the map.
 103 fold :: (a -> b -> b) -> b -> Container a -> b
 104 fold = IntMap.fold
 105
 106 -- | Add or update two elements of the map.
 107 addTwo :: Key -> a -> Key -> a -> Container a -> Container a
 108 addTwo k1 v1 k2 v2 c = add k1 v1 $ add k2 v2 c
 109
 110 -- | Compute the name of an element in a container.
 111 nameOf :: (T.Element a) => Container a -> Key -> String
 112 nameOf c k = T.nameOf $ find k c
 113
 114 -- | Compute the maximum name length in an Element Container.
 115 maxNameLen :: (T.Element a) => Container a -> Int
 116 maxNameLen = maximum . map (length . T.nameOf) . elems
 117
 118 -- | Find an element by name in a Container; this is a very slow function.
 119 findByName :: (T.Element a, Monad m) =>
 120               Container a -> String -> m Key
 121 findByName c n =
 122     let all_elems = elems c
 123         result = filter ((== n) . T.nameOf) all_elems
 124         nems = length result
 125     in
 126       if nems /= 1 then
 127           fail $ "Wrong number of elems (" ++ (show nems) ++
 128                    ") found with name " ++ n
 129       else
 130           return $ T.idxOf $ head result