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

4
# Copyright (C) 2010, 2011 Google Inc.
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
#
# This program is free software; you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation; either version 2 of the License, or
# (at your option) any later version.
#
# This program is distributed in the hope that it will be useful, but
# WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
# General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program; if not, write to the Free Software
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
# 02110-1301, USA.


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

How it works:

  - Add field definitions
    - See how L{NODE_FIELDS} is built
    - Each field gets:
      - Query field definition (L{objects.QueryFieldDefinition}, use
        L{_MakeField} for creating), containing:
          - Name, must be lowercase and match L{FIELD_NAME_RE}
          - Title for tables, must not contain whitespace and match
            L{TITLE_RE}
          - Value data type, e.g. L{constants.QFT_NUMBER}
35
36
          - Human-readable description, must not end with punctuation or
            contain newlines
Michael Hanselmann's avatar
Michael Hanselmann committed
37
      - Data request type, see e.g. C{NQ_*}
Michael Hanselmann's avatar
Michael Hanselmann committed
38
      - OR-ed flags, see C{QFF_*}
Michael Hanselmann's avatar
Michael Hanselmann committed
39
40
41
42
43
44
45
46
47
48
49
50
      - 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 qlang
66

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

72

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

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

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

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

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

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

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

#: Verification function for each field type
_VERIFY_FN = {
108
109
110
111
112
113
114
  QFT_UNKNOWN: ht.TNone,
  QFT_TEXT: ht.TString,
  QFT_BOOL: ht.TBool,
  QFT_NUMBER: ht.TInt,
  QFT_UNIT: ht.TInt,
  QFT_TIMESTAMP: ht.TOr(ht.TInt, ht.TFloat),
  QFT_OTHER: lambda _: True,
115
116
  }

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

123
124
125
126
127
128
129
130
131
132
#: VType to QFT mapping
_VTToQFT = {
  # TODO: fix validation of empty strings
  constants.VTYPE_STRING: QFT_OTHER, # since VTYPE_STRINGs can be empty
  constants.VTYPE_MAYBE_STRING: QFT_OTHER,
  constants.VTYPE_BOOL: QFT_BOOL,
  constants.VTYPE_SIZE: QFT_UNIT,
  constants.VTYPE_INT: QFT_NUMBER,
  }

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

135
136
137
138
139

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

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


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

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

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

  """
  result = []

  for name in selected:
    try:
      fdef = fielddefs[name]
    except KeyError:
160
      fdef = (_MakeField(name, name, QFT_UNKNOWN, "Unknown field '%s'" % name),
Michael Hanselmann's avatar
Michael Hanselmann committed
161
              None, 0, _GetUnknownField)
162

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

    result.append(fdef)

  return result


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

  @rtype: list of L{objects.QueryFieldDefinition}

  """
Michael Hanselmann's avatar
Michael Hanselmann committed
176
  return [fdef for (fdef, _, _, _) in fielddefs]
177
178


179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
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
287
288
289
290
291
292
293
294
295
296
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
353
354
355
356
357
358
359
360
361
362
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
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
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()

  def NoteUnaryOp(self, op): # pylint: disable-msg=W0613
    """Called when handling an unary operation.

    @type op: string
    @param op: Operator

    """
    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)


class _FilterCompilerHelper:
  """Converts a query filter to a callable usable for filtering.

  """
  # String statement has no effect, pylint: disable-msg=W0105

  #: 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_*}
  (e.g. L{QFF_HOSTNAME}).

  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],
                                               case_sensitive=False)),
    (None, operator.eq),
    ]

  """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}
    - C{_OPTYPE_UNARY}: Callable taking exactly one parameter; used by
      L{_HandleUnaryOp}
    - 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
    qlang.OP_NOT: (_OPTYPE_UNARY, operator.not_),

    # Binary operators
    qlang.OP_EQUAL: (_OPTYPE_BINARY, _EQUALITY_CHECKS),
    qlang.OP_NOT_EQUAL:
      (_OPTYPE_BINARY, [(flags, compat.partial(_WrapNot, fn))
                        for (flags, fn) in _EQUALITY_CHECKS]),
    qlang.OP_GLOB: (_OPTYPE_BINARY, NotImplemented),
    qlang.OP_REGEXP: (_OPTYPE_BINARY, NotImplemented),
    qlang.OP_CONTAINS: (_OPTYPE_BINARY, [
      (None, operator.contains),
      ]),
    }

  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

  def __call__(self, hints, filter_):
    """Converts a query filter into a callable function.

    @type hints: L{_FilterHints} or None
    @param hints: Callbacks doing analysis on filter
    @type filter_: list
    @param filter_: Filter structure
    @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:
      filter_fn = self._Compile(filter_, 0)
    finally:
      self._op_handler = None

    return filter_fn

  def _Compile(self, filter_, level):
    """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).

    """
    if not (isinstance(filter_, (list, tuple)) and filter_):
      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
    operands = filter_[:]
    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)

  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

    """
    if hints_fn:
      hints_fn(op)

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

    return compat.partial(_WrapUnaryOp, op_fn,
                          self._Compile(operands[0], level + 1))

  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

    """
    # Unused arguments, pylint: disable-msg=W0613
    try:
      (name, value) = operands
    except (ValueError, TypeError):
      raise errors.ParameterError("Invalid binary operator, expected exactly"
                                  " two operands")

    try:
      (fdef, datakind, field_flags, retrieval_fn) = self._fields[name]
    except KeyError:
      raise errors.ParameterError("Unknown field '%s'" % name)

    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)

    for (fn_flags, fn) in op_data:
      if fn_flags is None or fn_flags & field_flags:
        return compat.partial(_WrapBinaryOp, fn, retrieval_fn, value)

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


def _CompileFilter(fields, hints, filter_):
  """Converts a query filter into a callable function.

  See L{_FilterCompilerHelper} for details.

  @rtype: callable

  """
  return _FilterCompilerHelper(fields)(hints, filter_)


557
class Query:
558
  def __init__(self, fieldlist, selected, filter_=None, namefield=None):
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
    """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

    """
577
578
    assert namefield is None or namefield in fieldlist

579
580
    self._fields = _GetQueryFields(fieldlist, selected)

581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
    self._filter_fn = None
    self._requested_names = None
    self._filter_datakinds = frozenset()

    if filter_ is not None:
      # Collect requested names if wanted
      if namefield:
        hints = _FilterHints(namefield)
      else:
        hints = None

      # Build filter function
      self._filter_fn = _CompileFilter(fieldlist, hints, filter_)
      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

612
613
614
615
616
617
  def RequestedData(self):
    """Gets requested kinds of data.

    @rtype: frozenset

    """
618
619
620
    return (self._filter_datakinds |
            frozenset(datakind for (_, datakind, _, _) in self._fields
                      if datakind is not None))
621
622
623
624
625
626
627
628
629
630
631

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

    Includes unknown fields.

    @rtype: List of L{objects.QueryFieldDefinition}

    """
    return GetAllFields(self._fields)

632
  def Query(self, ctx, sort_by_name=True):
633
634
635
636
    """Execute a query.

    @param ctx: Data container passed to field retrieval functions, must
      support iteration using C{__iter__}
637
638
639
    @type sort_by_name: boolean
    @param sort_by_name: Whether to sort by name or keep the input data's
      ordering
640
641

    """
642
643
    sort = (self._name_fn and sort_by_name)

644
645
646
647
648
    result = []

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

650
651
652
653
      row = [_ProcessResult(fn(ctx, item)) for (_, _, _, fn) in self._fields]

      # Verify result
      if __debug__:
654
        _VerifyResultRow(self._fields, row)
655

656
      if sort:
657
658
659
        (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?
660
        result.append((utils.NiceSortKey(name), idx, row))
661
      else:
662
        result.append(row)
663

664
665
    if not sort:
      return result
666
667
668
669
670
671
672
673
674

    # 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)
675

676
  def OldStyleQuery(self, ctx, sort_by_name=True):
677
678
679
680
681
    """Query with "old" query result format.

    See L{Query.Query} for arguments.

    """
Michael Hanselmann's avatar
Michael Hanselmann committed
682
683
    unknown = set(fdef.name for (fdef, _, _, _) in self._fields
                  if fdef.kind == QFT_UNKNOWN)
684
685
686
687
688
689
    if unknown:
      raise errors.OpPrereqError("Unknown output fields selected: %s" %
                                 (utils.CommaJoin(unknown), ),
                                 errors.ECODE_INVAL)

    return [[value for (_, value) in row]
690
            for row in self.Query(ctx, sort_by_name=sort_by_name)]
691
692


693
694
695
696
697
def _ProcessResult(value):
  """Converts result values into externally-visible ones.

  """
  if value is _FS_UNKNOWN:
René Nussbaumer's avatar
René Nussbaumer committed
698
    return (RS_UNKNOWN, None)
699
  elif value is _FS_NODATA:
René Nussbaumer's avatar
René Nussbaumer committed
700
    return (RS_NODATA, None)
701
  elif value is _FS_UNAVAIL:
René Nussbaumer's avatar
René Nussbaumer committed
702
    return (RS_UNAVAIL, None)
703
  elif value is _FS_OFFLINE:
René Nussbaumer's avatar
René Nussbaumer committed
704
    return (RS_OFFLINE, None)
705
  else:
René Nussbaumer's avatar
René Nussbaumer committed
706
    return (RS_NORMAL, value)
707
708


709
710
711
712
713
714
715
716
717
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

  """
718
719
  assert len(row) == len(fields)
  errs = []
Michael Hanselmann's avatar
Michael Hanselmann committed
720
  for ((status, value), (fdef, _, _, _)) in zip(row, fields):
René Nussbaumer's avatar
René Nussbaumer committed
721
    if status == RS_NORMAL:
722
723
724
725
726
727
728
      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))
729
730


731
def _PrepareFieldList(fields, aliases):
732
733
734
735
  """Prepares field list for use by L{Query}.

  Converts the list to a dictionary and does some verification.

736
737
738
739
740
741
742
  @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
743
744
745
746
  @rtype: dict
  @return: Field dictionary for L{Query}

  """
747
748
  if __debug__:
    duplicates = utils.FindDuplicates(fdef.title.lower()
Michael Hanselmann's avatar
Michael Hanselmann committed
749
                                      for (fdef, _, _, _) in fields)
750
    assert not duplicates, "Duplicate title(s) found: %r" % duplicates
751
752
753
754

  result = {}

  for field in fields:
Michael Hanselmann's avatar
Michael Hanselmann committed
755
    (fdef, _, flags, fn) = field
756
757
758
759

    assert fdef.name and fdef.title, "Name and title are required"
    assert FIELD_NAME_RE.match(fdef.name)
    assert TITLE_RE.match(fdef.title)
760
761
762
    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
763
    assert callable(fn)
764
765
    assert fdef.name not in result, \
           "Duplicate field name '%s' found" % fdef.name
Michael Hanselmann's avatar
Michael Hanselmann committed
766
    assert (flags & ~QFF_ALL) == 0, "Unknown flags for field '%s'" % fdef.name
767
768
769

    result[fdef.name] = field

770
771
772
  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
773
    (fdef, k, flags, fn) = result[target]
774
775
    fdef = fdef.Copy()
    fdef.name = alias
Michael Hanselmann's avatar
Michael Hanselmann committed
776
    result[alias] = (fdef, k, flags, fn)
777
778

  assert len(result) == len(fields) + len(aliases)
779
  assert compat.all(name == fdef.name
Michael Hanselmann's avatar
Michael Hanselmann committed
780
                    for (name, (fdef, _, _, _)) in result.items())
781
782
783
784

  return result


785
def GetQueryResponse(query, ctx, sort_by_name=True):
786
787
788
789
  """Prepares the response for a query.

  @type query: L{Query}
  @param ctx: Data container, see L{Query.Query}
790
791
792
  @type sort_by_name: boolean
  @param sort_by_name: Whether to sort by name or keep the input data's
    ordering
793
794

  """
795
  return objects.QueryResponse(data=query.Query(ctx, sort_by_name=sort_by_name),
796
797
798
                               fields=query.GetFields()).ToDict()


799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
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()


820
def _MakeField(name, title, kind, doc):
821
822
823
824
825
  """Wrapper for creating L{objects.QueryFieldDefinition} instances.

  @param name: Field name as a regular expression
  @param title: Human-readable title
  @param kind: Field type
826
  @param doc: Human-readable description
827
828

  """
829
830
  return objects.QueryFieldDefinition(name=name, title=title, kind=kind,
                                      doc=doc)
Michael Hanselmann's avatar
Michael Hanselmann committed
831
832
833
834
835
836
837
838
839
840
841
842


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:
843
    return constants.NR_MASTER
Michael Hanselmann's avatar
Michael Hanselmann committed
844
  elif node.master_candidate:
845
    return constants.NR_MCANDIDATE
Michael Hanselmann's avatar
Michael Hanselmann committed
846
  elif node.drained:
847
    return constants.NR_DRAINED
Michael Hanselmann's avatar
Michael Hanselmann committed
848
  elif node.offline:
849
    return constants.NR_OFFLINE
Michael Hanselmann's avatar
Michael Hanselmann committed
850
  else:
851
    return constants.NR_REGULAR
Michael Hanselmann's avatar
Michael Hanselmann committed
852
853
854
855
856
857
858
859
860


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

  @param attr: Attribute name

  """
  getter = operator.attrgetter(attr)
861
  return lambda _, item: getter(item)
Michael Hanselmann's avatar
Michael Hanselmann committed
862
863


864
865
866
867
868
869
870
871
872
873
874
875
876
877
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
878
      return _FS_UNAVAIL
879
    else:
880
      return timestamp
881
882
883
884
885
886
887
888
889
890
891

  return fn


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

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

  """
  return [
892
    (_MakeField("ctime", "CTime", QFT_TIMESTAMP, "Creation timestamp"),
Michael Hanselmann's avatar
Michael Hanselmann committed
893
     datatype, 0, _GetItemTimestamp(operator.attrgetter("ctime"))),
894
    (_MakeField("mtime", "MTime", QFT_TIMESTAMP, "Modification timestamp"),
Michael Hanselmann's avatar
Michael Hanselmann committed
895
     datatype, 0, _GetItemTimestamp(operator.attrgetter("mtime"))),
896
897
898
    ]


Michael Hanselmann's avatar
Michael Hanselmann committed
899
900
901
902
903
class NodeQueryData:
  """Data container for node data queries.

  """
  def __init__(self, nodes, live_data, master_name, node_to_primary,
904
               node_to_secondary, groups, oob_support, cluster):
Michael Hanselmann's avatar
Michael Hanselmann committed
905
906
907
908
909
910
911
912
913
    """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
914
    self.oob_support = oob_support
915
    self.cluster = cluster
Michael Hanselmann's avatar
Michael Hanselmann committed
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936

    # Used for individual rows
    self.curlive_data = None

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

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

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


#: Fields that are direct attributes of an L{objects.Node} object
_NODE_SIMPLE_FIELDS = {
Michael Hanselmann's avatar
Michael Hanselmann committed
937
938
  "drained": ("Drained", QFT_BOOL, 0, "Whether node is drained"),
  "master_candidate": ("MasterC", QFT_BOOL, 0,
939
                       "Whether node is a master candidate"),
Michael Hanselmann's avatar
Michael Hanselmann committed
940
  "master_capable": ("MasterCapable", QFT_BOOL, 0,
941
                     "Whether node can become a master candidate"),
Michael Hanselmann's avatar
Michael Hanselmann committed
942
943
944
945
946
  "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
947
948
949
950
  }


#: Fields requiring talking to the node
951
# Note that none of these are available for non-vm_capable nodes
Michael Hanselmann's avatar
Michael Hanselmann committed
952
_NODE_LIVE_FIELDS = {
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
  "bootid": ("BootID", QFT_TEXT, "bootid",
             "Random UUID renewed for each system reboot, can be used"
             " for detecting reboots by tracking changes"),
  "cnodes": ("CNodes", QFT_NUMBER, "cpu_nodes",
             "Number of NUMA domains on node (if exported by hypervisor)"),
  "csockets": ("CSockets", QFT_NUMBER, "cpu_sockets",
               "Number of physical CPU sockets (if exported by hypervisor)"),
  "ctotal": ("CTotal", QFT_NUMBER, "cpu_total", "Number of logical processors"),
  "dfree": ("DFree", QFT_UNIT, "vg_free",
            "Available disk space in volume group"),
  "dtotal": ("DTotal", QFT_UNIT, "vg_size",
             "Total disk space in volume group used for instance disk"
             " allocation"),
  "mfree": ("MFree", QFT_UNIT, "memory_free",
            "Memory available for instance allocations"),
  "mnode": ("MNode", QFT_UNIT, "memory_dom0",
            "Amount of memory used by node (dom0 for Xen)"),
  "mtotal": ("MTotal", QFT_UNIT, "memory_total",
             "Total amount of memory of physical machine"),
Michael Hanselmann's avatar
Michael Hanselmann committed
972
973
974
  }


975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
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
992
      return _FS_UNAVAIL
993
994
995
996
997
998
999

    return cb(ctx, node, ng)

  return fn


def _GetNodeGroup(ctx, node, ng): # pylint: disable-msg=W0613
Michael Hanselmann's avatar
Michael Hanselmann committed
1000
1001
1002
1003
1004
  """Returns the name of a node's group.

  @type ctx: L{NodeQueryData}
  @type node: L{objects.Node}
  @param node: Node object
1005
1006
  @type ng: L{objects.NodeGroup}
  @param ng: The node group this node belongs to
Michael Hanselmann's avatar
Michael Hanselmann committed
1007
1008

  """
1009
  return ng.name
Michael Hanselmann's avatar
Michael Hanselmann committed
1010
1011


1012
1013
1014
1015
1016
1017
1018
1019
1020
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]:
1021
    return node.powered
1022

1023
  return _FS_UNAVAIL
1024
1025


1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
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

  """
1036
  return ctx.cluster.SimpleFillND(ng.FillND(node))
1037
1038


1039
def _GetLiveNodeField(field, kind, ctx, node):
Michael Hanselmann's avatar
Michael Hanselmann committed
1040
1041
1042
1043
1044
  """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}
1045
1046
  @type node: L{objects.Node}
  @param node: Node object
Michael Hanselmann's avatar
Michael Hanselmann committed
1047
1048

  """
1049
  if node.offline:
1050
    return _FS_OFFLINE
1051

1052
1053
1054
  if not node.vm_capable:
    return _FS_UNAVAIL

Michael Hanselmann's avatar
Michael Hanselmann committed
1055
  if not ctx.curlive_data:
1056
    return _FS_NODATA
Michael Hanselmann's avatar
Michael Hanselmann committed
1057
1058
1059
1060

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

1063
  if kind == QFT_TEXT:
1064
    return value
Michael Hanselmann's avatar
Michael Hanselmann committed
1065

1066
  assert kind in (QFT_NUMBER, QFT_UNIT)
Michael Hanselmann's avatar
Michael Hanselmann committed
1067
1068
1069

  # Try to convert into number
  try:
1070
    return int(value)
Michael Hanselmann's avatar
Michael Hanselmann committed
1071
1072
1073
  except (ValueError, TypeError):
    logging.exception("Failed to convert node field '%s' (value %r) to int",
                      value, field)
1074
    return _FS_UNAVAIL
Michael Hanselmann's avatar
Michael Hanselmann committed
1075
1076
1077
1078
1079
1080
1081


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

  """
  fields = [
1082
    (_MakeField("pip", "PrimaryIP", QFT_TEXT, "Primary IP address"),
Michael Hanselmann's avatar
Michael Hanselmann committed
1083
     NQ_CONFIG, 0, _GetItemAttr("primary_ip")),
1084
    (_MakeField("sip", "SecondaryIP", QFT_TEXT, "Secondary IP address"),
Michael Hanselmann's avatar
Michael Hanselmann committed
1085
1086
     NQ_CONFIG, 0, _GetItemAttr("secondary_ip")),
    (_MakeField("tags", "Tags", QFT_OTHER, "Tags"), NQ_CONFIG, 0,
1087
     lambda ctx, node: list(node.GetTags())),
1088
    (_MakeField("master", "IsMaster", QFT_BOOL, "Whether node is master"),
Michael Hanselmann's avatar
Michael Hanselmann committed
1089
1090
     NQ_CONFIG, 0, lambda ctx, node: node.name == ctx.master_name),
    (_MakeField("group", "Group", QFT_TEXT, "Node group"), NQ_GROUP, 0,
1091
     _GetGroup(_GetNodeGroup)),
1092
    (_MakeField("group.uuid", "GroupUUID", QFT_TEXT, "UUID of node group"),
Michael Hanselmann's avatar
Michael Hanselmann committed
1093
     NQ_CONFIG, 0, _GetItemAttr("group")),
1094
1095
    (_MakeField("powered", "Powered", QFT_BOOL,
                "Whether node is thought to be powered on"),
Michael Hanselmann's avatar
Michael Hanselmann committed
1096
     NQ_OOB, 0, _GetNodePower),
1097
1098
    (_MakeField("ndparams", "NodeParameters", QFT_OTHER,
                "Merged node parameters"),
Michael Hanselmann's avatar
Michael Hanselmann committed
1099
     NQ_GROUP, 0, _GetGroup(_GetNdParams)),
1100
1101
    (_MakeField("custom_ndparams", "CustomNodeParameters", QFT_OTHER,
                "Custom node parameters"),
Michael Hanselmann's avatar
Michael Hanselmann committed
1102
      NQ_GROUP, 0, _GetItemAttr("ndparams")),
Michael Hanselmann's avatar
Michael Hanselmann committed
1103
1104
    ]

1105
1106
1107
1108
1109
1110
1111
  # Node role
  role_values = (constants.NR_MASTER, constants.NR_MCANDIDATE,
                 constants.NR_REGULAR, constants.NR_DRAINED,
                 constants.NR_OFFLINE)
  role_doc = ("Node role; \"%s\" for master, \"%s\" for master candidate,"
              " \"%s\" for regular, \"%s\" for a drained, \"%s\" for offline" %
              role_values)
Michael Hanselmann's avatar
Michael Hanselmann committed
1112
  fields.append((_MakeField("role", "Role", QFT_TEXT, role_doc), NQ_CONFIG, 0,
1113
1114
1115
                 lambda ctx, node: _GetNodeRole(node, ctx.master_name)))
  assert set(role_values) == constants.NR_ALL

Michael Hanselmann's avatar
Michael Hanselmann committed
1116
  def _GetLength(getter):
1117
    return lambda ctx, node: len(getter(ctx)[node.name])
Michael Hanselmann's avatar
Michael Hanselmann committed
1118
1119

  def _GetList(getter):
1120
    return lambda ctx, node: list(getter(ctx)[node.name])
Michael Hanselmann's avatar
Michael Hanselmann committed
1121
1122

  # Add fields operating on instance lists
1123
1124
1125
  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
1126
    # TODO: Allow filterting by hostname in list
Michael Hanselmann's avatar
Michael Hanselmann committed
1127
    fields.extend([
1128
1129
      (_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
1130
       NQ_INST, 0, _GetLength(getter)),
Michael Hanselmann's avatar
Michael Hanselmann committed
1131
      (_MakeField("%sinst_list" % prefix, "%sInstances" % titleprefix,
1132
1133
                  QFT_OTHER,
                  "List of instances with this node as %s" % docword),
Michael Hanselmann's avatar
Michael Hanselmann committed
1134
       NQ_INST, 0, _GetList(getter)),
Michael Hanselmann's avatar
Michael Hanselmann committed
1135
1136
1137
      ])

  # Add simple fields
Michael Hanselmann's avatar
Michael Hanselmann committed
1138
1139
1140
1141
  fields.extend([
    (_MakeField(name, title, kind, doc), NQ_CONFIG, flags, _GetItemAttr(name))
    for (name, (title, kind, flags, doc)) in _NODE_SIMPLE_FIELDS.items()
    ])
Michael Hanselmann's avatar
Michael Hanselmann committed
1142
1143
1144

  # Add fields requiring live data
  fields.extend([
Michael Hanselmann's avatar
Michael Hanselmann committed
1145
    (_MakeField(name, title, kind, doc), NQ_LIVE, 0,
Michael Hanselmann's avatar
Michael Hanselmann committed
1146
     compat.partial(_GetLiveNodeField, nfield, kind))
1147
    for (name, (title, kind, nfield, doc)) in _NODE_LIVE_FIELDS.items()
Michael Hanselmann's avatar
Michael Hanselmann committed
1148
1149
    ])

1150
1151
1152
  # Add timestamps
  fields.extend(_GetItemTimestampFields(NQ_CONFIG))

1153
  return _PrepareFieldList(fields, [])
Michael Hanselmann's avatar
Michael Hanselmann committed
1154
1155


1156
1157
1158
1159
1160
class InstanceQueryData:
  """Data container for instance data queries.

  """
  def __init__(self, instances, cluster, disk_usage, offline_nodes, bad_nodes,
1161
               live_data, wrongnode_inst, console):
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
    """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
1174
1175
    @type wrongnode_inst: set
    @param wrongnode_inst: Set of instances running on wrong node(s)
1176
1177
    @type console: dict; instance name as key
    @param console: Per-instance console information
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190

    """
    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
1191
    self.wrongnode_inst = wrongnode_inst
1192
    self.console = console
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222

    # 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
1223
  # Can't use RS_OFFLINE here as it would describe the instance to
1224
  # be offline when we actually don't know due to missing data
1225
  if inst.primary_node in ctx.bad_nodes:
1226
    return _FS_NODATA
1227
  else:
1228
    return bool(ctx.live_data.get(inst.name))
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247


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
1248
      # Can't use RS_OFFLINE here as it would describe the instance to be
1249
      # offline when we actually don't know due to missing data
1250
      return _FS_NODATA
1251
1252
1253
1254

    if inst.name in ctx.live_data:
      data = ctx.live_data[inst.name]
      if name in data:
1255
        return data[name]
1256

1257
    return _FS_UNAVAIL
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270

  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:
1271
    return constants.INSTST_NODEOFFLINE
1272
1273

  if inst.primary_node in ctx.bad_nodes:
1274
    return constants.INSTST_NODEDOWN
1275
1276

  if bool(ctx.live_data.get(inst.name)):
1277
    if inst.name in ctx.wrongnode_inst:
1278
      return constants.INSTST_WRONGNODE
1279
    elif inst.admin_up:
1280
      return constants.INSTST_RUNNING
1281
    else:
1282
      return constants.INSTST_ERRORUP
1283
1284

  if inst.admin_up:
1285
    return constants.INSTST_ERRORDOWN
1286

1287
  return constants.INSTST_ADMINDOWN
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304


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:
1305
      return inst.disks[index].size
1306
    except IndexError:
1307
      return _FS_UNAVAIL
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331

  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:
1332
      return _FS_UNAVAIL
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347

    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:
1348
    return _FS_UNAVAIL
1349
  else:
1350
    return nic.ip
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365


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:
1366
    return nicparams[constants.NIC_LINK]
1367
  else:
1368
    return _FS_UNAVAIL
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390


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)

1391
  return result
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411


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
1412
    return ctx.inst_nicparams[index][name]
1413
1414
1415
1416
1417
1418
1419

  return fn


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

1420
1421
  @return: Tuple containing list of field definitions used as input for
    L{_PrepareFieldList} and a list of aliases
1422
1423

  """
1424
  nic_mac_fn = lambda ctx, _, nic: nic.mac
1425
1426
1427
1428
1429
  nic_mode_fn = _GetInstNicParam(constants.NIC_MODE)
  nic_link_fn = _GetInstNicParam(constants.NIC_LINK)

  fields = [
    # All NICs
1430
1431
    (_MakeField("nic.count", "NICs", QFT_NUMBER,
                "Number of network interfaces"),
Michael Hanselmann's avatar
Michael Hanselmann committed
1432
     IQ_CONFIG, 0, lambda ctx, inst: len(inst.nics)),
1433
1434
    (_MakeField("nic.macs", "NIC_MACs", QFT_OTHER,
                "List containing each network interface's MAC address"),
Michael Hanselmann's avatar
Michael Hanselmann committed
1435
     IQ_CONFIG, 0, lambda ctx, inst: [nic.mac for nic in inst.nics]),
1436
1437
    (_MakeField("nic.ips", "NIC_IPs", QFT_OTHER,
                "List containing each network interface's IP address"),
Michael Hanselmann's avatar
Michael Hanselmann committed
1438
     IQ_CONFIG, 0, lambda ctx, inst: [nic.ip for nic in inst.nics]),
1439
    (_MakeField("nic.modes", "NIC_modes", QFT_OTHER,
Michael Hanselmann's avatar
Michael Hanselmann committed
1440
                "List containing each network interface's mode"), IQ_CONFIG, 0,
1441
1442
     lambda ctx, inst: [nicp[constants.NIC_MODE]
                        for nicp in ctx.inst_nicparams]),
1443
    (_MakeField("nic.links", "NIC_links", QFT_OTHER,
Michael Hanselmann's avatar
Michael Hanselmann committed
1444
                "List containing each network interface's link"), IQ_CONFIG, 0,
1445
1446
     lambda ctx, inst: [nicp[constants.NIC_LINK]
                        for nicp in ctx.inst_nicparams]),
1447
    (_MakeField("nic.bridges", "NIC_bridges", QFT_OTHER,
Michael Hanselmann's avatar
Michael Hanselmann committed
1448
1449
                "List containing each network interface's bridge"),
     IQ_CONFIG, 0, _GetInstAllNicBridges),
1450
1451
1452
1453
    ]

  # NICs by number
  for i in range(constants.MAX_NICS):
1454
    numtext = utils.FormatOrdinal(i + 1)
1455
    fields.extend([
1456
1457
      (_MakeField("nic.ip/%s" % i, "NicIP/%s" % i, QFT_TEXT,
                  "IP address of %s network interface" % numtext),
Michael Hanselmann's avatar
Michael Hanselmann committed
1458
       IQ_CONFIG, 0, _GetInstNic(i, _GetInstNicIp)),
1459
1460
      (_MakeField("nic.mac/%s" % i, "NicMAC/%s" % i, QFT_TEXT,
                  "MAC address of %s network interface" % numtext),
Michael Hanselmann's avatar
Michael Hanselmann committed
1461
       IQ_CONFIG, 0, _GetInstNic(i, nic_mac_fn)),
1462
1463
      (_MakeField("nic.mode/%s" % i, "NicMode/%s" % i, QFT_TEXT,
                  "Mode of %s network interface" % numtext),
Michael Hanselmann's avatar
Michael Hanselmann committed
1464
       IQ_CONFIG, 0, _GetInstNic(i, nic_mode_fn)),
1465
1466
      (_MakeField("nic.link/%s" % i, "NicLink/%s" % i, QFT_TEXT,
                  "Link of %s network interface" % numtext),
Michael Hanselmann's avatar
Michael Hanselmann committed
1467
       IQ_CONFIG, 0, _GetInstNic(i, nic_link_fn)),
1468
1469
      (_MakeField("nic.bridge/%s" % i, "NicBridge/%s" % i, QFT_TEXT,
                  "Bridge of %s network interface" % numtext),
Michael Hanselmann's avatar
Michael Hanselmann committed
1470
       IQ_CONFIG, 0, _GetInstNic(i, _GetInstNicBridge)),
1471
1472
      ])

Michael Hanselmann's avatar