mcpu.py 18.3 KB
Newer Older
Iustin Pop's avatar
Iustin Pop committed
1
#
Iustin Pop's avatar
Iustin Pop committed
2
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
#

# Copyright (C) 2006, 2007 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 implementing the logic behind the cluster operations

This module implements the logic for doing operations in the cluster. There
are two kinds of classes defined:
  - logical units, which know how to deal with their specific opcode only
  - the processor, which dispatches the opcodes to their logical units

"""

31
import logging
32
33
import random
import time
Iustin Pop's avatar
Iustin Pop committed
34
35
36
37
38
39

from ganeti import opcodes
from ganeti import constants
from ganeti import errors
from ganeti import rpc
from ganeti import cmdlib
40
from ganeti import locking
Iustin Pop's avatar
Iustin Pop committed
41

42

43
44
class LockAcquireTimeout(Exception):
  """Exception to report timeouts on acquiring locks.
45
46
47
48

  """


49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
def _CalculateLockAttemptTimeouts():
  """Calculate timeouts for lock attempts.

  """
  result = [1.0]

  # Wait for a total of at least 150s before doing a blocking acquire
  while sum(result) < 150.0:
    timeout = (result[-1] * 1.05) ** 1.25

    # Cap timeout at 10 seconds. This gives other jobs a chance to run
    # even if we're still trying to get our locks, before finally moving
    # to a blocking acquire.
    if timeout > 10.0:
      timeout = 10.0

    elif timeout < 0.1:
      # Lower boundary for safety
      timeout = 0.1

    result.append(timeout)

  return result


74
class LockAttemptTimeoutStrategy(object):
75
76
77
78
  """Class with lock acquire timeout strategy.

  """
  __slots__ = [
79
    "_timeouts",
80
    "_random_fn",
81
    "_time_fn",
82
83
    ]

84
  _TIMEOUT_PER_ATTEMPT = _CalculateLockAttemptTimeouts()
85

86
  def __init__(self, _time_fn=time.time, _random_fn=random.random):
87
88
    """Initializes this class.

89
    @param _time_fn: Time function for unittests
90
91
92
93
94
    @param _random_fn: Random number generator for unittests

    """
    object.__init__(self)

95
    self._timeouts = iter(self._TIMEOUT_PER_ATTEMPT)
96
97
98
    self._time_fn = _time_fn
    self._random_fn = _random_fn

99
  def NextAttempt(self):
100
    """Returns the timeout for the next attempt.
101
102

    """
103
104
105
106
107
    try:
      timeout = self._timeouts.next()
    except StopIteration:
      # No more timeouts, do blocking acquire
      timeout = None
108

109
110
111
112
113
114
    if timeout is not None:
      # Add a small variation (-/+ 5%) to timeout. This helps in situations
      # where two or more jobs are fighting for the same lock(s).
      variation_range = timeout * 0.1
      timeout += ((self._random_fn() * variation_range) -
                  (variation_range * 0.5))
115

116
    return timeout
117
118


Iustin Pop's avatar
Iustin Pop committed
119
class OpExecCbBase: # pylint: disable-msg=W0232
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
  """Base class for OpCode execution callbacks.

  """
  def NotifyStart(self):
    """Called when we are about to execute the LU.

    This function is called when we're about to start the lu's Exec() method,
    that is, after we have acquired all locks.

    """

  def Feedback(self, *args):
    """Sends feedback from the LU code to the end-user.

    """

136
137
  def CheckCancel(self):
    """Check whether job has been cancelled.
138
139
140

    """

141

Iustin Pop's avatar
Iustin Pop committed
142
143
144
145
class Processor(object):
  """Object which runs OpCodes"""
  DISPATCH_TABLE = {
    # Cluster
146
    opcodes.OpPostInitCluster: cmdlib.LUPostInitCluster,
Iustin Pop's avatar
Iustin Pop committed
147
148
149
    opcodes.OpDestroyCluster: cmdlib.LUDestroyCluster,
    opcodes.OpQueryClusterInfo: cmdlib.LUQueryClusterInfo,
    opcodes.OpVerifyCluster: cmdlib.LUVerifyCluster,
150
    opcodes.OpQueryConfigValues: cmdlib.LUQueryConfigValues,
151
    opcodes.OpRenameCluster: cmdlib.LURenameCluster,
152
    opcodes.OpVerifyDisks: cmdlib.LUVerifyDisks,
153
    opcodes.OpSetClusterParams: cmdlib.LUSetClusterParams,
154
    opcodes.OpRedistributeConfig: cmdlib.LURedistributeConfig,
155
    opcodes.OpRepairDiskSizes: cmdlib.LURepairDiskSizes,
Iustin Pop's avatar
Iustin Pop committed
156
157
158
    # node lu
    opcodes.OpAddNode: cmdlib.LUAddNode,
    opcodes.OpQueryNodes: cmdlib.LUQueryNodes,
159
    opcodes.OpQueryNodeVolumes: cmdlib.LUQueryNodeVolumes,
160
    opcodes.OpQueryNodeStorage: cmdlib.LUQueryNodeStorage,
161
    opcodes.OpModifyNodeStorage: cmdlib.LUModifyNodeStorage,
162
    opcodes.OpRepairNodeStorage: cmdlib.LURepairNodeStorage,
Iustin Pop's avatar
Iustin Pop committed
163
    opcodes.OpRemoveNode: cmdlib.LURemoveNode,
Iustin Pop's avatar
Iustin Pop committed
164
    opcodes.OpSetNodeParams: cmdlib.LUSetNodeParams,
Iustin Pop's avatar
Iustin Pop committed
165
    opcodes.OpPowercycleNode: cmdlib.LUPowercycleNode,
166
    opcodes.OpMigrateNode: cmdlib.LUMigrateNode,
Iustin Pop's avatar
Iustin Pop committed
167
    opcodes.OpNodeEvacuationStrategy: cmdlib.LUNodeEvacuationStrategy,
Iustin Pop's avatar
Iustin Pop committed
168
169
    # instance lu
    opcodes.OpCreateInstance: cmdlib.LUCreateInstance,
170
    opcodes.OpReinstallInstance: cmdlib.LUReinstallInstance,
Iustin Pop's avatar
Iustin Pop committed
171
    opcodes.OpRemoveInstance: cmdlib.LURemoveInstance,
172
    opcodes.OpRenameInstance: cmdlib.LURenameInstance,
Iustin Pop's avatar
Iustin Pop committed
173
174
175
    opcodes.OpActivateInstanceDisks: cmdlib.LUActivateInstanceDisks,
    opcodes.OpShutdownInstance: cmdlib.LUShutdownInstance,
    opcodes.OpStartupInstance: cmdlib.LUStartupInstance,
176
    opcodes.OpRebootInstance: cmdlib.LURebootInstance,
Iustin Pop's avatar
Iustin Pop committed
177
178
    opcodes.OpDeactivateInstanceDisks: cmdlib.LUDeactivateInstanceDisks,
    opcodes.OpReplaceDisks: cmdlib.LUReplaceDisks,
Iustin Pop's avatar
Iustin Pop committed
179
    opcodes.OpRecreateInstanceDisks: cmdlib.LURecreateInstanceDisks,
Iustin Pop's avatar
Iustin Pop committed
180
    opcodes.OpFailoverInstance: cmdlib.LUFailoverInstance,
181
    opcodes.OpMigrateInstance: cmdlib.LUMigrateInstance,
182
    opcodes.OpMoveInstance: cmdlib.LUMoveInstance,
Iustin Pop's avatar
Iustin Pop committed
183
184
185
    opcodes.OpConnectConsole: cmdlib.LUConnectConsole,
    opcodes.OpQueryInstances: cmdlib.LUQueryInstances,
    opcodes.OpQueryInstanceData: cmdlib.LUQueryInstanceData,
186
    opcodes.OpSetInstanceParams: cmdlib.LUSetInstanceParams,
Iustin Pop's avatar
Iustin Pop committed
187
    opcodes.OpGrowDisk: cmdlib.LUGrowDisk,
Iustin Pop's avatar
Iustin Pop committed
188
189
190
191
    # os lu
    opcodes.OpDiagnoseOS: cmdlib.LUDiagnoseOS,
    # exports lu
    opcodes.OpQueryExports: cmdlib.LUQueryExports,
192
    opcodes.OpPrepareExport: cmdlib.LUPrepareExport,
Iustin Pop's avatar
Iustin Pop committed
193
    opcodes.OpExportInstance: cmdlib.LUExportInstance,
194
    opcodes.OpRemoveExport: cmdlib.LURemoveExport,
195
196
    # tags lu
    opcodes.OpGetTags: cmdlib.LUGetTags,
Iustin Pop's avatar
Iustin Pop committed
197
    opcodes.OpSearchTags: cmdlib.LUSearchTags,
198
199
    opcodes.OpAddTags: cmdlib.LUAddTags,
    opcodes.OpDelTags: cmdlib.LUDelTags,
200
201
    # test lu
    opcodes.OpTestDelay: cmdlib.LUTestDelay,
202
    opcodes.OpTestAllocator: cmdlib.LUTestAllocator,
203
    opcodes.OpTestJobqueue: cmdlib.LUTestJobqueue,
Iustin Pop's avatar
Iustin Pop committed
204
205
    }

206
  def __init__(self, context, ec_id):
Iustin Pop's avatar
Iustin Pop committed
207
208
    """Constructor for Processor

209
210
211
212
213
    @type context: GanetiContext
    @param context: global Ganeti context
    @type ec_id: string
    @param ec_id: execution context identifier

Iustin Pop's avatar
Iustin Pop committed
214
    """
215
    self.context = context
216
    self._ec_id = ec_id
217
    self._cbs = None
Iustin Pop's avatar
Iustin Pop committed
218
    self.rpc = rpc.RpcRunner(context.cfg)
219
    self.hmclass = HooksMaster
Iustin Pop's avatar
Iustin Pop committed
220

221
  def _AcquireLocks(self, level, names, shared, timeout, priority):
222
223
224
225
226
227
228
229
230
231
232
233
    """Acquires locks via the Ganeti lock manager.

    @type level: int
    @param level: Lock level
    @type names: list or string
    @param names: Lock names
    @type shared: bool
    @param shared: Whether the locks should be acquired in shared mode
    @type timeout: None or float
    @param timeout: Timeout for acquiring the locks

    """
234
235
    if self._cbs:
      self._cbs.CheckCancel()
236
237

    acquired = self.context.glm.acquire(level, names, shared=shared,
238
                                        timeout=timeout, priority=priority)
239
240
241

    return acquired

242
243
244
245
246
247
  def _ExecLU(self, lu):
    """Logical Unit execution sequence.

    """
    write_count = self.context.cfg.write_count
    lu.CheckPrereq()
248
    hm = HooksMaster(self.rpc.call_hooks_runner, lu)
249
250
    h_results = hm.RunPhase(constants.HOOKS_PHASE_PRE)
    lu.HooksCallBack(constants.HOOKS_PHASE_PRE, h_results,
251
                     self.Log, None)
252
253
254
255
256
257
258
259
260

    if getattr(lu.op, "dry_run", False):
      # in this mode, no post-hooks are run, and the config is not
      # written (as it might have been modified by another LU, and we
      # shouldn't do writeout on behalf of other threads
      self.LogInfo("dry-run mode requested, not actually executing"
                   " the operation")
      return lu.dry_run_result

261
    try:
262
      result = lu.Exec(self.Log)
263
264
      h_results = hm.RunPhase(constants.HOOKS_PHASE_POST)
      result = lu.HooksCallBack(constants.HOOKS_PHASE_POST, h_results,
265
                                self.Log, result)
266
267
268
269
270
271
272
    finally:
      # FIXME: This needs locks if not lu_class.REQ_BGL
      if write_count != self.context.cfg.write_count:
        hm.RunConfigUpdate()

    return result

273
  def _LockAndExecLU(self, lu, level, calc_timeout, priority):
274
275
276
277
278
279
280
    """Execute a Logical Unit, with the needed locks.

    This is a recursive function that starts locking the given level, and
    proceeds up, till there are no more locks to acquire. Then it executes the
    given LU and its opcodes.

    """
281
282
    adding_locks = level in lu.add_locks
    acquiring_locks = level in lu.needed_locks
283
    if level not in locking.LEVELS:
284
285
286
      if self._cbs:
        self._cbs.NotifyStart()

287
      result = self._ExecLU(lu)
288

289
290
291
    elif adding_locks and acquiring_locks:
      # We could both acquire and add locks at the same level, but for now we
      # don't need this, so we'll avoid the complicated code needed.
292
293
294
      raise NotImplementedError("Can't declare locks to acquire when adding"
                                " others")

295
    elif adding_locks or acquiring_locks:
Guido Trotter's avatar
Guido Trotter committed
296
      lu.DeclareLocks(level)
Guido Trotter's avatar
Guido Trotter committed
297
      share = lu.share_locks[level]
298

299
      try:
300
301
302
303
304
305
306
        assert adding_locks ^ acquiring_locks, \
          "Locks must be either added or acquired"

        if acquiring_locks:
          # Acquiring locks
          needed_locks = lu.needed_locks[level]

307
          acquired = self._AcquireLocks(level, needed_locks, share,
308
                                        calc_timeout(), priority)
309
310

          if acquired is None:
311
            raise LockAcquireTimeout()
312
313
314
315
316
317
318
319
320
321
322

        else:
          # Adding locks
          add_locks = lu.add_locks[level]
          lu.remove_locks[level] = add_locks

          try:
            self.context.glm.add(level, add_locks, acquired=1, shared=share)
          except errors.LockError:
            raise errors.OpPrereqError(
              "Couldn't add locks (%s), probably because of a race condition"
323
324
              " with another job, who added them first" % add_locks,
              errors.ECODE_FAULT)
325

326
327
          acquired = add_locks

328
        try:
329
330
          lu.acquired_locks[level] = acquired

331
          result = self._LockAndExecLU(lu, level + 1, calc_timeout, priority)
332
333
334
        finally:
          if level in lu.remove_locks:
            self.context.glm.remove(level, lu.remove_locks[level])
335
      finally:
336
        if self.context.glm.is_owned(level):
337
          self.context.glm.release(level)
338

339
    else:
340
      result = self._LockAndExecLU(lu, level + 1, calc_timeout, priority)
341
342
343

    return result

344
  def ExecOpCode(self, op, cbs, timeout=None, priority=None):
Iustin Pop's avatar
Iustin Pop committed
345
346
    """Execute an opcode.

Iustin Pop's avatar
Iustin Pop committed
347
348
    @type op: an OpCode instance
    @param op: the opcode to be executed
349
350
    @type cbs: L{OpExecCbBase}
    @param cbs: Runtime callbacks
351
352
    @type timeout: float or None
    @param timeout: Maximum time to acquire all locks, None for no timeout
353
354
    @type priority: number or None
    @param priority: Priority for acquiring lock(s)
355
356
    @raise LockAcquireTimeout: In case locks couldn't be acquired in specified
        amount of time
Iustin Pop's avatar
Iustin Pop committed
357
358
359

    """
    if not isinstance(op, opcodes.OpCode):
360
361
      raise errors.ProgrammerError("Non-opcode instance passed"
                                   " to ExecOpcode")
Iustin Pop's avatar
Iustin Pop committed
362

363
364
365
366
367
368
369
370
371
    lu_class = self.DISPATCH_TABLE.get(op.__class__, None)
    if lu_class is None:
      raise errors.OpCodeUnknown("Unknown opcode")

    if timeout is None:
      calc_timeout = lambda: None
    else:
      calc_timeout = locking.RunningTimeout(timeout, False).Remaining

372
    self._cbs = cbs
373
    try:
374
375
376
377
      # Acquire the Big Ganeti Lock exclusively if this LU requires it,
      # and in a shared fashion otherwise (to prevent concurrent run with
      # an exclusive LU.
      if self._AcquireLocks(locking.LEVEL_CLUSTER, locking.BGL,
378
379
                            not lu_class.REQ_BGL, calc_timeout(),
                            priority) is None:
380
        raise LockAcquireTimeout()
381

382
383
384
385
      try:
        lu = lu_class(self, op, self.context, self.rpc)
        lu.ExpandNames()
        assert lu.needed_locks is not None, "needed_locks not set by LU"
386
387

        try:
388
389
          return self._LockAndExecLU(lu, locking.LEVEL_INSTANCE, calc_timeout,
                                     priority)
390
391
392
393
394
        finally:
          if self._ec_id:
            self.context.cfg.DropECReservations(self._ec_id)
      finally:
        self.context.glm.release(locking.LEVEL_CLUSTER)
395
    finally:
396
      self._cbs = None
397

398
  def Log(self, *args):
399
400
401
402
403
404
    """Forward call to feedback callback function.

    """
    if self._cbs:
      self._cbs.Feedback(*args)

405
406
407
408
  def LogStep(self, current, total, message):
    """Log a change in LU execution progress.

    """
409
    logging.debug("Step %d/%d %s", current, total, message)
410
    self.Log("STEP %d/%d %s" % (current, total, message))
411

412
  def LogWarning(self, message, *args, **kwargs):
413
414
    """Log a warning to the logs and the user.

415
416
417
418
    The optional keyword argument is 'hint' and can be used to show a
    hint to the user (presumably related to the warning). If the
    message is empty, it will not be printed at all, allowing one to
    show only a hint.
419

420
421
422
423
424
425
426
    """
    assert not kwargs or (len(kwargs) == 1 and "hint" in kwargs), \
           "Invalid keyword arguments for LogWarning (%s)" % str(kwargs)
    if args:
      message = message % tuple(args)
    if message:
      logging.warning(message)
427
      self.Log(" - WARNING: %s" % message)
428
    if "hint" in kwargs:
429
      self.Log("      Hint: %s" % kwargs["hint"])
430
431

  def LogInfo(self, message, *args):
432
433
434
    """Log an informational message to the logs and the user.

    """
435
436
    if args:
      message = message % tuple(args)
437
    logging.info(message)
438
    self.Log(" - INFO: %s" % message)
439

440
441
442
443
444
  def GetECId(self):
    if not self._ec_id:
      errors.ProgrammerError("Tried to use execution context id when not set")
    return self._ec_id

Iustin Pop's avatar
Iustin Pop committed
445
446
447
448
449
450
451
452
453
454
455
456
457

class HooksMaster(object):
  """Hooks master.

  This class distributes the run commands to the nodes based on the
  specific LU class.

  In order to remove the direct dependency on the rpc module, the
  constructor needs a function which actually does the remote
  call. This will usually be rpc.call_hooks_runner, but any function
  which behaves the same works.

  """
458
  def __init__(self, callfn, lu):
Iustin Pop's avatar
Iustin Pop committed
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
    self.callfn = callfn
    self.lu = lu
    self.op = lu.op
    self.env, node_list_pre, node_list_post = self._BuildEnv()
    self.node_list = {constants.HOOKS_PHASE_PRE: node_list_pre,
                      constants.HOOKS_PHASE_POST: node_list_post}

  def _BuildEnv(self):
    """Compute the environment and the target nodes.

    Based on the opcode and the current node list, this builds the
    environment for the hooks and the target node list for the run.

    """
    env = {
      "PATH": "/sbin:/bin:/usr/sbin:/usr/bin",
      "GANETI_HOOKS_VERSION": constants.HOOKS_VERSION,
      "GANETI_OP_CODE": self.op.OP_ID,
      "GANETI_OBJECT_TYPE": self.lu.HTYPE,
478
      "GANETI_DATA_DIR": constants.DATA_DIR,
Iustin Pop's avatar
Iustin Pop committed
479
480
      }

481
482
483
484
485
486
487
    if self.lu.HPATH is not None:
      lu_env, lu_nodes_pre, lu_nodes_post = self.lu.BuildHooksEnv()
      if lu_env:
        for key in lu_env:
          env["GANETI_" + key] = lu_env[key]
    else:
      lu_nodes_pre = lu_nodes_post = []
Iustin Pop's avatar
Iustin Pop committed
488

489
490
491
492
493
494
495
496
497
498
499
    return env, frozenset(lu_nodes_pre), frozenset(lu_nodes_post)

  def _RunWrapper(self, node_list, hpath, phase):
    """Simple wrapper over self.callfn.

    This method fixes the environment before doing the rpc call.

    """
    env = self.env.copy()
    env["GANETI_HOOKS_PHASE"] = phase
    env["GANETI_HOOKS_PATH"] = hpath
Michael Hanselmann's avatar
Michael Hanselmann committed
500
501
502
    if self.lu.cfg is not None:
      env["GANETI_CLUSTER"] = self.lu.cfg.GetClusterName()
      env["GANETI_MASTER"] = self.lu.cfg.GetMasterNode()
Iustin Pop's avatar
Iustin Pop committed
503

504
    env = dict([(str(key), str(val)) for key, val in env.iteritems()])
Iustin Pop's avatar
Iustin Pop committed
505

506
    return self.callfn(node_list, hpath, phase, env)
Iustin Pop's avatar
Iustin Pop committed
507

508
  def RunPhase(self, phase, nodes=None):
Iustin Pop's avatar
Iustin Pop committed
509
510
511
512
    """Run all the scripts for a phase.

    This is the main function of the HookMaster.

Iustin Pop's avatar
Iustin Pop committed
513
514
    @param phase: one of L{constants.HOOKS_PHASE_POST} or
        L{constants.HOOKS_PHASE_PRE}; it denotes the hooks phase
515
    @param nodes: overrides the predefined list of nodes for the given phase
Iustin Pop's avatar
Iustin Pop committed
516
517
    @return: the processed results of the hooks multi-node rpc call
    @raise errors.HooksFailure: on communication failure to the nodes
518
    @raise errors.HooksAbort: on failure of one of the hooks
519

Iustin Pop's avatar
Iustin Pop committed
520
    """
521
    if not self.node_list[phase] and not nodes:
522
523
524
      # empty node list, we should not attempt to run this as either
      # we're in the cluster init phase and the rpc client part can't
      # even attempt to run, or this LU doesn't do hooks at all
Iustin Pop's avatar
Iustin Pop committed
525
      return
526
    hpath = self.lu.HPATH
527
528
529
530
    if nodes is not None:
      results = self._RunWrapper(nodes, hpath, phase)
    else:
      results = self._RunWrapper(self.node_list[phase], hpath, phase)
531
532
533
534
535
536
537
    errs = []
    if not results:
      msg = "Communication Failure"
      if phase == constants.HOOKS_PHASE_PRE:
        raise errors.HooksFailure(msg)
      else:
        self.lu.LogWarning(msg)
538
        return results
539
540
541
542
    for node_name in results:
      res = results[node_name]
      if res.offline:
        continue
543
      msg = res.fail_msg
544
545
546
547
548
549
550
      if msg:
        self.lu.LogWarning("Communication failure to node %s: %s",
                           node_name, msg)
        continue
      for script, hkr, output in res.payload:
        if hkr == constants.HKR_FAIL:
          if phase == constants.HOOKS_PHASE_PRE:
Iustin Pop's avatar
Iustin Pop committed
551
            errs.append((node_name, script, output))
552
553
          else:
            if not output:
554
              output = "(no output)"
555
556
557
558
            self.lu.LogWarning("On %s script %s failed, output: %s" %
                               (node_name, script, output))
    if errs and phase == constants.HOOKS_PHASE_PRE:
      raise errors.HooksAbort(errs)
559
    return results
560
561
562
563
564
565
566
567
568
569

  def RunConfigUpdate(self):
    """Run the special configuration update hook

    This is a special hook that runs only on the master after each
    top-level LI if the configuration has been updated.

    """
    phase = constants.HOOKS_PHASE_POST
    hpath = constants.HOOKS_NAME_CFGUPDATE
Michael Hanselmann's avatar
Michael Hanselmann committed
570
    nodes = [self.lu.cfg.GetMasterNode()]
Iustin Pop's avatar
Iustin Pop committed
571
    self._RunWrapper(nodes, hpath, phase)