query.py 35 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
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
"""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}
      - 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.

"""
52

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

64
65
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
66
67
                              RS_NORMAL, RS_UNKNOWN, RS_NODATA,
                              RS_UNAVAIL, RS_OFFLINE)
68

69

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

80
81
(IQ_CONFIG,
 IQ_LIVE,
82
83
 IQ_DISKUSAGE,
 IQ_CONSOLE) = range(100, 104)
84

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

89
90
91
92
93
(GQ_CONFIG,
 GQ_NODE,
 GQ_INST) = range(200, 203)


94
95
96
97
98
FIELD_NAME_RE = re.compile(r"^[a-z0-9/._]+$")
TITLE_RE = re.compile(r"^[^\s]+$")

#: Verification function for each field type
_VERIFY_FN = {
99
100
101
102
103
104
105
  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,
106
107
  }

108
109
110
111
112
113
# Unique objects for special field statuses
_FS_UNKNOWN = object()
_FS_NODATA = object()
_FS_UNAVAIL = object()
_FS_OFFLINE = object()

114
115
116
117
118
119
120
121
122
123
#: 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,
  }

124
125
126
127
128

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

  """
129
  return _FS_UNKNOWN
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148


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:
149
      fdef = (_MakeField(name, name, QFT_UNKNOWN), None, _GetUnknownField)
150
151
152
153
154
155
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

    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__}

    """
216
    result = [[_ProcessResult(fn(ctx, item)) for (_, _, fn) in self._fields]
217
218
219
220
              for item in ctx]

    # Verify result
    if __debug__:
221
222
      for row in result:
        _VerifyResultRow(self._fields, row)
223
224
225
226
227
228
229
230
231
232

    return result

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

    See L{Query.Query} for arguments.

    """
    unknown = set(fdef.name
233
                  for (fdef, _, _) in self._fields if fdef.kind == QFT_UNKNOWN)
234
235
236
237
238
239
240
241
242
    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)]


243
244
245
246
247
def _ProcessResult(value):
  """Converts result values into externally-visible ones.

  """
  if value is _FS_UNKNOWN:
René Nussbaumer's avatar
René Nussbaumer committed
248
    return (RS_UNKNOWN, None)
249
  elif value is _FS_NODATA:
René Nussbaumer's avatar
René Nussbaumer committed
250
    return (RS_NODATA, None)
251
  elif value is _FS_UNAVAIL:
René Nussbaumer's avatar
René Nussbaumer committed
252
    return (RS_UNAVAIL, None)
253
  elif value is _FS_OFFLINE:
René Nussbaumer's avatar
René Nussbaumer committed
254
    return (RS_OFFLINE, None)
255
  else:
René Nussbaumer's avatar
René Nussbaumer committed
256
    return (RS_NORMAL, value)
257
258


259
260
261
262
263
264
265
266
267
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

  """
268
269
270
  assert len(row) == len(fields)
  errs = []
  for ((status, value), (fdef, _, _)) in zip(row, fields):
René Nussbaumer's avatar
René Nussbaumer committed
271
    if status == RS_NORMAL:
272
273
274
275
276
277
278
      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))
279
280


281
def _PrepareFieldList(fields, aliases):
282
283
284
285
  """Prepares field list for use by L{Query}.

  Converts the list to a dictionary and does some verification.

286
287
288
289
290
291
292
  @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
293
294
295
296
  @rtype: dict
  @return: Field dictionary for L{Query}

  """
297
298
299
300
  if __debug__:
    duplicates = utils.FindDuplicates(fdef.title.lower()
                                      for (fdef, _, _) in fields)
    assert not duplicates, "Duplicate title(s) found: %r" % duplicates
301
302
303
304
305
306
307
308
309
310

  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)
    assert callable(fn)
311
312
    assert fdef.name not in result, \
           "Duplicate field name '%s' found" % fdef.name
313
314
315

    result[fdef.name] = field

316
317
318
319
320
321
322
323
324
  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)
325
326
327
328
329
330
  assert compat.all(name == fdef.name
                    for (name, (fdef, _, _)) in result.items())

  return result


331
332
333
334
335
336
337
338
339
340
341
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()


342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
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()


363
364
365
366
367
368
369
370
371
def _MakeField(name, title, kind):
  """Wrapper for creating L{objects.QueryFieldDefinition} instances.

  @param name: Field name as a regular expression
  @param title: Human-readable title
  @param kind: Field type

  """
  return objects.QueryFieldDefinition(name=name, title=title, kind=kind)
Michael Hanselmann's avatar
Michael Hanselmann committed
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
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:
    return "M"
  elif node.master_candidate:
    return "C"
  elif node.drained:
    return "D"
  elif node.offline:
    return "O"
  else:
    return "R"


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

  @param attr: Attribute name

  """
  getter = operator.attrgetter(attr)
402
  return lambda _, item: getter(item)
Michael Hanselmann's avatar
Michael Hanselmann committed
403
404


405
406
407
408
409
410
411
412
413
414
415
416
417
418
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
419
      return _FS_UNAVAIL
420
    else:
421
      return timestamp
422
423
424
425
426
427
428
429
430
431
432

  return fn


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

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

  """
  return [
433
    (_MakeField("ctime", "CTime", QFT_TIMESTAMP), datatype,
434
     _GetItemTimestamp(operator.attrgetter("ctime"))),
435
    (_MakeField("mtime", "MTime", QFT_TIMESTAMP), datatype,
436
437
438
439
     _GetItemTimestamp(operator.attrgetter("mtime"))),
    ]


Michael Hanselmann's avatar
Michael Hanselmann committed
440
441
442
443
444
class NodeQueryData:
  """Data container for node data queries.

  """
  def __init__(self, nodes, live_data, master_name, node_to_primary,
445
               node_to_secondary, groups, oob_support, cluster):
Michael Hanselmann's avatar
Michael Hanselmann committed
446
447
448
449
450
451
452
453
454
    """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
455
    self.oob_support = oob_support
456
    self.cluster = cluster
Michael Hanselmann's avatar
Michael Hanselmann committed
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477

    # 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 = {
478
479
480
481
482
483
484
485
  "drained": ("Drained", QFT_BOOL),
  "master_candidate": ("MasterC", QFT_BOOL),
  "master_capable": ("MasterCapable", QFT_BOOL),
  "name": ("Node", QFT_TEXT),
  "offline": ("Offline", QFT_BOOL),
  "serial_no": ("SerialNo", QFT_NUMBER),
  "uuid": ("UUID", QFT_TEXT),
  "vm_capable": ("VMCapable", QFT_BOOL),
Michael Hanselmann's avatar
Michael Hanselmann committed
486
487
488
489
490
  }


#: Fields requiring talking to the node
_NODE_LIVE_FIELDS = {
491
492
493
494
495
496
497
498
499
  "bootid": ("BootID", QFT_TEXT, "bootid"),
  "cnodes": ("CNodes", QFT_NUMBER, "cpu_nodes"),
  "csockets": ("CSockets", QFT_NUMBER, "cpu_sockets"),
  "ctotal": ("CTotal", QFT_NUMBER, "cpu_total"),
  "dfree": ("DFree", QFT_UNIT, "vg_free"),
  "dtotal": ("DTotal", QFT_UNIT, "vg_size"),
  "mfree": ("MFree", QFT_UNIT, "memory_free"),
  "mnode": ("MNode", QFT_UNIT, "memory_dom0"),
  "mtotal": ("MTotal", QFT_UNIT, "memory_total"),
Michael Hanselmann's avatar
Michael Hanselmann committed
500
501
502
  }


503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
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
520
      return _FS_UNAVAIL
521
522
523
524
525
526
527

    return cb(ctx, node, ng)

  return fn


def _GetNodeGroup(ctx, node, ng): # pylint: disable-msg=W0613
Michael Hanselmann's avatar
Michael Hanselmann committed
528
529
530
531
532
  """Returns the name of a node's group.

  @type ctx: L{NodeQueryData}
  @type node: L{objects.Node}
  @param node: Node object
533
534
  @type ng: L{objects.NodeGroup}
  @param ng: The node group this node belongs to
Michael Hanselmann's avatar
Michael Hanselmann committed
535
536

  """
537
  return ng.name
Michael Hanselmann's avatar
Michael Hanselmann committed
538
539


540
541
542
543
544
545
546
547
548
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]:
549
    return node.powered
550

551
  return _FS_UNAVAIL
552
553


554
555
556
557
558
559
560
561
562
563
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

  """
564
  return ctx.cluster.SimpleFillND(ng.FillND(node))
565
566


567
def _GetLiveNodeField(field, kind, ctx, node):
Michael Hanselmann's avatar
Michael Hanselmann committed
568
569
570
571
572
  """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}
573
574
  @type node: L{objects.Node}
  @param node: Node object
Michael Hanselmann's avatar
Michael Hanselmann committed
575
576

  """
577
  if node.offline:
578
    return _FS_OFFLINE
579

Michael Hanselmann's avatar
Michael Hanselmann committed
580
  if not ctx.curlive_data:
581
    return _FS_NODATA
Michael Hanselmann's avatar
Michael Hanselmann committed
582
583
584
585

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

588
  if kind == QFT_TEXT:
589
    return value
Michael Hanselmann's avatar
Michael Hanselmann committed
590

591
  assert kind in (QFT_NUMBER, QFT_UNIT)
Michael Hanselmann's avatar
Michael Hanselmann committed
592
593
594

  # Try to convert into number
  try:
595
    return int(value)
Michael Hanselmann's avatar
Michael Hanselmann committed
596
597
598
  except (ValueError, TypeError):
    logging.exception("Failed to convert node field '%s' (value %r) to int",
                      value, field)
599
    return _FS_UNAVAIL
Michael Hanselmann's avatar
Michael Hanselmann committed
600
601
602
603
604
605
606


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

  """
  fields = [
607
    (_MakeField("pip", "PrimaryIP", QFT_TEXT), NQ_CONFIG,
608
     _GetItemAttr("primary_ip")),
609
    (_MakeField("sip", "SecondaryIP", QFT_TEXT), NQ_CONFIG,
610
     _GetItemAttr("secondary_ip")),
611
    (_MakeField("tags", "Tags", QFT_OTHER), NQ_CONFIG,
612
     lambda ctx, node: list(node.GetTags())),
613
    (_MakeField("master", "IsMaster", QFT_BOOL), NQ_CONFIG,
614
     lambda ctx, node: node.name == ctx.master_name),
615
    (_MakeField("role", "Role", QFT_TEXT), NQ_CONFIG,
616
     lambda ctx, node: _GetNodeRole(node, ctx.master_name)),
617
    (_MakeField("group", "Group", QFT_TEXT), NQ_GROUP,
618
     _GetGroup(_GetNodeGroup)),
619
    (_MakeField("group.uuid", "GroupUUID", QFT_TEXT),
620
     NQ_CONFIG, _GetItemAttr("group")),
621
622
    (_MakeField("powered", "Powered", QFT_BOOL), NQ_OOB, _GetNodePower),
    (_MakeField("ndparams", "NodeParameters", QFT_OTHER), NQ_GROUP,
623
      _GetGroup(_GetNdParams)),
624
    (_MakeField("custom_ndparams", "CustomNodeParameters", QFT_OTHER),
625
      NQ_GROUP, _GetItemAttr("ndparams")),
Michael Hanselmann's avatar
Michael Hanselmann committed
626
627
628
    ]

  def _GetLength(getter):
629
    return lambda ctx, node: len(getter(ctx)[node.name])
Michael Hanselmann's avatar
Michael Hanselmann committed
630
631

  def _GetList(getter):
632
    return lambda ctx, node: list(getter(ctx)[node.name])
Michael Hanselmann's avatar
Michael Hanselmann committed
633
634
635
636
637
638

  # Add fields operating on instance lists
  for prefix, titleprefix, getter in \
      [("p", "Pri", operator.attrgetter("node_to_primary")),
       ("s", "Sec", operator.attrgetter("node_to_secondary"))]:
    fields.extend([
639
      (_MakeField("%sinst_cnt" % prefix, "%sinst" % prefix.upper(), QFT_NUMBER),
Michael Hanselmann's avatar
Michael Hanselmann committed
640
641
       NQ_INST, _GetLength(getter)),
      (_MakeField("%sinst_list" % prefix, "%sInstances" % titleprefix,
642
                  QFT_OTHER),
Michael Hanselmann's avatar
Michael Hanselmann committed
643
644
645
646
647
648
649
650
651
652
653
654
655
656
       NQ_INST, _GetList(getter)),
      ])

  # Add simple fields
  fields.extend([(_MakeField(name, title, kind), NQ_CONFIG, _GetItemAttr(name))
                 for (name, (title, kind)) in _NODE_SIMPLE_FIELDS.items()])

  # Add fields requiring live data
  fields.extend([
    (_MakeField(name, title, kind), NQ_LIVE,
     compat.partial(_GetLiveNodeField, nfield, kind))
    for (name, (title, kind, nfield)) in _NODE_LIVE_FIELDS.items()
    ])

657
658
659
  # Add timestamps
  fields.extend(_GetItemTimestampFields(NQ_CONFIG))

660
  return _PrepareFieldList(fields, [])
Michael Hanselmann's avatar
Michael Hanselmann committed
661
662


663
664
665
666
667
class InstanceQueryData:
  """Data container for instance data queries.

  """
  def __init__(self, instances, cluster, disk_usage, offline_nodes, bad_nodes,
668
               live_data, wrongnode_inst, console):
669
670
671
672
673
674
675
676
677
678
679
680
    """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
681
682
    @type wrongnode_inst: set
    @param wrongnode_inst: Set of instances running on wrong node(s)
683
684
    @type console: dict; instance name as key
    @param console: Per-instance console information
685
686
687
688
689
690
691
692
693
694
695
696
697

    """
    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
698
    self.wrongnode_inst = wrongnode_inst
699
    self.console = console
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729

    # 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
730
  # Can't use RS_OFFLINE here as it would describe the instance to
731
  # be offline when we actually don't know due to missing data
732
  if inst.primary_node in ctx.bad_nodes:
733
    return _FS_NODATA
734
  else:
735
    return bool(ctx.live_data.get(inst.name))
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754


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
755
      # Can't use RS_OFFLINE here as it would describe the instance to be
756
      # offline when we actually don't know due to missing data
757
      return _FS_NODATA
758
759
760
761

    if inst.name in ctx.live_data:
      data = ctx.live_data[inst.name]
      if name in data:
762
        return data[name]
763

764
    return _FS_UNAVAIL
765
766
767
768
769
770
771
772
773
774
775
776
777

  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:
778
    return "ERROR_nodeoffline"
779
780

  if inst.primary_node in ctx.bad_nodes:
781
    return "ERROR_nodedown"
782
783

  if bool(ctx.live_data.get(inst.name)):
784
785
786
    if inst.name in ctx.wrongnode_inst:
      return "ERROR_wrongnode"
    elif inst.admin_up:
787
      return "running"
788
    else:
789
      return "ERROR_up"
790
791

  if inst.admin_up:
792
    return "ERROR_down"
793

794
  return "ADMIN_down"
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811


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:
812
      return inst.disks[index].size
813
    except IndexError:
814
      return _FS_UNAVAIL
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838

  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:
839
      return _FS_UNAVAIL
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854

    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:
855
    return _FS_UNAVAIL
856
  else:
857
    return nic.ip
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872


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:
873
    return nicparams[constants.NIC_LINK]
874
  else:
875
    return _FS_UNAVAIL
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897


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)

898
  return result
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918


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
919
    return ctx.inst_nicparams[index][name]
920
921
922
923
924
925
926
927
928
929

  return fn


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

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

  """
930
  nic_mac_fn = lambda ctx, _, nic: nic.mac
931
932
933
934
935
  nic_mode_fn = _GetInstNicParam(constants.NIC_MODE)
  nic_link_fn = _GetInstNicParam(constants.NIC_LINK)

  fields = [
    # First NIC (legacy)
936
    (_MakeField("ip", "IP_address", QFT_TEXT), IQ_CONFIG,
937
     _GetInstNic(0, _GetInstNicIp)),
938
    (_MakeField("mac", "MAC_address", QFT_TEXT), IQ_CONFIG,
939
     _GetInstNic(0, nic_mac_fn)),
940
    (_MakeField("bridge", "Bridge", QFT_TEXT), IQ_CONFIG,
941
     _GetInstNic(0, _GetInstNicBridge)),
942
    (_MakeField("nic_mode", "NIC_Mode", QFT_TEXT), IQ_CONFIG,
943
     _GetInstNic(0, nic_mode_fn)),
944
    (_MakeField("nic_link", "NIC_Link", QFT_TEXT), IQ_CONFIG,
945
946
947
     _GetInstNic(0, nic_link_fn)),

    # All NICs
948
    (_MakeField("nic.count", "NICs", QFT_NUMBER), IQ_CONFIG,
949
     lambda ctx, inst: len(inst.nics)),
950
    (_MakeField("nic.macs", "NIC_MACs", QFT_OTHER), IQ_CONFIG,
951
     lambda ctx, inst: [nic.mac for nic in inst.nics]),
952
    (_MakeField("nic.ips", "NIC_IPs", QFT_OTHER), IQ_CONFIG,
953
     lambda ctx, inst: [nic.ip for nic in inst.nics]),
954
    (_MakeField("nic.modes", "NIC_modes", QFT_OTHER), IQ_CONFIG,
955
956
     lambda ctx, inst: [nicp[constants.NIC_MODE]
                        for nicp in ctx.inst_nicparams]),
957
    (_MakeField("nic.links", "NIC_links", QFT_OTHER), IQ_CONFIG,
958
959
     lambda ctx, inst: [nicp[constants.NIC_LINK]
                        for nicp in ctx.inst_nicparams]),
960
    (_MakeField("nic.bridges", "NIC_bridges", QFT_OTHER), IQ_CONFIG,
961
962
963
964
965
966
     _GetInstAllNicBridges),
    ]

  # NICs by number
  for i in range(constants.MAX_NICS):
    fields.extend([
967
      (_MakeField("nic.ip/%s" % i, "NicIP/%s" % i, QFT_TEXT),
968
       IQ_CONFIG, _GetInstNic(i, _GetInstNicIp)),
969
      (_MakeField("nic.mac/%s" % i, "NicMAC/%s" % i, QFT_TEXT),
970
       IQ_CONFIG, _GetInstNic(i, nic_mac_fn)),
971
      (_MakeField("nic.mode/%s" % i, "NicMode/%s" % i, QFT_TEXT),
972
       IQ_CONFIG, _GetInstNic(i, nic_mode_fn)),
973
      (_MakeField("nic.link/%s" % i, "NicLink/%s" % i, QFT_TEXT),
974
       IQ_CONFIG, _GetInstNic(i, nic_link_fn)),
975
      (_MakeField("nic.bridge/%s" % i, "NicBridge/%s" % i, QFT_TEXT),
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
       IQ_CONFIG, _GetInstNic(i, _GetInstNicBridge)),
      ])

  return fields


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

995
  return usage
996
997


998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
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


1014
1015
1016
1017
1018
1019
1020
def _GetInstanceDiskFields():
  """Get instance fields involving disks.

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

  """
  fields = [
1021
    (_MakeField("disk_usage", "DiskUsage", QFT_UNIT), IQ_DISKUSAGE,
1022
     _GetInstDiskUsage),
1023
    (_MakeField("disk.count", "Disks", QFT_NUMBER), IQ_CONFIG,
1024
     lambda ctx, inst: len(inst.disks)),
1025
    (_MakeField("disk.sizes", "Disk_sizes", QFT_OTHER), IQ_CONFIG,
1026
     lambda ctx, inst: [disk.size for disk in inst.disks]),
1027
1028
1029
1030
    ]

  # Disks by number
  fields.extend([
1031
    (_MakeField("disk.size/%s" % i, "Disk/%s" % i, QFT_UNIT),
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
     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",
1048
1049
    constants.BE_MEMORY: "ConfigMemory",
    constants.BE_VCPUS: "ConfigVCPUs",
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
    }

  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
1066
    (_MakeField("hvparams", "HypervisorParameters", QFT_OTHER),
1067
     IQ_CONFIG, lambda ctx, _: ctx.inst_hvparams),
1068
    (_MakeField("beparams", "BackendParameters", QFT_OTHER),
1069
     IQ_CONFIG, lambda ctx, _: ctx.inst_beparams),
1070
1071

    # Unfilled parameters
1072
    (_MakeField("custom_hvparams", "CustomHypervisorParameters", QFT_OTHER),
1073
     IQ_CONFIG, _GetItemAttr("hvparams")),
1074
    (_MakeField("custom_beparams", "CustomBackendParameters", QFT_OTHER),
1075
     IQ_CONFIG, _GetItemAttr("beparams")),
1076
    (_MakeField("custom_nicparams", "CustomNicParameters", QFT_OTHER),
1077
     IQ_CONFIG, lambda ctx, inst: [nic.nicparams for nic in inst.nics]),
1078
1079
1080
1081
    ]

  # HV params
  def _GetInstHvParam(name):
1082
    return lambda ctx, _: ctx.inst_hvparams.get(name, _FS_UNAVAIL)
1083
1084

  fields.extend([
1085
1086
    (_MakeField("hv/%s" % name, hv_title.get(name, "hv/%s" % name),
                _VTToQFT[kind]),
1087
     IQ_CONFIG, _GetInstHvParam(name))
1088
    for name, kind in constants.HVS_PARAMETER_TYPES.items()
1089
1090
1091
1092
1093
    if name not in constants.HVC_GLOBALS
    ])

  # BE params
  def _GetInstBeParam(name):
1094
    return lambda ctx, _: ctx.inst_beparams.get(name, None)
1095
1096

  fields.extend([
1097
1098
1099
1100
    (_MakeField("be/%s" % name, be_title.get(name, "be/%s" % name),
                _VTToQFT[kind]), IQ_CONFIG,
     _GetInstBeParam(name))
    for name, kind in constants.BES_PARAMETER_TYPES.items()
1101
1102
1103
1104
1105
1106
    ])

  return fields


_INST_SIMPLE_FIELDS = {
1107
1108
1109
  "disk_template": ("Disk_template", QFT_TEXT),
  "hypervisor": ("Hypervisor", QFT_TEXT),
  "name": ("Node", QFT_TEXT),
1110
  # Depending on the hypervisor, the port can be None
1111
1112
1113
1114
  "network_port": ("Network_port", QFT_OTHER),
  "os": ("OS", QFT_TEXT),
  "serial_no": ("SerialNo", QFT_NUMBER),
  "uuid": ("UUID", QFT_TEXT),
1115
1116
1117
1118
1119
1120
1121
1122
  }


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

  """
  fields = [
1123
    (_MakeField("pnode", "Primary_node", QFT_TEXT), IQ_CONFIG,
1124
     _GetItemAttr("primary_node")),
1125
    (_MakeField("snodes", "Secondary_Nodes", QFT_OTHER), IQ_CONFIG,
1126
     lambda ctx, inst: list(inst.secondary_nodes)),
1127
    (_MakeField("admin_state", "Autostart", QFT_BOOL), IQ_CONFIG,
1128
     _GetItemAttr("admin_up")),
1129
    (_MakeField("tags", "Tags", QFT_OTHER), IQ_CONFIG,
1130
     lambda ctx, inst: list(inst.GetTags())),
1131
1132
    (_MakeField("console", "Console", QFT_OTHER), IQ_CONSOLE,
     _GetInstanceConsole),
1133
1134
1135
1136
1137
1138
1139
1140
    ]

  # Add simple fields
  fields.extend([(_MakeField(name, title, kind), IQ_CONFIG, _GetItemAttr(name))
                 for (name, (title, kind)) in _INST_SIMPLE_FIELDS.items()])

  # Fields requiring talking to the node
  fields.extend([
1141
    (_MakeField("oper_state", "Running", QFT_BOOL), IQ_LIVE,
1142
     _GetInstOperState),
1143
    (_MakeField("oper_ram", "Memory", QFT_UNIT), IQ_LIVE,
1144
     _GetInstLiveData("memory")),
1145
    (_MakeField("oper_vcpus", "VCPUs", QFT_NUMBER), IQ_LIVE,
1146
     _GetInstLiveData("vcpus")),
1147
    (_MakeField("status", "Status", QFT_TEXT), IQ_LIVE, _GetInstStatus),
1148
1149
1150
1151
1152
    ])

  fields.extend(_GetInstanceParameterFields())
  fields.extend(_GetInstanceDiskFields())
  fields.extend(_GetInstanceNetworkFields())
1153
  fields.extend(_GetItemTimestampFields(IQ_CONFIG))
1154

1155
1156
1157
1158
1159
1160
1161
  aliases = [
    ("vcpus", "be/vcpus"),
    ("sda_size", "disk.size/0"),
    ("sdb_size", "disk.size/1"),
    ]

  return _PrepareFieldList(fields, aliases)
1162
1163


1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
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)

1190
  return owners
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202


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]

1203
  return pending
1204
1205
1206
1207
1208
1209
1210


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

  """
  return _PrepareFieldList([
1211
    (_MakeField("name", "Name", QFT_TEXT), None,
1212
     lambda ctx, (name, mode, owners, pending): name),
1213
    (_MakeField("mode", "Mode", QFT_OTHER), LQ_MODE,
1214
     lambda ctx, (name, mode, owners, pending): mode),
1215
1216
    (_MakeField("owner", "Owner", QFT_OTHER), LQ_OWNER, _GetLockOwners),
    (_MakeField("pending", "Pending", QFT_OTHER), LQ_PENDING, _GetLockPending),
1217
    ], [])
1218
1219


1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
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 = {
1246
1247
1248
1249
1250
  "alloc_policy": ("AllocPolicy", QFT_TEXT),
  "name": ("Group", QFT_TEXT),
  "serial_no": ("SerialNo", QFT_NUMBER),
  "uuid": ("UUID", QFT_TEXT),
  "ndparams": ("NDParams", QFT_OTHER),
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
  }


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

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

  def _GetLength(getter):
1263
    return lambda ctx, group: len(getter(ctx)[group.uuid])
1264
1265

  def _GetSortedList(getter):
1266
    return lambda ctx, group: utils.NiceSort(getter(ctx)[group.uuid])
1267
1268
1269
1270
1271
1272

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

  # Add fields for nodes
  fields.extend([
1273
    (_MakeField("node_cnt", "Nodes", QFT_NUMBER),
1274
     GQ_NODE, _GetLength(group_to_nodes)),
1275
    (_MakeField("node_list", "NodeList", QFT_OTHER),
1276
1277
1278
1279
1280
     GQ_NODE, _GetSortedList(group_to_nodes)),
    ])

  # Add fields for instances
  fields.extend([
1281
    (_MakeField("pinst_cnt", "Instances", QFT_NUMBER),
1282
     GQ_INST, _GetLength(group_to_instances)),
1283
    (_MakeField("pinst_list", "InstanceList", QFT_OTHER),
1284
1285
1286
1287
1288
     GQ_INST, _GetSortedList(group_to_instances)),
    ])

  fields.extend(_GetItemTimestampFields(GQ_CONFIG))

1289
  return _PrepareFieldList(fields, [])
1290
1291


Michael Hanselmann's avatar
Michael Hanselmann committed
1292
1293
#: Fields available for node queries
NODE_FIELDS = _BuildNodeFields()
1294
1295
1296

#: Fields available for instance queries
INSTANCE_FIELDS = _BuildInstanceFields()
1297
1298
1299

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

1301
1302
1303
#: Fields available for node group queries
GROUP_FIELDS = _BuildGroupFields()

1304
#: All available field lists
1305
ALL_FIELD_LISTS = [NODE_FIELDS, INSTANCE_FIELDS, LOCK_FIELDS, GROUP_FIELDS]