mcpu.py 14.5 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
Iustin Pop's avatar
Iustin Pop committed
39

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.

    """


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

121
  def __init__(self, context):
Iustin Pop's avatar
Iustin Pop committed
122
123
124
    """Constructor for Processor

    """
125
    self.context = context
126
    self._cbs = None
127
    self.exclusive_BGL = False
Iustin Pop's avatar
Iustin Pop committed
128
    self.rpc = rpc.RpcRunner(context.cfg)
129
    self.hmclass = HooksMaster
Iustin Pop's avatar
Iustin Pop committed
130

131
132
133
134
135
136
  def _ExecLU(self, lu):
    """Logical Unit execution sequence.

    """
    write_count = self.context.cfg.write_count
    lu.CheckPrereq()
137
    hm = HooksMaster(self.rpc.call_hooks_runner, lu)
138
139
    h_results = hm.RunPhase(constants.HOOKS_PHASE_PRE)
    lu.HooksCallBack(constants.HOOKS_PHASE_PRE, h_results,
140
                     self._Feedback, None)
141
142
143
144
145
146
147
148
149

    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

150
    try:
151
      result = lu.Exec(self._Feedback)
152
153
      h_results = hm.RunPhase(constants.HOOKS_PHASE_POST)
      result = lu.HooksCallBack(constants.HOOKS_PHASE_POST, h_results,
154
                                self._Feedback, result)
155
156
157
158
159
160
161
    finally:
      # FIXME: This needs locks if not lu_class.REQ_BGL
      if write_count != self.context.cfg.write_count:
        hm.RunConfigUpdate()

    return result

162
163
164
165
166
167
168
169
  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.

    """
170
171
    adding_locks = level in lu.add_locks
    acquiring_locks = level in lu.needed_locks
172
    if level not in locking.LEVELS:
173
174
175
      if self._cbs:
        self._cbs.NotifyStart()

176
      result = self._ExecLU(lu)
177
178
179
180
181
182
    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
183
      lu.DeclareLocks(level)
Guido Trotter's avatar
Guido Trotter committed
184
      share = lu.share_locks[level]
185
186
187
188
189
190
191
192
193
194
195
196
      if acquiring_locks:
        needed_locks = lu.needed_locks[level]
        lu.acquired_locks[level] = self.context.glm.acquire(level,
                                                            needed_locks,
                                                            shared=share)
      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
197
            "Couldn't add locks (%s), probably because of a race condition"
198
            " with another job, who added them first" % add_locks)
199
      try:
200
201
202
203
204
205
206
        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])
207
      finally:
208
        if self.context.glm.is_owned(level):
209
210
          self.context.glm.release(level)
    else:
211
      result = self._LockAndExecLU(lu, level + 1)
212
213
214

    return result

215
  def ExecOpCode(self, op, cbs):
Iustin Pop's avatar
Iustin Pop committed
216
217
    """Execute an opcode.

Iustin Pop's avatar
Iustin Pop committed
218
219
    @type op: an OpCode instance
    @param op: the opcode to be executed
220
221
    @type cbs: L{OpExecCbBase}
    @param cbs: Runtime callbacks
Iustin Pop's avatar
Iustin Pop committed
222
223
224

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

228
    self._cbs = cbs
229
    try:
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
      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.
      self.context.glm.acquire(locking.LEVEL_CLUSTER, [locking.BGL],
                               shared=not lu_class.REQ_BGL)
      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
248
    finally:
249
      self._cbs = None
250

Iustin Pop's avatar
Iustin Pop committed
251
252
    return result

253
254
255
256
257
258
259
  def _Feedback(self, *args):
    """Forward call to feedback callback function.

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

260
261
262
263
  def LogStep(self, current, total, message):
    """Log a change in LU execution progress.

    """
264
    logging.debug("Step %d/%d %s", current, total, message)
265
    self._Feedback("STEP %d/%d %s" % (current, total, message))
266

267
  def LogWarning(self, message, *args, **kwargs):
268
269
    """Log a warning to the logs and the user.

270
271
272
273
    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.
274

275
276
277
278
279
280
281
    """
    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)
282
      self._Feedback(" - WARNING: %s" % message)
283
    if "hint" in kwargs:
284
      self._Feedback("      Hint: %s" % kwargs["hint"])
285
286

  def LogInfo(self, message, *args):
287
288
289
    """Log an informational message to the logs and the user.

    """
290
291
    if args:
      message = message % tuple(args)
292
    logging.info(message)
293
    self._Feedback(" - INFO: %s" % message)
294

Iustin Pop's avatar
Iustin Pop committed
295
296
297
298
299
300
301
302
303
304
305
306
307

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.

  """
308
  def __init__(self, callfn, lu):
Iustin Pop's avatar
Iustin Pop committed
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
    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,
328
      "GANETI_DATA_DIR": constants.DATA_DIR,
Iustin Pop's avatar
Iustin Pop committed
329
330
      }

331
332
333
334
335
336
337
    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
338

339
340
341
342
343
344
345
346
347
348
349
    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
350
351
352
    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
353

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

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

358
  def RunPhase(self, phase, nodes=None):
Iustin Pop's avatar
Iustin Pop committed
359
360
361
362
    """Run all the scripts for a phase.

    This is the main function of the HookMaster.

Iustin Pop's avatar
Iustin Pop committed
363
364
    @param phase: one of L{constants.HOOKS_PHASE_POST} or
        L{constants.HOOKS_PHASE_PRE}; it denotes the hooks phase
365
    @param nodes: overrides the predefined list of nodes for the given phase
Iustin Pop's avatar
Iustin Pop committed
366
367
    @return: the processed results of the hooks multi-node rpc call
    @raise errors.HooksFailure: on communication failure to the nodes
368
    @raise errors.HooksAbort: on failure of one of the hooks
369

Iustin Pop's avatar
Iustin Pop committed
370
    """
371
    if not self.node_list[phase] and not nodes:
372
373
374
      # 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
375
      return
376
    hpath = self.lu.HPATH
377
378
379
380
    if nodes is not None:
      results = self._RunWrapper(nodes, hpath, phase)
    else:
      results = self._RunWrapper(self.node_list[phase], hpath, phase)
381
382
383
384
385
386
387
    errs = []
    if not results:
      msg = "Communication Failure"
      if phase == constants.HOOKS_PHASE_PRE:
        raise errors.HooksFailure(msg)
      else:
        self.lu.LogWarning(msg)
388
        return results
389
390
391
392
393
394
395
396
397
398
399
400
    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
401
            errs.append((node_name, script, output))
402
403
          else:
            if not output:
404
              output = "(no output)"
405
406
407
408
            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)
409
    return results
410
411
412
413
414
415
416
417
418
419

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