query.py 41.7 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
      - Data request type, see e.g. C{NQ_*}
Michael Hanselmann's avatar
Michael Hanselmann committed
38
      - OR-ed flags, see C{QFF_*}
Michael Hanselmann's avatar
Michael Hanselmann committed
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
      - 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.

"""
55

Michael Hanselmann's avatar
Michael Hanselmann committed
56
import logging
57
58
59
60
61
62
63
64
65
66
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

67
68
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
69
70
                              RS_NORMAL, RS_UNKNOWN, RS_NODATA,
                              RS_UNAVAIL, RS_OFFLINE)
71

72

Michael Hanselmann's avatar
Michael Hanselmann committed
73
74
75
76
# 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
77
78
79
(NQ_CONFIG,
 NQ_INST,
 NQ_LIVE,
80
81
 NQ_GROUP,
 NQ_OOB) = range(1, 6)
Michael Hanselmann's avatar
Michael Hanselmann committed
82

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

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

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

Michael Hanselmann's avatar
Michael Hanselmann committed
96
97
98
99
100
# Query field flags
QFF_HOSTNAME = 0x01
QFF_IP_ADDRESS = 0x02
# Next values: 0x04, 0x08, 0x10, 0x20, 0x40, 0x80, 0x100, 0x200
QFF_ALL = (QFF_HOSTNAME | QFF_IP_ADDRESS)
101

102
103
FIELD_NAME_RE = re.compile(r"^[a-z0-9/._]+$")
TITLE_RE = re.compile(r"^[^\s]+$")
104
DOC_RE = re.compile(r"^[A-Z].*[^.,?!]$")
105
106
107

#: Verification function for each field type
_VERIFY_FN = {
108
109
110
111
112
113
114
  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,
115
116
  }

117
118
119
120
121
122
# Unique objects for special field statuses
_FS_UNKNOWN = object()
_FS_NODATA = object()
_FS_UNAVAIL = object()
_FS_OFFLINE = object()

123
124
125
126
127
128
129
130
131
132
#: 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,
  }

133
134
_SERIAL_NO_DOC = "%s object serial number, incremented on each modification"

135
136
137
138
139

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

  """
140
  return _FS_UNKNOWN
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159


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:
160
      fdef = (_MakeField(name, name, QFT_UNKNOWN, "Unknown field '%s'" % name),
Michael Hanselmann's avatar
Michael Hanselmann committed
161
              None, 0, _GetUnknownField)
162

Michael Hanselmann's avatar
Michael Hanselmann committed
163
    assert len(fdef) == 4
164
165
166
167
168
169
170
171
172
173
174
175

    result.append(fdef)

  return result


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

  @rtype: list of L{objects.QueryFieldDefinition}

  """
Michael Hanselmann's avatar
Michael Hanselmann committed
176
  return [fdef for (fdef, _, _, _) in fielddefs]
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


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
Michael Hanselmann's avatar
Michael Hanselmann committed
208
                     for (_, datakind, _, _) in self._fields
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
                     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__}

    """
Michael Hanselmann's avatar
Michael Hanselmann committed
228
    result = [[_ProcessResult(fn(ctx, item)) for (_, _, _, fn) in self._fields]
229
230
231
232
              for item in ctx]

    # Verify result
    if __debug__:
233
234
      for row in result:
        _VerifyResultRow(self._fields, row)
235
236
237
238
239
240
241
242
243

    return result

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

    See L{Query.Query} for arguments.

    """
Michael Hanselmann's avatar
Michael Hanselmann committed
244
245
    unknown = set(fdef.name for (fdef, _, _, _) in self._fields
                  if fdef.kind == QFT_UNKNOWN)
246
247
248
249
250
251
252
253
254
    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)]


255
256
257
258
259
def _ProcessResult(value):
  """Converts result values into externally-visible ones.

  """
  if value is _FS_UNKNOWN:
René Nussbaumer's avatar
René Nussbaumer committed
260
    return (RS_UNKNOWN, None)
261
  elif value is _FS_NODATA:
René Nussbaumer's avatar
René Nussbaumer committed
262
    return (RS_NODATA, None)
263
  elif value is _FS_UNAVAIL:
René Nussbaumer's avatar
René Nussbaumer committed
264
    return (RS_UNAVAIL, None)
265
  elif value is _FS_OFFLINE:
René Nussbaumer's avatar
René Nussbaumer committed
266
    return (RS_OFFLINE, None)
267
  else:
René Nussbaumer's avatar
René Nussbaumer committed
268
    return (RS_NORMAL, value)
269
270


271
272
273
274
275
276
277
278
279
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

  """
280
281
  assert len(row) == len(fields)
  errs = []
Michael Hanselmann's avatar
Michael Hanselmann committed
282
  for ((status, value), (fdef, _, _, _)) in zip(row, fields):
René Nussbaumer's avatar
René Nussbaumer committed
283
    if status == RS_NORMAL:
284
285
286
287
288
289
290
      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))
291
292


293
def _PrepareFieldList(fields, aliases):
294
295
296
297
  """Prepares field list for use by L{Query}.

  Converts the list to a dictionary and does some verification.

298
299
300
301
302
303
304
  @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
305
306
307
308
  @rtype: dict
  @return: Field dictionary for L{Query}

  """
309
310
  if __debug__:
    duplicates = utils.FindDuplicates(fdef.title.lower()
Michael Hanselmann's avatar
Michael Hanselmann committed
311
                                      for (fdef, _, _, _) in fields)
312
    assert not duplicates, "Duplicate title(s) found: %r" % duplicates
313
314
315
316

  result = {}

  for field in fields:
Michael Hanselmann's avatar
Michael Hanselmann committed
317
    (fdef, _, flags, fn) = field
318
319
320
321

    assert fdef.name and fdef.title, "Name and title are required"
    assert FIELD_NAME_RE.match(fdef.name)
    assert TITLE_RE.match(fdef.title)
322
323
324
    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
325
    assert callable(fn)
326
327
    assert fdef.name not in result, \
           "Duplicate field name '%s' found" % fdef.name
Michael Hanselmann's avatar
Michael Hanselmann committed
328
    assert (flags & ~QFF_ALL) == 0, "Unknown flags for field '%s'" % fdef.name
329
330
331

    result[fdef.name] = field

332
333
334
  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)
Michael Hanselmann's avatar
Michael Hanselmann committed
335
    (fdef, k, flags, fn) = result[target]
336
337
    fdef = fdef.Copy()
    fdef.name = alias
Michael Hanselmann's avatar
Michael Hanselmann committed
338
    result[alias] = (fdef, k, flags, fn)
339
340

  assert len(result) == len(fields) + len(aliases)
341
  assert compat.all(name == fdef.name
Michael Hanselmann's avatar
Michael Hanselmann committed
342
                    for (name, (fdef, _, _, _)) in result.items())
343
344
345
346

  return result


347
348
349
350
351
352
353
354
355
356
357
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()


358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
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()


379
def _MakeField(name, title, kind, doc):
380
381
382
383
384
  """Wrapper for creating L{objects.QueryFieldDefinition} instances.

  @param name: Field name as a regular expression
  @param title: Human-readable title
  @param kind: Field type
385
  @param doc: Human-readable description
386
387

  """
388
389
  return objects.QueryFieldDefinition(name=name, title=title, kind=kind,
                                      doc=doc)
Michael Hanselmann's avatar
Michael Hanselmann committed
390
391
392
393
394
395
396
397
398
399
400
401


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:
402
    return constants.NR_MASTER
Michael Hanselmann's avatar
Michael Hanselmann committed
403
  elif node.master_candidate:
404
    return constants.NR_MCANDIDATE
Michael Hanselmann's avatar
Michael Hanselmann committed
405
  elif node.drained:
406
    return constants.NR_DRAINED
Michael Hanselmann's avatar
Michael Hanselmann committed
407
  elif node.offline:
408
    return constants.NR_OFFLINE
Michael Hanselmann's avatar
Michael Hanselmann committed
409
  else:
410
    return constants.NR_REGULAR
Michael Hanselmann's avatar
Michael Hanselmann committed
411
412
413
414
415
416
417
418
419


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

  @param attr: Attribute name

  """
  getter = operator.attrgetter(attr)
420
  return lambda _, item: getter(item)
Michael Hanselmann's avatar
Michael Hanselmann committed
421
422


423
424
425
426
427
428
429
430
431
432
433
434
435
436
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
437
      return _FS_UNAVAIL
438
    else:
439
      return timestamp
440
441
442
443
444
445
446
447
448
449
450

  return fn


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

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

  """
  return [
451
    (_MakeField("ctime", "CTime", QFT_TIMESTAMP, "Creation timestamp"),
Michael Hanselmann's avatar
Michael Hanselmann committed
452
     datatype, 0, _GetItemTimestamp(operator.attrgetter("ctime"))),
453
    (_MakeField("mtime", "MTime", QFT_TIMESTAMP, "Modification timestamp"),
Michael Hanselmann's avatar
Michael Hanselmann committed
454
     datatype, 0, _GetItemTimestamp(operator.attrgetter("mtime"))),
455
456
457
    ]


Michael Hanselmann's avatar
Michael Hanselmann committed
458
459
460
461
462
class NodeQueryData:
  """Data container for node data queries.

  """
  def __init__(self, nodes, live_data, master_name, node_to_primary,
463
               node_to_secondary, groups, oob_support, cluster):
Michael Hanselmann's avatar
Michael Hanselmann committed
464
465
466
467
468
469
470
471
472
    """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
473
    self.oob_support = oob_support
474
    self.cluster = cluster
Michael Hanselmann's avatar
Michael Hanselmann committed
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495

    # 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 = {
Michael Hanselmann's avatar
Michael Hanselmann committed
496
497
  "drained": ("Drained", QFT_BOOL, 0, "Whether node is drained"),
  "master_candidate": ("MasterC", QFT_BOOL, 0,
498
                       "Whether node is a master candidate"),
Michael Hanselmann's avatar
Michael Hanselmann committed
499
  "master_capable": ("MasterCapable", QFT_BOOL, 0,
500
                     "Whether node can become a master candidate"),
Michael Hanselmann's avatar
Michael Hanselmann committed
501
502
503
504
505
  "name": ("Node", QFT_TEXT, QFF_HOSTNAME, "Node name"),
  "offline": ("Offline", QFT_BOOL, 0, "Whether node is marked offline"),
  "serial_no": ("SerialNo", QFT_NUMBER, 0, _SERIAL_NO_DOC % "Node"),
  "uuid": ("UUID", QFT_TEXT, 0, "Node UUID"),
  "vm_capable": ("VMCapable", QFT_BOOL, 0, "Whether node can host instances"),
Michael Hanselmann's avatar
Michael Hanselmann committed
506
507
508
509
  }


#: Fields requiring talking to the node
510
# Note that none of these are available for non-vm_capable nodes
Michael Hanselmann's avatar
Michael Hanselmann committed
511
_NODE_LIVE_FIELDS = {
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
  "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
531
532
533
  }


534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
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
551
      return _FS_UNAVAIL
552
553
554
555
556
557
558

    return cb(ctx, node, ng)

  return fn


def _GetNodeGroup(ctx, node, ng): # pylint: disable-msg=W0613
Michael Hanselmann's avatar
Michael Hanselmann committed
559
560
561
562
563
  """Returns the name of a node's group.

  @type ctx: L{NodeQueryData}
  @type node: L{objects.Node}
  @param node: Node object
564
565
  @type ng: L{objects.NodeGroup}
  @param ng: The node group this node belongs to
Michael Hanselmann's avatar
Michael Hanselmann committed
566
567

  """
568
  return ng.name
Michael Hanselmann's avatar
Michael Hanselmann committed
569
570


571
572
573
574
575
576
577
578
579
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]:
580
    return node.powered
581

582
  return _FS_UNAVAIL
583
584


585
586
587
588
589
590
591
592
593
594
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

  """
595
  return ctx.cluster.SimpleFillND(ng.FillND(node))
596
597


598
def _GetLiveNodeField(field, kind, ctx, node):
Michael Hanselmann's avatar
Michael Hanselmann committed
599
600
601
602
603
  """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}
604
605
  @type node: L{objects.Node}
  @param node: Node object
Michael Hanselmann's avatar
Michael Hanselmann committed
606
607

  """
608
  if node.offline:
609
    return _FS_OFFLINE
610

611
612
613
  if not node.vm_capable:
    return _FS_UNAVAIL

Michael Hanselmann's avatar
Michael Hanselmann committed
614
  if not ctx.curlive_data:
615
    return _FS_NODATA
Michael Hanselmann's avatar
Michael Hanselmann committed
616
617
618
619

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

622
  if kind == QFT_TEXT:
623
    return value
Michael Hanselmann's avatar
Michael Hanselmann committed
624

625
  assert kind in (QFT_NUMBER, QFT_UNIT)
Michael Hanselmann's avatar
Michael Hanselmann committed
626
627
628

  # Try to convert into number
  try:
629
    return int(value)
Michael Hanselmann's avatar
Michael Hanselmann committed
630
631
632
  except (ValueError, TypeError):
    logging.exception("Failed to convert node field '%s' (value %r) to int",
                      value, field)
633
    return _FS_UNAVAIL
Michael Hanselmann's avatar
Michael Hanselmann committed
634
635
636
637
638
639
640


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

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

664
665
666
667
668
669
670
  # 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)
Michael Hanselmann's avatar
Michael Hanselmann committed
671
  fields.append((_MakeField("role", "Role", QFT_TEXT, role_doc), NQ_CONFIG, 0,
672
673
674
                 lambda ctx, node: _GetNodeRole(node, ctx.master_name)))
  assert set(role_values) == constants.NR_ALL

Michael Hanselmann's avatar
Michael Hanselmann committed
675
  def _GetLength(getter):
676
    return lambda ctx, node: len(getter(ctx)[node.name])
Michael Hanselmann's avatar
Michael Hanselmann committed
677
678

  def _GetList(getter):
679
    return lambda ctx, node: list(getter(ctx)[node.name])
Michael Hanselmann's avatar
Michael Hanselmann committed
680
681

  # Add fields operating on instance lists
682
683
684
  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
685
    # TODO: Allow filterting by hostname in list
Michael Hanselmann's avatar
Michael Hanselmann committed
686
    fields.extend([
687
688
      (_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
689
       NQ_INST, 0, _GetLength(getter)),
Michael Hanselmann's avatar
Michael Hanselmann committed
690
      (_MakeField("%sinst_list" % prefix, "%sInstances" % titleprefix,
691
692
                  QFT_OTHER,
                  "List of instances with this node as %s" % docword),
Michael Hanselmann's avatar
Michael Hanselmann committed
693
       NQ_INST, 0, _GetList(getter)),
Michael Hanselmann's avatar
Michael Hanselmann committed
694
695
696
      ])

  # Add simple fields
Michael Hanselmann's avatar
Michael Hanselmann committed
697
698
699
700
  fields.extend([
    (_MakeField(name, title, kind, doc), NQ_CONFIG, flags, _GetItemAttr(name))
    for (name, (title, kind, flags, doc)) in _NODE_SIMPLE_FIELDS.items()
    ])
Michael Hanselmann's avatar
Michael Hanselmann committed
701
702
703

  # Add fields requiring live data
  fields.extend([
Michael Hanselmann's avatar
Michael Hanselmann committed
704
    (_MakeField(name, title, kind, doc), NQ_LIVE, 0,
Michael Hanselmann's avatar
Michael Hanselmann committed
705
     compat.partial(_GetLiveNodeField, nfield, kind))
706
    for (name, (title, kind, nfield, doc)) in _NODE_LIVE_FIELDS.items()
Michael Hanselmann's avatar
Michael Hanselmann committed
707
708
    ])

709
710
711
  # Add timestamps
  fields.extend(_GetItemTimestampFields(NQ_CONFIG))

712
  return _PrepareFieldList(fields, [])
Michael Hanselmann's avatar
Michael Hanselmann committed
713
714


715
716
717
718
719
class InstanceQueryData:
  """Data container for instance data queries.

  """
  def __init__(self, instances, cluster, disk_usage, offline_nodes, bad_nodes,
720
               live_data, wrongnode_inst, console):
721
722
723
724
725
726
727
728
729
730
731
732
    """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
733
734
    @type wrongnode_inst: set
    @param wrongnode_inst: Set of instances running on wrong node(s)
735
736
    @type console: dict; instance name as key
    @param console: Per-instance console information
737
738
739
740
741
742
743
744
745
746
747
748
749

    """
    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
750
    self.wrongnode_inst = wrongnode_inst
751
    self.console = console
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781

    # 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
782
  # Can't use RS_OFFLINE here as it would describe the instance to
783
  # be offline when we actually don't know due to missing data
784
  if inst.primary_node in ctx.bad_nodes:
785
    return _FS_NODATA
786
  else:
787
    return bool(ctx.live_data.get(inst.name))
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806


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
807
      # Can't use RS_OFFLINE here as it would describe the instance to be
808
      # offline when we actually don't know due to missing data
809
      return _FS_NODATA
810
811
812
813

    if inst.name in ctx.live_data:
      data = ctx.live_data[inst.name]
      if name in data:
814
        return data[name]
815

816
    return _FS_UNAVAIL
817
818
819
820
821
822
823
824
825
826
827
828
829

  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:
830
    return constants.INSTST_NODEOFFLINE
831
832

  if inst.primary_node in ctx.bad_nodes:
833
    return constants.INSTST_NODEDOWN
834
835

  if bool(ctx.live_data.get(inst.name)):
836
    if inst.name in ctx.wrongnode_inst:
837
      return constants.INSTST_WRONGNODE
838
    elif inst.admin_up:
839
      return constants.INSTST_RUNNING
840
    else:
841
      return constants.INSTST_ERRORUP
842
843

  if inst.admin_up:
844
    return constants.INSTST_ERRORDOWN
845

846
  return constants.INSTST_ADMINDOWN
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863


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:
864
      return inst.disks[index].size
865
    except IndexError:
866
      return _FS_UNAVAIL
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890

  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:
891
      return _FS_UNAVAIL
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906

    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:
907
    return _FS_UNAVAIL
908
  else:
909
    return nic.ip
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924


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:
925
    return nicparams[constants.NIC_LINK]
926
  else:
927
    return _FS_UNAVAIL
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949


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)

950
  return result
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970


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
971
    return ctx.inst_nicparams[index][name]
972
973
974
975
976
977
978

  return fn


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

979
980
  @return: Tuple containing list of field definitions used as input for
    L{_PrepareFieldList} and a list of aliases
981
982

  """
983
  nic_mac_fn = lambda ctx, _, nic: nic.mac
984
985
986
987
988
  nic_mode_fn = _GetInstNicParam(constants.NIC_MODE)
  nic_link_fn = _GetInstNicParam(constants.NIC_LINK)

  fields = [
    # All NICs
989
990
    (_MakeField("nic.count", "NICs", QFT_NUMBER,
                "Number of network interfaces"),
Michael Hanselmann's avatar
Michael Hanselmann committed
991
     IQ_CONFIG, 0, lambda ctx, inst: len(inst.nics)),
992
993
    (_MakeField("nic.macs", "NIC_MACs", QFT_OTHER,
                "List containing each network interface's MAC address"),
Michael Hanselmann's avatar
Michael Hanselmann committed
994
     IQ_CONFIG, 0, lambda ctx, inst: [nic.mac for nic in inst.nics]),
995
996
    (_MakeField("nic.ips", "NIC_IPs", QFT_OTHER,
                "List containing each network interface's IP address"),
Michael Hanselmann's avatar
Michael Hanselmann committed
997
     IQ_CONFIG, 0, lambda ctx, inst: [nic.ip for nic in inst.nics]),
998
    (_MakeField("nic.modes", "NIC_modes", QFT_OTHER,
Michael Hanselmann's avatar
Michael Hanselmann committed
999
                "List containing each network interface's mode"), IQ_CONFIG, 0,
1000
1001
     lambda ctx, inst: [nicp[constants.NIC_MODE]
                        for nicp in ctx.inst_nicparams]),
1002
    (_MakeField("nic.links", "NIC_links", QFT_OTHER,
Michael Hanselmann's avatar
Michael Hanselmann committed
1003
                "List containing each network interface's link"), IQ_CONFIG, 0,
1004
1005
     lambda ctx, inst: [nicp[constants.NIC_LINK]
                        for nicp in ctx.inst_nicparams]),
1006
    (_MakeField("nic.bridges", "NIC_bridges", QFT_OTHER,
Michael Hanselmann's avatar
Michael Hanselmann committed
1007
1008
                "List containing each network interface's bridge"),
     IQ_CONFIG, 0, _GetInstAllNicBridges),
1009
1010
1011
1012
    ]

  # NICs by number
  for i in range(constants.MAX_NICS):
1013
    numtext = utils.FormatOrdinal(i + 1)
1014
    fields.extend([
1015
1016
      (_MakeField("nic.ip/%s" % i, "NicIP/%s" % i, QFT_TEXT,
                  "IP address of %s network interface" % numtext),
Michael Hanselmann's avatar
Michael Hanselmann committed
1017
       IQ_CONFIG, 0, _GetInstNic(i, _GetInstNicIp)),
1018
1019
      (_MakeField("nic.mac/%s" % i, "NicMAC/%s" % i, QFT_TEXT,
                  "MAC address of %s network interface" % numtext),
Michael Hanselmann's avatar
Michael Hanselmann committed
1020
       IQ_CONFIG, 0, _GetInstNic(i, nic_mac_fn)),
1021
1022
      (_MakeField("nic.mode/%s" % i, "NicMode/%s" % i, QFT_TEXT,
                  "Mode of %s network interface" % numtext),
Michael Hanselmann's avatar
Michael Hanselmann committed
1023
       IQ_CONFIG, 0, _GetInstNic(i, nic_mode_fn)),
1024
1025
      (_MakeField("nic.link/%s" % i, "NicLink/%s" % i, QFT_TEXT,
                  "Link of %s network interface" % numtext),
Michael Hanselmann's avatar
Michael Hanselmann committed
1026
       IQ_CONFIG, 0, _GetInstNic(i, nic_link_fn)),
1027
1028
      (_MakeField("nic.bridge/%s" % i, "NicBridge/%s" % i, QFT_TEXT,
                  "Bridge of %s network interface" % numtext),
Michael Hanselmann's avatar
Michael Hanselmann committed
1029
       IQ_CONFIG, 0, _GetInstNic(i, _GetInstNicBridge)),
1030
1031
      ])

1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
  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)
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056


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

1057
  return usage
1058
1059


1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
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


1076
1077
1078
1079
1080
1081
1082
def _GetInstanceDiskFields():
  """Get instance fields involving disks.

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

  """
  fields = [
1083
1084
1085
1086
    (_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"),
Michael Hanselmann's avatar
Michael Hanselmann committed
1087
     IQ_DISKUSAGE, 0, _GetInstDiskUsage),
1088
    (_MakeField("disk.count", "Disks", QFT_NUMBER, "Number of disks"),
Michael Hanselmann's avatar
Michael Hanselmann committed
1089
     IQ_CONFIG, 0, lambda ctx, inst: len(inst.disks)),
1090
    (_MakeField("disk.sizes", "Disk_sizes", QFT_OTHER, "List of disk sizes"),
Michael Hanselmann's avatar
Michael Hanselmann committed
1091
     IQ_CONFIG, 0, lambda ctx, inst: [disk.size for disk in inst.disks]),
1092
1093
1094
1095
    ]

  # Disks by number
  fields.extend([
1096
1097
    (_MakeField("disk.size/%s" % i, "Disk/%s" % i, QFT_UNIT,
                "Disk size of %s disk" % utils.FormatOrdinal(i + 1)),
Michael Hanselmann's avatar
Michael Hanselmann committed
1098
     IQ_CONFIG, 0, _GetInstDiskSize(i))
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
    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",
1114
1115
    constants.BE_MEMORY: "ConfigMemory",
    constants.BE_VCPUS: "ConfigVCPUs",
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
    }

  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
1132
1133
    (_MakeField("hvparams", "HypervisorParameters", QFT_OTHER,
                "Hypervisor parameters"),
Michael Hanselmann's avatar
Michael Hanselmann committed
1134
     IQ_CONFIG, 0, lambda ctx, _: ctx.inst_hvparams),
1135
1136
    (_MakeField("beparams", "BackendParameters", QFT_OTHER,
                "Backend parameters"),
Michael Hanselmann's avatar
Michael Hanselmann committed
1137
     IQ_CONFIG, 0, lambda ctx, _: ctx.inst_beparams),
1138
1139

    # Unfilled parameters
1140
1141
    (_MakeField("custom_hvparams", "CustomHypervisorParameters", QFT_OTHER,
                "Custom hypervisor parameters"),
Michael Hanselmann's avatar
Michael Hanselmann committed
1142
     IQ_CONFIG, 0, _GetItemAttr("hvparams")),
1143
1144
    (_MakeField("custom_beparams", "CustomBackendParameters", QFT_OTHER,
                "Custom backend parameters",),
Michael Hanselmann's avatar
Michael Hanselmann committed
1145
     IQ_CONFIG, 0, _GetItemAttr("beparams")),
1146
1147
    (_MakeField("custom_nicparams", "CustomNicParameters", QFT_OTHER,
                "Custom network interface parameters"),
Michael Hanselmann's avatar
Michael Hanselmann committed
1148
     IQ_CONFIG, 0, lambda ctx, inst: [nic.nicparams for nic in inst.nics]),
1149
1150
1151
1152
    ]

  # HV params
  def _GetInstHvParam(name):
1153
    return lambda ctx, _: ctx.inst_hvparams.get(name, _FS_UNAVAIL)
1154
1155

  fields.extend([
1156
    (_MakeField("hv/%s" % name, hv_title.get(name, "hv/%s" % name),
1157
                _VTToQFT[kind], "The \"%s\" hypervisor parameter" % name),
Michael Hanselmann's avatar
Michael Hanselmann committed
1158
     IQ_CONFIG, 0, _GetInstHvParam(name))
1159
    for name, kind in constants.HVS_PARAMETER_TYPES.items()
1160
1161
1162
1163
1164
    if name not in constants.HVC_GLOBALS
    ])

  # BE params
  def _GetInstBeParam(name):
1165
    return lambda ctx, _: ctx.inst_beparams.get(name, None)
1166
1167

  fields.extend([
1168
    (_MakeField("be/%s" % name, be_title.get(name, "be/%s" % name),
1169
                _VTToQFT[kind], "The \"%s\" backend parameter" % name),
Michael Hanselmann's avatar
Michael Hanselmann committed
1170
     IQ_CONFIG, 0, _GetInstBeParam(name))
1171
    for name, kind in constants.BES_PARAMETER_TYPES.items()
1172
1173
1174
1175
1176
1177
    ])

  return fields


_INST_SIMPLE_FIELDS = {
Michael Hanselmann's avatar
Michael Hanselmann committed
1178
1179
1180
  "disk_template": ("Disk_template", QFT_TEXT, 0, "Instance disk template"),
  "hypervisor": ("Hypervisor", QFT_TEXT, 0, "Hypervisor name"),
  "name": ("Instance", QFT_TEXT, QFF_HOSTNAME, "Instance name"),
1181
  # Depending on the hypervisor, the port can be None
Michael Hanselmann's avatar
Michael Hanselmann committed
1182
  "network_port": ("Network_port", QFT_OTHER, 0,
1183
                   "Instance network port if available (e.g. for VNC console)"),
Michael Hanselmann's avatar
Michael Hanselmann committed
1184
1185
1186
  "os": ("OS", QFT_TEXT, 0, "Operating system"),
  "serial_no": ("SerialNo", QFT_NUMBER, 0, _SERIAL_NO_DOC % "Instance"),
  "uuid": ("UUID", QFT_TEXT, 0, "Instance UUID"),
1187
1188
1189
1190
1191
1192
1193
1194
  }


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

  """
  fields = [
Michael Hanselmann's avatar
Michael Hanselmann committed
1195
1196
1197
    (_MakeField("pnode", "Primary_node", QFT_TEXT, "Primary node"),
     IQ_CONFIG, QFF_HOSTNAME, _GetItemAttr("primary_node")),
    # TODO: Allow filtering by secondary node as hostname
1198
1199
    (_MakeField("snodes", "Secondary_Nodes", QFT_OTHER,
                "Secondary nodes; usually this will just be one node"),
Michael Hanselmann's avatar
Michael Hanselmann committed
1200
     IQ_CONFIG, 0, lambda ctx, inst: list(inst.secondary_nodes)),
1201
1202
1203
    (_MakeField("admin_state", "Autostart", QFT_BOOL,
                "Desired state of instance (if set, the instance should be"
                " up)"),
Michael Hanselmann's avatar
Michael Hanselmann committed
1204
1205
     IQ_CONFIG, 0, _GetItemAttr("admin_up")),
    (_MakeField("tags", "Tags", QFT_OTHER, "Tags"), IQ_CONFIG, 0,
1206
     lambda ctx, inst: list(inst.GetTags())),
1207
    (_MakeField("console", "Console", QFT_OTHER,
Michael Hanselmann's avatar
Michael Hanselmann committed
1208
                "Instance console information"), IQ_CONSOLE, 0,
1209
     _GetInstanceConsole),
1210
1211
1212
    ]

  # Add simple fields
Michael Hanselmann's avatar
Michael Hanselmann committed
1213
1214
1215
1216
  fields.extend([
    (_MakeField(name, title, kind, doc), IQ_CONFIG, flags, _GetItemAttr(name))
    for (name, (title, kind, flags, doc)) in _INST_SIMPLE_FIELDS.items()
    ])
1217
1218
1219

  # Fields requiring talking to the node
  fields.extend([
1220
    (_MakeField("oper_state", "Running", QFT_BOOL, "Actual state of instance"),
Michael Hanselmann's avatar
Michael Hanselmann committed
1221
     IQ_LIVE, 0, _GetInstOperState),
1222
1223
    (_MakeField("oper_ram", "Memory", QFT_UNIT,
                "Actual memory usage as seen by hypervisor"),
Michael Hanselmann's avatar
Michael Hanselmann committed
1224
     IQ_LIVE, 0, _GetInstLiveData("memory")),
1225
1226
    (_MakeField("oper_vcpus", "VCPUs", QFT_NUMBER,
                "Actual number of VCPUs as seen by hypervisor"),
Michael Hanselmann's avatar
Michael Hanselmann committed
1227
     IQ_LIVE, 0, _GetInstLiveData("vcpus")),
1228
1229
    ])

1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
  # 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),
Michael Hanselmann's avatar
Michael Hanselmann committed
1244
                 IQ_LIVE, 0, _GetInstStatus))
1245
1246
1247
  assert set(status_values) == constants.INSTST_ALL, \
         "Status documentation mismatch"

1248
1249
1250
  (network_fields, network_aliases) = _GetInstanceNetworkFields()

  fields.extend(network_fields)
1251
1252
  fields.extend(_GetInstanceParameterFields())
  fields.extend(_GetInstanceDiskFields())
1253
  fields.extend(_GetItemTimestampFields(IQ_CONFIG))
1254

1255
1256
1257