mcpu.py 12.2 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
38
#

# 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 config
from ganeti import ssconf
39
from ganeti import logger
40
from ganeti import locking
Iustin Pop's avatar
Iustin Pop committed
41

42

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

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

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

103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
  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

125
126
127
128
129
130
131
132
133
  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
134
135
136
      # This gives a chance to LUs to make last-minute changes after acquiring
      # locks at any preceding level.
      lu.DeclareLocks(level)
137
138
139
140
141
142
143
144
145
146
147
148
149
150
      # 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,
                                                        lu.needed_locks[level])
      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

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

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

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

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

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

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

Iustin Pop's avatar
Iustin Pop committed
186
187
    return result

188
  def ChainOpCode(self, op):
Iustin Pop's avatar
Iustin Pop committed
189
190
191
192
193
194
195
196
197
    """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):
198
199
      raise errors.ProgrammerError("Non-opcode instance passed"
                                   " to ExecOpcode")
Iustin Pop's avatar
Iustin Pop committed
200
201
202

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

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

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

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

229
230
231
232
233
234
235
  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
236
  def LogWarning(self, message, hint=None):
237
238
239
240
241
    """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
242
243
    if hint:
      self._feedback_fn("      Hint: %s" % hint)
244
245
246
247
248
249
250
251

  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
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
308
309
310
    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
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.

321
322
323
324
325
326
    Args:
      phase: the hooks phase to run

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

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

  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)