mcpu.py 13 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,
Iustin Pop's avatar
Iustin Pop committed
52
53
54
    # node lu
    opcodes.OpAddNode: cmdlib.LUAddNode,
    opcodes.OpQueryNodes: cmdlib.LUQueryNodes,
55
    opcodes.OpQueryNodeVolumes: cmdlib.LUQueryNodeVolumes,
Iustin Pop's avatar
Iustin Pop committed
56
    opcodes.OpRemoveNode: cmdlib.LURemoveNode,
Iustin Pop's avatar
Iustin Pop committed
57
    opcodes.OpSetNodeParams: cmdlib.LUSetNodeParams,
Iustin Pop's avatar
Iustin Pop committed
58
59
    # instance lu
    opcodes.OpCreateInstance: cmdlib.LUCreateInstance,
60
    opcodes.OpReinstallInstance: cmdlib.LUReinstallInstance,
Iustin Pop's avatar
Iustin Pop committed
61
    opcodes.OpRemoveInstance: cmdlib.LURemoveInstance,
62
    opcodes.OpRenameInstance: cmdlib.LURenameInstance,
Iustin Pop's avatar
Iustin Pop committed
63
64
65
    opcodes.OpActivateInstanceDisks: cmdlib.LUActivateInstanceDisks,
    opcodes.OpShutdownInstance: cmdlib.LUShutdownInstance,
    opcodes.OpStartupInstance: cmdlib.LUStartupInstance,
66
    opcodes.OpRebootInstance: cmdlib.LURebootInstance,
Iustin Pop's avatar
Iustin Pop committed
67
68
69
70
71
72
    opcodes.OpDeactivateInstanceDisks: cmdlib.LUDeactivateInstanceDisks,
    opcodes.OpReplaceDisks: cmdlib.LUReplaceDisks,
    opcodes.OpFailoverInstance: cmdlib.LUFailoverInstance,
    opcodes.OpConnectConsole: cmdlib.LUConnectConsole,
    opcodes.OpQueryInstances: cmdlib.LUQueryInstances,
    opcodes.OpQueryInstanceData: cmdlib.LUQueryInstanceData,
73
    opcodes.OpSetInstanceParams: cmdlib.LUSetInstanceParams,
Iustin Pop's avatar
Iustin Pop committed
74
    opcodes.OpGrowDisk: cmdlib.LUGrowDisk,
Iustin Pop's avatar
Iustin Pop committed
75
76
77
78
79
    # os lu
    opcodes.OpDiagnoseOS: cmdlib.LUDiagnoseOS,
    # exports lu
    opcodes.OpQueryExports: cmdlib.LUQueryExports,
    opcodes.OpExportInstance: cmdlib.LUExportInstance,
80
    opcodes.OpRemoveExport: cmdlib.LURemoveExport,
81
82
    # tags lu
    opcodes.OpGetTags: cmdlib.LUGetTags,
Iustin Pop's avatar
Iustin Pop committed
83
    opcodes.OpSearchTags: cmdlib.LUSearchTags,
84
85
    opcodes.OpAddTags: cmdlib.LUAddTags,
    opcodes.OpDelTags: cmdlib.LUDelTags,
86
87
    # test lu
    opcodes.OpTestDelay: cmdlib.LUTestDelay,
88
    opcodes.OpTestAllocator: cmdlib.LUTestAllocator,
Iustin Pop's avatar
Iustin Pop committed
89
90
    }

91
  def __init__(self, context):
Iustin Pop's avatar
Iustin Pop committed
92
93
    """Constructor for Processor

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

103
104
105
106
107
108
  def _ExecLU(self, lu):
    """Logical Unit execution sequence.

    """
    write_count = self.context.cfg.write_count
    lu.CheckPrereq()
Iustin Pop's avatar
Iustin Pop committed
109
    hm = HooksMaster(self.rpc.call_hooks_runner, self, lu)
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
    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

125
126
127
128
129
130
131
132
  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.

    """
133
134
    adding_locks = level in lu.add_locks
    acquiring_locks = level in lu.needed_locks
135
    if level not in locking.LEVELS:
Iustin Pop's avatar
Iustin Pop committed
136
137
      if callable(self._run_notifier):
        self._run_notifier()
138
      result = self._ExecLU(lu)
139
140
141
142
143
144
    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
145
      lu.DeclareLocks(level)
Guido Trotter's avatar
Guido Trotter committed
146
      share = lu.share_locks[level]
147
148
149
150
151
152
153
154
155
156
157
158
159
160
      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)
161
      try:
162
163
164
165
166
167
168
        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])
169
      finally:
170
        if self.context.glm.is_owned(level):
171
172
          self.context.glm.release(level)
    else:
173
      result = self._LockAndExecLU(lu, level + 1)
174
175
176

    return result

Iustin Pop's avatar
Iustin Pop committed
177
  def ExecOpCode(self, op, feedback_fn, run_notifier):
Iustin Pop's avatar
Iustin Pop committed
178
179
    """Execute an opcode.

Iustin Pop's avatar
Iustin Pop committed
180
181
182
183
184
185
186
187
188
    @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
189
190
191

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

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

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

Iustin Pop's avatar
Iustin Pop committed
215
216
    return result

217
218
219
220
  def LogStep(self, current, total, message):
    """Log a change in LU execution progress.

    """
221
    logging.debug("Step %d/%d %s", current, total, message)
222
223
    self._feedback_fn("STEP %d/%d %s" % (current, total, message))

224
  def LogWarning(self, message, *args, **kwargs):
225
226
    """Log a warning to the logs and the user.

227
228
229
230
    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.
231

232
233
234
235
236
237
238
239
240
241
242
243
    """
    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):
244
245
246
    """Log an informational message to the logs and the user.

    """
247
248
    if args:
      message = message % tuple(args)
249
    logging.info(message)
250
251
    self._feedback_fn(" - INFO: %s" % message)

Iustin Pop's avatar
Iustin Pop committed
252
253
254
255
256
257
258
259
260
261
262
263
264

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.

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

289
290
291
292
293
294
295
    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
296

297
298
299
300
301
302
303
304
305
306
307
    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
308
309
310
    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
311

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

314
    return self.callfn(node_list, hpath, phase, env)
Iustin Pop's avatar
Iustin Pop committed
315
316
317
318
319
320

  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
321
322
323
324
    @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
325

Iustin Pop's avatar
Iustin Pop committed
326
327
    """
    if not self.node_list[phase]:
328
329
330
      # 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
331
      return
332
333
    hpath = self.lu.HPATH
    results = self._RunWrapper(self.node_list[phase], hpath, phase)
Iustin Pop's avatar
Iustin Pop committed
334
335
336
    if phase == constants.HOOKS_PHASE_PRE:
      errs = []
      if not results:
337
        raise errors.HooksFailure("Communication failure")
Iustin Pop's avatar
Iustin Pop committed
338
339
      for node_name in results:
        res = results[node_name]
340
        if res.failed or res.data is False or not isinstance(res.data, list):
341
342
          self.proc.LogWarning("Communication failure to node %s" % node_name)
          continue
343
        for script, hkr, output in res.data:
Iustin Pop's avatar
Iustin Pop committed
344
345
346
347
          if hkr == constants.HKR_FAIL:
            output = output.strip().encode("string_escape")
            errs.append((node_name, script, output))
      if errs:
348
        raise errors.HooksAbort(errs)
349
    return results
350
351
352
353
354
355
356
357
358
359

  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
360
    nodes = [self.lu.cfg.GetMasterNode()]
361
    results = self._RunWrapper(nodes, hpath, phase)