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

# 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

161
162
163
164
165
166
167
168
169
170
171
172
  def Summary(self):
    """Generates a summary description of this opcode.

    """
    # all OP_ID start with OP_, we remove that
    txt = self.OP_ID[3:]
    field_name = getattr(self, "OP_DSC_FIELD", None)
    if field_name:
      field_value = getattr(self, field_name, None)
      txt = "%s(%s)" % (txt, field_value)
    return txt

Iustin Pop's avatar
Iustin Pop committed
173

174
175
# cluster opcodes

Iustin Pop's avatar
Iustin Pop committed
176
class OpDestroyCluster(OpCode):
Iustin Pop's avatar
Iustin Pop committed
177
178
179
180
181
182
  """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
183
184
185
186
187
  OP_ID = "OP_CLUSTER_DESTROY"
  __slots__ = []


class OpQueryClusterInfo(OpCode):
Iustin Pop's avatar
Iustin Pop committed
188
  """Query cluster information."""
Iustin Pop's avatar
Iustin Pop committed
189
190
191
192
193
  OP_ID = "OP_CLUSTER_QUERY"
  __slots__ = []


class OpVerifyCluster(OpCode):
Iustin Pop's avatar
Iustin Pop committed
194
195
196
197
198
199
200
201
202
  """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
203
  OP_ID = "OP_CLUSTER_VERIFY"
204
  __slots__ = ["skip_checks"]
Iustin Pop's avatar
Iustin Pop committed
205
206


Iustin Pop's avatar
Iustin Pop committed
207
208
209
210
211
class OpVerifyDisks(OpCode):
  """Verify the cluster disks.

  Parameters: none

212
  Result: a tuple of four elements:
Iustin Pop's avatar
Iustin Pop committed
213
    - list of node names with bad data returned (unreachable, etc.)
Iustin Pop's avatar
Iustin Pop committed
214
    - dict of node names with broken volume groups (values: error msg)
Iustin Pop's avatar
Iustin Pop committed
215
    - list of instances with degraded disks (that should be activated)
216
217
    - dict of instances with missing logical volumes (values: (node, vol)
      pairs with details about the missing volumes)
Iustin Pop's avatar
Iustin Pop committed
218

219
220
221
222
  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
223
224
225
226
227
228
229
230
231

  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__ = []


232
233
234
235
class OpQueryConfigValues(OpCode):
  """Query cluster configuration values."""
  OP_ID = "OP_CLUSTER_CONFIG_QUERY"
  __slots__ = ["output_fields"]
Iustin Pop's avatar
Iustin Pop committed
236
237


238
class OpRenameCluster(OpCode):
Iustin Pop's avatar
Iustin Pop committed
239
240
241
242
243
244
245
246
  """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.

  """
247
  OP_ID = "OP_CLUSTER_RENAME"
248
  OP_DSC_FIELD = "name"
249
250
251
  __slots__ = ["name"]


252
class OpSetClusterParams(OpCode):
Iustin Pop's avatar
Iustin Pop committed
253
254
255
256
257
258
  """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.

  """
259
  OP_ID = "OP_CLUSTER_SET_PARAMS"
260
261
262
263
264
265
266
  __slots__ = [
    "vg_name",
    "enabled_hypervisors",
    "hvparams",
    "beparams",
    "candidate_pool_size",
    ]
267
268


269
270
271
272
273
274
275
276
class OpRedistributeConfig(OpCode):
  """Force a full push of the cluster configuration.

  """
  OP_ID = "OP_CLUSTER_REDIST_CONF"
  __slots__ = [
    ]

277
278
# node opcodes

Iustin Pop's avatar
Iustin Pop committed
279
class OpRemoveNode(OpCode):
Iustin Pop's avatar
Iustin Pop committed
280
281
282
283
284
285
286
  """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
287
  OP_ID = "OP_NODE_REMOVE"
288
  OP_DSC_FIELD = "node_name"
Iustin Pop's avatar
Iustin Pop committed
289
290
291
292
  __slots__ = ["node_name"]


class OpAddNode(OpCode):
Iustin Pop's avatar
Iustin Pop committed
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
  """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
314
  OP_ID = "OP_NODE_ADD"
315
  OP_DSC_FIELD = "node_name"
316
  __slots__ = ["node_name", "primary_ip", "secondary_ip", "readd"]
Iustin Pop's avatar
Iustin Pop committed
317
318
319
320
321


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


325
326
327
328
329
330
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
331
332
333
334
335
336
337
338
class OpSetNodeParams(OpCode):
  """Change the parameters of a node."""
  OP_ID = "OP_NODE_SET_PARAMS"
  OP_DSC_FIELD = "node_name"
  __slots__ = [
    "node_name",
    "force",
    "master_candidate",
339
    "offline",
Iustin Pop's avatar
Iustin Pop committed
340
341
    ]

Iustin Pop's avatar
Iustin Pop committed
342
343
344
# instance opcodes

class OpCreateInstance(OpCode):
Iustin Pop's avatar
Iustin Pop committed
345
  """Create an instance."""
Iustin Pop's avatar
Iustin Pop committed
346
  OP_ID = "OP_INSTANCE_CREATE"
347
  OP_DSC_FIELD = "instance_name"
348
  __slots__ = [
349
350
351
352
353
    "instance_name", "os_type", "pnode",
    "disk_template", "snode", "mode",
    "disks", "nics",
    "src_node", "src_path", "start",
    "wait_for_sync", "ip_check",
354
    "file_storage_dir", "file_driver",
355
356
    "iallocator",
    "hypervisor", "hvparams", "beparams",
357
    ]
Iustin Pop's avatar
Iustin Pop committed
358
359


360
class OpReinstallInstance(OpCode):
Iustin Pop's avatar
Iustin Pop committed
361
  """Reinstall an instance's OS."""
362
  OP_ID = "OP_INSTANCE_REINSTALL"
363
  OP_DSC_FIELD = "instance_name"
364
  __slots__ = ["instance_name", "os_type"]
365
366


Iustin Pop's avatar
Iustin Pop committed
367
368
369
class OpRemoveInstance(OpCode):
  """Remove an instance."""
  OP_ID = "OP_INSTANCE_REMOVE"
370
  OP_DSC_FIELD = "instance_name"
Iustin Pop's avatar
Iustin Pop committed
371
  __slots__ = ["instance_name", "ignore_failures"]
Iustin Pop's avatar
Iustin Pop committed
372
373


374
375
376
377
378
379
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
380
class OpStartupInstance(OpCode):
Iustin Pop's avatar
Iustin Pop committed
381
  """Startup an instance."""
Iustin Pop's avatar
Iustin Pop committed
382
  OP_ID = "OP_INSTANCE_STARTUP"
383
  OP_DSC_FIELD = "instance_name"
Iustin Pop's avatar
Iustin Pop committed
384
385
386
387
  __slots__ = ["instance_name", "force", "extra_args"]


class OpShutdownInstance(OpCode):
Iustin Pop's avatar
Iustin Pop committed
388
  """Shutdown an instance."""
Iustin Pop's avatar
Iustin Pop committed
389
  OP_ID = "OP_INSTANCE_SHUTDOWN"
390
  OP_DSC_FIELD = "instance_name"
Iustin Pop's avatar
Iustin Pop committed
391
392
393
  __slots__ = ["instance_name"]


394
395
class OpRebootInstance(OpCode):
  """Reboot an instance."""
Iustin Pop's avatar
Iustin Pop committed
396
  OP_ID = "OP_INSTANCE_REBOOT"
397
  OP_DSC_FIELD = "instance_name"
398
399
400
401
  __slots__ = ["instance_name", "reboot_type", "extra_args",
               "ignore_secondaries" ]


Iustin Pop's avatar
Iustin Pop committed
402
class OpReplaceDisks(OpCode):
Iustin Pop's avatar
Iustin Pop committed
403
  """Replace the disks of an instance."""
Iustin Pop's avatar
Iustin Pop committed
404
  OP_ID = "OP_INSTANCE_REPLACE_DISKS"
405
  OP_DSC_FIELD = "instance_name"
406
  __slots__ = ["instance_name", "remote_node", "mode", "disks", "iallocator"]
Iustin Pop's avatar
Iustin Pop committed
407
408
409
410
411


class OpFailoverInstance(OpCode):
  """Failover an instance."""
  OP_ID = "OP_INSTANCE_FAILOVER"
412
  OP_DSC_FIELD = "instance_name"
Iustin Pop's avatar
Iustin Pop committed
413
414
415
  __slots__ = ["instance_name", "ignore_consistency"]


416
417
418
419
420
421
422
423
424
425
426
427
428
class OpMigrateInstance(OpCode):
  """Migrate an instance.

  This migrates (without shutting down an instance) to its secondary
  node.

  @var instance_name: the name of the instance

  """
  OP_ID = "OP_INSTANCE_MIGRATE"
  __slots__ = ["instance_name", "live", "cleanup"]


Iustin Pop's avatar
Iustin Pop committed
429
class OpConnectConsole(OpCode):
Iustin Pop's avatar
Iustin Pop committed
430
  """Connect to an instance's console."""
Iustin Pop's avatar
Iustin Pop committed
431
  OP_ID = "OP_INSTANCE_CONSOLE"
432
  OP_DSC_FIELD = "instance_name"
Iustin Pop's avatar
Iustin Pop committed
433
434
435
436
  __slots__ = ["instance_name"]


class OpActivateInstanceDisks(OpCode):
Iustin Pop's avatar
Iustin Pop committed
437
  """Activate an instance's disks."""
Iustin Pop's avatar
Iustin Pop committed
438
  OP_ID = "OP_INSTANCE_ACTIVATE_DISKS"
439
  OP_DSC_FIELD = "instance_name"
Iustin Pop's avatar
Iustin Pop committed
440
441
442
443
  __slots__ = ["instance_name"]


class OpDeactivateInstanceDisks(OpCode):
Iustin Pop's avatar
Iustin Pop committed
444
  """Deactivate an instance's disks."""
Iustin Pop's avatar
Iustin Pop committed
445
  OP_ID = "OP_INSTANCE_DEACTIVATE_DISKS"
446
  OP_DSC_FIELD = "instance_name"
Iustin Pop's avatar
Iustin Pop committed
447
448
449
450
451
452
  __slots__ = ["instance_name"]


class OpQueryInstances(OpCode):
  """Compute the list of instances."""
  OP_ID = "OP_INSTANCE_QUERY"
453
  __slots__ = ["output_fields", "names"]
Iustin Pop's avatar
Iustin Pop committed
454
455
456
457
458


class OpQueryInstanceData(OpCode):
  """Compute the run-time status of instances."""
  OP_ID = "OP_INSTANCE_QUERY_DATA"
459
  __slots__ = ["instances", "static"]
Iustin Pop's avatar
Iustin Pop committed
460
461


462
class OpSetInstanceParams(OpCode):
Iustin Pop's avatar
Iustin Pop committed
463
  """Change the parameters of an instance."""
464
  OP_ID = "OP_INSTANCE_SET_PARAMS"
465
  OP_DSC_FIELD = "instance_name"
466
  __slots__ = [
467
    "instance_name",
Iustin Pop's avatar
Iustin Pop committed
468
    "hvparams", "beparams", "force",
469
    "nics", "disks",
470
    ]
Iustin Pop's avatar
Iustin Pop committed
471
472


Iustin Pop's avatar
Iustin Pop committed
473
474
475
class OpGrowDisk(OpCode):
  """Grow a disk of an instance."""
  OP_ID = "OP_INSTANCE_GROW_DISK"
476
  OP_DSC_FIELD = "instance_name"
477
  __slots__ = ["instance_name", "disk", "amount", "wait_for_sync"]
Iustin Pop's avatar
Iustin Pop committed
478
479


Iustin Pop's avatar
Iustin Pop committed
480
481
482
483
# OS opcodes
class OpDiagnoseOS(OpCode):
  """Compute the list of guest operating systems."""
  OP_ID = "OP_OS_DIAGNOSE"
484
  __slots__ = ["output_fields", "names"]
Iustin Pop's avatar
Iustin Pop committed
485

486

Iustin Pop's avatar
Iustin Pop committed
487
488
489
490
491
492
# Exports opcodes
class OpQueryExports(OpCode):
  """Compute the list of exported images."""
  OP_ID = "OP_BACKUP_QUERY"
  __slots__ = ["nodes"]

493

Iustin Pop's avatar
Iustin Pop committed
494
495
496
class OpExportInstance(OpCode):
  """Export an instance."""
  OP_ID = "OP_BACKUP_EXPORT"
497
  OP_DSC_FIELD = "instance_name"
Iustin Pop's avatar
Iustin Pop committed
498
  __slots__ = ["instance_name", "target_node", "shutdown"]
499

Michael Hanselmann's avatar
Michael Hanselmann committed
500

501
502
503
class OpRemoveExport(OpCode):
  """Remove an instance's export."""
  OP_ID = "OP_BACKUP_REMOVE"
504
  OP_DSC_FIELD = "instance_name"
505
  __slots__ = ["instance_name"]
506

Michael Hanselmann's avatar
Michael Hanselmann committed
507

508
509
510
511
# Tags opcodes
class OpGetTags(OpCode):
  """Returns the tags of the given object."""
  OP_ID = "OP_TAGS_GET"
512
  OP_DSC_FIELD = "name"
513
514
515
  __slots__ = ["kind", "name"]


Iustin Pop's avatar
Iustin Pop committed
516
517
518
class OpSearchTags(OpCode):
  """Searches the tags in the cluster for a given pattern."""
  OP_ID = "OP_TAGS_SEARCH"
519
  OP_DSC_FIELD = "pattern"
Iustin Pop's avatar
Iustin Pop committed
520
521
522
  __slots__ = ["pattern"]


523
524
class OpAddTags(OpCode):
  """Add a list of tags on a given object."""
525
  OP_ID = "OP_TAGS_SET"
526
  __slots__ = ["kind", "name", "tags"]
527
528


529
530
class OpDelTags(OpCode):
  """Remove a list of tags from a given object."""
531
  OP_ID = "OP_TAGS_DEL"
532
  __slots__ = ["kind", "name", "tags"]
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557


# 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"
558
  OP_DSC_FIELD = "duration"
559
  __slots__ = ["duration", "on_master", "on_nodes"]
560
561
562
563
564
565
566
567
568
569
570
571
572
573


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"
574
  OP_DSC_FIELD = "allocator"
575
576
577
  __slots__ = [
    "direction", "mode", "allocator", "name",
    "mem_size", "disks", "disk_template",
578
    "os", "tags", "nics", "vcpus", "hypervisor",
579
    ]