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

4
# Copyright (C) 2010, 2011, 2012, 2013 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
      - 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
51
  times, in any order and any number of times.
Michael Hanselmann's avatar
Michael Hanselmann committed
52
53

"""
54

Michael Hanselmann's avatar
Michael Hanselmann committed
55
import logging
56
57
58
59
60
61
62
63
64
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
65
from ganeti import runtime
66
from ganeti import qlang
67
from ganeti import jstore
68
from ganeti.hypervisor import hv_base
69

70
from ganeti.constants import (QFT_UNKNOWN, QFT_TEXT, QFT_BOOL, QFT_NUMBER,
Klaus Aehlig's avatar
Klaus Aehlig committed
71
72
                              QFT_NUMBER_FLOAT, QFT_UNIT, QFT_TIMESTAMP,
                              QFT_OTHER, RS_NORMAL, RS_UNKNOWN, RS_NODATA,
René Nussbaumer's avatar
René Nussbaumer committed
73
                              RS_UNAVAIL, RS_OFFLINE)
74

75
76
77
78
(NETQ_CONFIG,
 NETQ_GROUP,
 NETQ_STATS,
 NETQ_INST) = range(300, 304)
79

Michael Hanselmann's avatar
Michael Hanselmann committed
80
81
82
83
# 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
84
85
86
(NQ_CONFIG,
 NQ_INST,
 NQ_LIVE,
87
88
 NQ_GROUP,
 NQ_OOB) = range(1, 6)
Michael Hanselmann's avatar
Michael Hanselmann committed
89

90
91
(IQ_CONFIG,
 IQ_LIVE,
92
 IQ_DISKUSAGE,
93
 IQ_CONSOLE,
94
95
 IQ_NODES,
 IQ_NETWORKS) = range(100, 106)
96

97
98
99
(LQ_MODE,
 LQ_OWNER,
 LQ_PENDING) = range(10, 13)
Michael Hanselmann's avatar
Michael Hanselmann committed
100

101
102
(GQ_CONFIG,
 GQ_NODE,
103
104
 GQ_INST,
 GQ_DISKPARAMS) = range(200, 204)
105

106
107
108
109
(CQ_CONFIG,
 CQ_QUEUE_DRAINED,
 CQ_WATCHER_PAUSE) = range(300, 303)

110
111
(JQ_ARCHIVED, ) = range(400, 401)

Michael Hanselmann's avatar
Michael Hanselmann committed
112
113
114
# Query field flags
QFF_HOSTNAME = 0x01
QFF_IP_ADDRESS = 0x02
115
116
117
118
QFF_JOB_ID = 0x04
QFF_SPLIT_TIMESTAMP = 0x08
# Next values: 0x10, 0x20, 0x40, 0x80, 0x100, 0x200
QFF_ALL = (QFF_HOSTNAME | QFF_IP_ADDRESS | QFF_JOB_ID | QFF_SPLIT_TIMESTAMP)
119

120
121
FIELD_NAME_RE = re.compile(r"^[a-z0-9/._]+$")
TITLE_RE = re.compile(r"^[^\s]+$")
122
DOC_RE = re.compile(r"^[A-Z].*[^.,?!]$")
123
124
125

#: Verification function for each field type
_VERIFY_FN = {
126
127
128
129
  QFT_UNKNOWN: ht.TNone,
  QFT_TEXT: ht.TString,
  QFT_BOOL: ht.TBool,
  QFT_NUMBER: ht.TInt,
Klaus Aehlig's avatar
Klaus Aehlig committed
130
  QFT_NUMBER_FLOAT: ht.TFloat,
131
  QFT_UNIT: ht.TInt,
132
  QFT_TIMESTAMP: ht.TNumber,
133
  QFT_OTHER: lambda _: True,
134
135
  }

136
137
138
139
140
141
# Unique objects for special field statuses
_FS_UNKNOWN = object()
_FS_NODATA = object()
_FS_UNAVAIL = object()
_FS_OFFLINE = object()

142
#: List of all special status
143
144
145
146
147
148
_FS_ALL = compat.UniqueFrozenset([
  _FS_UNKNOWN,
  _FS_NODATA,
  _FS_UNAVAIL,
  _FS_OFFLINE,
  ])
149

150
151
152
153
154
155
156
157
#: 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,
Klaus Aehlig's avatar
Klaus Aehlig committed
158
  constants.VTYPE_FLOAT: QFT_NUMBER_FLOAT,
159
160
  }

161
162
_SERIAL_NO_DOC = "%s object serial number, incremented on each modification"

163

164
def _GetUnknownField(ctx, item): # pylint: disable=W0613
165
166
167
  """Gets the contents of an unknown field.

  """
168
  return _FS_UNKNOWN
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187


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

Michael Hanselmann's avatar
Michael Hanselmann committed
191
    assert len(fdef) == 4
192
193
194
195
196
197
198
199
200
201
202
203

    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
204
  return [fdef for (fdef, _, _, _) in fielddefs]
205
206


207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
class _FilterHints:
  """Class for filter analytics.

  When filters are used, the user of the L{Query} class usually doesn't know
  exactly which items will be necessary for building the result. It therefore
  has to prepare and compute the input data for potentially returning
  everything.

  There are two ways to optimize this. The first, and simpler, is to assign
  each field a group of data, so that the caller can determine which
  computations are necessary depending on the data groups requested. The list
  of referenced groups must also be computed for fields referenced in the
  filter.

  The second is restricting the items based on a primary key. The primary key
  is usually a unique name (e.g. a node name). This class extracts all
  referenced names from a filter. If it encounters any filter condition which
  disallows such a list to be determined (e.g. a non-equality filter), all
  names will be requested.

  The end-effect is that any operation other than L{qlang.OP_OR} and
  L{qlang.OP_EQUAL} will make the query more expensive.

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

    @type namefield: string
    @param namefield: Field caller is interested in

    """
    self._namefield = namefield

    #: Whether all names need to be requested (e.g. if a non-equality operator
    #: has been used)
    self._allnames = False

    #: Which names to request
    self._names = None

    #: Data kinds referenced by the filter (used by L{Query.RequestedData})
    self._datakinds = set()

  def RequestedNames(self):
    """Returns all requested values.

    Returns C{None} if list of values can't be determined (e.g. encountered
    non-equality operators).

    @rtype: list

    """
    if self._allnames or self._names is None:
      return None

    return utils.UniqueSequence(self._names)

  def ReferencedData(self):
    """Returns all kinds of data referenced by the filter.

    """
    return frozenset(self._datakinds)

  def _NeedAllNames(self):
    """Changes internal state to request all names.

    """
    self._allnames = True
    self._names = None

  def NoteLogicOp(self, op):
    """Called when handling a logic operation.

    @type op: string
    @param op: Operator

    """
    if op != qlang.OP_OR:
      self._NeedAllNames()

287
  def NoteUnaryOp(self, op, datakind): # pylint: disable=W0613
288
289
290
291
292
293
    """Called when handling an unary operation.

    @type op: string
    @param op: Operator

    """
294
295
296
    if datakind is not None:
      self._datakinds.add(datakind)

297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
    self._NeedAllNames()

  def NoteBinaryOp(self, op, datakind, name, value):
    """Called when handling a binary operation.

    @type op: string
    @param op: Operator
    @type name: string
    @param name: Left-hand side of operator (field name)
    @param value: Right-hand side of operator

    """
    if datakind is not None:
      self._datakinds.add(datakind)

    if self._allnames:
      return

    # If any operator other than equality was used, all names need to be
    # retrieved
    if op == qlang.OP_EQUAL and name == self._namefield:
      if self._names is None:
        self._names = []
      self._names.append(value)
    else:
      self._NeedAllNames()


def _WrapLogicOp(op_fn, sentences, ctx, item):
  """Wrapper for logic operator functions.

  """
  return op_fn(fn(ctx, item) for fn in sentences)


def _WrapUnaryOp(op_fn, inner, ctx, item):
  """Wrapper for unary operator functions.

  """
  return op_fn(inner(ctx, item))


def _WrapBinaryOp(op_fn, retrieval_fn, value, ctx, item):
  """Wrapper for binary operator functions.

  """
  return op_fn(retrieval_fn(ctx, item), value)


def _WrapNot(fn, lhs, rhs):
  """Negates the result of a wrapped function.

  """
  return not fn(lhs, rhs)


353
354
355
356
357
358
359
360
361
362
def _PrepareRegex(pattern):
  """Compiles a regular expression.

  """
  try:
    return re.compile(pattern)
  except re.error, err:
    raise errors.ParameterError("Invalid regex pattern (%s)" % err)


363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
def _PrepareSplitTimestamp(value):
  """Prepares a value for comparison by L{_MakeSplitTimestampComparison}.

  """
  if ht.TNumber(value):
    return value
  else:
    return utils.MergeTime(value)


def _MakeSplitTimestampComparison(fn):
  """Compares split timestamp values after converting to float.

  """
  return lambda lhs, rhs: fn(utils.MergeTime(lhs), rhs)


def _MakeComparisonChecks(fn):
  """Prepares flag-specific comparisons using a comparison function.

  """
  return [
    (QFF_SPLIT_TIMESTAMP, _MakeSplitTimestampComparison(fn),
     _PrepareSplitTimestamp),
    (QFF_JOB_ID, lambda lhs, rhs: fn(jstore.ParseJobId(lhs), rhs),
     jstore.ParseJobId),
    (None, fn, None),
    ]


393
394
395
396
class _FilterCompilerHelper:
  """Converts a query filter to a callable usable for filtering.

  """
397
  # String statement has no effect, pylint: disable=W0105
398
399
400
401
402
403
404
405
406
407
408
409
410

  #: How deep filters can be nested
  _LEVELS_MAX = 10

  # Unique identifiers for operator groups
  (_OPTYPE_LOGIC,
   _OPTYPE_UNARY,
   _OPTYPE_BINARY) = range(1, 4)

  """Functions for equality checks depending on field flags.

  List of tuples containing flags and a callable receiving the left- and
  right-hand side of the operator. The flags are an OR-ed value of C{QFF_*}
411
  (e.g. L{QFF_HOSTNAME} or L{QFF_SPLIT_TIMESTAMP}).
412
413
414
415
416
417
418
419

  Order matters. The first item with flags will be used. Flags are checked
  using binary AND.

  """
  _EQUALITY_CHECKS = [
    (QFF_HOSTNAME,
     lambda lhs, rhs: utils.MatchNameComponent(rhs, [lhs],
420
421
                                               case_sensitive=False),
     None),
422
423
    (QFF_SPLIT_TIMESTAMP, _MakeSplitTimestampComparison(operator.eq),
     _PrepareSplitTimestamp),
424
    (None, operator.eq, None),
425
426
427
428
429
430
431
432
433
    ]

  """Known operators

  Operator as key (C{qlang.OP_*}), value a tuple of operator group
  (C{_OPTYPE_*}) and a group-specific value:

    - C{_OPTYPE_LOGIC}: Callable taking any number of arguments; used by
      L{_HandleLogicOp}
434
    - C{_OPTYPE_UNARY}: Always C{None}; details handled by L{_HandleUnaryOp}
435
436
437
438
439
440
441
442
443
444
    - C{_OPTYPE_BINARY}: Callable taking exactly two parameters, the left- and
      right-hand side of the operator, used by L{_HandleBinaryOp}

  """
  _OPS = {
    # Logic operators
    qlang.OP_OR: (_OPTYPE_LOGIC, compat.any),
    qlang.OP_AND: (_OPTYPE_LOGIC, compat.all),

    # Unary operators
445
446
    qlang.OP_NOT: (_OPTYPE_UNARY, None),
    qlang.OP_TRUE: (_OPTYPE_UNARY, None),
447
448
449
450

    # Binary operators
    qlang.OP_EQUAL: (_OPTYPE_BINARY, _EQUALITY_CHECKS),
    qlang.OP_NOT_EQUAL:
451
452
      (_OPTYPE_BINARY, [(flags, compat.partial(_WrapNot, fn), valprepfn)
                        for (flags, fn, valprepfn) in _EQUALITY_CHECKS]),
453
454
455
456
    qlang.OP_LT: (_OPTYPE_BINARY, _MakeComparisonChecks(operator.lt)),
    qlang.OP_LE: (_OPTYPE_BINARY, _MakeComparisonChecks(operator.le)),
    qlang.OP_GT: (_OPTYPE_BINARY, _MakeComparisonChecks(operator.gt)),
    qlang.OP_GE: (_OPTYPE_BINARY, _MakeComparisonChecks(operator.ge)),
457
458
459
    qlang.OP_REGEXP: (_OPTYPE_BINARY, [
      (None, lambda lhs, rhs: rhs.search(lhs), _PrepareRegex),
      ]),
460
    qlang.OP_CONTAINS: (_OPTYPE_BINARY, [
461
      (None, operator.contains, None),
462
463
464
465
466
467
468
469
470
471
472
473
474
      ]),
    }

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

    @param fields: Field definitions (return value of L{_PrepareFieldList})

    """
    self._fields = fields
    self._hints = None
    self._op_handler = None

475
  def __call__(self, hints, qfilter):
476
477
478
479
    """Converts a query filter into a callable function.

    @type hints: L{_FilterHints} or None
    @param hints: Callbacks doing analysis on filter
480
481
    @type qfilter: list
    @param qfilter: Filter structure
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
    @rtype: callable
    @return: Function receiving context and item as parameters, returning
             boolean as to whether item matches filter

    """
    self._op_handler = {
      self._OPTYPE_LOGIC:
        (self._HandleLogicOp, getattr(hints, "NoteLogicOp", None)),
      self._OPTYPE_UNARY:
        (self._HandleUnaryOp, getattr(hints, "NoteUnaryOp", None)),
      self._OPTYPE_BINARY:
        (self._HandleBinaryOp, getattr(hints, "NoteBinaryOp", None)),
      }

    try:
497
      filter_fn = self._Compile(qfilter, 0)
498
499
500
501
502
    finally:
      self._op_handler = None

    return filter_fn

503
  def _Compile(self, qfilter, level):
504
505
506
507
508
509
    """Inner function for converting filters.

    Calls the correct handler functions for the top-level operator. This
    function is called recursively (e.g. for logic operators).

    """
510
    if not (isinstance(qfilter, (list, tuple)) and qfilter):
511
512
513
514
515
516
517
518
      raise errors.ParameterError("Invalid filter on level %s" % level)

    # Limit recursion
    if level >= self._LEVELS_MAX:
      raise errors.ParameterError("Only up to %s levels are allowed (filter"
                                  " nested too deep)" % self._LEVELS_MAX)

    # Create copy to be modified
519
    operands = qfilter[:]
520
521
522
523
524
525
526
527
528
529
530
    op = operands.pop(0)

    try:
      (kind, op_data) = self._OPS[op]
    except KeyError:
      raise errors.ParameterError("Unknown operator '%s'" % op)

    (handler, hints_cb) = self._op_handler[kind]

    return handler(hints_cb, level, op, op_data, operands)

531
532
533
534
535
536
537
538
539
  def _LookupField(self, name):
    """Returns a field definition by name.

    """
    try:
      return self._fields[name]
    except KeyError:
      raise errors.ParameterError("Unknown field '%s'" % name)

540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
  def _HandleLogicOp(self, hints_fn, level, op, op_fn, operands):
    """Handles logic operators.

    @type hints_fn: callable
    @param hints_fn: Callback doing some analysis on the filter
    @type level: integer
    @param level: Current depth
    @type op: string
    @param op: Operator
    @type op_fn: callable
    @param op_fn: Function implementing operator
    @type operands: list
    @param operands: List of operands

    """
    if hints_fn:
      hints_fn(op)

    return compat.partial(_WrapLogicOp, op_fn,
                          [self._Compile(op, level + 1) for op in operands])

  def _HandleUnaryOp(self, hints_fn, level, op, op_fn, operands):
    """Handles unary operators.

    @type hints_fn: callable
    @param hints_fn: Callback doing some analysis on the filter
    @type level: integer
    @param level: Current depth
    @type op: string
    @param op: Operator
    @type op_fn: callable
    @param op_fn: Function implementing operator
    @type operands: list
    @param operands: List of operands

    """
576
577
    assert op_fn is None

578
579
580
581
    if len(operands) != 1:
      raise errors.ParameterError("Unary operator '%s' expects exactly one"
                                  " operand" % op)

582
    if op == qlang.OP_TRUE:
583
584
585
586
      (_, datakind, _, retrieval_fn) = self._LookupField(operands[0])

      if hints_fn:
        hints_fn(op, datakind)
587
588
589
590

      op_fn = operator.truth
      arg = retrieval_fn
    elif op == qlang.OP_NOT:
591
592
593
      if hints_fn:
        hints_fn(op, None)

594
595
596
597
598
599
      op_fn = operator.not_
      arg = self._Compile(operands[0], level + 1)
    else:
      raise errors.ProgrammerError("Can't handle operator '%s'" % op)

    return compat.partial(_WrapUnaryOp, op_fn, arg)
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614

  def _HandleBinaryOp(self, hints_fn, level, op, op_data, operands):
    """Handles binary operators.

    @type hints_fn: callable
    @param hints_fn: Callback doing some analysis on the filter
    @type level: integer
    @param level: Current depth
    @type op: string
    @param op: Operator
    @param op_data: Functions implementing operators
    @type operands: list
    @param operands: List of operands

    """
615
    # Unused arguments, pylint: disable=W0613
616
617
618
619
620
621
    try:
      (name, value) = operands
    except (ValueError, TypeError):
      raise errors.ParameterError("Invalid binary operator, expected exactly"
                                  " two operands")

622
    (fdef, datakind, field_flags, retrieval_fn) = self._LookupField(name)
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637

    assert fdef.kind != QFT_UNKNOWN

    # TODO: Type conversions?

    verify_fn = _VERIFY_FN[fdef.kind]
    if not verify_fn(value):
      raise errors.ParameterError("Unable to compare field '%s' (type '%s')"
                                  " with '%s', expected %s" %
                                  (name, fdef.kind, value.__class__.__name__,
                                   verify_fn))

    if hints_fn:
      hints_fn(op, datakind, name, value)

638
    for (fn_flags, fn, valprepfn) in op_data:
639
      if fn_flags is None or fn_flags & field_flags:
640
641
642
643
        # Prepare value if necessary (e.g. compile regular expression)
        if valprepfn:
          value = valprepfn(value)

644
645
646
647
648
649
        return compat.partial(_WrapBinaryOp, fn, retrieval_fn, value)

    raise errors.ProgrammerError("Unable to find operator implementation"
                                 " (op '%s', flags %s)" % (op, field_flags))


650
def _CompileFilter(fields, hints, qfilter):
651
652
653
654
655
656
657
  """Converts a query filter into a callable function.

  See L{_FilterCompilerHelper} for details.

  @rtype: callable

  """
658
  return _FilterCompilerHelper(fields)(hints, qfilter)
659
660


661
class Query:
662
  def __init__(self, fieldlist, selected, qfilter=None, namefield=None):
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
    """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

    """
681
682
    assert namefield is None or namefield in fieldlist

683
684
    self._fields = _GetQueryFields(fieldlist, selected)

685
686
687
688
    self._filter_fn = None
    self._requested_names = None
    self._filter_datakinds = frozenset()

689
    if qfilter is not None:
690
691
692
693
694
695
696
      # Collect requested names if wanted
      if namefield:
        hints = _FilterHints(namefield)
      else:
        hints = None

      # Build filter function
697
      self._filter_fn = _CompileFilter(fieldlist, hints, qfilter)
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
      if hints:
        self._requested_names = hints.RequestedNames()
        self._filter_datakinds = hints.ReferencedData()

    if namefield is None:
      self._name_fn = None
    else:
      (_, _, _, self._name_fn) = fieldlist[namefield]

  def RequestedNames(self):
    """Returns all names referenced in the filter.

    If there is no filter or operators are preventing determining the exact
    names, C{None} is returned.

    """
    return self._requested_names

716
717
718
719
720
721
  def RequestedData(self):
    """Gets requested kinds of data.

    @rtype: frozenset

    """
722
723
724
    return (self._filter_datakinds |
            frozenset(datakind for (_, datakind, _, _) in self._fields
                      if datakind is not None))
725
726
727
728
729
730
731
732
733
734
735

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

    Includes unknown fields.

    @rtype: List of L{objects.QueryFieldDefinition}

    """
    return GetAllFields(self._fields)

736
  def Query(self, ctx, sort_by_name=True):
737
738
739
740
    """Execute a query.

    @param ctx: Data container passed to field retrieval functions, must
      support iteration using C{__iter__}
741
742
743
    @type sort_by_name: boolean
    @param sort_by_name: Whether to sort by name or keep the input data's
      ordering
744
745

    """
746
747
    sort = (self._name_fn and sort_by_name)

748
749
750
751
752
    result = []

    for idx, item in enumerate(ctx):
      if not (self._filter_fn is None or self._filter_fn(ctx, item)):
        continue
753

754
755
756
757
      row = [_ProcessResult(fn(ctx, item)) for (_, _, _, fn) in self._fields]

      # Verify result
      if __debug__:
758
        _VerifyResultRow(self._fields, row)
759

760
      if sort:
761
762
763
        (status, name) = _ProcessResult(self._name_fn(ctx, item))
        assert status == constants.RS_NORMAL
        # TODO: Are there cases where we wouldn't want to use NiceSort?
Iustin Pop's avatar
Iustin Pop committed
764
        # Answer: if the name field is non-string...
765
        result.append((utils.NiceSortKey(name), idx, row))
766
      else:
767
        result.append(row)
768

769
770
    if not sort:
      return result
771
772
773
774
775
776
777
778
779

    # TODO: Would "heapq" be more efficient than sorting?

    # Sorting in-place instead of using "sorted()"
    result.sort()

    assert not result or (len(result[0]) == 3 and len(result[-1]) == 3)

    return map(operator.itemgetter(2), result)
780

781
  def OldStyleQuery(self, ctx, sort_by_name=True):
782
783
784
785
786
    """Query with "old" query result format.

    See L{Query.Query} for arguments.

    """
Michael Hanselmann's avatar
Michael Hanselmann committed
787
788
    unknown = set(fdef.name for (fdef, _, _, _) in self._fields
                  if fdef.kind == QFT_UNKNOWN)
789
790
791
792
793
794
    if unknown:
      raise errors.OpPrereqError("Unknown output fields selected: %s" %
                                 (utils.CommaJoin(unknown), ),
                                 errors.ECODE_INVAL)

    return [[value for (_, value) in row]
795
            for row in self.Query(ctx, sort_by_name=sort_by_name)]
796
797


798
799
800
801
802
def _ProcessResult(value):
  """Converts result values into externally-visible ones.

  """
  if value is _FS_UNKNOWN:
René Nussbaumer's avatar
René Nussbaumer committed
803
    return (RS_UNKNOWN, None)
804
  elif value is _FS_NODATA:
René Nussbaumer's avatar
René Nussbaumer committed
805
    return (RS_NODATA, None)
806
  elif value is _FS_UNAVAIL:
René Nussbaumer's avatar
René Nussbaumer committed
807
    return (RS_UNAVAIL, None)
808
  elif value is _FS_OFFLINE:
René Nussbaumer's avatar
René Nussbaumer committed
809
    return (RS_OFFLINE, None)
810
  else:
René Nussbaumer's avatar
René Nussbaumer committed
811
    return (RS_NORMAL, value)
812
813


814
815
816
817
818
819
820
821
822
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

  """
823
824
  assert len(row) == len(fields)
  errs = []
Michael Hanselmann's avatar
Michael Hanselmann committed
825
  for ((status, value), (fdef, _, _, _)) in zip(row, fields):
René Nussbaumer's avatar
René Nussbaumer committed
826
    if status == RS_NORMAL:
827
828
829
830
831
832
      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" %
833
                    (utils.CommaJoin(errs), row))
834
835


836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
def _FieldDictKey((fdef, _, flags, fn)):
  """Generates key for field dictionary.

  """
  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 (DOC_RE.match(fdef.doc) and len(fdef.doc.splitlines()) == 1 and
          fdef.doc.strip() == fdef.doc), \
         "Invalid description for field '%s'" % fdef.name
  assert callable(fn)
  assert (flags & ~QFF_ALL) == 0, "Unknown flags for field '%s'" % fdef.name

  return fdef.name


852
def _PrepareFieldList(fields, aliases):
853
854
855
856
  """Prepares field list for use by L{Query}.

  Converts the list to a dictionary and does some verification.

857
858
859
860
861
862
863
  @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
864
865
866
867
  @rtype: dict
  @return: Field dictionary for L{Query}

  """
868
869
  if __debug__:
    duplicates = utils.FindDuplicates(fdef.title.lower()
Michael Hanselmann's avatar
Michael Hanselmann committed
870
                                      for (fdef, _, _, _) in fields)
871
    assert not duplicates, "Duplicate title(s) found: %r" % duplicates
872

873
  result = utils.SequenceToDict(fields, key=_FieldDictKey)
874

875
876
877
  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
878
    (fdef, k, flags, fn) = result[target]
879
880
    fdef = fdef.Copy()
    fdef.name = alias
Michael Hanselmann's avatar
Michael Hanselmann committed
881
    result[alias] = (fdef, k, flags, fn)
882
883

  assert len(result) == len(fields) + len(aliases)
884
  assert compat.all(name == fdef.name
Michael Hanselmann's avatar
Michael Hanselmann committed
885
                    for (name, (fdef, _, _, _)) in result.items())
886
887
888
889

  return result


890
def GetQueryResponse(query, ctx, sort_by_name=True):
891
892
893
894
  """Prepares the response for a query.

  @type query: L{Query}
  @param ctx: Data container, see L{Query.Query}
895
896
897
  @type sort_by_name: boolean
  @param sort_by_name: Whether to sort by name or keep the input data's
    ordering
898
899

  """
900
  return objects.QueryResponse(data=query.Query(ctx, sort_by_name=sort_by_name),
901
902
903
                               fields=query.GetFields()).ToDict()


904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
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()


925
def _MakeField(name, title, kind, doc):
926
927
928
929
930
  """Wrapper for creating L{objects.QueryFieldDefinition} instances.

  @param name: Field name as a regular expression
  @param title: Human-readable title
  @param kind: Field type
931
  @param doc: Human-readable description
932
933

  """
934
935
  return objects.QueryFieldDefinition(name=name, title=title, kind=kind,
                                      doc=doc)
Michael Hanselmann's avatar
Michael Hanselmann committed
936
937


938
939
940
941
942
943
944
945
946
947
948
949
950
951
def _StaticValueInner(value, ctx, _): # pylint: disable=W0613
  """Returns a static value.

  """
  return value


def _StaticValue(value):
  """Prepares a function to return a static value.

  """
  return compat.partial(_StaticValueInner, value)


952
def _GetNodeRole(node, master_uuid):
Michael Hanselmann's avatar
Michael Hanselmann committed
953
954
955
956
  """Determine node role.

  @type node: L{objects.Node}
  @param node: Node object
957
958
  @type master_uuid: string
  @param master_uuid: Master node UUID
Michael Hanselmann's avatar
Michael Hanselmann committed
959
960

  """
961
  if node.uuid == master_uuid:
962
    return constants.NR_MASTER
Michael Hanselmann's avatar
Michael Hanselmann committed
963
  elif node.master_candidate:
964
    return constants.NR_MCANDIDATE
Michael Hanselmann's avatar
Michael Hanselmann committed
965
  elif node.drained:
966
    return constants.NR_DRAINED
Michael Hanselmann's avatar
Michael Hanselmann committed
967
  elif node.offline:
968
    return constants.NR_OFFLINE
Michael Hanselmann's avatar
Michael Hanselmann committed
969
  else:
970
    return constants.NR_REGULAR
Michael Hanselmann's avatar
Michael Hanselmann committed
971
972
973
974
975
976
977
978
979


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

  @param attr: Attribute name

  """
  getter = operator.attrgetter(attr)
980
  return lambda _, item: getter(item)
Michael Hanselmann's avatar
Michael Hanselmann committed
981
982


983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
def _GetItemMaybeAttr(attr):
  """Returns a field function to return a not-None attribute of the item.

  If the value is None, then C{_FS_UNAVAIL} will be returned instead.

  @param attr: Attribute name

  """
  def _helper(_, obj):
    val = getattr(obj, attr)
    if val is None:
      return _FS_UNAVAIL
    else:
      return val
  return _helper


1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
def _GetNDParam(name):
  """Return a field function to return an ND parameter out of the context.

  """
  def _helper(ctx, _):
    if ctx.ndparams is None:
      return _FS_UNAVAIL
    else:
      return ctx.ndparams.get(name, None)
  return _helper


def _BuildNDFields(is_group):
  """Builds all the ndparam fields.

  @param is_group: whether this is called at group or node level

  """
  if is_group:
    field_kind = GQ_CONFIG
  else:
    field_kind = NQ_GROUP
1022
1023
1024
  return [(_MakeField("ndp/%s" % name,
                      constants.NDS_PARAMETER_TITLES.get(name,
                                                         "ndp/%s" % name),
1025
1026
1027
1028
1029
                      _VTToQFT[kind], "The \"%s\" node parameter" % name),
           field_kind, 0, _GetNDParam(name))
          for name, kind in constants.NDS_PARAMETER_TYPES.items()]


1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
def _ConvWrapInner(convert, fn, ctx, item):
  """Wrapper for converting values.

  @param convert: Conversion function receiving value as single parameter
  @param fn: Retrieval function

  """
  value = fn(ctx, item)

  # Is the value an abnormal status?
  if compat.any(value is fs for fs in _FS_ALL):
    # Return right away
    return value

  # TODO: Should conversion function also receive context, item or both?
  return convert(value)


def _ConvWrap(convert, fn):
  """Convenience wrapper for L{_ConvWrapInner}.

  @param convert: Conversion function receiving value as single parameter
  @param fn: Retrieval function

  """
  return compat.partial(_ConvWrapInner, convert, fn)


1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
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
1072
      return _FS_UNAVAIL
1073
    else:
1074
      return timestamp
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085

  return fn


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

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

  """
  return [
1086
    (_MakeField("ctime", "CTime", QFT_TIMESTAMP, "Creation timestamp"),
Michael Hanselmann's avatar
Michael Hanselmann committed
1087
     datatype, 0, _GetItemTimestamp(operator.attrgetter("ctime"))),
1088
    (_MakeField("mtime", "MTime", QFT_TIMESTAMP, "Modification timestamp"),
Michael Hanselmann's avatar
Michael Hanselmann committed
1089
     datatype, 0, _GetItemTimestamp(operator.attrgetter("mtime"))),
1090
1091
1092
    ]


Michael Hanselmann's avatar
Michael Hanselmann committed
1093
1094
1095
1096
class NodeQueryData:
  """Data container for node data queries.

  """
Thomas Thrainer's avatar
Thomas Thrainer committed
1097
  def __init__(self, nodes, live_data, master_uuid, node_to_primary,
1098
1099
               node_to_secondary, inst_uuid_to_inst_name, groups, oob_support,
               cluster):
Michael Hanselmann's avatar
Michael Hanselmann committed
1100
1101
1102
1103
1104
    """Initializes this class.

    """
    self.nodes = nodes
    self.live_data = live_data
Thomas Thrainer's avatar
Thomas Thrainer committed
1105
    self.master_uuid = master_uuid
Michael Hanselmann's avatar
Michael Hanselmann committed
1106
1107
    self.node_to_primary = node_to_primary
    self.node_to_secondary = node_to_secondary
1108
    self.inst_uuid_to_inst_name = inst_uuid_to_inst_name
Michael Hanselmann's avatar
Michael Hanselmann committed
1109
    self.groups = groups
1110
    self.oob_support = oob_support
1111
    self.cluster = cluster
Michael Hanselmann's avatar
Michael Hanselmann committed
1112
1113
1114

    # Used for individual rows
    self.curlive_data = None
1115
    self.ndparams = None
Michael Hanselmann's avatar
Michael Hanselmann committed
1116
1117
1118
1119
1120
1121
1122
1123
1124

  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:
1125
1126
1127
1128
1129
      group = self.groups.get(node.group, None)
      if group is None:
        self.ndparams = None
      else:
        self.ndparams = self.cluster.FillND(node, group)
Michael Hanselmann's avatar
Michael Hanselmann committed
1130
      if self.live_data:
Thomas Thrainer's avatar
Thomas Thrainer committed
1131
        self.curlive_data = self.live_data.get(node.uuid, None)
Michael Hanselmann's avatar
Michael Hanselmann committed
1132
1133
1134
1135
1136
1137
1138
      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
1139
1140
  "drained": ("Drained", QFT_BOOL, 0, "Whether node is drained"),
  "master_candidate": ("MasterC", QFT_BOOL, 0,
1141
                       "Whether node is a master candidate"),
Michael Hanselmann's avatar
Michael Hanselmann committed
1142
  "master_capable": ("MasterCapable", QFT_BOOL, 0,
1143
                     "Whether node can become a master candidate"),
Michael Hanselmann's avatar
Michael Hanselmann committed
1144
1145
1146
1147
1148
  "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
1149
1150
1151
1152
  }


#: Fields requiring talking to the node
1153
# Note that none of these are available for non-vm_capable nodes
Michael Hanselmann's avatar
Michael Hanselmann committed
1154
_NODE_LIVE_FIELDS = {
1155
1156
1157
1158
1159
  "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)"),
1160
1161
  "cnos": ("CNOs", QFT_NUMBER, "cpu_dom0",
            "Number of logical processors used by the node OS (dom0 for Xen)"),
1162
1163
1164
  "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"),
1165
1166
1167
1168
  "dfree": ("DFree", QFT_UNIT, "storage_free",
            "Available storage space in storage unit"),
  "dtotal": ("DTotal", QFT_UNIT, "storage_size",
             "Total storage space in storage unit used for instance disk"
1169
             " allocation"),
Bernardo Dal Seno's avatar
Bernardo Dal Seno committed
1170
1171
1172
1173
  "spfree": ("SpFree", QFT_NUMBER, "spindles_free",
             "Available spindles in volume group (exclusive storage only)"),
  "sptotal": ("SpTotal", QFT_NUMBER, "spindles_total",
              "Total spindles in volume group (exclusive storage only)"),
1174
1175
1176
1177
1178
1179
  "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
1180
1181
1182
  }


1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
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
1200
      return _FS_UNAVAIL
1201
1202
1203
1204
1205
1206

    return cb(ctx, node, ng)

  return fn


1207
def _GetNodeGroup(ctx, node, ng): # pylint: disable=W0613
Michael Hanselmann's avatar
Michael Hanselmann committed
1208
1209
1210
1211
1212
  """Returns the name of a node's group.

  @type ctx: L{NodeQueryData}
  @type node: L{objects.Node}
  @param node: Node object
1213
1214
  @type ng: L{objects.NodeGroup}
  @param ng: The node group this node belongs to
Michael Hanselmann's avatar
Michael Hanselmann committed
1215
1216

  """
1217
  return ng.name
Michael Hanselmann's avatar
Michael Hanselmann committed
1218
1219


1220
1221
1222
1223
1224
1225
1226
1227
def _GetNodePower(ctx, node):
  """Returns the node powered state

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

  """
Thomas Thrainer's avatar
Thomas Thrainer committed
1228
  if ctx.oob_support[node.uuid]:
1229
    return node.powered
1230

1231
  return _FS_UNAVAIL
1232
1233


1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
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

  """
1244
  return ctx.cluster.SimpleFillND(ng.FillND(node))
1245
1246


1247
def _GetLiveNodeField(field, kind, ctx, node):
Michael Hanselmann's avatar
Michael Hanselmann committed
1248
1249
1250
1251
1252
  """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}
1253
1254
  @type node: L{objects.Node}
  @param node: Node object
Michael Hanselmann's avatar
Michael Hanselmann committed
1255
1256

  """
1257
  if node.offline:
1258
    return _FS_OFFLINE
1259

1260
1261
1262
  if not node.vm_capable:
    return _FS_UNAVAIL

Michael Hanselmann's avatar
Michael Hanselmann committed
1263
  if not ctx.curlive_data:
1264
    return _FS_NODATA
Michael Hanselmann's avatar
Michael Hanselmann committed
1265

1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
  return _GetStatsField(field, kind, ctx.curlive_data)


def _GetStatsField(field, kind, data):
  """Gets a value from live statistics.

  If the value is not found, L{_FS_UNAVAIL} is returned. If the field kind is
  numeric a conversion to integer is attempted. If that fails, L{_FS_UNAVAIL}
  is returned.

  @param field: Live field name
  @param kind: Data kind, one of L{constants.QFT_ALL}
  @type data: dict
  @param data: Statistics

  """
Michael Hanselmann's avatar
Michael Hanselmann committed
1282
  try:
1283
    value = data[field]
Michael Hanselmann's avatar
Michael Hanselmann committed
1284
  except KeyError:
1285
    return _FS_UNAVAIL
Michael Hanselmann's avatar
Michael Hanselmann committed
1286

1287
  if kind == QFT_TEXT:
1288
    return value
Michael Hanselmann's avatar
Michael Hanselmann committed
1289

1290
  assert kind in (QFT_NUMBER, QFT_UNIT)
Michael Hanselmann's avatar
Michael Hanselmann committed
1291
1292
1293

  # Try to convert into number
  try:
1294
    return int(value)
Michael Hanselmann's avatar
Michael Hanselmann committed
1295
1296
  except (ValueError, TypeError):
    logging.exception("Failed to convert node field '%s' (value %r) to int",
1297
                      field, value)
1298
    return _FS_UNAVAIL
Michael Hanselmann's avatar
Michael Hanselmann committed
1299
1300


1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
def _GetNodeHvState(_, node):
  """Converts node's hypervisor state for query result.

  """
  hv_state = node.hv_state

  if hv_state is None:
    return _FS_UNAVAIL

  return dict((name, value.ToDict()) for (name, value) in hv_state.items())


def _GetNodeDiskState(_, node):
  """Converts node's disk state for query result.

  """
  disk_state = node.disk_state

  if disk_state is None:
    return _FS_UNAVAIL

  return dict((disk_kind, dict((name, value.ToDict())
                               for (name, value) in kind_state.items()))
              for (disk_kind, kind_state) in disk_state.items())


Michael Hanselmann's avatar
Michael Hanselmann committed
1327
1328
1329
1330
1331
def _BuildNodeFields():
  """Builds list of fields for node queries.

  """
  fields = [
1332
    (_MakeField("pip", "PrimaryIP", QFT_TEXT, "Primary IP address"),
Michael Hanselmann's avatar
Michael Hanselmann committed
1333
     NQ_CONFIG, 0, _GetItemAttr("primary_ip")),
1334
    (_MakeField("sip", "SecondaryIP", QFT_TEXT, "Secondary IP address"),
Michael Hanselmann's avatar
Michael Hanselmann committed
1335
1336
     NQ_CONFIG, 0, _GetItemAttr("secondary_ip")),
    (_MakeField("tags", "Tags", QFT_OTHER, "Tags"), NQ_CONFIG, 0,
1337
     lambda ctx, node: list(node.GetTags())),
1338
    (_MakeField("master", "IsMaster", QFT_BOOL, "Whether node is master"),
Thomas Thrainer's avatar
Thomas Thrainer committed
1339
     NQ_CONFIG, 0, lambda ctx, node: node.uuid == ctx.master_uuid),
Michael Hanselmann's avatar
Michael Hanselmann committed
1340
    (_MakeField("group", "Group", QFT_TEXT, "Node group"), NQ_GROUP, 0,
1341
     _GetGroup(_GetNodeGroup)),
1342
    (_MakeField("group.uuid", "GroupUUID", QFT_TEXT, "UUID of node group"),
Michael Hanselmann's avatar
Michael Hanselmann committed
1343
     NQ_CONFIG, 0, _GetItemAttr("group")),
1344
1345
    (_MakeField("powered", "Powered", QFT_BOOL,
                "Whether node is thought to be powered on"),
Michael Hanselmann's avatar
Michael Hanselmann committed
1346
     NQ_OOB, 0, _GetNodePower),
1347
1348
    (_MakeField("ndparams", "NodeParameters", QFT_OTHER,
                "Merged node parameters"),
Michael Hanselmann's avatar
Michael Hanselmann committed
1349
     NQ_GROUP, 0, _GetGroup(_GetNdParams)),
1350
1351
    (_MakeField("custom_ndparams", "CustomNodeParameters", QFT_OTHER,
                "Custom node parameters"),
Michael Hanselmann's avatar
Michael Hanselmann committed
1352
      NQ_GROUP, 0, _GetItemAttr("ndparams")),
1353
1354
1355
1356
    (_MakeField("hv_state", "HypervisorState", QFT_OTHER, "Hypervisor state"),
     NQ_CONFIG, 0, _GetNodeHvState),
    (_MakeField("disk_state", "DiskState", QFT_OTHER, "Disk state"),
     NQ_CONFIG, 0, _GetNodeDiskState),
Michael Hanselmann's avatar
Michael Hanselmann committed
1357
1358
    ]

1359
1360
  fields.extend(_BuildNDFields(False))

1361
1362
1363
1364
1365
  # 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,"
Iustin Pop's avatar
Iustin Pop committed
1366
              " \"%s\" for regular, \"%s\" for drained, \"%s\" for offline" %
1367
              role_values)
Michael Hanselmann's avatar
Michael Hanselmann committed
1368
  fields.append((_MakeField("role", "Role", QFT_TEXT, role_doc), NQ_CONFIG, 0,
Thomas Thrainer's avatar
Thomas Thrainer committed
1369
                 lambda ctx, node: _GetNodeRole(node, ctx.master_uuid)))
1370
1371
  assert set(role_values) == constants.NR_ALL

Michael Hanselmann's avatar
Michael Hanselmann committed
1372
  def _GetLength(getter):
Thomas Thrainer's avatar
Thomas Thrainer committed
1373
    return lambda ctx, node: len(getter(ctx)[node.uuid])
Michael Hanselmann's avatar
Michael Hanselmann committed
1374
1375

  def _GetList(getter):
1376
1377
1378
    return lambda ctx, node: utils.NiceSort(
                               [ctx.inst_uuid_to_inst_name[uuid]
                                for uuid in getter(ctx)[node.uuid]])
Michael Hanselmann's avatar
Michael Hanselmann committed
1379
1380

  # Add fields operating on instance lists
1381
1382
1383
  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
1384
    # TODO: Allow filterting by hostname in list
Michael Hanselmann's avatar
Michael Hanselmann committed
1385
    fields.extend([
1386
1387
      (_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
1388
       NQ_INST, 0, _GetLength(getter)),
Michael Hanselmann's avatar
Michael Hanselmann committed
1389
      (_MakeField("%sinst_list" % prefix, "%sInstances" % titleprefix,
1390
1391
                  QFT_OTHER,
                  "List of instances with this node as %s" % docword),
Michael Hanselmann's avatar
Michael Hanselmann committed
1392
       NQ_INST, 0, _GetList(getter)),
Michael Hanselmann's avatar
Michael Hanselmann committed
1393
1394
1395
      ])

  # Add simple fields
Michael Hanselmann's avatar
Michael Hanselmann committed
1396
1397
  fields.extend([
    (_MakeField(name, title, kind, doc), NQ_CONFIG, flags, _GetItemAttr(name))
1398
    for (name, (title, kind, flags, doc)) in _NODE_SIMPLE_FIELDS.items()])
Michael Hanselmann's avatar
Michael Hanselmann committed
1399
1400
1401

  # Add fields requiring live data
  fields.extend([
Michael Hanselmann's avatar
Michael Hanselmann committed
1402
    (_MakeField(name, title, kind, doc), NQ_LIVE, 0,