Statistics
| Branch: | Tag: | Revision:

root / lib / rpc.py @ e437117f

History | View | Annotate | Download (26.2 kB)

1
#
2
#
3

    
4
# Copyright (C) 2006, 2007, 2008, 2009, 2010, 2011 Google Inc.
5
#
6
# This program is free software; you can redistribute it and/or modify
7
# it under the terms of the GNU General Public License as published by
8
# the Free Software Foundation; either version 2 of the License, or
9
# (at your option) any later version.
10
#
11
# This program is distributed in the hope that it will be useful, but
12
# WITHOUT ANY WARRANTY; without even the implied warranty of
13
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
14
# General Public License for more details.
15
#
16
# You should have received a copy of the GNU General Public License
17
# along with this program; if not, write to the Free Software
18
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
19
# 02110-1301, USA.
20

    
21

    
22
"""Inter-node RPC library.
23

24
"""
25

    
26
# pylint: disable=C0103,R0201,R0904
27
# C0103: Invalid name, since call_ are not valid
28
# R0201: Method could be a function, we keep all rpcs instance methods
29
# as not to change them back and forth between static/instance methods
30
# if they need to start using instance attributes
31
# R0904: Too many public methods
32

    
33
import os
34
import logging
35
import zlib
36
import base64
37
import pycurl
38
import threading
39

    
40
from ganeti import utils
41
from ganeti import objects
42
from ganeti import http
43
from ganeti import serializer
44
from ganeti import constants
45
from ganeti import errors
46
from ganeti import netutils
47
from ganeti import ssconf
48
from ganeti import runtime
49
from ganeti import compat
50

    
51
# Special module generated at build time
52
from ganeti import _generated_rpc
53

    
54
# pylint has a bug here, doesn't see this import
55
import ganeti.http.client  # pylint: disable=W0611
56

    
57

    
58
# Timeout for connecting to nodes (seconds)
59
_RPC_CONNECT_TIMEOUT = 5
60

    
61
_RPC_CLIENT_HEADERS = [
62
  "Content-type: %s" % http.HTTP_APP_JSON,
63
  "Expect:",
64
  ]
65

    
66
# Various time constants for the timeout table
67
_TMO_URGENT = 60 # one minute
68
_TMO_FAST = 5 * 60 # five minutes
69
_TMO_NORMAL = 15 * 60 # 15 minutes
70
_TMO_SLOW = 3600 # one hour
71
_TMO_4HRS = 4 * 3600
72
_TMO_1DAY = 86400
73

    
74
# Timeout table that will be built later by decorators
75
# Guidelines for choosing timeouts:
76
# - call used during watcher: timeout -> 1min, _TMO_URGENT
77
# - trivial (but be sure it is trivial) (e.g. reading a file): 5min, _TMO_FAST
78
# - other calls: 15 min, _TMO_NORMAL
79
# - special calls (instance add, etc.): either _TMO_SLOW (1h) or huge timeouts
80

    
81
_TIMEOUTS = {
82
}
83

    
84
#: Special value to describe an offline host
85
_OFFLINE = object()
86

    
87

    
88
def Init():
89
  """Initializes the module-global HTTP client manager.
90

91
  Must be called before using any RPC function and while exactly one thread is
92
  running.
93

94
  """
95
  # curl_global_init(3) and curl_global_cleanup(3) must be called with only
96
  # one thread running. This check is just a safety measure -- it doesn't
97
  # cover all cases.
98
  assert threading.activeCount() == 1, \
99
         "Found more than one active thread when initializing pycURL"
100

    
101
  logging.info("Using PycURL %s", pycurl.version)
102

    
103
  pycurl.global_init(pycurl.GLOBAL_ALL)
104

    
105

    
106
def Shutdown():
107
  """Stops the module-global HTTP client manager.
108

109
  Must be called before quitting the program and while exactly one thread is
110
  running.
111

112
  """
113
  pycurl.global_cleanup()
114

    
115

    
116
def _ConfigRpcCurl(curl):
117
  noded_cert = str(constants.NODED_CERT_FILE)
118

    
119
  curl.setopt(pycurl.FOLLOWLOCATION, False)
120
  curl.setopt(pycurl.CAINFO, noded_cert)
121
  curl.setopt(pycurl.SSL_VERIFYHOST, 0)
122
  curl.setopt(pycurl.SSL_VERIFYPEER, True)
123
  curl.setopt(pycurl.SSLCERTTYPE, "PEM")
124
  curl.setopt(pycurl.SSLCERT, noded_cert)
125
  curl.setopt(pycurl.SSLKEYTYPE, "PEM")
126
  curl.setopt(pycurl.SSLKEY, noded_cert)
127
  curl.setopt(pycurl.CONNECTTIMEOUT, _RPC_CONNECT_TIMEOUT)
128

    
129

    
130
def _RpcTimeout(secs):
131
  """Timeout decorator.
132

133
  When applied to a rpc call_* function, it updates the global timeout
134
  table with the given function/timeout.
135

136
  """
137
  def decorator(f):
138
    name = f.__name__
139
    assert name.startswith("call_")
140
    _TIMEOUTS[name[len("call_"):]] = secs
141
    return f
142
  return decorator
143

    
144

    
145
def RunWithRPC(fn):
146
  """RPC-wrapper decorator.
147

148
  When applied to a function, it runs it with the RPC system
149
  initialized, and it shutsdown the system afterwards. This means the
150
  function must be called without RPC being initialized.
151

152
  """
153
  def wrapper(*args, **kwargs):
154
    Init()
155
    try:
156
      return fn(*args, **kwargs)
157
    finally:
158
      Shutdown()
159
  return wrapper
160

    
161

    
162
def _Compress(data):
163
  """Compresses a string for transport over RPC.
164

165
  Small amounts of data are not compressed.
166

167
  @type data: str
168
  @param data: Data
169
  @rtype: tuple
170
  @return: Encoded data to send
171

172
  """
173
  # Small amounts of data are not compressed
174
  if len(data) < 512:
175
    return (constants.RPC_ENCODING_NONE, data)
176

    
177
  # Compress with zlib and encode in base64
178
  return (constants.RPC_ENCODING_ZLIB_BASE64,
179
          base64.b64encode(zlib.compress(data, 3)))
180

    
181

    
182
class RpcResult(object):
183
  """RPC Result class.
184

185
  This class holds an RPC result. It is needed since in multi-node
186
  calls we can't raise an exception just because one one out of many
187
  failed, and therefore we use this class to encapsulate the result.
188

189
  @ivar data: the data payload, for successful results, or None
190
  @ivar call: the name of the RPC call
191
  @ivar node: the name of the node to which we made the call
192
  @ivar offline: whether the operation failed because the node was
193
      offline, as opposed to actual failure; offline=True will always
194
      imply failed=True, in order to allow simpler checking if
195
      the user doesn't care about the exact failure mode
196
  @ivar fail_msg: the error message if the call failed
197

198
  """
199
  def __init__(self, data=None, failed=False, offline=False,
200
               call=None, node=None):
201
    self.offline = offline
202
    self.call = call
203
    self.node = node
204

    
205
    if offline:
206
      self.fail_msg = "Node is marked offline"
207
      self.data = self.payload = None
208
    elif failed:
209
      self.fail_msg = self._EnsureErr(data)
210
      self.data = self.payload = None
211
    else:
212
      self.data = data
213
      if not isinstance(self.data, (tuple, list)):
214
        self.fail_msg = ("RPC layer error: invalid result type (%s)" %
215
                         type(self.data))
216
        self.payload = None
217
      elif len(data) != 2:
218
        self.fail_msg = ("RPC layer error: invalid result length (%d), "
219
                         "expected 2" % len(self.data))
220
        self.payload = None
221
      elif not self.data[0]:
222
        self.fail_msg = self._EnsureErr(self.data[1])
223
        self.payload = None
224
      else:
225
        # finally success
226
        self.fail_msg = None
227
        self.payload = data[1]
228

    
229
    for attr_name in ["call", "data", "fail_msg",
230
                      "node", "offline", "payload"]:
231
      assert hasattr(self, attr_name), "Missing attribute %s" % attr_name
232

    
233
  @staticmethod
234
  def _EnsureErr(val):
235
    """Helper to ensure we return a 'True' value for error."""
236
    if val:
237
      return val
238
    else:
239
      return "No error information"
240

    
241
  def Raise(self, msg, prereq=False, ecode=None):
242
    """If the result has failed, raise an OpExecError.
243

244
    This is used so that LU code doesn't have to check for each
245
    result, but instead can call this function.
246

247
    """
248
    if not self.fail_msg:
249
      return
250

    
251
    if not msg: # one could pass None for default message
252
      msg = ("Call '%s' to node '%s' has failed: %s" %
253
             (self.call, self.node, self.fail_msg))
254
    else:
255
      msg = "%s: %s" % (msg, self.fail_msg)
256
    if prereq:
257
      ec = errors.OpPrereqError
258
    else:
259
      ec = errors.OpExecError
260
    if ecode is not None:
261
      args = (msg, ecode)
262
    else:
263
      args = (msg, )
264
    raise ec(*args) # pylint: disable=W0142
265

    
266

    
267
def _SsconfResolver(node_list,
268
                    ssc=ssconf.SimpleStore,
269
                    nslookup_fn=netutils.Hostname.GetIP):
270
  """Return addresses for given node names.
271

272
  @type node_list: list
273
  @param node_list: List of node names
274
  @type ssc: class
275
  @param ssc: SimpleStore class that is used to obtain node->ip mappings
276
  @type nslookup_fn: callable
277
  @param nslookup_fn: function use to do NS lookup
278
  @rtype: list of tuple; (string, string)
279
  @return: List of tuples containing node name and IP address
280

281
  """
282
  ss = ssc()
283
  iplist = ss.GetNodePrimaryIPList()
284
  family = ss.GetPrimaryIPFamily()
285
  ipmap = dict(entry.split() for entry in iplist)
286

    
287
  result = []
288
  for node in node_list:
289
    ip = ipmap.get(node)
290
    if ip is None:
291
      ip = nslookup_fn(node, family=family)
292
    result.append((node, ip))
293

    
294
  return result
295

    
296

    
297
class _StaticResolver:
298
  def __init__(self, addresses):
299
    """Initializes this class.
300

301
    """
302
    self._addresses = addresses
303

    
304
  def __call__(self, hosts):
305
    """Returns static addresses for hosts.
306

307
    """
308
    assert len(hosts) == len(self._addresses)
309
    return zip(hosts, self._addresses)
310

    
311

    
312
def _CheckConfigNode(name, node):
313
  """Checks if a node is online.
314

315
  @type name: string
316
  @param name: Node name
317
  @type node: L{objects.Node} or None
318
  @param node: Node object
319

320
  """
321
  if node is None:
322
    # Depend on DNS for name resolution
323
    ip = name
324
  elif node.offline:
325
    ip = _OFFLINE
326
  else:
327
    ip = node.primary_ip
328
  return (name, ip)
329

    
330

    
331
def _NodeConfigResolver(single_node_fn, all_nodes_fn, hosts):
332
  """Calculate node addresses using configuration.
333

334
  """
335
  # Special case for single-host lookups
336
  if len(hosts) == 1:
337
    (name, ) = hosts
338
    return [_CheckConfigNode(name, single_node_fn(name))]
339
  else:
340
    all_nodes = all_nodes_fn()
341
    return [_CheckConfigNode(name, all_nodes.get(name, None))
342
            for name in hosts]
343

    
344

    
345
class _RpcProcessor:
346
  def __init__(self, resolver, port, lock_monitor_cb=None):
347
    """Initializes this class.
348

349
    @param resolver: callable accepting a list of hostnames, returning a list
350
      of tuples containing name and IP address (IP address can be the name or
351
      the special value L{_OFFLINE} to mark offline machines)
352
    @type port: int
353
    @param port: TCP port
354
    @param lock_monitor_cb: Callable for registering with lock monitor
355

356
    """
357
    self._resolver = resolver
358
    self._port = port
359
    self._lock_monitor_cb = lock_monitor_cb
360

    
361
  @staticmethod
362
  def _PrepareRequests(hosts, port, procedure, body, read_timeout):
363
    """Prepares requests by sorting offline hosts into separate list.
364

365
    """
366
    results = {}
367
    requests = {}
368

    
369
    for (name, ip) in hosts:
370
      if ip is _OFFLINE:
371
        # Node is marked as offline
372
        results[name] = RpcResult(node=name, offline=True, call=procedure)
373
      else:
374
        requests[name] = \
375
          http.client.HttpClientRequest(str(ip), port,
376
                                        http.HTTP_PUT, str("/%s" % procedure),
377
                                        headers=_RPC_CLIENT_HEADERS,
378
                                        post_data=body,
379
                                        read_timeout=read_timeout,
380
                                        nicename="%s/%s" % (name, procedure),
381
                                        curl_config_fn=_ConfigRpcCurl)
382

    
383
    return (results, requests)
384

    
385
  @staticmethod
386
  def _CombineResults(results, requests, procedure):
387
    """Combines pre-computed results for offline hosts with actual call results.
388

389
    """
390
    for name, req in requests.items():
391
      if req.success and req.resp_status_code == http.HTTP_OK:
392
        host_result = RpcResult(data=serializer.LoadJson(req.resp_body),
393
                                node=name, call=procedure)
394
      else:
395
        # TODO: Better error reporting
396
        if req.error:
397
          msg = req.error
398
        else:
399
          msg = req.resp_body
400

    
401
        logging.error("RPC error in %s on node %s: %s", procedure, name, msg)
402
        host_result = RpcResult(data=msg, failed=True, node=name,
403
                                call=procedure)
404

    
405
      results[name] = host_result
406

    
407
    return results
408

    
409
  def __call__(self, hosts, procedure, body, read_timeout=None,
410
               _req_process_fn=http.client.ProcessRequests):
411
    """Makes an RPC request to a number of nodes.
412

413
    @type hosts: sequence
414
    @param hosts: Hostnames
415
    @type procedure: string
416
    @param procedure: Request path
417
    @type body: string
418
    @param body: Request body
419
    @type read_timeout: int or None
420
    @param read_timeout: Read timeout for request
421

422
    """
423
    if read_timeout is None:
424
      read_timeout = _TIMEOUTS.get(procedure, None)
425

    
426
    assert read_timeout is not None, \
427
      "Missing RPC read timeout for procedure '%s'" % procedure
428

    
429
    (results, requests) = \
430
      self._PrepareRequests(self._resolver(hosts), self._port, procedure,
431
                            str(body), read_timeout)
432

    
433
    _req_process_fn(requests.values(), lock_monitor_cb=self._lock_monitor_cb)
434

    
435
    assert not frozenset(results).intersection(requests)
436

    
437
    return self._CombineResults(results, requests, procedure)
438

    
439

    
440
def _EncodeImportExportIO(ieio, ieioargs):
441
  """Encodes import/export I/O information.
442

443
  """
444
  if ieio == constants.IEIO_RAW_DISK:
445
    assert len(ieioargs) == 1
446
    return (ieioargs[0].ToDict(), )
447

    
448
  if ieio == constants.IEIO_SCRIPT:
449
    assert len(ieioargs) == 2
450
    return (ieioargs[0].ToDict(), ieioargs[1])
451

    
452
  return ieioargs
453

    
454

    
455
class RpcRunner(_generated_rpc.RpcClientDefault):
456
  """RPC runner class.
457

458
  """
459
  def __init__(self, context):
460
    """Initialized the RPC runner.
461

462
    @type context: C{masterd.GanetiContext}
463
    @param context: Ganeti context
464

465
    """
466
    _generated_rpc.RpcClientDefault.__init__(self)
467

    
468
    self._cfg = context.cfg
469
    self._proc = _RpcProcessor(compat.partial(_NodeConfigResolver,
470
                                              self._cfg.GetNodeInfo,
471
                                              self._cfg.GetAllNodesInfo),
472
                               netutils.GetDaemonPort(constants.NODED),
473
                               lock_monitor_cb=context.glm.AddToLockMonitor)
474

    
475
  def _InstDict(self, instance, hvp=None, bep=None, osp=None):
476
    """Convert the given instance to a dict.
477

478
    This is done via the instance's ToDict() method and additionally
479
    we fill the hvparams with the cluster defaults.
480

481
    @type instance: L{objects.Instance}
482
    @param instance: an Instance object
483
    @type hvp: dict or None
484
    @param hvp: a dictionary with overridden hypervisor parameters
485
    @type bep: dict or None
486
    @param bep: a dictionary with overridden backend parameters
487
    @type osp: dict or None
488
    @param osp: a dictionary with overridden os parameters
489
    @rtype: dict
490
    @return: the instance dict, with the hvparams filled with the
491
        cluster defaults
492

493
    """
494
    idict = instance.ToDict()
495
    cluster = self._cfg.GetClusterInfo()
496
    idict["hvparams"] = cluster.FillHV(instance)
497
    if hvp is not None:
498
      idict["hvparams"].update(hvp)
499
    idict["beparams"] = cluster.FillBE(instance)
500
    if bep is not None:
501
      idict["beparams"].update(bep)
502
    idict["osparams"] = cluster.SimpleFillOS(instance.os, instance.osparams)
503
    if osp is not None:
504
      idict["osparams"].update(osp)
505
    for nic in idict["nics"]:
506
      nic['nicparams'] = objects.FillDict(
507
        cluster.nicparams[constants.PP_DEFAULT],
508
        nic['nicparams'])
509
    return idict
510

    
511
  def _MultiNodeCall(self, node_list, procedure, args, read_timeout=None):
512
    """Helper for making a multi-node call
513

514
    """
515
    body = serializer.DumpJson(args, indent=False)
516
    return self._proc(node_list, procedure, body, read_timeout=read_timeout)
517

    
518
  def _Call(self, node_list, procedure, timeout, args):
519
    """Entry point for automatically generated RPC wrappers.
520

521
    """
522
    return self._MultiNodeCall(node_list, procedure, args, read_timeout=timeout)
523

    
524
  @staticmethod
525
  def _StaticMultiNodeCall(node_list, procedure, args,
526
                           address_list=None, read_timeout=None):
527
    """Helper for making a multi-node static call
528

529
    """
530
    body = serializer.DumpJson(args, indent=False)
531

    
532
    if address_list is None:
533
      resolver = _SsconfResolver
534
    else:
535
      # Caller provided an address list
536
      resolver = _StaticResolver(address_list)
537

    
538
    proc = _RpcProcessor(resolver,
539
                         netutils.GetDaemonPort(constants.NODED))
540
    return proc(node_list, procedure, body, read_timeout=read_timeout)
541

    
542
  def _SingleNodeCall(self, node, procedure, args, read_timeout=None):
543
    """Helper for making a single-node call
544

545
    """
546
    body = serializer.DumpJson(args, indent=False)
547
    return self._proc([node], procedure, body, read_timeout=read_timeout)[node]
548

    
549
  @classmethod
550
  def _StaticSingleNodeCall(cls, node, procedure, args, read_timeout=None):
551
    """Helper for making a single-node static call
552

553
    """
554
    body = serializer.DumpJson(args, indent=False)
555
    proc = _RpcProcessor(_SsconfResolver,
556
                         netutils.GetDaemonPort(constants.NODED))
557
    return proc([node], procedure, body, read_timeout=read_timeout)[node]
558

    
559
  @staticmethod
560
  def _BlockdevFindPostProc(result):
561
    if not result.fail_msg and result.payload is not None:
562
      result.payload = objects.BlockDevStatus.FromDict(result.payload)
563
    return result
564

    
565
  @staticmethod
566
  def _BlockdevGetMirrorStatusPostProc(result):
567
    if not result.fail_msg:
568
      result.payload = [objects.BlockDevStatus.FromDict(i)
569
                        for i in result.payload]
570
    return result
571

    
572
  @staticmethod
573
  def _BlockdevGetMirrorStatusMultiPostProc(result):
574
    for nres in result.values():
575
      if nres.fail_msg:
576
        continue
577

    
578
      for idx, (success, status) in enumerate(nres.payload):
579
        if success:
580
          nres.payload[idx] = (success, objects.BlockDevStatus.FromDict(status))
581

    
582
    return result
583

    
584
  @staticmethod
585
  def _OsGetPostProc(result):
586
    if not result.fail_msg and isinstance(result.payload, dict):
587
      result.payload = objects.OS.FromDict(result.payload)
588
    return result
589

    
590
  @staticmethod
591
  def _PrepareFinalizeExportDisks(snap_disks):
592
    flat_disks = []
593

    
594
    for disk in snap_disks:
595
      if isinstance(disk, bool):
596
        flat_disks.append(disk)
597
      else:
598
        flat_disks.append(disk.ToDict())
599

    
600
    return flat_disks
601

    
602
  @staticmethod
603
  def _ImpExpStatusPostProc(result):
604
    """Post-processor for import/export status.
605

606
    @rtype: Payload containing list of L{objects.ImportExportStatus} instances
607
    @return: Returns a list of the state of each named import/export or None if
608
             a status couldn't be retrieved
609

610
    """
611
    if not result.fail_msg:
612
      decoded = []
613

    
614
      for i in result.payload:
615
        if i is None:
616
          decoded.append(None)
617
          continue
618
        decoded.append(objects.ImportExportStatus.FromDict(i))
619

    
620
      result.payload = decoded
621

    
622
    return result
623

    
624
  #
625
  # Begin RPC calls
626
  #
627

    
628
  @_RpcTimeout(_TMO_NORMAL)
629
  def call_storage_list(self, node_list, su_name, su_args, name, fields):
630
    """Get list of storage units.
631

632
    This is a multi-node call.
633

634
    """
635
    return self._MultiNodeCall(node_list, "storage_list",
636
                               [su_name, su_args, name, fields])
637

    
638
  @_RpcTimeout(_TMO_NORMAL)
639
  def call_storage_modify(self, node, su_name, su_args, name, changes):
640
    """Modify a storage unit.
641

642
    This is a single-node call.
643

644
    """
645
    return self._SingleNodeCall(node, "storage_modify",
646
                                [su_name, su_args, name, changes])
647

    
648
  @_RpcTimeout(_TMO_NORMAL)
649
  def call_storage_execute(self, node, su_name, su_args, name, op):
650
    """Executes an operation on a storage unit.
651

652
    This is a single-node call.
653

654
    """
655
    return self._SingleNodeCall(node, "storage_execute",
656
                                [su_name, su_args, name, op])
657

    
658
  @_RpcTimeout(_TMO_NORMAL)
659
  def call_instance_start(self, node, instance, hvp, bep, startup_paused):
660
    """Starts an instance.
661

662
    This is a single-node call.
663

664
    """
665
    idict = self._InstDict(instance, hvp=hvp, bep=bep)
666
    return self._SingleNodeCall(node, "instance_start", [idict, startup_paused])
667

    
668
  @_RpcTimeout(_TMO_1DAY)
669
  def call_instance_os_add(self, node, inst, reinstall, debug, osparams=None):
670
    """Installs an OS on the given instance.
671

672
    This is a single-node call.
673

674
    """
675
    return self._SingleNodeCall(node, "instance_os_add",
676
                                [self._InstDict(inst, osp=osparams),
677
                                 reinstall, debug])
678

    
679
  @classmethod
680
  @_RpcTimeout(_TMO_FAST)
681
  def call_node_start_master_daemons(cls, node, no_voting):
682
    """Starts master daemons on a node.
683

684
    This is a single-node call.
685

686
    """
687
    return cls._StaticSingleNodeCall(node, "node_start_master_daemons",
688
                                     [no_voting])
689

    
690
  @classmethod
691
  @_RpcTimeout(_TMO_FAST)
692
  def call_node_activate_master_ip(cls, node):
693
    """Activates master IP on a node.
694

695
    This is a single-node call.
696

697
    """
698
    return cls._StaticSingleNodeCall(node, "node_activate_master_ip", [])
699

    
700
  @classmethod
701
  @_RpcTimeout(_TMO_FAST)
702
  def call_node_stop_master(cls, node):
703
    """Deactivates master IP and stops master daemons on a node.
704

705
    This is a single-node call.
706

707
    """
708
    return cls._StaticSingleNodeCall(node, "node_stop_master", [])
709

    
710
  @classmethod
711
  @_RpcTimeout(_TMO_FAST)
712
  def call_node_deactivate_master_ip(cls, node):
713
    """Deactivates master IP on a node.
714

715
    This is a single-node call.
716

717
    """
718
    return cls._StaticSingleNodeCall(node, "node_deactivate_master_ip", [])
719

    
720
  @classmethod
721
  @_RpcTimeout(_TMO_FAST)
722
  def call_node_change_master_netmask(cls, node, netmask):
723
    """Change master IP netmask.
724

725
    This is a single-node call.
726

727
    """
728
    return cls._StaticSingleNodeCall(node, "node_change_master_netmask",
729
                  [netmask])
730

    
731
  @classmethod
732
  @_RpcTimeout(_TMO_URGENT)
733
  def call_master_info(cls, node_list):
734
    """Query master info.
735

736
    This is a multi-node call.
737

738
    """
739
    # TODO: should this method query down nodes?
740
    return cls._StaticMultiNodeCall(node_list, "master_info", [])
741

    
742
  @classmethod
743
  @_RpcTimeout(_TMO_URGENT)
744
  def call_version(cls, node_list):
745
    """Query node version.
746

747
    This is a multi-node call.
748

749
    """
750
    return cls._StaticMultiNodeCall(node_list, "version", [])
751

    
752
  @classmethod
753
  @_RpcTimeout(_TMO_NORMAL)
754
  def call_upload_file(cls, node_list, file_name, address_list=None):
755
    """Upload a file.
756

757
    The node will refuse the operation in case the file is not on the
758
    approved file list.
759

760
    This is a multi-node call.
761

762
    @type node_list: list
763
    @param node_list: the list of node names to upload to
764
    @type file_name: str
765
    @param file_name: the filename to upload
766
    @type address_list: list or None
767
    @keyword address_list: an optional list of node addresses, in order
768
        to optimize the RPC speed
769

770
    """
771
    file_contents = utils.ReadFile(file_name)
772
    data = _Compress(file_contents)
773
    st = os.stat(file_name)
774
    getents = runtime.GetEnts()
775
    params = [file_name, data, st.st_mode, getents.LookupUid(st.st_uid),
776
              getents.LookupGid(st.st_gid), st.st_atime, st.st_mtime]
777
    return cls._StaticMultiNodeCall(node_list, "upload_file", params,
778
                                    address_list=address_list)
779

    
780
  @classmethod
781
  @_RpcTimeout(_TMO_NORMAL)
782
  def call_write_ssconf_files(cls, node_list, values):
783
    """Write ssconf files.
784

785
    This is a multi-node call.
786

787
    """
788
    return cls._StaticMultiNodeCall(node_list, "write_ssconf_files", [values])
789

    
790
  @classmethod
791
  @_RpcTimeout(_TMO_NORMAL)
792
  def call_node_leave_cluster(cls, node, modify_ssh_setup):
793
    """Requests a node to clean the cluster information it has.
794

795
    This will remove the configuration information from the ganeti data
796
    dir.
797

798
    This is a single-node call.
799

800
    """
801
    return cls._StaticSingleNodeCall(node, "node_leave_cluster",
802
                                     [modify_ssh_setup])
803

    
804
  def call_test_delay(self, node_list, duration, read_timeout=None):
805
    """Sleep for a fixed time on given node(s).
806

807
    This is a multi-node call.
808

809
    """
810
    assert read_timeout is None
811
    return self.call_test_delay(node_list, duration,
812
                                read_timeout=int(duration + 5))
813

    
814
  @classmethod
815
  @_RpcTimeout(_TMO_URGENT)
816
  def call_jobqueue_update(cls, node_list, address_list, file_name, content):
817
    """Update job queue.
818

819
    This is a multi-node call.
820

821
    """
822
    return cls._StaticMultiNodeCall(node_list, "jobqueue_update",
823
                                    [file_name, _Compress(content)],
824
                                    address_list=address_list)
825

    
826
  @classmethod
827
  @_RpcTimeout(_TMO_NORMAL)
828
  def call_jobqueue_purge(cls, node):
829
    """Purge job queue.
830

831
    This is a single-node call.
832

833
    """
834
    return cls._StaticSingleNodeCall(node, "jobqueue_purge", [])
835

    
836
  @classmethod
837
  @_RpcTimeout(_TMO_URGENT)
838
  def call_jobqueue_rename(cls, node_list, address_list, rename):
839
    """Rename a job queue file.
840

841
    This is a multi-node call.
842

843
    """
844
    return cls._StaticMultiNodeCall(node_list, "jobqueue_rename", rename,
845
                                    address_list=address_list)
846

    
847
  @_RpcTimeout(_TMO_NORMAL)
848
  def call_hypervisor_validate_params(self, node_list, hvname, hvparams):
849
    """Validate the hypervisor params.
850

851
    This is a multi-node call.
852

853
    @type node_list: list
854
    @param node_list: the list of nodes to query
855
    @type hvname: string
856
    @param hvname: the hypervisor name
857
    @type hvparams: dict
858
    @param hvparams: the hypervisor parameters to be validated
859

860
    """
861
    cluster = self._cfg.GetClusterInfo()
862
    hv_full = objects.FillDict(cluster.hvparams.get(hvname, {}), hvparams)
863
    return self._MultiNodeCall(node_list, "hypervisor_validate_params",
864
                               [hvname, hv_full])
865

    
866
  @_RpcTimeout(_TMO_NORMAL)
867
  def call_import_start(self, node, opts, instance, component,
868
                        dest, dest_args):
869
    """Starts a listener for an import.
870

871
    This is a single-node call.
872

873
    @type node: string
874
    @param node: Node name
875
    @type instance: C{objects.Instance}
876
    @param instance: Instance object
877
    @type component: string
878
    @param component: which part of the instance is being imported
879

880
    """
881
    return self._SingleNodeCall(node, "import_start",
882
                                [opts.ToDict(),
883
                                 self._InstDict(instance), component, dest,
884
                                 _EncodeImportExportIO(dest, dest_args)])
885

    
886
  @_RpcTimeout(_TMO_NORMAL)
887
  def call_export_start(self, node, opts, host, port,
888
                        instance, component, source, source_args):
889
    """Starts an export daemon.
890

891
    This is a single-node call.
892

893
    @type node: string
894
    @param node: Node name
895
    @type instance: C{objects.Instance}
896
    @param instance: Instance object
897
    @type component: string
898
    @param component: which part of the instance is being imported
899

900
    """
901
    return self._SingleNodeCall(node, "export_start",
902
                                [opts.ToDict(), host, port,
903
                                 self._InstDict(instance),
904
                                 component, source,
905
                                 _EncodeImportExportIO(source, source_args)])