mcpu.py 12.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
31
32
33
34
35
36
37
#

# 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

"""


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

41

Iustin Pop's avatar
Iustin Pop committed
42
43
44
45
46
47
48
49
class Processor(object):
  """Object which runs OpCodes"""
  DISPATCH_TABLE = {
    # Cluster
    opcodes.OpDestroyCluster: cmdlib.LUDestroyCluster,
    opcodes.OpQueryClusterInfo: cmdlib.LUQueryClusterInfo,
    opcodes.OpVerifyCluster: cmdlib.LUVerifyCluster,
    opcodes.OpDumpClusterConfig: cmdlib.LUDumpClusterConfig,
50
    opcodes.OpRenameCluster: cmdlib.LURenameCluster,
51
    opcodes.OpVerifyDisks: cmdlib.LUVerifyDisks,
52
    opcodes.OpSetClusterParams: cmdlib.LUSetClusterParams,
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
58
59
    opcodes.OpRemoveNode: cmdlib.LURemoveNode,
    # 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

102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
  def _ExecLU(self, lu):
    """Logical Unit execution sequence.

    """
    write_count = self.context.cfg.write_count
    lu.CheckPrereq()
    hm = HooksMaster(rpc.call_hooks_runner, self, lu)
    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

124
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.

    """
    if level in lu.needed_locks:
Guido Trotter's avatar
Guido Trotter committed
133
134
135
      # This gives a chance to LUs to make last-minute changes after acquiring
      # locks at any preceding level.
      lu.DeclareLocks(level)
Guido Trotter's avatar
Guido Trotter committed
136
137
      needed_locks = lu.needed_locks[level]
      share = lu.share_locks[level]
138
139
140
      # This is always safe to do, as we can't acquire more/less locks than
      # what was requested.
      lu.needed_locks[level] = self.context.glm.acquire(level,
Guido Trotter's avatar
Guido Trotter committed
141
142
                                                        needed_locks,
                                                        shared=share)
143
144
145
146
147
148
149
150
151
152
      try:
        result = self._LockAndExecLU(lu, level + 1)
      finally:
        if lu.needed_locks[level]:
          self.context.glm.release(level)
    else:
      result = self._ExecLU(lu)

    return result

153
  def ExecOpCode(self, op, feedback_fn):
Iustin Pop's avatar
Iustin Pop committed
154
155
156
    """Execute an opcode.

    Args:
157
      op: the opcode to be executed
Iustin Pop's avatar
Iustin Pop committed
158
159
160

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

164
    self._feedback_fn = feedback_fn
Iustin Pop's avatar
Iustin Pop committed
165
166
    lu_class = self.DISPATCH_TABLE.get(op.__class__, None)
    if lu_class is None:
167
      raise errors.OpCodeUnknown("Unknown opcode")
Iustin Pop's avatar
Iustin Pop committed
168

169
170
171
172
173
    if lu_class.REQ_WSSTORE:
      sstore = ssconf.WritableSimpleStore()
    else:
      sstore = ssconf.SimpleStore()

174
175
    # 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
176
    self.context.glm.acquire(locking.LEVEL_CLUSTER, [locking.BGL],
177
                             shared=not lu_class.REQ_BGL)
178
    try:
179
      self.exclusive_BGL = lu_class.REQ_BGL
Guido Trotter's avatar
Guido Trotter committed
180
      lu = lu_class(self, op, self.context, sstore)
181
      lu.ExpandNames()
182
      assert lu.needed_locks is not None, "needed_locks not set by LU"
183
      result = self._LockAndExecLU(lu, locking.LEVEL_INSTANCE)
184
    finally:
Guido Trotter's avatar
Guido Trotter committed
185
      self.context.glm.release(locking.LEVEL_CLUSTER)
186
      self.exclusive_BGL = False
187

Iustin Pop's avatar
Iustin Pop committed
188
189
    return result

190
  def ChainOpCode(self, op):
Iustin Pop's avatar
Iustin Pop committed
191
192
193
194
195
196
197
198
199
    """Chain and execute an opcode.

    This is used by LUs when they need to execute a child LU.

    Args:
     - opcode: the opcode to be executed

    """
    if not isinstance(op, opcodes.OpCode):
200
201
      raise errors.ProgrammerError("Non-opcode instance passed"
                                   " to ExecOpcode")
Iustin Pop's avatar
Iustin Pop committed
202
203
204

    lu_class = self.DISPATCH_TABLE.get(op.__class__, None)
    if lu_class is None:
205
      raise errors.OpCodeUnknown("Unknown opcode")
Iustin Pop's avatar
Iustin Pop committed
206

207
208
209
210
    if lu_class.REQ_BGL and not self.exclusive_BGL:
      raise errors.ProgrammerError("LUs which require the BGL cannot"
                                   " be chained to granular ones.")

211
212
213
214
215
    if lu_class.REQ_WSSTORE:
      sstore = ssconf.WritableSimpleStore()
    else:
      sstore = ssconf.SimpleStore()

216
    #do_hooks = lu_class.HPATH is not None
Guido Trotter's avatar
Guido Trotter committed
217
    lu = lu_class(self, op, self.context, sstore)
Iustin Pop's avatar
Iustin Pop committed
218
219
    lu.CheckPrereq()
    #if do_hooks:
220
    #  hm = HooksMaster(rpc.call_hooks_runner, self, lu)
221
222
223
    #  h_results = hm.RunPhase(constants.HOOKS_PHASE_PRE)
    #  lu.HooksCallBack(constants.HOOKS_PHASE_PRE,
    #                   h_results, self._feedback_fn, None)
224
    result = lu.Exec(self._feedback_fn)
Iustin Pop's avatar
Iustin Pop committed
225
    #if do_hooks:
226
227
228
    #  h_results = hm.RunPhase(constants.HOOKS_PHASE_POST)
    #  result = lu.HooksCallBack(constants.HOOKS_PHASE_POST,
    #                   h_results, self._feedback_fn, result)
Iustin Pop's avatar
Iustin Pop committed
229
230
    return result

231
232
233
234
235
236
237
  def LogStep(self, current, total, message):
    """Log a change in LU execution progress.

    """
    logger.Debug("Step %d/%d %s" % (current, total, message))
    self._feedback_fn("STEP %d/%d %s" % (current, total, message))

Iustin Pop's avatar
Iustin Pop committed
238
  def LogWarning(self, message, hint=None):
239
240
241
242
243
    """Log a warning to the logs and the user.

    """
    logger.Error(message)
    self._feedback_fn(" - WARNING: %s" % message)
Iustin Pop's avatar
Iustin Pop committed
244
245
    if hint:
      self._feedback_fn("      Hint: %s" % hint)
246
247
248
249
250
251
252
253

  def LogInfo(self, message):
    """Log an informational message to the logs and the user.

    """
    logger.Info(message)
    self._feedback_fn(" - INFO: %s" % message)

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

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.

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

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

299
300
301
302
303
304
305
306
307
308
309
    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
310
311
312
    if self.lu.sstore is not None:
      env["GANETI_CLUSTER"] = self.lu.sstore.GetClusterName()
      env["GANETI_MASTER"] = self.lu.sstore.GetMasterNode()
Iustin Pop's avatar
Iustin Pop committed
313

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

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

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

    This is the main function of the HookMaster.

323
324
325
326
327
328
    Args:
      phase: the hooks phase to run

    Returns:
      the result of the hooks multi-node rpc call

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
343
      for node_name in results:
        res = results[node_name]
        if res is False or not isinstance(res, list):
344
345
          self.proc.LogWarning("Communication failure to node %s" % node_name)
          continue
Iustin Pop's avatar
Iustin Pop committed
346
347
348
349
350
        for script, hkr, output in res:
          if hkr == constants.HKR_FAIL:
            output = output.strip().encode("string_escape")
            errs.append((node_name, script, output))
      if errs:
351
        raise errors.HooksAbort(errs)
352
    return results
353
354
355
356
357
358
359
360
361
362
363
364
365
366

  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
    if self.lu.sstore is None:
      raise errors.ProgrammerError("Null sstore on config update hook")
    nodes = [self.lu.sstore.GetMasterNode()]
    results = self._RunWrapper(nodes, hpath, phase)