mcpu.py 15.9 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
Iustin Pop's avatar
Iustin Pop committed
32
33
34
35
36
37

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

41

42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
class OpExecCbBase:
  """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.

    """

59
60
61
62
63
  def ReportLocks(self, msg):
    """Report lock operations.

    """

64

Iustin Pop's avatar
Iustin Pop committed
65
66
67
68
class Processor(object):
  """Object which runs OpCodes"""
  DISPATCH_TABLE = {
    # Cluster
69
    opcodes.OpPostInitCluster: cmdlib.LUPostInitCluster,
Iustin Pop's avatar
Iustin Pop committed
70
71
72
    opcodes.OpDestroyCluster: cmdlib.LUDestroyCluster,
    opcodes.OpQueryClusterInfo: cmdlib.LUQueryClusterInfo,
    opcodes.OpVerifyCluster: cmdlib.LUVerifyCluster,
73
    opcodes.OpQueryConfigValues: cmdlib.LUQueryConfigValues,
74
    opcodes.OpRenameCluster: cmdlib.LURenameCluster,
75
    opcodes.OpVerifyDisks: cmdlib.LUVerifyDisks,
76
    opcodes.OpSetClusterParams: cmdlib.LUSetClusterParams,
77
    opcodes.OpRedistributeConfig: cmdlib.LURedistributeConfig,
78
    opcodes.OpRepairDiskSizes: cmdlib.LURepairDiskSizes,
Iustin Pop's avatar
Iustin Pop committed
79
80
81
    # node lu
    opcodes.OpAddNode: cmdlib.LUAddNode,
    opcodes.OpQueryNodes: cmdlib.LUQueryNodes,
82
    opcodes.OpQueryNodeVolumes: cmdlib.LUQueryNodeVolumes,
83
    opcodes.OpQueryNodeStorage: cmdlib.LUQueryNodeStorage,
84
    opcodes.OpModifyNodeStorage: cmdlib.LUModifyNodeStorage,
85
    opcodes.OpRepairNodeStorage: cmdlib.LURepairNodeStorage,
Iustin Pop's avatar
Iustin Pop committed
86
    opcodes.OpRemoveNode: cmdlib.LURemoveNode,
Iustin Pop's avatar
Iustin Pop committed
87
    opcodes.OpSetNodeParams: cmdlib.LUSetNodeParams,
Iustin Pop's avatar
Iustin Pop committed
88
    opcodes.OpPowercycleNode: cmdlib.LUPowercycleNode,
89
    opcodes.OpEvacuateNode: cmdlib.LUEvacuateNode,
90
    opcodes.OpMigrateNode: cmdlib.LUMigrateNode,
Iustin Pop's avatar
Iustin Pop committed
91
92
    # instance lu
    opcodes.OpCreateInstance: cmdlib.LUCreateInstance,
93
    opcodes.OpReinstallInstance: cmdlib.LUReinstallInstance,
Iustin Pop's avatar
Iustin Pop committed
94
    opcodes.OpRemoveInstance: cmdlib.LURemoveInstance,
95
    opcodes.OpRenameInstance: cmdlib.LURenameInstance,
Iustin Pop's avatar
Iustin Pop committed
96
97
98
    opcodes.OpActivateInstanceDisks: cmdlib.LUActivateInstanceDisks,
    opcodes.OpShutdownInstance: cmdlib.LUShutdownInstance,
    opcodes.OpStartupInstance: cmdlib.LUStartupInstance,
99
    opcodes.OpRebootInstance: cmdlib.LURebootInstance,
Iustin Pop's avatar
Iustin Pop committed
100
101
    opcodes.OpDeactivateInstanceDisks: cmdlib.LUDeactivateInstanceDisks,
    opcodes.OpReplaceDisks: cmdlib.LUReplaceDisks,
Iustin Pop's avatar
Iustin Pop committed
102
    opcodes.OpRecreateInstanceDisks: cmdlib.LURecreateInstanceDisks,
Iustin Pop's avatar
Iustin Pop committed
103
    opcodes.OpFailoverInstance: cmdlib.LUFailoverInstance,
104
    opcodes.OpMigrateInstance: cmdlib.LUMigrateInstance,
105
    opcodes.OpMoveInstance: cmdlib.LUMoveInstance,
Iustin Pop's avatar
Iustin Pop committed
106
107
108
    opcodes.OpConnectConsole: cmdlib.LUConnectConsole,
    opcodes.OpQueryInstances: cmdlib.LUQueryInstances,
    opcodes.OpQueryInstanceData: cmdlib.LUQueryInstanceData,
109
    opcodes.OpSetInstanceParams: cmdlib.LUSetInstanceParams,
Iustin Pop's avatar
Iustin Pop committed
110
    opcodes.OpGrowDisk: cmdlib.LUGrowDisk,
Iustin Pop's avatar
Iustin Pop committed
111
112
113
114
115
    # os lu
    opcodes.OpDiagnoseOS: cmdlib.LUDiagnoseOS,
    # exports lu
    opcodes.OpQueryExports: cmdlib.LUQueryExports,
    opcodes.OpExportInstance: cmdlib.LUExportInstance,
116
    opcodes.OpRemoveExport: cmdlib.LURemoveExport,
117
118
    # tags lu
    opcodes.OpGetTags: cmdlib.LUGetTags,
Iustin Pop's avatar
Iustin Pop committed
119
    opcodes.OpSearchTags: cmdlib.LUSearchTags,
120
121
    opcodes.OpAddTags: cmdlib.LUAddTags,
    opcodes.OpDelTags: cmdlib.LUDelTags,
122
123
    # test lu
    opcodes.OpTestDelay: cmdlib.LUTestDelay,
124
    opcodes.OpTestAllocator: cmdlib.LUTestAllocator,
Iustin Pop's avatar
Iustin Pop committed
125
126
    }

127
  def __init__(self, context):
Iustin Pop's avatar
Iustin Pop committed
128
129
130
    """Constructor for Processor

    """
131
    self.context = context
132
    self._cbs = None
133
    self.exclusive_BGL = False
Iustin Pop's avatar
Iustin Pop committed
134
    self.rpc = rpc.RpcRunner(context.cfg)
135
    self.hmclass = HooksMaster
Iustin Pop's avatar
Iustin Pop committed
136

137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
  def _ReportLocks(self, level, names, shared, acquired):
    """Reports lock operations.

    @type level: int
    @param level: Lock level
    @type names: list or string
    @param names: Lock names
    @type shared: bool
    @param shared: Whether the lock should be acquired in shared mode
    @type acquired: bool
    @param acquired: Whether the lock has already been acquired

    """
    parts = []

    # Build message
    if acquired:
      parts.append("acquired")
    else:
      parts.append("waiting")

    parts.append(locking.LEVEL_NAMES[level])

    if names == locking.ALL_SET:
      parts.append("ALL")
    elif isinstance(names, basestring):
      parts.append(names)
    else:
      parts.append(",".join(names))

    if shared:
      parts.append("shared")
    else:
      parts.append("exclusive")

    msg = "/".join(parts)

    logging.debug("LU locks %s", msg)

    if self._cbs:
      self._cbs.ReportLocks(msg)

179
180
181
182
183
184
  def _ExecLU(self, lu):
    """Logical Unit execution sequence.

    """
    write_count = self.context.cfg.write_count
    lu.CheckPrereq()
185
    hm = HooksMaster(self.rpc.call_hooks_runner, lu)
186
187
    h_results = hm.RunPhase(constants.HOOKS_PHASE_PRE)
    lu.HooksCallBack(constants.HOOKS_PHASE_PRE, h_results,
188
                     self._Feedback, None)
189
190
191
192
193
194
195
196
197

    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

198
    try:
199
      result = lu.Exec(self._Feedback)
200
201
      h_results = hm.RunPhase(constants.HOOKS_PHASE_POST)
      result = lu.HooksCallBack(constants.HOOKS_PHASE_POST, h_results,
202
                                self._Feedback, result)
203
204
205
206
207
208
209
    finally:
      # FIXME: This needs locks if not lu_class.REQ_BGL
      if write_count != self.context.cfg.write_count:
        hm.RunConfigUpdate()

    return result

210
211
212
213
214
215
216
217
  def _LockAndExecLU(self, lu, level):
    """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.

    """
218
219
    adding_locks = level in lu.add_locks
    acquiring_locks = level in lu.needed_locks
220
    if level not in locking.LEVELS:
221
222
223
      if self._cbs:
        self._cbs.NotifyStart()

224
      result = self._ExecLU(lu)
225
226
227
228
229
230
    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.
      raise NotImplementedError(
        "Can't declare locks to acquire when adding others")
    elif adding_locks or acquiring_locks:
Guido Trotter's avatar
Guido Trotter committed
231
      lu.DeclareLocks(level)
Guido Trotter's avatar
Guido Trotter committed
232
      share = lu.share_locks[level]
233
234
      if acquiring_locks:
        needed_locks = lu.needed_locks[level]
235
236

        self._ReportLocks(level, needed_locks, share, False)
237
238
239
        lu.acquired_locks[level] = self.context.glm.acquire(level,
                                                            needed_locks,
                                                            shared=share)
240
241
        self._ReportLocks(level, needed_locks, share, True)

242
243
244
245
246
247
248
      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(
Michael Hanselmann's avatar
Michael Hanselmann committed
249
            "Couldn't add locks (%s), probably because of a race condition"
250
            " with another job, who added them first" % add_locks)
251
      try:
252
253
254
255
256
257
258
        try:
          if adding_locks:
            lu.acquired_locks[level] = add_locks
          result = self._LockAndExecLU(lu, level + 1)
        finally:
          if level in lu.remove_locks:
            self.context.glm.remove(level, lu.remove_locks[level])
259
      finally:
260
        if self.context.glm.is_owned(level):
261
262
          self.context.glm.release(level)
    else:
263
      result = self._LockAndExecLU(lu, level + 1)
264
265
266

    return result

267
  def ExecOpCode(self, op, cbs):
Iustin Pop's avatar
Iustin Pop committed
268
269
    """Execute an opcode.

Iustin Pop's avatar
Iustin Pop committed
270
271
    @type op: an OpCode instance
    @param op: the opcode to be executed
272
273
    @type cbs: L{OpExecCbBase}
    @param cbs: Runtime callbacks
Iustin Pop's avatar
Iustin Pop committed
274
275
276

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

280
    self._cbs = cbs
281
    try:
282
283
284
285
286
287
288
      lu_class = self.DISPATCH_TABLE.get(op.__class__, None)
      if lu_class is None:
        raise errors.OpCodeUnknown("Unknown opcode")

      # 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.
289
290
291
292
293
294
295
296
      self._ReportLocks(locking.LEVEL_CLUSTER, [locking.BGL],
                        not lu_class.REQ_BGL, False)
      try:
        self.context.glm.acquire(locking.LEVEL_CLUSTER, [locking.BGL],
                                 shared=not lu_class.REQ_BGL)
      finally:
        self._ReportLocks(locking.LEVEL_CLUSTER, [locking.BGL],
                          not lu_class.REQ_BGL, True)
297
298
299
300
301
302
303
304
305
      try:
        self.exclusive_BGL = lu_class.REQ_BGL
        lu = lu_class(self, op, self.context, self.rpc)
        lu.ExpandNames()
        assert lu.needed_locks is not None, "needed_locks not set by LU"
        result = self._LockAndExecLU(lu, locking.LEVEL_INSTANCE)
      finally:
        self.context.glm.release(locking.LEVEL_CLUSTER)
        self.exclusive_BGL = False
306
    finally:
307
      self._cbs = None
308

Iustin Pop's avatar
Iustin Pop committed
309
310
    return result

311
312
313
314
315
316
317
  def _Feedback(self, *args):
    """Forward call to feedback callback function.

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

318
319
320
321
  def LogStep(self, current, total, message):
    """Log a change in LU execution progress.

    """
322
    logging.debug("Step %d/%d %s", current, total, message)
323
    self._Feedback("STEP %d/%d %s" % (current, total, message))
324

325
  def LogWarning(self, message, *args, **kwargs):
326
327
    """Log a warning to the logs and the user.

328
329
330
331
    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.
332

333
334
335
336
337
338
339
    """
    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)
340
      self._Feedback(" - WARNING: %s" % message)
341
    if "hint" in kwargs:
342
      self._Feedback("      Hint: %s" % kwargs["hint"])
343
344

  def LogInfo(self, message, *args):
345
346
347
    """Log an informational message to the logs and the user.

    """
348
349
    if args:
      message = message % tuple(args)
350
    logging.info(message)
351
    self._Feedback(" - INFO: %s" % message)
352

Iustin Pop's avatar
Iustin Pop committed
353
354
355
356
357
358
359
360
361
362
363
364
365

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.

  """
366
  def __init__(self, callfn, lu):
Iustin Pop's avatar
Iustin Pop committed
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
    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,
386
      "GANETI_DATA_DIR": constants.DATA_DIR,
Iustin Pop's avatar
Iustin Pop committed
387
388
      }

389
390
391
392
393
394
395
    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
396

397
398
399
400
401
402
403
404
405
406
407
    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
408
409
410
    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
411

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

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

416
  def RunPhase(self, phase, nodes=None):
Iustin Pop's avatar
Iustin Pop committed
417
418
419
420
    """Run all the scripts for a phase.

    This is the main function of the HookMaster.

Iustin Pop's avatar
Iustin Pop committed
421
422
    @param phase: one of L{constants.HOOKS_PHASE_POST} or
        L{constants.HOOKS_PHASE_PRE}; it denotes the hooks phase
423
    @param nodes: overrides the predefined list of nodes for the given phase
Iustin Pop's avatar
Iustin Pop committed
424
425
    @return: the processed results of the hooks multi-node rpc call
    @raise errors.HooksFailure: on communication failure to the nodes
426
    @raise errors.HooksAbort: on failure of one of the hooks
427

Iustin Pop's avatar
Iustin Pop committed
428
    """
429
    if not self.node_list[phase] and not nodes:
430
431
432
      # 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
433
      return
434
    hpath = self.lu.HPATH
435
436
437
438
    if nodes is not None:
      results = self._RunWrapper(nodes, hpath, phase)
    else:
      results = self._RunWrapper(self.node_list[phase], hpath, phase)
439
440
441
442
443
444
445
    errs = []
    if not results:
      msg = "Communication Failure"
      if phase == constants.HOOKS_PHASE_PRE:
        raise errors.HooksFailure(msg)
      else:
        self.lu.LogWarning(msg)
446
        return results
447
448
449
450
451
452
453
454
455
456
457
458
    for node_name in results:
      res = results[node_name]
      if res.offline:
        continue
      msg = res.RemoteFailMsg()
      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
459
            errs.append((node_name, script, output))
460
461
          else:
            if not output:
462
              output = "(no output)"
463
464
465
466
            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)
467
    return results
468
469
470
471
472
473
474
475
476
477

  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
478
    nodes = [self.lu.cfg.GetMasterNode()]
Iustin Pop's avatar
Iustin Pop committed
479
    self._RunWrapper(nodes, hpath, phase)