1 {-| Module describing a node.
3 All updates are functional (copy-based) and return a new node with
9 Copyright (C) 2009 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
28 module Ganeti.HTools.Node
29 ( Node(failN1, name, idx, t_mem, n_mem, f_mem, r_mem, t_dsk, f_dsk,
31 plist, slist, offline)
35 -- ** Finalization after data loading
44 -- * Instance (re)location
57 import Text.Printf (printf)
59 import qualified Ganeti.HTools.Container as Container
60 import qualified Ganeti.HTools.Instance as Instance
61 import qualified Ganeti.HTools.PeerMap as PeerMap
63 import qualified Ganeti.HTools.Types as T
65 -- * Type declarations
68 data Node = Node { name :: String -- ^ The node name
69 , t_mem :: Double -- ^ Total memory (MiB)
70 , n_mem :: Int -- ^ Node memory (MiB)
71 , f_mem :: Int -- ^ Free memory (MiB)
72 , x_mem :: Int -- ^ Unaccounted memory (MiB)
73 , t_dsk :: Double -- ^ Total disk space (MiB)
74 , f_dsk :: Int -- ^ Free disk space (MiB)
75 , plist :: [T.Idx]-- ^ List of primary instance indices
76 , slist :: [T.Idx]-- ^ List of secondary instance indices
77 , idx :: T.Ndx -- ^ Internal index for book-keeping
78 , peers :: PeerMap.PeerMap -- ^ Pnode to instance mapping
79 , failN1:: Bool -- ^ Whether the node has failed n1
80 , r_mem :: Int -- ^ Maximum memory needed for
81 -- failover by primaries of this node
82 , p_mem :: Double -- ^ Percent of free memory
83 , p_dsk :: Double -- ^ Percent of free disk
84 , p_rem :: Double -- ^ Percent of reserved memory
85 , offline :: Bool -- ^ Whether the node should not be used
86 -- for allocations and skipped from
90 instance T.Element Node where
96 -- | A simple name for the int, node association list.
97 type AssocList = [(T.Ndx, Node)]
99 -- | A simple name for a node map.
100 type List = Container.Container Node
102 -- | Constant node index for a non-moveable instance.
106 -- * Initialization functions
108 -- | Create a new node.
110 -- The index and the peers maps are empty, and will be need to be
111 -- update later via the 'setIdx' and 'buildPeers' functions.
112 create :: String -> Double -> Int -> Int -> Double -> Int -> Bool -> Node
113 create name_init mem_t_init mem_n_init mem_f_init
114 dsk_t_init dsk_f_init offline_init =
127 peers = PeerMap.empty,
129 p_mem = (fromIntegral mem_f_init) / mem_t_init,
130 p_dsk = (fromIntegral dsk_f_init) / dsk_t_init,
132 offline = offline_init,
136 -- | Changes the index.
138 -- This is used only during the building of the data structures.
139 setIdx :: Node -> T.Ndx -> Node
140 setIdx t i = t {idx = i}
142 -- | Changes the name.
144 -- This is used only during the building of the data structures.
145 setName :: Node -> String -> Node
146 setName t s = t {name = s}
148 -- | Sets the offline attribute.
149 setOffline :: Node -> Bool -> Node
150 setOffline t val = t { offline = val }
152 -- | Sets the unnaccounted memory.
153 setXmem :: Node -> Int -> Node
154 setXmem t val = t { x_mem = val }
156 -- | Computes the maximum reserved memory for peers from a peer map.
157 computeMaxRes :: PeerMap.PeerMap -> PeerMap.Elem
158 computeMaxRes new_peers = PeerMap.maxElem new_peers
160 -- | Builds the peer map for a given node.
161 buildPeers :: Node -> Instance.List -> Node
164 (\i_idx -> let inst = Container.find i_idx il
165 in (Instance.pnode inst, Instance.mem inst))
167 pmap = PeerMap.accumArray (+) mdata
168 new_rmem = computeMaxRes pmap
169 new_failN1 = computeFailN1 new_rmem (f_mem t) (f_dsk t)
170 new_prem = (fromIntegral new_rmem) / (t_mem t)
171 in t {peers=pmap, failN1 = new_failN1, r_mem = new_rmem, p_rem = new_prem}
173 -- | Assigns an instance to a node as primary without other updates.
174 setPri :: Node -> T.Idx -> Node
175 setPri t idx = t { plist = idx:(plist t) }
177 -- | Assigns an instance to a node as secondary without other updates.
178 setSec :: Node -> T.Idx -> Node
179 setSec t idx = t { slist = idx:(slist t) }
181 -- * Update functions
183 -- | Sets the free memory.
184 setFmem :: Node -> Int -> Node
186 let new_n1 = computeFailN1 (r_mem t) new_mem (f_dsk t)
187 new_mp = (fromIntegral new_mem) / (t_mem t)
189 t { f_mem = new_mem, failN1 = new_n1, p_mem = new_mp }
191 -- | Given the rmem, free memory and disk, computes the failn1 status.
192 computeFailN1 :: Int -> Int -> Int -> Bool
193 computeFailN1 new_rmem new_mem new_dsk =
194 new_mem <= new_rmem || new_dsk <= 0
196 -- | Given the new free memory and disk, fail if any of them is below zero.
197 failHealth :: Int -> Int -> Bool
198 failHealth new_mem new_dsk = new_mem <= 0 || new_dsk <= 0
200 -- | Removes a primary instance.
201 removePri :: Node -> Instance.Instance -> Node
203 let iname = Instance.idx inst
204 new_plist = delete iname (plist t)
205 new_mem = f_mem t + Instance.mem inst
206 new_dsk = f_dsk t + Instance.dsk inst
207 new_mp = (fromIntegral new_mem) / (t_mem t)
208 new_dp = (fromIntegral new_dsk) / (t_dsk t)
209 new_failn1 = computeFailN1 (r_mem t) new_mem new_dsk
210 in t {plist = new_plist, f_mem = new_mem, f_dsk = new_dsk,
211 failN1 = new_failn1, p_mem = new_mp, p_dsk = new_dp}
213 -- | Removes a secondary instance.
214 removeSec :: Node -> Instance.Instance -> Node
216 let iname = Instance.idx inst
217 pnode = Instance.pnode inst
218 new_slist = delete iname (slist t)
219 new_dsk = f_dsk t + Instance.dsk inst
221 old_peem = PeerMap.find pnode old_peers
222 new_peem = old_peem - (Instance.mem inst)
223 new_peers = PeerMap.add pnode new_peem old_peers
225 new_rmem = if old_peem < old_rmem then
228 computeMaxRes new_peers
229 new_prem = (fromIntegral new_rmem) / (t_mem t)
230 new_failn1 = computeFailN1 new_rmem (f_mem t) new_dsk
231 new_dp = (fromIntegral new_dsk) / (t_dsk t)
232 in t {slist = new_slist, f_dsk = new_dsk, peers = new_peers,
233 failN1 = new_failn1, r_mem = new_rmem, p_dsk = new_dp,
236 -- | Adds a primary instance.
237 addPri :: Node -> Instance.Instance -> Maybe Node
239 let iname = Instance.idx inst
240 new_mem = f_mem t - Instance.mem inst
241 new_dsk = f_dsk t - Instance.dsk inst
242 new_failn1 = computeFailN1 (r_mem t) new_mem new_dsk in
243 if (failHealth new_mem new_dsk) || (new_failn1 && not (failN1 t)) then
246 let new_plist = iname:(plist t)
247 new_mp = (fromIntegral new_mem) / (t_mem t)
248 new_dp = (fromIntegral new_dsk) / (t_dsk t)
250 Just t {plist = new_plist, f_mem = new_mem, f_dsk = new_dsk,
251 failN1 = new_failn1, p_mem = new_mp, p_dsk = new_dp}
253 -- | Adds a secondary instance.
254 addSec :: Node -> Instance.Instance -> T.Ndx -> Maybe Node
256 let iname = Instance.idx inst
259 new_dsk = f_dsk t - Instance.dsk inst
260 new_peem = PeerMap.find pdx old_peers + Instance.mem inst
261 new_peers = PeerMap.add pdx new_peem old_peers
262 new_rmem = max (r_mem t) new_peem
263 new_prem = (fromIntegral new_rmem) / (t_mem t)
264 new_failn1 = computeFailN1 new_rmem old_mem new_dsk in
265 if (failHealth old_mem new_dsk) || (new_failn1 && not (failN1 t)) then
268 let new_slist = iname:(slist t)
269 new_dp = (fromIntegral new_dsk) / (t_dsk t)
271 Just t {slist = new_slist, f_dsk = new_dsk,
272 peers = new_peers, failN1 = new_failn1,
273 r_mem = new_rmem, p_dsk = new_dp,
276 -- * Display functions
278 -- | String converter for the node list functionality.
279 list :: Int -> Node -> String
291 imem = (truncate tmem) - nmem - xmem - fmem
293 printf " %c %-*s %5.0f %5d %5d %5d %5d %5d %5.0f %5d %3d %3d %.5f %.5f"
294 (if off then '-' else if fn then '*' else ' ')
295 mname (name t) tmem nmem imem xmem fmem (r_mem t)
296 ((t_dsk t) / 1024) ((f_dsk t) `div` 1024)
297 (length pl) (length sl)