Synnefo » snf-ganeti

{-| Implementation of the LUXI loader.

-}

{-

Copyright (C) 2009, 2010, 2011, 2012, 2013 Google Inc.

This program is free software; you can redistribute it and/or modify

it under the terms of the GNU General Public License as published by

the Free Software Foundation; either version 2 of the License, or

(at your option) any later version.

This program is distributed in the hope that it will be useful, but

WITHOUT ANY WARRANTY; without even the implied warranty of

MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU

General Public License for more details.

You should have received a copy of the GNU General Public License

along with this program; if not, write to the Free Software

Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA

02110-1301, USA.

-}

module Ganeti.HTools.Backend.Luxi

  ( loadData

  , parseData

  ) where

import qualified Control.Exception as E

import Control.Monad (liftM)

import Text.JSON.Types

import qualified Text.JSON

import Ganeti.BasicTypes

import Ganeti.Errors

import qualified Ganeti.Luxi as L

import qualified Ganeti.Query.Language as Qlang

import Ganeti.HTools.Loader

import Ganeti.HTools.Types

import qualified Ganeti.HTools.Group as Group

import qualified Ganeti.HTools.Node as Node

import qualified Ganeti.HTools.Instance as Instance

import Ganeti.JSON

{-# ANN module "HLint: ignore Eta reduce" #-}

-- * Utility functions

-- | Get values behind \"data\" part of the result.

getData :: (Monad m) => JSValue -> m JSValue

getData (JSObject o) = fromObj (fromJSObject o) "data"

getData x = fail $ "Invalid input, expected dict entry but got " ++ show x

-- | Converts a (status, value) into m value, if possible.

parseQueryField :: (Monad m) => JSValue -> m (JSValue, JSValue)

parseQueryField (JSArray [status, result]) = return (status, result)

parseQueryField o =

  fail $ "Invalid query field, expected (status, value) but got " ++ show o

-- | Parse a result row.

parseQueryRow :: (Monad m) => JSValue -> m [(JSValue, JSValue)]

parseQueryRow (JSArray arr) = mapM parseQueryField arr

parseQueryRow o =

  fail $ "Invalid query row result, expected array but got " ++ show o

-- | Parse an overall query result and get the [(status, value)] list

-- for each element queried.

parseQueryResult :: (Monad m) => JSValue -> m [[(JSValue, JSValue)]]

parseQueryResult (JSArray arr) = mapM parseQueryRow arr

parseQueryResult o =

  fail $ "Invalid query result, expected array but got " ++ show o

-- | Prepare resulting output as parsers expect it.

extractArray :: (Monad m) => JSValue -> m [[(JSValue, JSValue)]]

extractArray v =

  getData v >>= parseQueryResult

-- | Testing result status for more verbose error message.

fromJValWithStatus :: (Text.JSON.JSON a, Monad m) => (JSValue, JSValue) -> m a

fromJValWithStatus (st, v) = do

  st' <- fromJVal st

  Qlang.checkRS st' v >>= fromJVal

annotateConvert :: String -> String -> String -> Result a -> Result a

annotateConvert otype oname oattr =

  annotateResult $ otype ++ " '" ++ oname ++

    "', error while reading attribute '" ++ oattr ++ "'"

-- | Annotate errors when converting values with owner/attribute for

-- better debugging.

genericConvert :: (Text.JSON.JSON a) =>

                  String             -- ^ The object type

               -> String             -- ^ The object name

               -> String             -- ^ The attribute we're trying to convert

               -> (JSValue, JSValue) -- ^ The value we're trying to convert

               -> Result a           -- ^ The annotated result

genericConvert otype oname oattr =

  annotateConvert otype oname oattr . fromJValWithStatus

convertArrayMaybe :: (Text.JSON.JSON a) =>

                  String             -- ^ The object type

               -> String             -- ^ The object name

               -> String             -- ^ The attribute we're trying to convert

               -> (JSValue, JSValue) -- ^ The value we're trying to convert

               -> Result [Maybe a]   -- ^ The annotated result

convertArrayMaybe otype oname oattr (st, v) = do

  st' <- fromJVal st

  Qlang.checkRS st' v >>=

    annotateConvert otype oname oattr . arrayMaybeFromJVal

-- * Data querying functionality

-- | The input data for node query.

queryNodesMsg :: L.LuxiOp

queryNodesMsg =

  L.Query (Qlang.ItemTypeOpCode Qlang.QRNode)

     ["name", "mtotal", "mnode", "mfree", "dtotal", "dfree",

      "ctotal", "cnos", "offline", "drained", "vm_capable",

      "ndp/spindle_count", "group.uuid", "tags",

      "ndp/exclusive_storage", "sptotal", "spfree"] Qlang.EmptyFilter

-- | The input data for instance query.

queryInstancesMsg :: L.LuxiOp

queryInstancesMsg =

  L.Query (Qlang.ItemTypeOpCode Qlang.QRInstance)

     ["name", "disk_usage", "be/memory", "be/vcpus",

      "status", "pnode", "snodes", "tags", "oper_ram",

      "be/auto_balance", "disk_template",

      "be/spindle_use", "disk.sizes", "disk.spindles"] Qlang.EmptyFilter

-- | The input data for cluster query.

queryClusterInfoMsg :: L.LuxiOp

queryClusterInfoMsg = L.QueryClusterInfo

-- | The input data for node group query.

queryGroupsMsg :: L.LuxiOp

queryGroupsMsg =

  L.Query (Qlang.ItemTypeOpCode Qlang.QRGroup)

     ["uuid", "name", "alloc_policy", "ipolicy", "tags"]

     Qlang.EmptyFilter

-- | Wraper over 'callMethod' doing node query.

queryNodes :: L.Client -> IO (Result JSValue)

queryNodes = liftM errToResult . L.callMethod queryNodesMsg

-- | Wraper over 'callMethod' doing instance query.

queryInstances :: L.Client -> IO (Result JSValue)

queryInstances = liftM errToResult . L.callMethod queryInstancesMsg

-- | Wrapper over 'callMethod' doing cluster information query.

queryClusterInfo :: L.Client -> IO (Result JSValue)

queryClusterInfo = liftM errToResult . L.callMethod queryClusterInfoMsg

-- | Wrapper over callMethod doing group query.

queryGroups :: L.Client -> IO (Result JSValue)

queryGroups = liftM errToResult . L.callMethod queryGroupsMsg

-- | Parse a instance list in JSON format.

getInstances :: NameAssoc

             -> JSValue

             -> Result [(String, Instance.Instance)]

getInstances ktn arr = extractArray arr >>= mapM (parseInstance ktn)

-- | Construct an instance from a JSON object.

parseInstance :: NameAssoc

              -> [(JSValue, JSValue)]

              -> Result (String, Instance.Instance)

parseInstance ktn [ name, disk, mem, vcpus

                  , status, pnode, snodes, tags, oram

                  , auto_balance, disk_template, su

                  , dsizes, dspindles ] = do

  xname <- annotateResult "Parsing new instance" (fromJValWithStatus name)

  let convert a = genericConvert "Instance" xname a

  xdisk <- convert "disk_usage" disk

  xmem <- case oram of -- FIXME: remove the "guessing"

            (_, JSRational _ _) -> convert "oper_ram" oram

            _ -> convert "be/memory" mem

  xvcpus <- convert "be/vcpus" vcpus

  xpnode <- convert "pnode" pnode >>= lookupNode ktn xname

  xsnodes <- convert "snodes" snodes::Result [String]

  snode <- case xsnodes of

             [] -> return Node.noSecondary

             x:_ -> lookupNode ktn xname x

  xrunning <- convert "status" status

  xtags <- convert "tags" tags

  xauto_balance <- convert "auto_balance" auto_balance

  xdt <- convert "disk_template" disk_template

  xsu <- convert "be/spindle_use" su

  xdsizes <- convert "disk.sizes" dsizes

  xdspindles <- convertArrayMaybe "Instance" xname "disk.spindles" dspindles

  let disks = zipWith Instance.Disk xdsizes xdspindles

      inst = Instance.create xname xmem xdisk disks

             xvcpus xrunning xtags xauto_balance xpnode snode xdt xsu []

  return (xname, inst)

parseInstance _ v = fail ("Invalid instance query result: " ++ show v)

-- | Parse a node list in JSON format.

getNodes :: NameAssoc -> JSValue -> Result [(String, Node.Node)]

getNodes ktg arr = extractArray arr >>= mapM (parseNode ktg)

-- | Construct a node from a JSON object.

parseNode :: NameAssoc -> [(JSValue, JSValue)] -> Result (String, Node.Node)

parseNode ktg [ name, mtotal, mnode, mfree, dtotal, dfree

              , ctotal, cnos, offline, drained, vm_capable, spindles, g_uuid

              , tags, excl_stor, sptotal, spfree ]

    = do

  xname <- annotateResult "Parsing new node" (fromJValWithStatus name)

  let convert a = genericConvert "Node" xname a

  xoffline <- convert "offline" offline

  xdrained <- convert "drained" drained

  xvm_capable <- convert "vm_capable" vm_capable

  xgdx   <- convert "group.uuid" g_uuid >>= lookupGroup ktg xname

  xtags <- convert "tags" tags

  xexcl_stor <- convert "exclusive_storage" excl_stor

  let live = not xoffline && not xdrained && xvm_capable

      lvconvert def n d = eitherLive live def $ convert n d

  xsptotal <- if xexcl_stor

              then lvconvert 0 "sptotal" sptotal

              else convert "spindles" spindles

  xspfree <- lvconvert 0 "spfree" spfree

  xmtotal <- lvconvert 0.0 "mtotal" mtotal

  xmnode <- lvconvert 0 "mnode" mnode

  xmfree <- lvconvert 0 "mfree" mfree

  xdtotal <- lvconvert 0.0 "dtotal" dtotal

  xdfree <- lvconvert 0 "dfree" dfree

  xctotal <- lvconvert 0.0 "ctotal" ctotal

  xcnos <- lvconvert 0 "cnos" cnos

  let node = flip Node.setNodeTags xtags $

             Node.create xname xmtotal xmnode xmfree xdtotal xdfree

             xctotal xcnos (not live) xsptotal xspfree xgdx xexcl_stor

  return (xname, node)

parseNode _ v = fail ("Invalid node query result: " ++ show v)

-- | Parses the cluster tags.

getClusterData :: JSValue -> Result ([String], IPolicy, String)

getClusterData (JSObject obj) = do

  let errmsg = "Parsing cluster info"

      obj' = fromJSObject obj

  ctags <- tryFromObj errmsg obj' "tags"

  cpol <- tryFromObj errmsg obj' "ipolicy"

  master <- tryFromObj errmsg obj' "master"

  return (ctags, cpol, master)

getClusterData _ = Bad "Cannot parse cluster info, not a JSON record"

-- | Parses the cluster groups.

getGroups :: JSValue -> Result [(String, Group.Group)]

getGroups jsv = extractArray jsv >>= mapM parseGroup

-- | Parses a given group information.

parseGroup :: [(JSValue, JSValue)] -> Result (String, Group.Group)

parseGroup [uuid, name, apol, ipol, tags] = do

  xname <- annotateResult "Parsing new group" (fromJValWithStatus name)

  let convert a = genericConvert "Group" xname a

  xuuid <- convert "uuid" uuid

  xapol <- convert "alloc_policy" apol

  xipol <- convert "ipolicy" ipol

  xtags <- convert "tags" tags

  -- TODO: parse networks to which this group is connected

  return (xuuid, Group.create xname xuuid xapol [] xipol xtags)

parseGroup v = fail ("Invalid group query result: " ++ show v)

-- * Main loader functionality

-- | Builds the cluster data by querying a given socket name.

readData :: String -- ^ Unix socket to use as source

         -> IO (Result JSValue, Result JSValue, Result JSValue, Result JSValue)

readData master =

  E.bracket

       (L.getLuxiClient master)

       L.closeClient

       (\s -> do

          nodes <- queryNodes s

          instances <- queryInstances s

          cinfo <- queryClusterInfo s

          groups <- queryGroups s

          return (groups, nodes, instances, cinfo)

       )

-- | Converts the output of 'readData' into the internal cluster

-- representation.

parseData :: (Result JSValue, Result JSValue, Result JSValue, Result JSValue)

          -> Result ClusterData

parseData (groups, nodes, instances, cinfo) = do

  group_data <- groups >>= getGroups

  let (group_names, group_idx) = assignIndices group_data

  node_data <- nodes >>= getNodes group_names

  let (node_names, node_idx) = assignIndices node_data

  inst_data <- instances >>= getInstances node_names

  let (_, inst_idx) = assignIndices inst_data

  (ctags, cpol, master) <- cinfo >>= getClusterData

  node_idx' <- setMaster node_names node_idx master

  return (ClusterData group_idx node_idx' inst_idx ctags cpol)

-- | Top level function for data loading.

loadData :: String -- ^ Unix socket to use as source

         -> IO (Result ClusterData)

loadData = fmap parseData . readData