opcodes.py 13.7 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
#

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


"""OpCodes module

This module implements the data structures which define the cluster
operations - the so-called opcodes.

Iustin Pop's avatar
Iustin Pop committed
27
28
Every operation which modifies the cluster state is expressed via
opcodes.
Iustin Pop's avatar
Iustin Pop committed
29
30
31
32
33
34
35

"""

# this are practically structures, so disable the message about too
# few public methods:
# pylint: disable-msg=R0903

36

Iustin Pop's avatar
Iustin Pop committed
37
class BaseOpCode(object):
38
39
  """A simple serializable object.

Iustin Pop's avatar
Iustin Pop committed
40
41
42
  This object serves as a parent class for OpCode without any custom
  field handling.

43
  """
Iustin Pop's avatar
Iustin Pop committed
44
45
46
  __slots__ = []

  def __init__(self, **kwargs):
Iustin Pop's avatar
Iustin Pop committed
47
48
49
50
51
52
53
54
    """Constructor for BaseOpCode.

    The constructor takes only keyword arguments and will set
    attributes on this object based on the passed arguments. As such,
    it means that you should not pass arguments which are not in the
    __slots__ attribute for this class.

    """
Iustin Pop's avatar
Iustin Pop committed
55
56
    for key in kwargs:
      if key not in self.__slots__:
57
        raise TypeError("Object %s doesn't support the parameter '%s'" %
58
                        (self.__class__.__name__, key))
Iustin Pop's avatar
Iustin Pop committed
59
60
      setattr(self, key, kwargs[key])

61
  def __getstate__(self):
Iustin Pop's avatar
Iustin Pop committed
62
63
64
65
66
67
68
69
70
    """Generic serializer.

    This method just returns the contents of the instance as a
    dictionary.

    @rtype:  C{dict}
    @return: the instance attributes and their values

    """
71
72
73
74
75
76
77
    state = {}
    for name in self.__slots__:
      if hasattr(self, name):
        state[name] = getattr(self, name)
    return state

  def __setstate__(self, state):
Iustin Pop's avatar
Iustin Pop committed
78
79
80
81
82
83
84
85
86
    """Generic unserializer.

    This method just restores from the serialized state the attributes
    of the current instance.

    @param state: the serialized opcode data
    @type state:  C{dict}

    """
87
88
89
90
91
92
93
94
95
96
97
98
    if not isinstance(state, dict):
      raise ValueError("Invalid data to __setstate__: expected dict, got %s" %
                       type(state))

    for name in self.__slots__:
      if name not in state:
        delattr(self, name)

    for name in state:
      setattr(self, name, state[name])


Iustin Pop's avatar
Iustin Pop committed
99
class OpCode(BaseOpCode):
Iustin Pop's avatar
Iustin Pop committed
100
101
102
103
104
105
106
107
108
  """Abstract OpCode.

  This is the root of the actual OpCode hierarchy. All clases derived
  from this class should override OP_ID.

  @cvar OP_ID: The ID of this opcode. This should be unique amongst all
               childre of this class.

  """
109
110
111
112
113
114
  OP_ID = "OP_ABSTRACT"
  __slots__ = []

  def __getstate__(self):
    """Specialized getstate for opcodes.

Iustin Pop's avatar
Iustin Pop committed
115
116
117
118
119
120
121
    This method adds to the state dictionary the OP_ID of the class,
    so that on unload we can identify the correct class for
    instantiating the opcode.

    @rtype:   C{dict}
    @return:  the state as a dictionary

122
    """
Iustin Pop's avatar
Iustin Pop committed
123
    data = BaseOpCode.__getstate__(self)
124
125
126
127
    data["OP_ID"] = self.OP_ID
    return data

  @classmethod
128
  def LoadOpCode(cls, data):
129
130
    """Generic load opcode method.

Iustin Pop's avatar
Iustin Pop committed
131
132
133
134
135
136
137
    The method identifies the correct opcode class from the dict-form
    by looking for a OP_ID key, if this is not found, or its value is
    not available in this module as a child of this class, we fail.

    @type data:  C{dict}
    @param data: the serialized opcode

138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
    """
    if not isinstance(data, dict):
      raise ValueError("Invalid data to LoadOpCode (%s)" % type(data))
    if "OP_ID" not in data:
      raise ValueError("Invalid data to LoadOpcode, missing OP_ID")
    op_id = data["OP_ID"]
    op_class = None
    for item in globals().values():
      if (isinstance(item, type) and
          issubclass(item, cls) and
          hasattr(item, "OP_ID") and
          getattr(item, "OP_ID") == op_id):
        op_class = item
        break
    if op_class is None:
      raise ValueError("Invalid data to LoadOpCode: OP_ID %s unsupported" %
                       op_id)
    op = op_class()
    new_data = data.copy()
    del new_data["OP_ID"]
    op.__setstate__(new_data)
    return op

Iustin Pop's avatar
Iustin Pop committed
161
162

class OpDestroyCluster(OpCode):
Iustin Pop's avatar
Iustin Pop committed
163
164
165
166
167
168
  """Destroy the cluster.

  This opcode has no other parameters. All the state is irreversibly
  lost after the execution of this opcode.

  """
Iustin Pop's avatar
Iustin Pop committed
169
170
171
172
173
  OP_ID = "OP_CLUSTER_DESTROY"
  __slots__ = []


class OpQueryClusterInfo(OpCode):
Iustin Pop's avatar
Iustin Pop committed
174
  """Query cluster information."""
Iustin Pop's avatar
Iustin Pop committed
175
176
177
178
179
  OP_ID = "OP_CLUSTER_QUERY"
  __slots__ = []


class OpVerifyCluster(OpCode):
Iustin Pop's avatar
Iustin Pop committed
180
181
182
183
184
185
186
187
188
  """Verify the cluster state.

  @type skip_checks: C{list}
  @ivar skip_checks: steps to be skipped from the verify process; this
                     needs to be a subset of
                     L{constants.VERIFY_OPTIONAL_CHECKS}; currently
                     only L{constants.VERIFY_NPLUSONE_MEM} can be passed

  """
Iustin Pop's avatar
Iustin Pop committed
189
  OP_ID = "OP_CLUSTER_VERIFY"
190
  __slots__ = ["skip_checks"]
Iustin Pop's avatar
Iustin Pop committed
191
192


Iustin Pop's avatar
Iustin Pop committed
193
194
195
196
197
198
199
class OpVerifyDisks(OpCode):
  """Verify the cluster disks.

  Parameters: none

  Result: two lists:
    - list of node names with bad data returned (unreachable, etc.)
Iustin Pop's avatar
Iustin Pop committed
200
    - dict of node names with broken volume groups (values: error msg)
Iustin Pop's avatar
Iustin Pop committed
201
    - list of instances with degraded disks (that should be activated)
202
203
    - dict of instances with missing logical volumes (values: (node, vol)
      pairs with details about the missing volumes)
Iustin Pop's avatar
Iustin Pop committed
204

205
206
207
208
  In normal operation, all lists should be empty. A non-empty instance
  list (3rd element of the result) is still ok (errors were fixed) but
  non-empty node list means some node is down, and probably there are
  unfixable drbd errors.
Iustin Pop's avatar
Iustin Pop committed
209
210
211
212
213
214
215
216
217

  Note that only instances that are drbd-based are taken into
  consideration. This might need to be revisited in the future.

  """
  OP_ID = "OP_CLUSTER_VERIFY_DISKS"
  __slots__ = []


Iustin Pop's avatar
Iustin Pop committed
218
class OpDumpClusterConfig(OpCode):
Iustin Pop's avatar
Iustin Pop committed
219
  """Dump the cluster configuration."""
Iustin Pop's avatar
Iustin Pop committed
220
221
222
223
  OP_ID = "OP_CLUSTER_DUMPCONFIG"
  __slots__ = []


224
class OpRenameCluster(OpCode):
Iustin Pop's avatar
Iustin Pop committed
225
226
227
228
229
230
231
232
  """Rename the cluster.

  @type name: C{str}
  @ivar name: The new name of the cluster. The name and/or the master IP
              address will be changed to match the new name and its IP
              address.

  """
233
234
235
236
  OP_ID = "OP_CLUSTER_RENAME"
  __slots__ = ["name"]


237
class OpSetClusterParams(OpCode):
Iustin Pop's avatar
Iustin Pop committed
238
239
240
241
242
243
  """Change the parameters of the cluster.

  @type vg_name: C{str} or C{None}
  @ivar vg_name: The new volume group name or None to disable LVM usage.

  """
244
245
246
247
  OP_ID = "OP_CLUSTER_SET_PARAMS"
  __slots__ = ["vg_name"]


248
249
# node opcodes

Iustin Pop's avatar
Iustin Pop committed
250
class OpRemoveNode(OpCode):
Iustin Pop's avatar
Iustin Pop committed
251
252
253
254
255
256
257
  """Remove a node.

  @type node_name: C{str}
  @ivar node_name: The name of the node to remove. If the node still has
                   instances on it, the operation will fail.

  """
Iustin Pop's avatar
Iustin Pop committed
258
259
260
261
262
  OP_ID = "OP_NODE_REMOVE"
  __slots__ = ["node_name"]


class OpAddNode(OpCode):
Iustin Pop's avatar
Iustin Pop committed
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
  """Add a node to the cluster.

  @type node_name: C{str}
  @ivar node_name: The name of the node to add. This can be a short name,
                   but it will be expanded to the FQDN.
  @type primary_ip: IP address
  @ivar primary_ip: The primary IP of the node. This will be ignored when the
                    opcode is submitted, but will be filled during the node
                    add (so it will be visible in the job query).
  @type secondary_ip: IP address
  @ivar secondary_ip: The secondary IP of the node. This needs to be passed
                      if the cluster has been initialized in 'dual-network'
                      mode, otherwise it must not be given.
  @type readd: C{bool}
  @ivar readd: Whether to re-add an existing node to the cluster. If
               this is not passed, then the operation will abort if the node
               name is already in the cluster; use this parameter to 'repair'
               a node that had its configuration broken, or was reinstalled
               without removal from the cluster.

  """
Iustin Pop's avatar
Iustin Pop committed
284
  OP_ID = "OP_NODE_ADD"
285
  __slots__ = ["node_name", "primary_ip", "secondary_ip", "readd"]
Iustin Pop's avatar
Iustin Pop committed
286
287
288
289
290


class OpQueryNodes(OpCode):
  """Compute the list of nodes."""
  OP_ID = "OP_NODE_QUERY"
291
  __slots__ = ["output_fields", "names"]
Iustin Pop's avatar
Iustin Pop committed
292
293


294
295
296
297
298
299
class OpQueryNodeVolumes(OpCode):
  """Get list of volumes on node."""
  OP_ID = "OP_NODE_QUERYVOLS"
  __slots__ = ["nodes", "output_fields"]


Iustin Pop's avatar
Iustin Pop committed
300
301
302
# instance opcodes

class OpCreateInstance(OpCode):
Iustin Pop's avatar
Iustin Pop committed
303
  """Create an instance."""
Iustin Pop's avatar
Iustin Pop committed
304
  OP_ID = "OP_INSTANCE_CREATE"
305
306
307
308
309
  __slots__ = [
    "instance_name", "mem_size", "disk_size", "os_type", "pnode",
    "disk_template", "snode", "swap_size", "mode",
    "vcpus", "ip", "bridge", "src_node", "src_path", "start",
    "wait_for_sync", "ip_check", "mac",
310
311
    "kernel_path", "initrd_path", "hvm_boot_order", "hvm_acpi",
    "hvm_pae", "hvm_cdrom_image_path", "vnc_bind_address",
312
    "file_storage_dir", "file_driver",
313
    "iallocator",
314
    ]
Iustin Pop's avatar
Iustin Pop committed
315
316


317
class OpReinstallInstance(OpCode):
Iustin Pop's avatar
Iustin Pop committed
318
  """Reinstall an instance's OS."""
319
  OP_ID = "OP_INSTANCE_REINSTALL"
320
  __slots__ = ["instance_name", "os_type"]
321
322


Iustin Pop's avatar
Iustin Pop committed
323
324
325
class OpRemoveInstance(OpCode):
  """Remove an instance."""
  OP_ID = "OP_INSTANCE_REMOVE"
Iustin Pop's avatar
Iustin Pop committed
326
  __slots__ = ["instance_name", "ignore_failures"]
Iustin Pop's avatar
Iustin Pop committed
327
328


329
330
331
332
333
334
class OpRenameInstance(OpCode):
  """Rename an instance."""
  OP_ID = "OP_INSTANCE_RENAME"
  __slots__ = ["instance_name", "ignore_ip", "new_name"]


Iustin Pop's avatar
Iustin Pop committed
335
class OpStartupInstance(OpCode):
Iustin Pop's avatar
Iustin Pop committed
336
  """Startup an instance."""
Iustin Pop's avatar
Iustin Pop committed
337
338
339
340
341
  OP_ID = "OP_INSTANCE_STARTUP"
  __slots__ = ["instance_name", "force", "extra_args"]


class OpShutdownInstance(OpCode):
Iustin Pop's avatar
Iustin Pop committed
342
  """Shutdown an instance."""
Iustin Pop's avatar
Iustin Pop committed
343
344
345
346
  OP_ID = "OP_INSTANCE_SHUTDOWN"
  __slots__ = ["instance_name"]


347
348
class OpRebootInstance(OpCode):
  """Reboot an instance."""
Iustin Pop's avatar
Iustin Pop committed
349
  OP_ID = "OP_INSTANCE_REBOOT"
350
351
352
353
  __slots__ = ["instance_name", "reboot_type", "extra_args",
               "ignore_secondaries" ]


Iustin Pop's avatar
Iustin Pop committed
354
class OpReplaceDisks(OpCode):
Iustin Pop's avatar
Iustin Pop committed
355
  """Replace the disks of an instance."""
Iustin Pop's avatar
Iustin Pop committed
356
  OP_ID = "OP_INSTANCE_REPLACE_DISKS"
357
  __slots__ = ["instance_name", "remote_node", "mode", "disks", "iallocator"]
Iustin Pop's avatar
Iustin Pop committed
358
359
360
361
362
363
364
365
366


class OpFailoverInstance(OpCode):
  """Failover an instance."""
  OP_ID = "OP_INSTANCE_FAILOVER"
  __slots__ = ["instance_name", "ignore_consistency"]


class OpConnectConsole(OpCode):
Iustin Pop's avatar
Iustin Pop committed
367
  """Connect to an instance's console."""
Iustin Pop's avatar
Iustin Pop committed
368
369
370
371
372
  OP_ID = "OP_INSTANCE_CONSOLE"
  __slots__ = ["instance_name"]


class OpActivateInstanceDisks(OpCode):
Iustin Pop's avatar
Iustin Pop committed
373
  """Activate an instance's disks."""
Iustin Pop's avatar
Iustin Pop committed
374
375
376
377
378
  OP_ID = "OP_INSTANCE_ACTIVATE_DISKS"
  __slots__ = ["instance_name"]


class OpDeactivateInstanceDisks(OpCode):
Iustin Pop's avatar
Iustin Pop committed
379
  """Deactivate an instance's disks."""
Iustin Pop's avatar
Iustin Pop committed
380
381
382
383
384
385
386
  OP_ID = "OP_INSTANCE_DEACTIVATE_DISKS"
  __slots__ = ["instance_name"]


class OpQueryInstances(OpCode):
  """Compute the list of instances."""
  OP_ID = "OP_INSTANCE_QUERY"
387
  __slots__ = ["output_fields", "names"]
Iustin Pop's avatar
Iustin Pop committed
388
389
390
391
392
393
394
395


class OpQueryInstanceData(OpCode):
  """Compute the run-time status of instances."""
  OP_ID = "OP_INSTANCE_QUERY_DATA"
  __slots__ = ["instances"]


396
class OpSetInstanceParams(OpCode):
Iustin Pop's avatar
Iustin Pop committed
397
  """Change the parameters of an instance."""
398
  OP_ID = "OP_INSTANCE_SET_PARAMS"
399
400
  __slots__ = [
    "instance_name", "mem", "vcpus", "ip", "bridge", "mac",
401
402
    "kernel_path", "initrd_path", "hvm_boot_order", "hvm_acpi",
    "hvm_pae", "hvm_cdrom_image_path", "vnc_bind_address"
403
    ]
Iustin Pop's avatar
Iustin Pop committed
404
405


Iustin Pop's avatar
Iustin Pop committed
406
407
408
409
410
411
class OpGrowDisk(OpCode):
  """Grow a disk of an instance."""
  OP_ID = "OP_INSTANCE_GROW_DISK"
  __slots__ = ["instance_name", "disk", "amount"]


Iustin Pop's avatar
Iustin Pop committed
412
413
414
415
# OS opcodes
class OpDiagnoseOS(OpCode):
  """Compute the list of guest operating systems."""
  OP_ID = "OP_OS_DIAGNOSE"
416
  __slots__ = ["output_fields", "names"]
Iustin Pop's avatar
Iustin Pop committed
417

418

Iustin Pop's avatar
Iustin Pop committed
419
420
421
422
423
424
# Exports opcodes
class OpQueryExports(OpCode):
  """Compute the list of exported images."""
  OP_ID = "OP_BACKUP_QUERY"
  __slots__ = ["nodes"]

425

Iustin Pop's avatar
Iustin Pop committed
426
427
428
429
class OpExportInstance(OpCode):
  """Export an instance."""
  OP_ID = "OP_BACKUP_EXPORT"
  __slots__ = ["instance_name", "target_node", "shutdown"]
430

431
432
433
434
class OpRemoveExport(OpCode):
  """Remove an instance's export."""
  OP_ID = "OP_BACKUP_REMOVE"
  __slots__ = ["instance_name"]
435
436
437
438
439
440
441
442

# Tags opcodes
class OpGetTags(OpCode):
  """Returns the tags of the given object."""
  OP_ID = "OP_TAGS_GET"
  __slots__ = ["kind", "name"]


Iustin Pop's avatar
Iustin Pop committed
443
444
445
446
447
448
class OpSearchTags(OpCode):
  """Searches the tags in the cluster for a given pattern."""
  OP_ID = "OP_TAGS_SEARCH"
  __slots__ = ["pattern"]


449
450
class OpAddTags(OpCode):
  """Add a list of tags on a given object."""
451
  OP_ID = "OP_TAGS_SET"
452
  __slots__ = ["kind", "name", "tags"]
453
454


455
456
class OpDelTags(OpCode):
  """Remove a list of tags from a given object."""
457
  OP_ID = "OP_TAGS_DEL"
458
  __slots__ = ["kind", "name", "tags"]
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484


# Test opcodes
class OpTestDelay(OpCode):
  """Sleeps for a configured amount of time.

  This is used just for debugging and testing.

  Parameters:
    - duration: the time to sleep
    - on_master: if true, sleep on the master
    - on_nodes: list of nodes in which to sleep

  If the on_master parameter is true, it will execute a sleep on the
  master (before any node sleep).

  If the on_nodes list is not empty, it will sleep on those nodes
  (after the sleep on the master, if that is enabled).

  As an additional feature, the case of duration < 0 will be reported
  as an execution error, so this opcode can be used as a failure
  generator. The case of duration == 0 will not be treated specially.

  """
  OP_ID = "OP_TEST_DELAY"
  __slots__ = ["duration", "on_master", "on_nodes"]
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503


class OpTestAllocator(OpCode):
  """Allocator framework testing.

  This opcode has two modes:
    - gather and return allocator input for a given mode (allocate new
      or replace secondary) and a given instance definition (direction
      'in')
    - run a selected allocator for a given operation (as above) and
      return the allocator output (direction 'out')

  """
  OP_ID = "OP_TEST_ALLOCATOR"
  __slots__ = [
    "direction", "mode", "allocator", "name",
    "mem_size", "disks", "disk_template",
    "os", "tags", "nics", "vcpus",
    ]