mcpu.py 13.1 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

Iustin Pop's avatar
Iustin Pop committed
41
42
43
44
45
46
47
class Processor(object):
  """Object which runs OpCodes"""
  DISPATCH_TABLE = {
    # Cluster
    opcodes.OpDestroyCluster: cmdlib.LUDestroyCluster,
    opcodes.OpQueryClusterInfo: cmdlib.LUQueryClusterInfo,
    opcodes.OpVerifyCluster: cmdlib.LUVerifyCluster,
48
    opcodes.OpQueryConfigValues: cmdlib.LUQueryConfigValues,
49
    opcodes.OpRenameCluster: cmdlib.LURenameCluster,
50
    opcodes.OpVerifyDisks: cmdlib.LUVerifyDisks,
51
    opcodes.OpSetClusterParams: cmdlib.LUSetClusterParams,
52
    opcodes.OpRedistributeConfig: cmdlib.LURedistributeConfig,
Iustin Pop's avatar
Iustin Pop committed
53
54
55
    # node lu
    opcodes.OpAddNode: cmdlib.LUAddNode,
    opcodes.OpQueryNodes: cmdlib.LUQueryNodes,
56
    opcodes.OpQueryNodeVolumes: cmdlib.LUQueryNodeVolumes,
Iustin Pop's avatar
Iustin Pop committed
57
    opcodes.OpRemoveNode: cmdlib.LURemoveNode,
Iustin Pop's avatar
Iustin Pop committed
58
    opcodes.OpSetNodeParams: cmdlib.LUSetNodeParams,
Iustin Pop's avatar
Iustin Pop committed
59
    opcodes.OpPowercycleNode: cmdlib.LUPowercycleNode,
Iustin Pop's avatar
Iustin Pop committed
60
61
    # instance lu
    opcodes.OpCreateInstance: cmdlib.LUCreateInstance,
62
    opcodes.OpReinstallInstance: cmdlib.LUReinstallInstance,
Iustin Pop's avatar
Iustin Pop committed
63
    opcodes.OpRemoveInstance: cmdlib.LURemoveInstance,
64
    opcodes.OpRenameInstance: cmdlib.LURenameInstance,
Iustin Pop's avatar
Iustin Pop committed
65
66
67
    opcodes.OpActivateInstanceDisks: cmdlib.LUActivateInstanceDisks,
    opcodes.OpShutdownInstance: cmdlib.LUShutdownInstance,
    opcodes.OpStartupInstance: cmdlib.LUStartupInstance,
68
    opcodes.OpRebootInstance: cmdlib.LURebootInstance,
Iustin Pop's avatar
Iustin Pop committed
69
70
71
    opcodes.OpDeactivateInstanceDisks: cmdlib.LUDeactivateInstanceDisks,
    opcodes.OpReplaceDisks: cmdlib.LUReplaceDisks,
    opcodes.OpFailoverInstance: cmdlib.LUFailoverInstance,
72
    opcodes.OpMigrateInstance: cmdlib.LUMigrateInstance,
Iustin Pop's avatar
Iustin Pop committed
73
74
75
    opcodes.OpConnectConsole: cmdlib.LUConnectConsole,
    opcodes.OpQueryInstances: cmdlib.LUQueryInstances,
    opcodes.OpQueryInstanceData: cmdlib.LUQueryInstanceData,
76
    opcodes.OpSetInstanceParams: cmdlib.LUSetInstanceParams,
Iustin Pop's avatar
Iustin Pop committed
77
    opcodes.OpGrowDisk: cmdlib.LUGrowDisk,
Iustin Pop's avatar
Iustin Pop committed
78
79
80
81
82
    # os lu
    opcodes.OpDiagnoseOS: cmdlib.LUDiagnoseOS,
    # exports lu
    opcodes.OpQueryExports: cmdlib.LUQueryExports,
    opcodes.OpExportInstance: cmdlib.LUExportInstance,
83
    opcodes.OpRemoveExport: cmdlib.LURemoveExport,
84
85
    # tags lu
    opcodes.OpGetTags: cmdlib.LUGetTags,
Iustin Pop's avatar
Iustin Pop committed
86
    opcodes.OpSearchTags: cmdlib.LUSearchTags,
87
88
    opcodes.OpAddTags: cmdlib.LUAddTags,
    opcodes.OpDelTags: cmdlib.LUDelTags,
89
90
    # test lu
    opcodes.OpTestDelay: cmdlib.LUTestDelay,
91
    opcodes.OpTestAllocator: cmdlib.LUTestAllocator,
Iustin Pop's avatar
Iustin Pop committed
92
93
    }

94
  def __init__(self, context):
Iustin Pop's avatar
Iustin Pop committed
95
96
    """Constructor for Processor

97
98
99
    Args:
     - feedback_fn: the feedback function (taking one string) to be run when
                    interesting events are happening
Iustin Pop's avatar
Iustin Pop committed
100
    """
101
    self.context = context
102
    self._feedback_fn = None
103
    self.exclusive_BGL = False
Iustin Pop's avatar
Iustin Pop committed
104
    self.rpc = rpc.RpcRunner(context.cfg)
Iustin Pop's avatar
Iustin Pop committed
105

106
107
108
109
110
111
  def _ExecLU(self, lu):
    """Logical Unit execution sequence.

    """
    write_count = self.context.cfg.write_count
    lu.CheckPrereq()
Iustin Pop's avatar
Iustin Pop committed
112
    hm = HooksMaster(self.rpc.call_hooks_runner, self, lu)
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
    h_results = hm.RunPhase(constants.HOOKS_PHASE_PRE)
    lu.HooksCallBack(constants.HOOKS_PHASE_PRE, h_results,
                     self._feedback_fn, None)
    try:
      result = lu.Exec(self._feedback_fn)
      h_results = hm.RunPhase(constants.HOOKS_PHASE_POST)
      result = lu.HooksCallBack(constants.HOOKS_PHASE_POST, h_results,
                                self._feedback_fn, result)
    finally:
      # FIXME: This needs locks if not lu_class.REQ_BGL
      if write_count != self.context.cfg.write_count:
        hm.RunConfigUpdate()

    return result

128
129
130
131
132
133
134
135
  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.

    """
136
137
    adding_locks = level in lu.add_locks
    acquiring_locks = level in lu.needed_locks
138
    if level not in locking.LEVELS:
Iustin Pop's avatar
Iustin Pop committed
139
140
      if callable(self._run_notifier):
        self._run_notifier()
141
      result = self._ExecLU(lu)
142
143
144
145
146
147
    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
148
      lu.DeclareLocks(level)
Guido Trotter's avatar
Guido Trotter committed
149
      share = lu.share_locks[level]
150
151
152
153
154
155
156
157
158
159
160
161
162
163
      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(
            "Coudn't add locks (%s), probably because of a race condition"
            " with another job, who added them first" % add_locks)
164
      try:
165
166
167
168
169
170
171
        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])
172
      finally:
173
        if self.context.glm.is_owned(level):
174
175
          self.context.glm.release(level)
    else:
176
      result = self._LockAndExecLU(lu, level + 1)
177
178
179

    return result

Iustin Pop's avatar
Iustin Pop committed
180
  def ExecOpCode(self, op, feedback_fn, run_notifier):
Iustin Pop's avatar
Iustin Pop committed
181
182
    """Execute an opcode.

Iustin Pop's avatar
Iustin Pop committed
183
184
185
186
187
188
189
190
191
    @type op: an OpCode instance
    @param op: the opcode to be executed
    @type feedback_fn: a function that takes a single argument
    @param feedback_fn: this function will be used as feedback from the LU
                        code to the end-user
    @type run_notifier: callable (no arguments) or None
    @param run_notifier:  this function (if callable) will be called when
                          we are about to call the lu's Exec() method, that
                          is, after we have aquired all locks
Iustin Pop's avatar
Iustin Pop committed
192
193
194

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

198
    self._feedback_fn = feedback_fn
Iustin Pop's avatar
Iustin Pop committed
199
    self._run_notifier = run_notifier
Iustin Pop's avatar
Iustin Pop committed
200
201
    lu_class = self.DISPATCH_TABLE.get(op.__class__, None)
    if lu_class is None:
202
      raise errors.OpCodeUnknown("Unknown opcode")
Iustin Pop's avatar
Iustin Pop committed
203

204
205
    # 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.
Guido Trotter's avatar
Guido Trotter committed
206
    self.context.glm.acquire(locking.LEVEL_CLUSTER, [locking.BGL],
207
                             shared=not lu_class.REQ_BGL)
208
    try:
209
      self.exclusive_BGL = lu_class.REQ_BGL
Iustin Pop's avatar
Iustin Pop committed
210
      lu = lu_class(self, op, self.context, self.rpc)
211
      lu.ExpandNames()
212
      assert lu.needed_locks is not None, "needed_locks not set by LU"
213
      result = self._LockAndExecLU(lu, locking.LEVEL_INSTANCE)
214
    finally:
Guido Trotter's avatar
Guido Trotter committed
215
      self.context.glm.release(locking.LEVEL_CLUSTER)
216
      self.exclusive_BGL = False
217

Iustin Pop's avatar
Iustin Pop committed
218
219
    return result

220
221
222
223
  def LogStep(self, current, total, message):
    """Log a change in LU execution progress.

    """
224
    logging.debug("Step %d/%d %s", current, total, message)
225
226
    self._feedback_fn("STEP %d/%d %s" % (current, total, message))

227
  def LogWarning(self, message, *args, **kwargs):
228
229
    """Log a warning to the logs and the user.

230
231
232
233
    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.
234

235
236
237
238
239
240
241
242
243
244
245
246
    """
    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)
      self._feedback_fn(" - WARNING: %s" % message)
    if "hint" in kwargs:
      self._feedback_fn("      Hint: %s" % kwargs["hint"])

  def LogInfo(self, message, *args):
247
248
249
    """Log an informational message to the logs and the user.

    """
250
251
    if args:
      message = message % tuple(args)
252
    logging.info(message)
253
254
    self._feedback_fn(" - INFO: %s" % message)

Iustin Pop's avatar
Iustin Pop committed
255
256
257
258
259
260
261
262
263
264
265
266
267

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.

  """
268
  def __init__(self, callfn, proc, lu):
Iustin Pop's avatar
Iustin Pop committed
269
    self.callfn = callfn
270
    self.proc = proc
Iustin Pop's avatar
Iustin Pop committed
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
    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,
289
      "GANETI_DATA_DIR": constants.DATA_DIR,
Iustin Pop's avatar
Iustin Pop committed
290
291
      }

292
293
294
295
296
297
298
    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
299

300
301
302
303
304
305
306
307
308
309
310
    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
311
312
313
    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
314

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

317
    return self.callfn(node_list, hpath, phase, env)
Iustin Pop's avatar
Iustin Pop committed
318
319
320
321
322
323

  def RunPhase(self, phase):
    """Run all the scripts for a phase.

    This is the main function of the HookMaster.

Iustin Pop's avatar
Iustin Pop committed
324
325
326
327
    @param phase: one of L{constants.HOOKS_PHASE_POST} or
        L{constants.HOOKS_PHASE_PRE}; it denotes the hooks phase
    @return: the processed results of the hooks multi-node rpc call
    @raise errors.HooksFailure: on communication failure to the nodes
328

Iustin Pop's avatar
Iustin Pop committed
329
330
    """
    if not self.node_list[phase]:
331
332
333
      # 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
334
      return
335
336
    hpath = self.lu.HPATH
    results = self._RunWrapper(self.node_list[phase], hpath, phase)
Iustin Pop's avatar
Iustin Pop committed
337
338
339
    if phase == constants.HOOKS_PHASE_PRE:
      errs = []
      if not results:
340
        raise errors.HooksFailure("Communication failure")
Iustin Pop's avatar
Iustin Pop committed
341
342
      for node_name in results:
        res = results[node_name]
343
        if res.offline:
344
          continue
345
346
347
348
349
350
        msg = res.RemoteFailMsg()
        if msg:
          self.proc.LogWarning("Communication failure to node %s: %s",
                               node_name, msg)
          continue
        for script, hkr, output in res.payload:
Iustin Pop's avatar
Iustin Pop committed
351
352
353
          if hkr == constants.HKR_FAIL:
            errs.append((node_name, script, output))
      if errs:
354
        raise errors.HooksAbort(errs)
355
    return results
356
357
358
359
360
361
362
363
364
365

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