query.py 41 KB
Newer Older
1
2
3
#
#

4
# Copyright (C) 2010, 2011 Google Inc.
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
#
# 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.


Michael Hanselmann's avatar
Michael Hanselmann committed
22
23
24
25
26
27
28
29
30
31
32
33
34
"""Module for query operations

How it works:

  - Add field definitions
    - See how L{NODE_FIELDS} is built
    - Each field gets:
      - Query field definition (L{objects.QueryFieldDefinition}, use
        L{_MakeField} for creating), containing:
          - Name, must be lowercase and match L{FIELD_NAME_RE}
          - Title for tables, must not contain whitespace and match
            L{TITLE_RE}
          - Value data type, e.g. L{constants.QFT_NUMBER}
35
36
          - Human-readable description, must not end with punctuation or
            contain newlines
Michael Hanselmann's avatar
Michael Hanselmann committed
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
      - Data request type, see e.g. C{NQ_*}
      - A retrieval function, see L{Query.__init__} for description
    - Pass list of fields through L{_PrepareFieldList} for preparation and
      checks
  - Instantiate L{Query} with prepared field list definition and selected fields
  - Call L{Query.RequestedData} to determine what data to collect/compute
  - Call L{Query.Query} or L{Query.OldStyleQuery} with collected data and use
    result
      - Data container must support iteration using C{__iter__}
      - Items are passed to retrieval functions and can have any format
  - Call L{Query.GetFields} to get list of definitions for selected fields

@attention: Retrieval functions must be idempotent. They can be called multiple
  times, in any order and any number of times. This is important to keep in
  mind for implementing filters in the future.

"""
54

Michael Hanselmann's avatar
Michael Hanselmann committed
55
import logging
56
57
58
59
60
61
62
63
64
65
import operator
import re

from ganeti import constants
from ganeti import errors
from ganeti import utils
from ganeti import compat
from ganeti import objects
from ganeti import ht

66
67
from ganeti.constants import (QFT_UNKNOWN, QFT_TEXT, QFT_BOOL, QFT_NUMBER,
                              QFT_UNIT, QFT_TIMESTAMP, QFT_OTHER,
René Nussbaumer's avatar
René Nussbaumer committed
68
69
                              RS_NORMAL, RS_UNKNOWN, RS_NODATA,
                              RS_UNAVAIL, RS_OFFLINE)
70

71

Michael Hanselmann's avatar
Michael Hanselmann committed
72
73
74
75
# Constants for requesting data from the caller/data provider. Each property
# collected/computed separately by the data provider should have its own to
# only collect the requested data and not more.

Michael Hanselmann's avatar
Michael Hanselmann committed
76
77
78
(NQ_CONFIG,
 NQ_INST,
 NQ_LIVE,
79
80
 NQ_GROUP,
 NQ_OOB) = range(1, 6)
Michael Hanselmann's avatar
Michael Hanselmann committed
81

82
83
(IQ_CONFIG,
 IQ_LIVE,
84
85
 IQ_DISKUSAGE,
 IQ_CONSOLE) = range(100, 104)
86

87
88
89
(LQ_MODE,
 LQ_OWNER,
 LQ_PENDING) = range(10, 13)
Michael Hanselmann's avatar
Michael Hanselmann committed
90

91
92
93
94
95
(GQ_CONFIG,
 GQ_NODE,
 GQ_INST) = range(200, 203)


96
97
FIELD_NAME_RE = re.compile(r"^[a-z0-9/._]+$")
TITLE_RE = re.compile(r"^[^\s]+$")
98
DOC_RE = re.compile(r"^[A-Z].*[^.,?!]$")
99
100
101

#: Verification function for each field type
_VERIFY_FN = {
102
103
104
105
106
107
108
  QFT_UNKNOWN: ht.TNone,
  QFT_TEXT: ht.TString,
  QFT_BOOL: ht.TBool,
  QFT_NUMBER: ht.TInt,
  QFT_UNIT: ht.TInt,
  QFT_TIMESTAMP: ht.TOr(ht.TInt, ht.TFloat),
  QFT_OTHER: lambda _: True,
109
110
  }

111
112
113
114
115
116
# Unique objects for special field statuses
_FS_UNKNOWN = object()
_FS_NODATA = object()
_FS_UNAVAIL = object()
_FS_OFFLINE = object()

117
118
119
120
121
122
123
124
125
126
#: VType to QFT mapping
_VTToQFT = {
  # TODO: fix validation of empty strings
  constants.VTYPE_STRING: QFT_OTHER, # since VTYPE_STRINGs can be empty
  constants.VTYPE_MAYBE_STRING: QFT_OTHER,
  constants.VTYPE_BOOL: QFT_BOOL,
  constants.VTYPE_SIZE: QFT_UNIT,
  constants.VTYPE_INT: QFT_NUMBER,
  }

127
128
_SERIAL_NO_DOC = "%s object serial number, incremented on each modification"

129
130
131
132
133

def _GetUnknownField(ctx, item): # pylint: disable-msg=W0613
  """Gets the contents of an unknown field.

  """
134
  return _FS_UNKNOWN
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153


def _GetQueryFields(fielddefs, selected):
  """Calculates the internal list of selected fields.

  Unknown fields are returned as L{constants.QFT_UNKNOWN}.

  @type fielddefs: dict
  @param fielddefs: Field definitions
  @type selected: list of strings
  @param selected: List of selected fields

  """
  result = []

  for name in selected:
    try:
      fdef = fielddefs[name]
    except KeyError:
154
155
      fdef = (_MakeField(name, name, QFT_UNKNOWN, "Unknown field '%s'" % name),
              None, _GetUnknownField)
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221

    assert len(fdef) == 3

    result.append(fdef)

  return result


def GetAllFields(fielddefs):
  """Extract L{objects.QueryFieldDefinition} from field definitions.

  @rtype: list of L{objects.QueryFieldDefinition}

  """
  return [fdef for (fdef, _, _) in fielddefs]


class Query:
  def __init__(self, fieldlist, selected):
    """Initializes this class.

    The field definition is a dictionary with the field's name as a key and a
    tuple containing, in order, the field definition object
    (L{objects.QueryFieldDefinition}, the data kind to help calling code
    collect data and a retrieval function. The retrieval function is called
    with two parameters, in order, the data container and the item in container
    (see L{Query.Query}).

    Users of this class can call L{RequestedData} before preparing the data
    container to determine what data is needed.

    @type fieldlist: dictionary
    @param fieldlist: Field definitions
    @type selected: list of strings
    @param selected: List of selected fields

    """
    self._fields = _GetQueryFields(fieldlist, selected)

  def RequestedData(self):
    """Gets requested kinds of data.

    @rtype: frozenset

    """
    return frozenset(datakind
                     for (_, datakind, _) in self._fields
                     if datakind is not None)

  def GetFields(self):
    """Returns the list of fields for this query.

    Includes unknown fields.

    @rtype: List of L{objects.QueryFieldDefinition}

    """
    return GetAllFields(self._fields)

  def Query(self, ctx):
    """Execute a query.

    @param ctx: Data container passed to field retrieval functions, must
      support iteration using C{__iter__}

    """
222
    result = [[_ProcessResult(fn(ctx, item)) for (_, _, fn) in self._fields]
223
224
225
226
              for item in ctx]

    # Verify result
    if __debug__:
227
228
      for row in result:
        _VerifyResultRow(self._fields, row)
229
230
231
232
233
234
235
236
237
238

    return result

  def OldStyleQuery(self, ctx):
    """Query with "old" query result format.

    See L{Query.Query} for arguments.

    """
    unknown = set(fdef.name
239
                  for (fdef, _, _) in self._fields if fdef.kind == QFT_UNKNOWN)
240
241
242
243
244
245
246
247
248
    if unknown:
      raise errors.OpPrereqError("Unknown output fields selected: %s" %
                                 (utils.CommaJoin(unknown), ),
                                 errors.ECODE_INVAL)

    return [[value for (_, value) in row]
            for row in self.Query(ctx)]


249
250
251
252
253
def _ProcessResult(value):
  """Converts result values into externally-visible ones.

  """
  if value is _FS_UNKNOWN:
René Nussbaumer's avatar
René Nussbaumer committed
254
    return (RS_UNKNOWN, None)
255
  elif value is _FS_NODATA:
René Nussbaumer's avatar
René Nussbaumer committed
256
    return (RS_NODATA, None)
257
  elif value is _FS_UNAVAIL:
René Nussbaumer's avatar
René Nussbaumer committed
258
    return (RS_UNAVAIL, None)
259
  elif value is _FS_OFFLINE:
René Nussbaumer's avatar
René Nussbaumer committed
260
    return (RS_OFFLINE, None)
261
  else:
René Nussbaumer's avatar
René Nussbaumer committed
262
    return (RS_NORMAL, value)
263
264


265
266
267
268
269
270
271
272
273
def _VerifyResultRow(fields, row):
  """Verifies the contents of a query result row.

  @type fields: list
  @param fields: Field definitions for result
  @type row: list of tuples
  @param row: Row data

  """
274
275
276
  assert len(row) == len(fields)
  errs = []
  for ((status, value), (fdef, _, _)) in zip(row, fields):
René Nussbaumer's avatar
René Nussbaumer committed
277
    if status == RS_NORMAL:
278
279
280
281
282
283
284
      if not _VERIFY_FN[fdef.kind](value):
        errs.append("normal field %s fails validation (value is %s)" %
                    (fdef.name, value))
    elif value is not None:
      errs.append("abnormal field %s has a non-None value" % fdef.name)
  assert not errs, ("Failed validation: %s in row %s" %
                    (utils.CommaJoin(errors), row))
285
286


287
def _PrepareFieldList(fields, aliases):
288
289
290
291
  """Prepares field list for use by L{Query}.

  Converts the list to a dictionary and does some verification.

292
293
294
295
296
297
298
  @type fields: list of tuples; (L{objects.QueryFieldDefinition}, data
      kind, retrieval function)
  @param fields: List of fields, see L{Query.__init__} for a better
      description
  @type aliases: list of tuples; (alias, target)
  @param aliases: list of tuples containing aliases; for each
      alias/target pair, a duplicate will be created in the field list
299
300
301
302
  @rtype: dict
  @return: Field dictionary for L{Query}

  """
303
304
305
306
  if __debug__:
    duplicates = utils.FindDuplicates(fdef.title.lower()
                                      for (fdef, _, _) in fields)
    assert not duplicates, "Duplicate title(s) found: %r" % duplicates
307
308
309
310
311
312
313
314
315

  result = {}

  for field in fields:
    (fdef, _, fn) = field

    assert fdef.name and fdef.title, "Name and title are required"
    assert FIELD_NAME_RE.match(fdef.name)
    assert TITLE_RE.match(fdef.title)
316
317
318
    assert (DOC_RE.match(fdef.doc) and len(fdef.doc.splitlines()) == 1 and
            fdef.doc.strip() == fdef.doc), \
           "Invalid description for field '%s'" % fdef.name
319
    assert callable(fn)
320
321
    assert fdef.name not in result, \
           "Duplicate field name '%s' found" % fdef.name
322
323
324

    result[fdef.name] = field

325
326
327
328
329
330
331
332
333
  for alias, target in aliases:
    assert alias not in result, "Alias %s overrides an existing field" % alias
    assert target in result, "Missing target %s for alias %s" % (target, alias)
    (fdef, k, fn) = result[target]
    fdef = fdef.Copy()
    fdef.name = alias
    result[alias] = (fdef, k, fn)

  assert len(result) == len(fields) + len(aliases)
334
335
336
337
338
339
  assert compat.all(name == fdef.name
                    for (name, (fdef, _, _)) in result.items())

  return result


340
341
342
343
344
345
346
347
348
349
350
def GetQueryResponse(query, ctx):
  """Prepares the response for a query.

  @type query: L{Query}
  @param ctx: Data container, see L{Query.Query}

  """
  return objects.QueryResponse(data=query.Query(ctx),
                               fields=query.GetFields()).ToDict()


351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
def QueryFields(fielddefs, selected):
  """Returns list of available fields.

  @type fielddefs: dict
  @param fielddefs: Field definitions
  @type selected: list of strings
  @param selected: List of selected fields
  @return: List of L{objects.QueryFieldDefinition}

  """
  if selected is None:
    # Client requests all fields, sort by name
    fdefs = utils.NiceSort(GetAllFields(fielddefs.values()),
                           key=operator.attrgetter("name"))
  else:
    # Keep order as requested by client
    fdefs = Query(fielddefs, selected).GetFields()

  return objects.QueryFieldsResponse(fields=fdefs).ToDict()


372
def _MakeField(name, title, kind, doc):
373
374
375
376
377
  """Wrapper for creating L{objects.QueryFieldDefinition} instances.

  @param name: Field name as a regular expression
  @param title: Human-readable title
  @param kind: Field type
378
  @param doc: Human-readable description
379
380

  """
381
382
  return objects.QueryFieldDefinition(name=name, title=title, kind=kind,
                                      doc=doc)
Michael Hanselmann's avatar
Michael Hanselmann committed
383
384
385
386
387
388
389
390
391
392
393
394


def _GetNodeRole(node, master_name):
  """Determine node role.

  @type node: L{objects.Node}
  @param node: Node object
  @type master_name: string
  @param master_name: Master node name

  """
  if node.name == master_name:
395
    return constants.NR_MASTER
Michael Hanselmann's avatar
Michael Hanselmann committed
396
  elif node.master_candidate:
397
    return constants.NR_MCANDIDATE
Michael Hanselmann's avatar
Michael Hanselmann committed
398
  elif node.drained:
399
    return constants.NR_DRAINED
Michael Hanselmann's avatar
Michael Hanselmann committed
400
  elif node.offline:
401
    return constants.NR_OFFLINE
Michael Hanselmann's avatar
Michael Hanselmann committed
402
  else:
403
    return constants.NR_REGULAR
Michael Hanselmann's avatar
Michael Hanselmann committed
404
405
406
407
408
409
410
411
412


def _GetItemAttr(attr):
  """Returns a field function to return an attribute of the item.

  @param attr: Attribute name

  """
  getter = operator.attrgetter(attr)
413
  return lambda _, item: getter(item)
Michael Hanselmann's avatar
Michael Hanselmann committed
414
415


416
417
418
419
420
421
422
423
424
425
426
427
428
429
def _GetItemTimestamp(getter):
  """Returns function for getting timestamp of item.

  @type getter: callable
  @param getter: Function to retrieve timestamp attribute

  """
  def fn(_, item):
    """Returns a timestamp of item.

    """
    timestamp = getter(item)
    if timestamp is None:
      # Old configs might not have all timestamps
430
      return _FS_UNAVAIL
431
    else:
432
      return timestamp
433
434
435
436
437
438
439
440
441
442
443

  return fn


def _GetItemTimestampFields(datatype):
  """Returns common timestamp fields.

  @param datatype: Field data type for use by L{Query.RequestedData}

  """
  return [
444
445
446
447
    (_MakeField("ctime", "CTime", QFT_TIMESTAMP, "Creation timestamp"),
     datatype, _GetItemTimestamp(operator.attrgetter("ctime"))),
    (_MakeField("mtime", "MTime", QFT_TIMESTAMP, "Modification timestamp"),
     datatype, _GetItemTimestamp(operator.attrgetter("mtime"))),
448
449
450
    ]


Michael Hanselmann's avatar
Michael Hanselmann committed
451
452
453
454
455
class NodeQueryData:
  """Data container for node data queries.

  """
  def __init__(self, nodes, live_data, master_name, node_to_primary,
456
               node_to_secondary, groups, oob_support, cluster):
Michael Hanselmann's avatar
Michael Hanselmann committed
457
458
459
460
461
462
463
464
465
    """Initializes this class.

    """
    self.nodes = nodes
    self.live_data = live_data
    self.master_name = master_name
    self.node_to_primary = node_to_primary
    self.node_to_secondary = node_to_secondary
    self.groups = groups
466
    self.oob_support = oob_support
467
    self.cluster = cluster
Michael Hanselmann's avatar
Michael Hanselmann committed
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488

    # Used for individual rows
    self.curlive_data = None

  def __iter__(self):
    """Iterate over all nodes.

    This function has side-effects and only one instance of the resulting
    generator should be used at a time.

    """
    for node in self.nodes:
      if self.live_data:
        self.curlive_data = self.live_data.get(node.name, None)
      else:
        self.curlive_data = None
      yield node


#: Fields that are direct attributes of an L{objects.Node} object
_NODE_SIMPLE_FIELDS = {
489
490
491
492
493
494
495
496
497
498
  "drained": ("Drained", QFT_BOOL, "Whether node is drained"),
  "master_candidate": ("MasterC", QFT_BOOL,
                       "Whether node is a master candidate"),
  "master_capable": ("MasterCapable", QFT_BOOL,
                     "Whether node can become a master candidate"),
  "name": ("Node", QFT_TEXT, "Node name"),
  "offline": ("Offline", QFT_BOOL, "Whether node is marked offline"),
  "serial_no": ("SerialNo", QFT_NUMBER, _SERIAL_NO_DOC % "Node"),
  "uuid": ("UUID", QFT_TEXT, "Node UUID"),
  "vm_capable": ("VMCapable", QFT_BOOL, "Whether node can host instances"),
Michael Hanselmann's avatar
Michael Hanselmann committed
499
500
501
502
  }


#: Fields requiring talking to the node
503
# Note that none of these are available for non-vm_capable nodes
Michael Hanselmann's avatar
Michael Hanselmann committed
504
_NODE_LIVE_FIELDS = {
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
  "bootid": ("BootID", QFT_TEXT, "bootid",
             "Random UUID renewed for each system reboot, can be used"
             " for detecting reboots by tracking changes"),
  "cnodes": ("CNodes", QFT_NUMBER, "cpu_nodes",
             "Number of NUMA domains on node (if exported by hypervisor)"),
  "csockets": ("CSockets", QFT_NUMBER, "cpu_sockets",
               "Number of physical CPU sockets (if exported by hypervisor)"),
  "ctotal": ("CTotal", QFT_NUMBER, "cpu_total", "Number of logical processors"),
  "dfree": ("DFree", QFT_UNIT, "vg_free",
            "Available disk space in volume group"),
  "dtotal": ("DTotal", QFT_UNIT, "vg_size",
             "Total disk space in volume group used for instance disk"
             " allocation"),
  "mfree": ("MFree", QFT_UNIT, "memory_free",
            "Memory available for instance allocations"),
  "mnode": ("MNode", QFT_UNIT, "memory_dom0",
            "Amount of memory used by node (dom0 for Xen)"),
  "mtotal": ("MTotal", QFT_UNIT, "memory_total",
             "Total amount of memory of physical machine"),
Michael Hanselmann's avatar
Michael Hanselmann committed
524
525
526
  }


527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
def _GetGroup(cb):
  """Build function for calling another function with an node group.

  @param cb: The callback to be called with the nodegroup

  """
  def fn(ctx, node):
    """Get group data for a node.

    @type ctx: L{NodeQueryData}
    @type inst: L{objects.Node}
    @param inst: Node object

    """
    ng = ctx.groups.get(node.group, None)
    if ng is None:
      # Nodes always have a group, or the configuration is corrupt
544
      return _FS_UNAVAIL
545
546
547
548
549
550
551

    return cb(ctx, node, ng)

  return fn


def _GetNodeGroup(ctx, node, ng): # pylint: disable-msg=W0613
Michael Hanselmann's avatar
Michael Hanselmann committed
552
553
554
555
556
  """Returns the name of a node's group.

  @type ctx: L{NodeQueryData}
  @type node: L{objects.Node}
  @param node: Node object
557
558
  @type ng: L{objects.NodeGroup}
  @param ng: The node group this node belongs to
Michael Hanselmann's avatar
Michael Hanselmann committed
559
560

  """
561
  return ng.name
Michael Hanselmann's avatar
Michael Hanselmann committed
562
563


564
565
566
567
568
569
570
571
572
def _GetNodePower(ctx, node):
  """Returns the node powered state

  @type ctx: L{NodeQueryData}
  @type node: L{objects.Node}
  @param node: Node object

  """
  if ctx.oob_support[node.name]:
573
    return node.powered
574

575
  return _FS_UNAVAIL
576
577


578
579
580
581
582
583
584
585
586
587
def _GetNdParams(ctx, node, ng):
  """Returns the ndparams for this node.

  @type ctx: L{NodeQueryData}
  @type node: L{objects.Node}
  @param node: Node object
  @type ng: L{objects.NodeGroup}
  @param ng: The node group this node belongs to

  """
588
  return ctx.cluster.SimpleFillND(ng.FillND(node))
589
590


591
def _GetLiveNodeField(field, kind, ctx, node):
Michael Hanselmann's avatar
Michael Hanselmann committed
592
593
594
595
596
  """Gets the value of a "live" field from L{NodeQueryData}.

  @param field: Live field name
  @param kind: Data kind, one of L{constants.QFT_ALL}
  @type ctx: L{NodeQueryData}
597
598
  @type node: L{objects.Node}
  @param node: Node object
Michael Hanselmann's avatar
Michael Hanselmann committed
599
600

  """
601
  if node.offline:
602
    return _FS_OFFLINE
603

604
605
606
  if not node.vm_capable:
    return _FS_UNAVAIL

Michael Hanselmann's avatar
Michael Hanselmann committed
607
  if not ctx.curlive_data:
608
    return _FS_NODATA
Michael Hanselmann's avatar
Michael Hanselmann committed
609
610
611
612

  try:
    value = ctx.curlive_data[field]
  except KeyError:
613
    return _FS_UNAVAIL
Michael Hanselmann's avatar
Michael Hanselmann committed
614

615
  if kind == QFT_TEXT:
616
    return value
Michael Hanselmann's avatar
Michael Hanselmann committed
617

618
  assert kind in (QFT_NUMBER, QFT_UNIT)
Michael Hanselmann's avatar
Michael Hanselmann committed
619
620
621

  # Try to convert into number
  try:
622
    return int(value)
Michael Hanselmann's avatar
Michael Hanselmann committed
623
624
625
  except (ValueError, TypeError):
    logging.exception("Failed to convert node field '%s' (value %r) to int",
                      value, field)
626
    return _FS_UNAVAIL
Michael Hanselmann's avatar
Michael Hanselmann committed
627
628
629
630
631
632
633


def _BuildNodeFields():
  """Builds list of fields for node queries.

  """
  fields = [
634
635
636
637
638
    (_MakeField("pip", "PrimaryIP", QFT_TEXT, "Primary IP address"),
     NQ_CONFIG, _GetItemAttr("primary_ip")),
    (_MakeField("sip", "SecondaryIP", QFT_TEXT, "Secondary IP address"),
     NQ_CONFIG, _GetItemAttr("secondary_ip")),
    (_MakeField("tags", "Tags", QFT_OTHER, "Tags"), NQ_CONFIG,
639
     lambda ctx, node: list(node.GetTags())),
640
641
642
    (_MakeField("master", "IsMaster", QFT_BOOL, "Whether node is master"),
     NQ_CONFIG, lambda ctx, node: node.name == ctx.master_name),
    (_MakeField("group", "Group", QFT_TEXT, "Node group"), NQ_GROUP,
643
     _GetGroup(_GetNodeGroup)),
644
    (_MakeField("group.uuid", "GroupUUID", QFT_TEXT, "UUID of node group"),
645
     NQ_CONFIG, _GetItemAttr("group")),
646
647
648
649
650
651
652
653
    (_MakeField("powered", "Powered", QFT_BOOL,
                "Whether node is thought to be powered on"),
     NQ_OOB, _GetNodePower),
    (_MakeField("ndparams", "NodeParameters", QFT_OTHER,
                "Merged node parameters"),
     NQ_GROUP, _GetGroup(_GetNdParams)),
    (_MakeField("custom_ndparams", "CustomNodeParameters", QFT_OTHER,
                "Custom node parameters"),
654
      NQ_GROUP, _GetItemAttr("ndparams")),
Michael Hanselmann's avatar
Michael Hanselmann committed
655
656
    ]

657
658
659
660
661
662
663
664
665
666
667
  # Node role
  role_values = (constants.NR_MASTER, constants.NR_MCANDIDATE,
                 constants.NR_REGULAR, constants.NR_DRAINED,
                 constants.NR_OFFLINE)
  role_doc = ("Node role; \"%s\" for master, \"%s\" for master candidate,"
              " \"%s\" for regular, \"%s\" for a drained, \"%s\" for offline" %
              role_values)
  fields.append((_MakeField("role", "Role", QFT_TEXT, role_doc), NQ_CONFIG,
                 lambda ctx, node: _GetNodeRole(node, ctx.master_name)))
  assert set(role_values) == constants.NR_ALL

Michael Hanselmann's avatar
Michael Hanselmann committed
668
  def _GetLength(getter):
669
    return lambda ctx, node: len(getter(ctx)[node.name])
Michael Hanselmann's avatar
Michael Hanselmann committed
670
671

  def _GetList(getter):
672
    return lambda ctx, node: list(getter(ctx)[node.name])
Michael Hanselmann's avatar
Michael Hanselmann committed
673
674

  # Add fields operating on instance lists
675
676
677
  for prefix, titleprefix, docword, getter in \
      [("p", "Pri", "primary", operator.attrgetter("node_to_primary")),
       ("s", "Sec", "secondary", operator.attrgetter("node_to_secondary"))]:
Michael Hanselmann's avatar
Michael Hanselmann committed
678
    fields.extend([
679
680
      (_MakeField("%sinst_cnt" % prefix, "%sinst" % prefix.upper(), QFT_NUMBER,
                  "Number of instances with this node as %s" % docword),
Michael Hanselmann's avatar
Michael Hanselmann committed
681
682
       NQ_INST, _GetLength(getter)),
      (_MakeField("%sinst_list" % prefix, "%sInstances" % titleprefix,
683
684
                  QFT_OTHER,
                  "List of instances with this node as %s" % docword),
Michael Hanselmann's avatar
Michael Hanselmann committed
685
686
687
688
       NQ_INST, _GetList(getter)),
      ])

  # Add simple fields
689
690
691
  fields.extend([(_MakeField(name, title, kind, doc), NQ_CONFIG,
                  _GetItemAttr(name))
                 for (name, (title, kind, doc)) in _NODE_SIMPLE_FIELDS.items()])
Michael Hanselmann's avatar
Michael Hanselmann committed
692
693
694

  # Add fields requiring live data
  fields.extend([
695
    (_MakeField(name, title, kind, doc), NQ_LIVE,
Michael Hanselmann's avatar
Michael Hanselmann committed
696
     compat.partial(_GetLiveNodeField, nfield, kind))
697
    for (name, (title, kind, nfield, doc)) in _NODE_LIVE_FIELDS.items()
Michael Hanselmann's avatar
Michael Hanselmann committed
698
699
    ])

700
701
702
  # Add timestamps
  fields.extend(_GetItemTimestampFields(NQ_CONFIG))

703
  return _PrepareFieldList(fields, [])
Michael Hanselmann's avatar
Michael Hanselmann committed
704
705


706
707
708
709
710
class InstanceQueryData:
  """Data container for instance data queries.

  """
  def __init__(self, instances, cluster, disk_usage, offline_nodes, bad_nodes,
711
               live_data, wrongnode_inst, console):
712
713
714
715
716
717
718
719
720
721
722
723
    """Initializes this class.

    @param instances: List of instance objects
    @param cluster: Cluster object
    @type disk_usage: dict; instance name as key
    @param disk_usage: Per-instance disk usage
    @type offline_nodes: list of strings
    @param offline_nodes: List of offline nodes
    @type bad_nodes: list of strings
    @param bad_nodes: List of faulty nodes
    @type live_data: dict; instance name as key
    @param live_data: Per-instance live data
724
725
    @type wrongnode_inst: set
    @param wrongnode_inst: Set of instances running on wrong node(s)
726
727
    @type console: dict; instance name as key
    @param console: Per-instance console information
728
729
730
731
732
733
734
735
736
737
738
739
740

    """
    assert len(set(bad_nodes) & set(offline_nodes)) == len(offline_nodes), \
           "Offline nodes not included in bad nodes"
    assert not (set(live_data.keys()) & set(bad_nodes)), \
           "Found live data for bad or offline nodes"

    self.instances = instances
    self.cluster = cluster
    self.disk_usage = disk_usage
    self.offline_nodes = offline_nodes
    self.bad_nodes = bad_nodes
    self.live_data = live_data
741
    self.wrongnode_inst = wrongnode_inst
742
    self.console = console
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772

    # Used for individual rows
    self.inst_hvparams = None
    self.inst_beparams = None
    self.inst_nicparams = None

  def __iter__(self):
    """Iterate over all instances.

    This function has side-effects and only one instance of the resulting
    generator should be used at a time.

    """
    for inst in self.instances:
      self.inst_hvparams = self.cluster.FillHV(inst, skip_globals=True)
      self.inst_beparams = self.cluster.FillBE(inst)
      self.inst_nicparams = [self.cluster.SimpleFillNIC(nic.nicparams)
                             for nic in inst.nics]

      yield inst


def _GetInstOperState(ctx, inst):
  """Get instance's operational status.

  @type ctx: L{InstanceQueryData}
  @type inst: L{objects.Instance}
  @param inst: Instance object

  """
René Nussbaumer's avatar
René Nussbaumer committed
773
  # Can't use RS_OFFLINE here as it would describe the instance to
774
  # be offline when we actually don't know due to missing data
775
  if inst.primary_node in ctx.bad_nodes:
776
    return _FS_NODATA
777
  else:
778
    return bool(ctx.live_data.get(inst.name))
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797


def _GetInstLiveData(name):
  """Build function for retrieving live data.

  @type name: string
  @param name: Live data field name

  """
  def fn(ctx, inst):
    """Get live data for an instance.

    @type ctx: L{InstanceQueryData}
    @type inst: L{objects.Instance}
    @param inst: Instance object

    """
    if (inst.primary_node in ctx.bad_nodes or
        inst.primary_node in ctx.offline_nodes):
René Nussbaumer's avatar
René Nussbaumer committed
798
      # Can't use RS_OFFLINE here as it would describe the instance to be
799
      # offline when we actually don't know due to missing data
800
      return _FS_NODATA
801
802
803
804

    if inst.name in ctx.live_data:
      data = ctx.live_data[inst.name]
      if name in data:
805
        return data[name]
806

807
    return _FS_UNAVAIL
808
809
810
811
812
813
814
815
816
817
818
819
820

  return fn


def _GetInstStatus(ctx, inst):
  """Get instance status.

  @type ctx: L{InstanceQueryData}
  @type inst: L{objects.Instance}
  @param inst: Instance object

  """
  if inst.primary_node in ctx.offline_nodes:
821
    return constants.INSTST_NODEOFFLINE
822
823

  if inst.primary_node in ctx.bad_nodes:
824
    return constants.INSTST_NODEDOWN
825
826

  if bool(ctx.live_data.get(inst.name)):
827
    if inst.name in ctx.wrongnode_inst:
828
      return constants.INSTST_WRONGNODE
829
    elif inst.admin_up:
830
      return constants.INSTST_RUNNING
831
    else:
832
      return constants.INSTST_ERRORUP
833
834

  if inst.admin_up:
835
    return constants.INSTST_ERRORDOWN
836

837
  return constants.INSTST_ADMINDOWN
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854


def _GetInstDiskSize(index):
  """Build function for retrieving disk size.

  @type index: int
  @param index: Disk index

  """
  def fn(_, inst):
    """Get size of a disk.

    @type inst: L{objects.Instance}
    @param inst: Instance object

    """
    try:
855
      return inst.disks[index].size
856
    except IndexError:
857
      return _FS_UNAVAIL
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881

  return fn


def _GetInstNic(index, cb):
  """Build function for calling another function with an instance NIC.

  @type index: int
  @param index: NIC index
  @type cb: callable
  @param cb: Callback

  """
  def fn(ctx, inst):
    """Call helper function with instance NIC.

    @type ctx: L{InstanceQueryData}
    @type inst: L{objects.Instance}
    @param inst: Instance object

    """
    try:
      nic = inst.nics[index]
    except IndexError:
882
      return _FS_UNAVAIL
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897

    return cb(ctx, index, nic)

  return fn


def _GetInstNicIp(ctx, _, nic): # pylint: disable-msg=W0613
  """Get a NIC's IP address.

  @type ctx: L{InstanceQueryData}
  @type nic: L{objects.NIC}
  @param nic: NIC object

  """
  if nic.ip is None:
898
    return _FS_UNAVAIL
899
  else:
900
    return nic.ip
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915


def _GetInstNicBridge(ctx, index, _):
  """Get a NIC's bridge.

  @type ctx: L{InstanceQueryData}
  @type index: int
  @param index: NIC index

  """
  assert len(ctx.inst_nicparams) >= index

  nicparams = ctx.inst_nicparams[index]

  if nicparams[constants.NIC_MODE] == constants.NIC_MODE_BRIDGED:
916
    return nicparams[constants.NIC_LINK]
917
  else:
918
    return _FS_UNAVAIL
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940


def _GetInstAllNicBridges(ctx, inst):
  """Get all network bridges for an instance.

  @type ctx: L{InstanceQueryData}
  @type inst: L{objects.Instance}
  @param inst: Instance object

  """
  assert len(ctx.inst_nicparams) == len(inst.nics)

  result = []

  for nicp in ctx.inst_nicparams:
    if nicp[constants.NIC_MODE] == constants.NIC_MODE_BRIDGED:
      result.append(nicp[constants.NIC_LINK])
    else:
      result.append(None)

  assert len(result) == len(inst.nics)

941
  return result
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961


def _GetInstNicParam(name):
  """Build function for retrieving a NIC parameter.

  @type name: string
  @param name: Parameter name

  """
  def fn(ctx, index, _):
    """Get a NIC's bridge.

    @type ctx: L{InstanceQueryData}
    @type inst: L{objects.Instance}
    @param inst: Instance object
    @type nic: L{objects.NIC}
    @param nic: NIC object

    """
    assert len(ctx.inst_nicparams) >= index
962
    return ctx.inst_nicparams[index][name]
963
964
965
966
967
968
969

  return fn


def _GetInstanceNetworkFields():
  """Get instance fields involving network interfaces.

970
971
  @return: Tuple containing list of field definitions used as input for
    L{_PrepareFieldList} and a list of aliases
972
973

  """
974
  nic_mac_fn = lambda ctx, _, nic: nic.mac
975
976
977
978
979
  nic_mode_fn = _GetInstNicParam(constants.NIC_MODE)
  nic_link_fn = _GetInstNicParam(constants.NIC_LINK)

  fields = [
    # All NICs
980
981
982
983
984
985
986
987
988
989
990
    (_MakeField("nic.count", "NICs", QFT_NUMBER,
                "Number of network interfaces"),
     IQ_CONFIG, lambda ctx, inst: len(inst.nics)),
    (_MakeField("nic.macs", "NIC_MACs", QFT_OTHER,
                "List containing each network interface's MAC address"),
     IQ_CONFIG, lambda ctx, inst: [nic.mac for nic in inst.nics]),
    (_MakeField("nic.ips", "NIC_IPs", QFT_OTHER,
                "List containing each network interface's IP address"),
     IQ_CONFIG, lambda ctx, inst: [nic.ip for nic in inst.nics]),
    (_MakeField("nic.modes", "NIC_modes", QFT_OTHER,
                "List containing each network interface's mode"), IQ_CONFIG,
991
992
     lambda ctx, inst: [nicp[constants.NIC_MODE]
                        for nicp in ctx.inst_nicparams]),
993
994
    (_MakeField("nic.links", "NIC_links", QFT_OTHER,
                "List containing each network interface's link"), IQ_CONFIG,
995
996
     lambda ctx, inst: [nicp[constants.NIC_LINK]
                        for nicp in ctx.inst_nicparams]),
997
998
    (_MakeField("nic.bridges", "NIC_bridges", QFT_OTHER,
                "List containing each network interface's bridge"), IQ_CONFIG,
999
1000
1001
1002
1003
     _GetInstAllNicBridges),
    ]

  # NICs by number
  for i in range(constants.MAX_NICS):
1004
    numtext = utils.FormatOrdinal(i + 1)
1005
    fields.extend([
1006
1007
      (_MakeField("nic.ip/%s" % i, "NicIP/%s" % i, QFT_TEXT,
                  "IP address of %s network interface" % numtext),
1008
       IQ_CONFIG, _GetInstNic(i, _GetInstNicIp)),
1009
1010
      (_MakeField("nic.mac/%s" % i, "NicMAC/%s" % i, QFT_TEXT,
                  "MAC address of %s network interface" % numtext),
1011
       IQ_CONFIG, _GetInstNic(i, nic_mac_fn)),
1012
1013
      (_MakeField("nic.mode/%s" % i, "NicMode/%s" % i, QFT_TEXT,
                  "Mode of %s network interface" % numtext),
1014
       IQ_CONFIG, _GetInstNic(i, nic_mode_fn)),
1015
1016
      (_MakeField("nic.link/%s" % i, "NicLink/%s" % i, QFT_TEXT,
                  "Link of %s network interface" % numtext),
1017
       IQ_CONFIG, _GetInstNic(i, nic_link_fn)),
1018
1019
      (_MakeField("nic.bridge/%s" % i, "NicBridge/%s" % i, QFT_TEXT,
                  "Bridge of %s network interface" % numtext),
1020
1021
1022
       IQ_CONFIG, _GetInstNic(i, _GetInstNicBridge)),
      ])

1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
  aliases = [
    # Legacy fields for first NIC
    ("ip", "nic.ip/0"),
    ("mac", "nic.mac/0"),
    ("bridge", "nic.bridge/0"),
    ("nic_mode", "nic.mode/0"),
    ("nic_link", "nic.link/0"),
    ]

  return (fields, aliases)
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047


def _GetInstDiskUsage(ctx, inst):
  """Get disk usage for an instance.

  @type ctx: L{InstanceQueryData}
  @type inst: L{objects.Instance}
  @param inst: Instance object

  """
  usage = ctx.disk_usage[inst.name]

  if usage is None:
    usage = 0

1048
  return usage
1049
1050


1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
def _GetInstanceConsole(ctx, inst):
  """Get console information for instance.

  @type ctx: L{InstanceQueryData}
  @type inst: L{objects.Instance}
  @param inst: Instance object

  """
  consinfo = ctx.console[inst.name]

  if consinfo is None:
    return _FS_UNAVAIL

  return consinfo


1067
1068
1069
1070
1071
1072
1073
def _GetInstanceDiskFields():
  """Get instance fields involving disks.

  @return: List of field definitions used as input for L{_PrepareFieldList}

  """
  fields = [
1074
1075
1076
1077
1078
1079
1080
1081
1082
    (_MakeField("disk_usage", "DiskUsage", QFT_UNIT,
                "Total disk space used by instance on each of its nodes;"
                " this is not the disk size visible to the instance, but"
                " the usage on the node"),
     IQ_DISKUSAGE, _GetInstDiskUsage),
    (_MakeField("disk.count", "Disks", QFT_NUMBER, "Number of disks"),
     IQ_CONFIG, lambda ctx, inst: len(inst.disks)),
    (_MakeField("disk.sizes", "Disk_sizes", QFT_OTHER, "List of disk sizes"),
     IQ_CONFIG, lambda ctx, inst: [disk.size for disk in inst.disks]),
1083
1084
1085
1086
    ]

  # Disks by number
  fields.extend([
1087
1088
    (_MakeField("disk.size/%s" % i, "Disk/%s" % i, QFT_UNIT,
                "Disk size of %s disk" % utils.FormatOrdinal(i + 1)),
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
     IQ_CONFIG, _GetInstDiskSize(i))
    for i in range(constants.MAX_DISKS)
    ])

  return fields


def _GetInstanceParameterFields():
  """Get instance fields involving parameters.

  @return: List of field definitions used as input for L{_PrepareFieldList}

  """
  # TODO: Consider moving titles closer to constants
  be_title = {
    constants.BE_AUTO_BALANCE: "Auto_balance",
1105
1106
    constants.BE_MEMORY: "ConfigMemory",
    constants.BE_VCPUS: "ConfigVCPUs",
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
    }

  hv_title = {
    constants.HV_ACPI: "ACPI",
    constants.HV_BOOT_ORDER: "Boot_order",
    constants.HV_CDROM_IMAGE_PATH: "CDROM_image_path",
    constants.HV_DISK_TYPE: "Disk_type",
    constants.HV_INITRD_PATH: "Initrd_path",
    constants.HV_KERNEL_PATH: "Kernel_path",
    constants.HV_NIC_TYPE: "NIC_type",
    constants.HV_PAE: "PAE",
    constants.HV_VNC_BIND_ADDRESS: "VNC_bind_address",
    }

  fields = [
    # Filled parameters
1123
1124
    (_MakeField("hvparams", "HypervisorParameters", QFT_OTHER,
                "Hypervisor parameters"),
1125
     IQ_CONFIG, lambda ctx, _: ctx.inst_hvparams),
1126
1127
    (_MakeField("beparams", "BackendParameters", QFT_OTHER,
                "Backend parameters"),
1128
     IQ_CONFIG, lambda ctx, _: ctx.inst_beparams),
1129
1130

    # Unfilled parameters
1131
1132
    (_MakeField("custom_hvparams", "CustomHypervisorParameters", QFT_OTHER,
                "Custom hypervisor parameters"),
1133
     IQ_CONFIG, _GetItemAttr("hvparams")),
1134
1135
    (_MakeField("custom_beparams", "CustomBackendParameters", QFT_OTHER,
                "Custom backend parameters",),
1136
     IQ_CONFIG, _GetItemAttr("beparams")),
1137
1138
    (_MakeField("custom_nicparams", "CustomNicParameters", QFT_OTHER,
                "Custom network interface parameters"),
1139
     IQ_CONFIG, lambda ctx, inst: [nic.nicparams for nic in inst.nics]),
1140
1141
1142
1143
    ]

  # HV params
  def _GetInstHvParam(name):
1144
    return lambda ctx, _: ctx.inst_hvparams.get(name, _FS_UNAVAIL)
1145
1146

  fields.extend([
1147
    (_MakeField("hv/%s" % name, hv_title.get(name, "hv/%s" % name),
1148
                _VTToQFT[kind], "The \"%s\" hypervisor parameter" % name),
1149
     IQ_CONFIG, _GetInstHvParam(name))
1150
    for name, kind in constants.HVS_PARAMETER_TYPES.items()
1151
1152
1153
1154
1155
    if name not in constants.HVC_GLOBALS
    ])

  # BE params
  def _GetInstBeParam(name):
1156
    return lambda ctx, _: ctx.inst_beparams.get(name, None)
1157
1158

  fields.extend([
1159
    (_MakeField("be/%s" % name, be_title.get(name, "be/%s" % name),
1160
1161
                _VTToQFT[kind], "The \"%s\" backend parameter" % name),
     IQ_CONFIG, _GetInstBeParam(name))
1162
    for name, kind in constants.BES_PARAMETER_TYPES.items()
1163
1164
1165
1166
1167
1168
    ])

  return fields


_INST_SIMPLE_FIELDS = {
1169
1170
1171
  "disk_template": ("Disk_template", QFT_TEXT, "Instance disk template"),
  "hypervisor": ("Hypervisor", QFT_TEXT, "Hypervisor name"),
  "name": ("Instance", QFT_TEXT, "Instance name"),
1172
  # Depending on the hypervisor, the port can be None
1173
1174
1175
1176
1177
  "network_port": ("Network_port", QFT_OTHER,
                   "Instance network port if available (e.g. for VNC console)"),
  "os": ("OS", QFT_TEXT, "Operating system"),
  "serial_no": ("SerialNo", QFT_NUMBER, _SERIAL_NO_DOC % "Instance"),
  "uuid": ("UUID", QFT_TEXT, "Instance UUID"),
1178
1179
1180
1181
1182
1183
1184
1185
  }


def _BuildInstanceFields():
  """Builds list of fields for instance queries.

  """
  fields = [
1186
    (_MakeField("pnode", "Primary_node", QFT_TEXT, "Primary node"), IQ_CONFIG,
1187
     _GetItemAttr("primary_node")),
1188
1189
1190
1191
1192
1193
1194
1195
    (_MakeField("snodes", "Secondary_Nodes", QFT_OTHER,
                "Secondary nodes; usually this will just be one node"),
     IQ_CONFIG, lambda ctx, inst: list(inst.secondary_nodes)),
    (_MakeField("admin_state", "Autostart", QFT_BOOL,
                "Desired state of instance (if set, the instance should be"
                " up)"),
     IQ_CONFIG, _GetItemAttr("admin_up")),
    (_MakeField("tags", "Tags", QFT_OTHER, "Tags"), IQ_CONFIG,
1196
     lambda ctx, inst: list(inst.GetTags())),
1197
1198
    (_MakeField("console", "Console", QFT_OTHER,
                "Instance console information"), IQ_CONSOLE,
1199
     _GetInstanceConsole),
1200
1201
1202
    ]

  # Add simple fields
1203
1204
1205
  fields.extend([(_MakeField(name, title, kind, doc),
                  IQ_CONFIG, _GetItemAttr(name))
                 for (name, (title, kind, doc)) in _INST_SIMPLE_FIELDS.items()])
1206
1207
1208

  # Fields requiring talking to the node
  fields.extend([
1209
1210
1211
1212
1213
1214
1215
1216
    (_MakeField("oper_state", "Running", QFT_BOOL, "Actual state of instance"),
     IQ_LIVE, _GetInstOperState),
    (_MakeField("oper_ram", "Memory", QFT_UNIT,
                "Actual memory usage as seen by hypervisor"),
     IQ_LIVE, _GetInstLiveData("memory")),
    (_MakeField("oper_vcpus", "VCPUs", QFT_NUMBER,
                "Actual number of VCPUs as seen by hypervisor"),
     IQ_LIVE, _GetInstLiveData("vcpus")),
1217
1218
    ])

1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
  # Status field
  status_values = (constants.INSTST_RUNNING, constants.INSTST_ADMINDOWN,
                   constants.INSTST_WRONGNODE, constants.INSTST_ERRORUP,
                   constants.INSTST_ERRORDOWN, constants.INSTST_NODEDOWN,
                   constants.INSTST_NODEOFFLINE)
  status_doc = ("Instance status; \"%s\" if instance is set to be running"
                " and actually is, \"%s\" if instance is stopped and"
                " is not running, \"%s\" if instance running, but not on its"
                " designated primary node, \"%s\" if instance should be"
                " stopped, but is actually running, \"%s\" if instance should"
                " run, but doesn't, \"%s\" if instance's primary node is down,"
                " \"%s\" if instance's primary node is marked offline" %
                status_values)
  fields.append((_MakeField("status", "Status", QFT_TEXT, status_doc),
                 IQ_LIVE, _GetInstStatus))
  assert set(status_values) == constants.INSTST_ALL, \
         "Status documentation mismatch"

1237
1238
1239
  (network_fields, network_aliases) = _GetInstanceNetworkFields()

  fields.extend(network_fields)
1240
1241
  fields.extend(_GetInstanceParameterFields())
  fields.extend(_GetInstanceDiskFields())
1242
  fields.extend(_GetItemTimestampFields(IQ_CONFIG))
1243

1244
1245
1246
1247
  aliases = [
    ("vcpus", "be/vcpus"),
    ("sda_size", "disk.size/0"),
    ("sdb_size", "disk.size/1"),
1248
    ] + network_aliases
1249
1250

  return _PrepareFieldList(fields, aliases)
1251
1252


1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
class LockQueryData:
  """Data container for lock data queries.

  """
  def __init__(self, lockdata):
    """Initializes this class.

    """
    self.lockdata = lockdata

  def __iter__(self):
    """Iterate over all locks.

    """
    return iter(self.lockdata)


def _GetLockOwners(_, data):
  """Returns a sorted list of a lock's current owners.

  """
  (_, _, owners, _) = data

  if owners:
    owners = utils.NiceSort(owners)

1279
  return owners
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291


def _GetLockPending(_, data):
  """Returns a sorted list of a lock's pending acquires.

  """
  (_, _, _, pending) = data

  if pending:
    pending = [(mode, utils.NiceSort(names))
               for (mode, names) in pending]

1292
  return pending
1293
1294
1295
1296
1297
1298
1299


def _BuildLockFields():
  """Builds list of fields for lock queries.

  """
  return _PrepareFieldList([
1300
    (_MakeField("name", "Name", QFT_TEXT, "Lock name"), None,
1301
     lambda ctx, (name, mode, owners, pending): name),
1302
1303
1304
1305
1306
1307
1308
1309
1310
    (_MakeField("mode", "Mode", QFT_OTHER,
                "Mode in which the lock is currently acquired"
                " (exclusive or shared)"),
     LQ_MODE, lambda ctx, (name, mode, owners, pending): mode),
    (_MakeField("owner", "Owner", QFT_OTHER, "Current lock owner(s)"),
     LQ_OWNER, _GetLockOwners),
    (_MakeField("pending", "Pending", QFT_OTHER,
                "Threads waiting for the lock"),
     LQ_PENDING, _GetLockPending),
1311
    ], [])
1312
1313


1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
class GroupQueryData:
  """Data container for node group data queries.

  """
  def __init__(self, groups, group_to_nodes, group_to_instances):
    """Initializes this class.

    @param groups: List of node group objects
    @type group_to_nodes: dict; group UUID as key
    @param group_to_nodes: Per-group list of nodes
    @type group_to_instances: dict; group UUID as key
    @param group_to_instances: Per-group list of (primary) instances

    """
    self.groups = groups
    self.group_to_nodes = group_to_nodes
    self.group_to_instances = group_to_instances

  def __iter__(self):
    """Iterate over all node groups.

    """
    return iter(self.groups)


_GROUP_SIMPLE_FIELDS = {
1340
1341
1342
1343
1344
  "alloc_policy": ("AllocPolicy", QFT_TEXT, "Allocation policy for group"),
  "name": ("Group", QFT_TEXT, "Group name"),
  "serial_no": ("SerialNo", QFT_NUMBER, _SERIAL_NO_DOC % "Group"),
  "uuid": ("UUID", QFT_TEXT, "Group UUID"),
  "ndparams": ("NDParams", QFT_OTHER, "Node parameters"),
1345
1346
1347
1348
1349
1350
1351
1352
  }


def _BuildGroupFields():
  """Builds list of fields for node group queries.

  """
  # Add simple fields
1353
1354
  fields = [(_MakeField(name, title, kind, doc), GQ_CONFIG, _GetItemAttr(name))
            for (name, (title, kind, doc)) in _GROUP_SIMPLE_FIELDS.items()]
1355
1356

  def _GetLength(getter):
1357
    return lambda ctx, group: len(getter(ctx)[group.uuid])
1358
1359

  def _GetSortedList(getter):
1360
    return lambda ctx, group: utils.NiceSort(getter(ctx)[group.uuid])
1361
1362
1363
1364
1365
1366

  group_to_nodes = operator.attrgetter("group_to_nodes")
  group_to_instances = operator.attrgetter("group_to_instances")

  # Add fields for nodes
  fields.extend([
1367
    (_MakeField("node_cnt", "Nodes", QFT_NUMBER, "Number of nodes"),
1368
     GQ_NODE, _GetLength(group_to_nodes)),
1369
    (_MakeField("node_list", "NodeList", QFT_OTHER, "List of nodes"),
1370
1371
1372
1373
1374
     GQ_NODE, _GetSortedList(group_to_nodes)),
    ])

  # Add fields for instances
  fields.extend([
1375
1376
    (_MakeField("pinst_cnt", "Instances", QFT_NUMBER,
                "Number of primary instances"),
1377
     GQ_INST, _GetLength(group_to_instances)),
1378
1379
    (_MakeField("pinst_list", "InstanceList", QFT_OTHER,
                "List of primary instances"),
1380
1381
1382
1383
1384
     GQ_INST, _GetSortedList(group_to_instances)),
    ])

  fields.extend(_GetItemTimestampFields(GQ_CONFIG))

1385
  return _PrepareFieldList(fields, [])
1386
1387


Michael Hanselmann's avatar
Michael Hanselmann committed
1388
1389
#: Fields available for node queries
NODE_FIELDS = _BuildNodeFields()
1390
1391
1392

#: Fields available for instance queries
INSTANCE_FIELDS = _BuildInstanceFields()
1393
1394
1395

#: Fields available for lock queries
LOCK_FIELDS = _BuildLockFields()
1396

1397
1398
1399
#: Fields available for node group queries
GROUP_FIELDS = _BuildGroupFields()

1400
1401
1402
1403
1404
1405
1406
1407
#: All available resources
ALL_FIELDS = {
  constants.QR_INSTANCE: INSTANCE_FIELDS,
  constants.QR_NODE: NODE_FIELDS,
  constants.QR_LOCK: LOCK_FIELDS,
  constants.QR_GROUP: GROUP_FIELDS,
  }

1408
#: All available field lists
1409