Rpc.hs 13.2 KB
Newer Older
1
{-# LANGUAGE MultiParamTypeClasses, FunctionalDependencies, CPP,
2
  BangPatterns, TemplateHaskell #-}
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32

{-| Implementation of the RPC client.

-}

{-

Copyright (C) 2012 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.Rpc
  ( RpcCall
  , Rpc
  , RpcError(..)
33
  , ERpcError
34
  , executeRpcCall
35
36
37
38
39
40
41

  , rpcCallName
  , rpcCallTimeout
  , rpcCallData
  , rpcCallAcceptOffline

  , rpcResultFill
42
43
44
45
46

  , InstanceInfo(..)
  , RpcCallAllInstancesInfo(..)
  , RpcResultAllInstancesInfo(..)

47
48
49
  , RpcCallInstanceList(..)
  , RpcResultInstanceList(..)

50
51
52
53
54
  , HvInfo(..)
  , VgInfo(..)
  , RpcCallNodeInfo(..)
  , RpcResultNodeInfo(..)

Agata Murawska's avatar
Agata Murawska committed
55
56
57
  , RpcCallVersion(..)
  , RpcResultVersion(..)

Agata Murawska's avatar
Agata Murawska committed
58
59
60
61
62
  , StorageType(..)
  , StorageField(..)
  , RpcCallStorageList(..)
  , RpcResultStorageList(..)

63
  , rpcTimeoutFromRaw -- FIXME: Not used anywhere
64
65
  ) where

66
import Control.Arrow (second)
67
import qualified Text.JSON as J
68
import Text.JSON.Pretty (pp_value)
69
import Text.JSON (makeObj)
70

71
72
#ifndef NO_CURL
import Network.Curl
Agata Murawska's avatar
Agata Murawska committed
73
import qualified Ganeti.Path as P
74
75
76
#endif

import qualified Ganeti.Constants as C
77
import Ganeti.Objects
78
import Ganeti.THH
79
80
import Ganeti.Compat
import Ganeti.JSON
81
82
83
84
85

#ifndef NO_CURL
-- | The curl options used for RPC.
curlOpts :: [CurlOption]
curlOpts = [ CurlFollowLocation False
Agata Murawska's avatar
Agata Murawska committed
86
           , CurlCAInfo P.nodedCertFile
87
88
89
           , CurlSSLVerifyHost 0
           , CurlSSLVerifyPeer True
           , CurlSSLCertType "PEM"
Agata Murawska's avatar
Agata Murawska committed
90
           , CurlSSLCert P.nodedCertFile
91
           , CurlSSLKeyType "PEM"
Agata Murawska's avatar
Agata Murawska committed
92
           , CurlSSLKey P.nodedCertFile
93
94
95
           , CurlConnectTimeout (fromIntegral C.rpcConnectTimeout)
           ]
#endif
96
97
98
99
100
101

-- | Data type for RPC error reporting.
data RpcError
  = CurlDisabledError
  | CurlLayerError Node String
  | JsonDecodeError String
Agata Murawska's avatar
Agata Murawska committed
102
  | RpcResultError String
103
104
105
106
107
108
109
  | OfflineNodeError Node
  deriving Eq

instance Show RpcError where
  show CurlDisabledError =
    "RPC/curl backend disabled at compile time"
  show (CurlLayerError node code) =
Agata Murawska's avatar
Agata Murawska committed
110
    "Curl error for " ++ nodeName node ++ ", " ++ code
111
  show (JsonDecodeError msg) =
Agata Murawska's avatar
Agata Murawska committed
112
113
114
    "Error while decoding JSON from HTTP response: " ++ msg
  show (RpcResultError msg) =
    "Error reponse received from RPC server: " ++ msg
115
116
117
  show (OfflineNodeError node) =
    "Node " ++ nodeName node ++ " is marked as offline"

118
119
type ERpcError = Either RpcError

120
121
122
123
124
125
126
127
128
129
-- | Basic timeouts for RPC calls.
$(declareIADT "RpcTimeout"
  [ ( "Urgent",    'C.rpcTmoUrgent )
  , ( "Fast",      'C.rpcTmoFast )
  , ( "Normal",    'C.rpcTmoNormal )
  , ( "Slow",      'C.rpcTmoSlow )
  , ( "FourHours", 'C.rpcTmo4hrs )
  , ( "OneDay",    'C.rpcTmo1day )
  ])

130
131
132
133
134
135
136
137
138
139
140
141
142
-- | A generic class for RPC calls.
class (J.JSON a) => RpcCall a where
  -- | Give the (Python) name of the procedure.
  rpcCallName :: a -> String
  -- | Calculate the timeout value for the call execution.
  rpcCallTimeout :: a -> Int
  -- | Prepare arguments of the call to be send as POST.
  rpcCallData :: Node -> a -> String
  -- | Whether we accept offline nodes when making a call.
  rpcCallAcceptOffline :: a -> Bool

-- | Generic class that ensures matching RPC call with its respective
-- result.
Agata Murawska's avatar
Agata Murawska committed
143
144
145
class (RpcCall a, J.JSON b) => Rpc a b  | a -> b, b -> a where
  -- | Create a result based on the received HTTP response.
  rpcResultFill :: (Monad m) => a -> J.JSValue -> m (ERpcError b)
146
147
148
149
150
151
152
153
154
155

-- | Http Request definition.
data HttpClientRequest = HttpClientRequest
  { requestTimeout :: Int
  , requestUrl :: String
  , requestPostData :: String
  }

-- | Execute the request and return the result as a plain String. When
-- curl reports an error, we propagate it.
156
157
executeHttpRequest :: Node -> ERpcError HttpClientRequest
                   -> IO (ERpcError String)
158
159
160
161
162
163
164
165
166
167
168
169

executeHttpRequest _ (Left rpc_err) = return $ Left rpc_err
#ifdef NO_CURL
executeHttpRequest _ _ = return $ Left CurlDisabledError
#else
executeHttpRequest node (Right request) = do
  let reqOpts = [ CurlTimeout (fromIntegral $ requestTimeout request)
                , CurlPostFields [requestPostData request]
                ]
      url = requestUrl request
  -- FIXME: This is very similar to getUrl in Htools/Rapi.hs
  (code, !body) <- curlGetString url $ curlOpts ++ reqOpts
Iustin Pop's avatar
Iustin Pop committed
170
171
172
  return $ case code of
             CurlOK -> Right body
             _ -> Left $ CurlLayerError node (show code)
173
174
175
176
177
178
179
#endif

-- | Prepare url for the HTTP request.
prepareUrl :: (RpcCall a) => Node -> a -> String
prepareUrl node call =
  let node_ip = nodePrimaryIp node
      port = snd C.daemonsPortsGanetiNoded
Iustin Pop's avatar
Iustin Pop committed
180
181
      path_prefix = "https://" ++ node_ip ++ ":" ++ show port
  in path_prefix ++ "/" ++ rpcCallName call
182
183
184
185

-- | Create HTTP request for a given node provided it is online,
-- otherwise create empty response.
prepareHttpRequest ::  (RpcCall a) => Node -> a
186
                   -> ERpcError HttpClientRequest
187
prepareHttpRequest node call
Iustin Pop's avatar
Iustin Pop committed
188
189
190
191
192
  | rpcCallAcceptOffline call || not (nodeOffline node) =
      Right HttpClientRequest { requestTimeout = rpcCallTimeout call
                              , requestUrl = prepareUrl node call
                              , requestPostData = rpcCallData node call
                              }
193
194
  | otherwise = Left $ OfflineNodeError node

195
-- | Parse a result based on the received HTTP response.
Agata Murawska's avatar
Agata Murawska committed
196
197
rpcResultParse :: (Monad m, Rpc a b) => a -> String -> m (ERpcError b)
rpcResultParse call res = do
198
199
200
  res' <- fromJResult "Reading JSON response" $ J.decode res
  case res' of
    (True, res'') ->
Agata Murawska's avatar
Agata Murawska committed
201
       rpcResultFill call res''
202
203
204
205
    (False, jerr) -> case jerr of
       J.JSString msg -> return . Left $ RpcResultError (J.fromJSString msg)
       _ -> (return . Left) . JsonDecodeError $ show (pp_value jerr)

206
-- | Parse the response or propagate the error.
Agata Murawska's avatar
Agata Murawska committed
207
208
209
parseHttpResponse :: (Rpc a b) => a -> ERpcError String -> IO (ERpcError b)
parseHttpResponse _ (Left err) = return $ Left err
parseHttpResponse call (Right response) = rpcResultParse call response
210
211

-- | Execute RPC call for a sigle node.
212
executeSingleRpcCall :: (Rpc a b) => Node -> a -> IO (Node, ERpcError b)
213
214
215
executeSingleRpcCall node call = do
  let request = prepareHttpRequest node call
  response <- executeHttpRequest node request
Agata Murawska's avatar
Agata Murawska committed
216
  result <- parseHttpResponse call response
217
218
219
  return (node, result)

-- | Execute RPC call for many nodes in parallel.
220
executeRpcCall :: (Rpc a b) => [Node] -> a -> IO [(Node, ERpcError b)]
221
222
223
executeRpcCall nodes call =
  sequence $ parMap rwhnf (uncurry executeSingleRpcCall)
               (zip nodes $ repeat call)
224

225
226
227
228
229
230
231
232
233
-- | Helper function that is used to read dictionaries of values.
sanitizeDictResults :: [(String, J.Result a)] -> ERpcError [(String, a)]
sanitizeDictResults [] = Right []
sanitizeDictResults ((_, J.Error err):_) = Left $ JsonDecodeError err
sanitizeDictResults ((name, J.Ok val):xs) =
  case sanitizeDictResults xs of
    Left err -> Left err
    Right res' -> Right $ (name, val):res'

234
235
236
-- * RPC calls and results

-- | AllInstancesInfo
237
--   Returns information about all running instances on the given nodes.
Iustin Pop's avatar
Iustin Pop committed
238
$(buildObject "RpcCallAllInstancesInfo" "rpcCallAllInstInfo"
239
240
  [ simpleField "hypervisors" [t| [Hypervisor] |] ])

Iustin Pop's avatar
Iustin Pop committed
241
$(buildObject "InstanceInfo" "instInfo"
242
243
  [ simpleField "memory" [t| Int|]
  , simpleField "state"  [t| String |] -- It depends on hypervisor :(
244
245
246
247
  , simpleField "vcpus"  [t| Int |]
  , simpleField "time"   [t| Int |]
  ])

Iustin Pop's avatar
Iustin Pop committed
248
$(buildObject "RpcResultAllInstancesInfo" "rpcResAllInstInfo"
249
  [ simpleField "instances" [t| [(String, InstanceInfo)] |] ])
250
251
252
253
254

instance RpcCall RpcCallAllInstancesInfo where
  rpcCallName _ = "all_instances_info"
  rpcCallTimeout _ = rpcTimeoutToRaw Urgent
  rpcCallAcceptOffline _ = False
255
256
  rpcCallData _ call = J.encode [rpcCallAllInstInfoHypervisors call]

Agata Murawska's avatar
Agata Murawska committed
257
instance Rpc RpcCallAllInstancesInfo RpcResultAllInstancesInfo where
258
  -- FIXME: Is there a simpler way to do it?
Agata Murawska's avatar
Agata Murawska committed
259
  rpcResultFill _ res =
260
261
262
263
264
265
266
267
268
    return $ case res of
      J.JSObject res' -> do
        let res'' = map (second J.readJSON) (J.fromJSObject res')
                        :: [(String, J.Result InstanceInfo)]
        case sanitizeDictResults res'' of
          Left err -> Left err
          Right insts -> Right $ RpcResultAllInstancesInfo insts
      _ -> Left $ JsonDecodeError
           ("Expected JSObject, got " ++ show res)
269

270
271
-- | InstanceList
-- Returns the list of running instances on the given nodes.
Iustin Pop's avatar
Iustin Pop committed
272
$(buildObject "RpcCallInstanceList" "rpcCallInstList"
273
274
  [ simpleField "hypervisors" [t| [Hypervisor] |] ])

Iustin Pop's avatar
Iustin Pop committed
275
$(buildObject "RpcResultInstanceList" "rpcResInstList"
276
  [ simpleField "instances" [t| [String] |] ])
277
278
279
280
281

instance RpcCall RpcCallInstanceList where
  rpcCallName _ = "instance_list"
  rpcCallTimeout _ = rpcTimeoutToRaw Urgent
  rpcCallAcceptOffline _ = False
282
  rpcCallData _ call = J.encode [rpcCallInstListHypervisors call]
283

Agata Murawska's avatar
Agata Murawska committed
284
285
286

instance Rpc RpcCallInstanceList RpcResultInstanceList where
  rpcResultFill _ res =
287
288
289
    return $ case J.readJSON res of
      J.Error err -> Left $ JsonDecodeError err
      J.Ok insts -> Right $ RpcResultInstanceList insts
290

291
292
-- | NodeInfo
-- Return node information.
Iustin Pop's avatar
Iustin Pop committed
293
$(buildObject "RpcCallNodeInfo" "rpcCallNodeInfo"
294
295
  [ simpleField "volume_groups" [t| [String] |]
  , simpleField "hypervisors" [t| [Hypervisor] |]
296
297
  ])

Iustin Pop's avatar
Iustin Pop committed
298
$(buildObject "VgInfo" "vgInfo"
299
  [ simpleField "name" [t| String |]
300
301
  , optionalField $ simpleField "vg_free" [t| Int |]
  , optionalField $ simpleField "vg_size" [t| Int |]
302
303
304
  ])

-- | We only provide common fields as described in hv_base.py.
Iustin Pop's avatar
Iustin Pop committed
305
$(buildObject "HvInfo" "hvInfo"
306
307
308
309
310
311
312
313
  [ simpleField "memory_total" [t| Int |]
  , simpleField "memory_free" [t| Int |]
  , simpleField "memory_dom0" [t| Int |]
  , simpleField "cpu_total" [t| Int |]
  , simpleField "cpu_nodes" [t| Int |]
  , simpleField "cpu_sockets" [t| Int |]
  ])

Iustin Pop's avatar
Iustin Pop committed
314
$(buildObject "RpcResultNodeInfo" "rpcResNodeInfo"
315
316
317
318
319
320
321
322
323
  [ simpleField "boot_id" [t| String |]
  , simpleField "vg_info" [t| [VgInfo] |]
  , simpleField "hv_info" [t| [HvInfo] |]
  ])

instance RpcCall RpcCallNodeInfo where
  rpcCallName _ = "node_info"
  rpcCallTimeout _ = rpcTimeoutToRaw Urgent
  rpcCallAcceptOffline _ = False
324
325
326
327
  rpcCallData _ call = J.encode ( rpcCallNodeInfoVolumeGroups call
                                , rpcCallNodeInfoHypervisors call
                                )

Agata Murawska's avatar
Agata Murawska committed
328
329
instance Rpc RpcCallNodeInfo RpcResultNodeInfo where
  rpcResultFill _ res =
330
331
332
333
    return $ case J.readJSON res of
      J.Error err -> Left $ JsonDecodeError err
      J.Ok (boot_id, vg_info, hv_info) ->
          Right $ RpcResultNodeInfo boot_id vg_info hv_info
334

Agata Murawska's avatar
Agata Murawska committed
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
-- | Version
-- Query node version.
-- Note: We can't use THH as it does not know what to do with empty dict
data RpcCallVersion = RpcCallVersion {}
  deriving (Show, Read, Eq)

instance J.JSON RpcCallVersion where
  showJSON _ = J.JSNull
  readJSON J.JSNull = return RpcCallVersion
  readJSON _ = fail "Unable to read RpcCallVersion"

$(buildObject "RpcResultVersion" "rpcResultVersion"
  [ simpleField "version" [t| Int |]
  ])

instance RpcCall RpcCallVersion where
  rpcCallName _ = "version"
  rpcCallTimeout _ = rpcTimeoutToRaw Urgent
  rpcCallAcceptOffline _ = True
  rpcCallData call _ = J.encode [call]

Agata Murawska's avatar
Agata Murawska committed
356
357
instance Rpc RpcCallVersion RpcResultVersion where
  rpcResultFill _ res =
Agata Murawska's avatar
Agata Murawska committed
358
359
360
361
    return $ case J.readJSON res of
      J.Error err -> Left $ JsonDecodeError err
      J.Ok ver -> Right $ RpcResultVersion ver

Agata Murawska's avatar
Agata Murawska committed
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
-- | StorageList
-- Get list of storage units.
-- FIXME: This may be moved to Objects
$(declareSADT "StorageType"
  [ ( "STLvmPv", 'C.stLvmPv )
  , ( "STFile",  'C.stFile )
  , ( "STLvmVg", 'C.stLvmVg )
  ])
$(makeJSONInstance ''StorageType)

-- FIXME: This may be moved to Objects
$(declareSADT "StorageField"
  [ ( "SFUsed",        'C.sfUsed)
  , ( "SFName",        'C.sfName)
  , ( "SFAllocatable", 'C.sfAllocatable)
  , ( "SFFree",        'C.sfFree)
  , ( "SFSize",        'C.sfSize)
  ])
$(makeJSONInstance ''StorageField)

$(buildObject "RpcCallStorageList" "rpcCallStorageList"
  [ simpleField "su_name" [t| StorageType |]
  , simpleField "su_args" [t| [String] |]
  , simpleField "name"    [t| String |]
  , simpleField "fields"  [t| [StorageField] |]
  ])

-- FIXME: The resulting JSValues should have types appropriate for their
-- StorageField value: Used -> Bool, Name -> String etc
$(buildObject "RpcResultStorageList" "rpcResStorageList"
  [ simpleField "storage" [t| [[(StorageField, J.JSValue)]] |] ])

instance RpcCall RpcCallStorageList where
  rpcCallName _ = "storage_list"
  rpcCallTimeout _ = rpcTimeoutToRaw Normal
  rpcCallAcceptOffline _ = False
  rpcCallData _ call = J.encode
    ( rpcCallStorageListSuName call
    , rpcCallStorageListSuArgs call
    , rpcCallStorageListName call
    , rpcCallStorageListFields call
    )

instance Rpc RpcCallStorageList RpcResultStorageList where
  rpcResultFill call res =
    let sfields = rpcCallStorageListFields call in
    return $ case J.readJSON res of
      J.Error err -> Left $ JsonDecodeError err
      J.Ok res_lst -> Right $ RpcResultStorageList (map (zip sfields) res_lst)