4 # Copyright (C) 2010, 2011, 2012, 2013 Google Inc.
6 # This program is free software; you can redistribute it and/or modify
7 # it under the terms of the GNU General Public License as published by
8 # the Free Software Foundation; either version 2 of the License, or
9 # (at your option) any later version.
11 # This program is distributed in the hope that it will be useful, but
12 # WITHOUT ANY WARRANTY; without even the implied warranty of
13 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
14 # General Public License for more details.
16 # You should have received a copy of the GNU General Public License
17 # along with this program; if not, write to the Free Software
18 # Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
22 """Module for query operations
26 - Add field definitions
27 - See how L{NODE_FIELDS} is built
29 - Query field definition (L{objects.QueryFieldDefinition}, use
30 L{_MakeField} for creating), containing:
31 - Name, must be lowercase and match L{FIELD_NAME_RE}
32 - Title for tables, must not contain whitespace and match
34 - Value data type, e.g. L{constants.QFT_NUMBER}
35 - Human-readable description, must not end with punctuation or
37 - Data request type, see e.g. C{NQ_*}
38 - OR-ed flags, see C{QFF_*}
39 - A retrieval function, see L{Query.__init__} for description
40 - Pass list of fields through L{_PrepareFieldList} for preparation and
42 - Instantiate L{Query} with prepared field list definition and selected fields
43 - Call L{Query.RequestedData} to determine what data to collect/compute
44 - Call L{Query.Query} or L{Query.OldStyleQuery} with collected data and use
46 - Data container must support iteration using C{__iter__}
47 - Items are passed to retrieval functions and can have any format
48 - Call L{Query.GetFields} to get list of definitions for selected fields
50 @attention: Retrieval functions must be idempotent. They can be called multiple
51 times, in any order and any number of times.
59 from ganeti import constants
60 from ganeti import errors
61 from ganeti import utils
62 from ganeti import compat
63 from ganeti import objects
65 from ganeti import runtime
66 from ganeti import qlang
67 from ganeti import jstore
69 from ganeti.constants import (QFT_UNKNOWN, QFT_TEXT, QFT_BOOL, QFT_NUMBER,
70 QFT_UNIT, QFT_TIMESTAMP, QFT_OTHER,
71 RS_NORMAL, RS_UNKNOWN, RS_NODATA,
72 RS_UNAVAIL, RS_OFFLINE)
77 NETQ_INST) = range(300, 304)
79 # Constants for requesting data from the caller/data provider. Each property
80 # collected/computed separately by the data provider should have its own to
81 # only collect the requested data and not more.
94 IQ_NETWORKS) = range(100, 106)
98 LQ_PENDING) = range(10, 13)
103 GQ_DISKPARAMS) = range(200, 204)
107 CQ_WATCHER_PAUSE) = range(300, 303)
109 (JQ_ARCHIVED, ) = range(400, 401)
113 QFF_IP_ADDRESS = 0x02
115 QFF_SPLIT_TIMESTAMP = 0x08
116 # Next values: 0x10, 0x20, 0x40, 0x80, 0x100, 0x200
117 QFF_ALL = (QFF_HOSTNAME | QFF_IP_ADDRESS | QFF_JOB_ID | QFF_SPLIT_TIMESTAMP)
119 FIELD_NAME_RE = re.compile(r"^[a-z0-9/._]+$")
120 TITLE_RE = re.compile(r"^[^\s]+$")
121 DOC_RE = re.compile(r"^[A-Z].*[^.,?!]$")
123 #: Verification function for each field type
125 QFT_UNKNOWN: ht.TNone,
126 QFT_TEXT: ht.TString,
130 QFT_TIMESTAMP: ht.TNumber,
131 QFT_OTHER: lambda _: True,
134 # Unique objects for special field statuses
135 _FS_UNKNOWN = object()
136 _FS_NODATA = object()
137 _FS_UNAVAIL = object()
138 _FS_OFFLINE = object()
140 #: List of all special status
141 _FS_ALL = compat.UniqueFrozenset([
148 #: VType to QFT mapping
150 # TODO: fix validation of empty strings
151 constants.VTYPE_STRING: QFT_OTHER, # since VTYPE_STRINGs can be empty
152 constants.VTYPE_MAYBE_STRING: QFT_OTHER,
153 constants.VTYPE_BOOL: QFT_BOOL,
154 constants.VTYPE_SIZE: QFT_UNIT,
155 constants.VTYPE_INT: QFT_NUMBER,
158 _SERIAL_NO_DOC = "%s object serial number, incremented on each modification"
161 def _GetUnknownField(ctx, item): # pylint: disable=W0613
162 """Gets the contents of an unknown field.
168 def _GetQueryFields(fielddefs, selected):
169 """Calculates the internal list of selected fields.
171 Unknown fields are returned as L{constants.QFT_UNKNOWN}.
173 @type fielddefs: dict
174 @param fielddefs: Field definitions
175 @type selected: list of strings
176 @param selected: List of selected fields
181 for name in selected:
183 fdef = fielddefs[name]
185 fdef = (_MakeField(name, name, QFT_UNKNOWN, "Unknown field '%s'" % name),
186 None, 0, _GetUnknownField)
188 assert len(fdef) == 4
195 def GetAllFields(fielddefs):
196 """Extract L{objects.QueryFieldDefinition} from field definitions.
198 @rtype: list of L{objects.QueryFieldDefinition}
201 return [fdef for (fdef, _, _, _) in fielddefs]
205 """Class for filter analytics.
207 When filters are used, the user of the L{Query} class usually doesn't know
208 exactly which items will be necessary for building the result. It therefore
209 has to prepare and compute the input data for potentially returning
212 There are two ways to optimize this. The first, and simpler, is to assign
213 each field a group of data, so that the caller can determine which
214 computations are necessary depending on the data groups requested. The list
215 of referenced groups must also be computed for fields referenced in the
218 The second is restricting the items based on a primary key. The primary key
219 is usually a unique name (e.g. a node name). This class extracts all
220 referenced names from a filter. If it encounters any filter condition which
221 disallows such a list to be determined (e.g. a non-equality filter), all
222 names will be requested.
224 The end-effect is that any operation other than L{qlang.OP_OR} and
225 L{qlang.OP_EQUAL} will make the query more expensive.
228 def __init__(self, namefield):
229 """Initializes this class.
231 @type namefield: string
232 @param namefield: Field caller is interested in
235 self._namefield = namefield
237 #: Whether all names need to be requested (e.g. if a non-equality operator
239 self._allnames = False
241 #: Which names to request
244 #: Data kinds referenced by the filter (used by L{Query.RequestedData})
245 self._datakinds = set()
247 def RequestedNames(self):
248 """Returns all requested values.
250 Returns C{None} if list of values can't be determined (e.g. encountered
251 non-equality operators).
256 if self._allnames or self._names is None:
259 return utils.UniqueSequence(self._names)
261 def ReferencedData(self):
262 """Returns all kinds of data referenced by the filter.
265 return frozenset(self._datakinds)
267 def _NeedAllNames(self):
268 """Changes internal state to request all names.
271 self._allnames = True
274 def NoteLogicOp(self, op):
275 """Called when handling a logic operation.
281 if op != qlang.OP_OR:
284 def NoteUnaryOp(self, op, datakind): # pylint: disable=W0613
285 """Called when handling an unary operation.
291 if datakind is not None:
292 self._datakinds.add(datakind)
296 def NoteBinaryOp(self, op, datakind, name, value):
297 """Called when handling a binary operation.
302 @param name: Left-hand side of operator (field name)
303 @param value: Right-hand side of operator
306 if datakind is not None:
307 self._datakinds.add(datakind)
312 # If any operator other than equality was used, all names need to be
314 if op == qlang.OP_EQUAL and name == self._namefield:
315 if self._names is None:
317 self._names.append(value)
322 def _WrapLogicOp(op_fn, sentences, ctx, item):
323 """Wrapper for logic operator functions.
326 return op_fn(fn(ctx, item) for fn in sentences)
329 def _WrapUnaryOp(op_fn, inner, ctx, item):
330 """Wrapper for unary operator functions.
333 return op_fn(inner(ctx, item))
336 def _WrapBinaryOp(op_fn, retrieval_fn, value, ctx, item):
337 """Wrapper for binary operator functions.
340 return op_fn(retrieval_fn(ctx, item), value)
343 def _WrapNot(fn, lhs, rhs):
344 """Negates the result of a wrapped function.
347 return not fn(lhs, rhs)
350 def _PrepareRegex(pattern):
351 """Compiles a regular expression.
355 return re.compile(pattern)
356 except re.error, err:
357 raise errors.ParameterError("Invalid regex pattern (%s)" % err)
360 def _PrepareSplitTimestamp(value):
361 """Prepares a value for comparison by L{_MakeSplitTimestampComparison}.
364 if ht.TNumber(value):
367 return utils.MergeTime(value)
370 def _MakeSplitTimestampComparison(fn):
371 """Compares split timestamp values after converting to float.
374 return lambda lhs, rhs: fn(utils.MergeTime(lhs), rhs)
377 def _MakeComparisonChecks(fn):
378 """Prepares flag-specific comparisons using a comparison function.
382 (QFF_SPLIT_TIMESTAMP, _MakeSplitTimestampComparison(fn),
383 _PrepareSplitTimestamp),
384 (QFF_JOB_ID, lambda lhs, rhs: fn(jstore.ParseJobId(lhs), rhs),
390 class _FilterCompilerHelper:
391 """Converts a query filter to a callable usable for filtering.
394 # String statement has no effect, pylint: disable=W0105
396 #: How deep filters can be nested
399 # Unique identifiers for operator groups
402 _OPTYPE_BINARY) = range(1, 4)
404 """Functions for equality checks depending on field flags.
406 List of tuples containing flags and a callable receiving the left- and
407 right-hand side of the operator. The flags are an OR-ed value of C{QFF_*}
408 (e.g. L{QFF_HOSTNAME} or L{QFF_SPLIT_TIMESTAMP}).
410 Order matters. The first item with flags will be used. Flags are checked
416 lambda lhs, rhs: utils.MatchNameComponent(rhs, [lhs],
417 case_sensitive=False),
419 (QFF_SPLIT_TIMESTAMP, _MakeSplitTimestampComparison(operator.eq),
420 _PrepareSplitTimestamp),
421 (None, operator.eq, None),
426 Operator as key (C{qlang.OP_*}), value a tuple of operator group
427 (C{_OPTYPE_*}) and a group-specific value:
429 - C{_OPTYPE_LOGIC}: Callable taking any number of arguments; used by
431 - C{_OPTYPE_UNARY}: Always C{None}; details handled by L{_HandleUnaryOp}
432 - C{_OPTYPE_BINARY}: Callable taking exactly two parameters, the left- and
433 right-hand side of the operator, used by L{_HandleBinaryOp}
438 qlang.OP_OR: (_OPTYPE_LOGIC, compat.any),
439 qlang.OP_AND: (_OPTYPE_LOGIC, compat.all),
442 qlang.OP_NOT: (_OPTYPE_UNARY, None),
443 qlang.OP_TRUE: (_OPTYPE_UNARY, None),
446 qlang.OP_EQUAL: (_OPTYPE_BINARY, _EQUALITY_CHECKS),
448 (_OPTYPE_BINARY, [(flags, compat.partial(_WrapNot, fn), valprepfn)
449 for (flags, fn, valprepfn) in _EQUALITY_CHECKS]),
450 qlang.OP_LT: (_OPTYPE_BINARY, _MakeComparisonChecks(operator.lt)),
451 qlang.OP_LE: (_OPTYPE_BINARY, _MakeComparisonChecks(operator.le)),
452 qlang.OP_GT: (_OPTYPE_BINARY, _MakeComparisonChecks(operator.gt)),
453 qlang.OP_GE: (_OPTYPE_BINARY, _MakeComparisonChecks(operator.ge)),
454 qlang.OP_REGEXP: (_OPTYPE_BINARY, [
455 (None, lambda lhs, rhs: rhs.search(lhs), _PrepareRegex),
457 qlang.OP_CONTAINS: (_OPTYPE_BINARY, [
458 (None, operator.contains, None),
462 def __init__(self, fields):
463 """Initializes this class.
465 @param fields: Field definitions (return value of L{_PrepareFieldList})
468 self._fields = fields
470 self._op_handler = None
472 def __call__(self, hints, qfilter):
473 """Converts a query filter into a callable function.
475 @type hints: L{_FilterHints} or None
476 @param hints: Callbacks doing analysis on filter
478 @param qfilter: Filter structure
480 @return: Function receiving context and item as parameters, returning
481 boolean as to whether item matches filter
486 (self._HandleLogicOp, getattr(hints, "NoteLogicOp", None)),
488 (self._HandleUnaryOp, getattr(hints, "NoteUnaryOp", None)),
490 (self._HandleBinaryOp, getattr(hints, "NoteBinaryOp", None)),
494 filter_fn = self._Compile(qfilter, 0)
496 self._op_handler = None
500 def _Compile(self, qfilter, level):
501 """Inner function for converting filters.
503 Calls the correct handler functions for the top-level operator. This
504 function is called recursively (e.g. for logic operators).
507 if not (isinstance(qfilter, (list, tuple)) and qfilter):
508 raise errors.ParameterError("Invalid filter on level %s" % level)
511 if level >= self._LEVELS_MAX:
512 raise errors.ParameterError("Only up to %s levels are allowed (filter"
513 " nested too deep)" % self._LEVELS_MAX)
515 # Create copy to be modified
516 operands = qfilter[:]
520 (kind, op_data) = self._OPS[op]
522 raise errors.ParameterError("Unknown operator '%s'" % op)
524 (handler, hints_cb) = self._op_handler[kind]
526 return handler(hints_cb, level, op, op_data, operands)
528 def _LookupField(self, name):
529 """Returns a field definition by name.
533 return self._fields[name]
535 raise errors.ParameterError("Unknown field '%s'" % name)
537 def _HandleLogicOp(self, hints_fn, level, op, op_fn, operands):
538 """Handles logic operators.
540 @type hints_fn: callable
541 @param hints_fn: Callback doing some analysis on the filter
543 @param level: Current depth
546 @type op_fn: callable
547 @param op_fn: Function implementing operator
549 @param operands: List of operands
555 return compat.partial(_WrapLogicOp, op_fn,
556 [self._Compile(op, level + 1) for op in operands])
558 def _HandleUnaryOp(self, hints_fn, level, op, op_fn, operands):
559 """Handles unary operators.
561 @type hints_fn: callable
562 @param hints_fn: Callback doing some analysis on the filter
564 @param level: Current depth
567 @type op_fn: callable
568 @param op_fn: Function implementing operator
570 @param operands: List of operands
575 if len(operands) != 1:
576 raise errors.ParameterError("Unary operator '%s' expects exactly one"
579 if op == qlang.OP_TRUE:
580 (_, datakind, _, retrieval_fn) = self._LookupField(operands[0])
583 hints_fn(op, datakind)
585 op_fn = operator.truth
587 elif op == qlang.OP_NOT:
591 op_fn = operator.not_
592 arg = self._Compile(operands[0], level + 1)
594 raise errors.ProgrammerError("Can't handle operator '%s'" % op)
596 return compat.partial(_WrapUnaryOp, op_fn, arg)
598 def _HandleBinaryOp(self, hints_fn, level, op, op_data, operands):
599 """Handles binary operators.
601 @type hints_fn: callable
602 @param hints_fn: Callback doing some analysis on the filter
604 @param level: Current depth
607 @param op_data: Functions implementing operators
609 @param operands: List of operands
612 # Unused arguments, pylint: disable=W0613
614 (name, value) = operands
615 except (ValueError, TypeError):
616 raise errors.ParameterError("Invalid binary operator, expected exactly"
619 (fdef, datakind, field_flags, retrieval_fn) = self._LookupField(name)
621 assert fdef.kind != QFT_UNKNOWN
623 # TODO: Type conversions?
625 verify_fn = _VERIFY_FN[fdef.kind]
626 if not verify_fn(value):
627 raise errors.ParameterError("Unable to compare field '%s' (type '%s')"
628 " with '%s', expected %s" %
629 (name, fdef.kind, value.__class__.__name__,
633 hints_fn(op, datakind, name, value)
635 for (fn_flags, fn, valprepfn) in op_data:
636 if fn_flags is None or fn_flags & field_flags:
637 # Prepare value if necessary (e.g. compile regular expression)
639 value = valprepfn(value)
641 return compat.partial(_WrapBinaryOp, fn, retrieval_fn, value)
643 raise errors.ProgrammerError("Unable to find operator implementation"
644 " (op '%s', flags %s)" % (op, field_flags))
647 def _CompileFilter(fields, hints, qfilter):
648 """Converts a query filter into a callable function.
650 See L{_FilterCompilerHelper} for details.
655 return _FilterCompilerHelper(fields)(hints, qfilter)
659 def __init__(self, fieldlist, selected, qfilter=None, namefield=None):
660 """Initializes this class.
662 The field definition is a dictionary with the field's name as a key and a
663 tuple containing, in order, the field definition object
664 (L{objects.QueryFieldDefinition}, the data kind to help calling code
665 collect data and a retrieval function. The retrieval function is called
666 with two parameters, in order, the data container and the item in container
667 (see L{Query.Query}).
669 Users of this class can call L{RequestedData} before preparing the data
670 container to determine what data is needed.
672 @type fieldlist: dictionary
673 @param fieldlist: Field definitions
674 @type selected: list of strings
675 @param selected: List of selected fields
678 assert namefield is None or namefield in fieldlist
680 self._fields = _GetQueryFields(fieldlist, selected)
682 self._filter_fn = None
683 self._requested_names = None
684 self._filter_datakinds = frozenset()
686 if qfilter is not None:
687 # Collect requested names if wanted
689 hints = _FilterHints(namefield)
693 # Build filter function
694 self._filter_fn = _CompileFilter(fieldlist, hints, qfilter)
696 self._requested_names = hints.RequestedNames()
697 self._filter_datakinds = hints.ReferencedData()
699 if namefield is None:
702 (_, _, _, self._name_fn) = fieldlist[namefield]
704 def RequestedNames(self):
705 """Returns all names referenced in the filter.
707 If there is no filter or operators are preventing determining the exact
708 names, C{None} is returned.
711 return self._requested_names
713 def RequestedData(self):
714 """Gets requested kinds of data.
719 return (self._filter_datakinds |
720 frozenset(datakind for (_, datakind, _, _) in self._fields
721 if datakind is not None))
724 """Returns the list of fields for this query.
726 Includes unknown fields.
728 @rtype: List of L{objects.QueryFieldDefinition}
731 return GetAllFields(self._fields)
733 def Query(self, ctx, sort_by_name=True):
736 @param ctx: Data container passed to field retrieval functions, must
737 support iteration using C{__iter__}
738 @type sort_by_name: boolean
739 @param sort_by_name: Whether to sort by name or keep the input data's
743 sort = (self._name_fn and sort_by_name)
747 for idx, item in enumerate(ctx):
748 if not (self._filter_fn is None or self._filter_fn(ctx, item)):
751 row = [_ProcessResult(fn(ctx, item)) for (_, _, _, fn) in self._fields]
755 _VerifyResultRow(self._fields, row)
758 (status, name) = _ProcessResult(self._name_fn(ctx, item))
759 assert status == constants.RS_NORMAL
760 # TODO: Are there cases where we wouldn't want to use NiceSort?
761 # Answer: if the name field is non-string...
762 result.append((utils.NiceSortKey(name), idx, row))
769 # TODO: Would "heapq" be more efficient than sorting?
771 # Sorting in-place instead of using "sorted()"
774 assert not result or (len(result[0]) == 3 and len(result[-1]) == 3)
776 return map(operator.itemgetter(2), result)
778 def OldStyleQuery(self, ctx, sort_by_name=True):
779 """Query with "old" query result format.
781 See L{Query.Query} for arguments.
784 unknown = set(fdef.name for (fdef, _, _, _) in self._fields
785 if fdef.kind == QFT_UNKNOWN)
787 raise errors.OpPrereqError("Unknown output fields selected: %s" %
788 (utils.CommaJoin(unknown), ),
791 return [[value for (_, value) in row]
792 for row in self.Query(ctx, sort_by_name=sort_by_name)]
795 def _ProcessResult(value):
796 """Converts result values into externally-visible ones.
799 if value is _FS_UNKNOWN:
800 return (RS_UNKNOWN, None)
801 elif value is _FS_NODATA:
802 return (RS_NODATA, None)
803 elif value is _FS_UNAVAIL:
804 return (RS_UNAVAIL, None)
805 elif value is _FS_OFFLINE:
806 return (RS_OFFLINE, None)
808 return (RS_NORMAL, value)
811 def _VerifyResultRow(fields, row):
812 """Verifies the contents of a query result row.
815 @param fields: Field definitions for result
816 @type row: list of tuples
820 assert len(row) == len(fields)
822 for ((status, value), (fdef, _, _, _)) in zip(row, fields):
823 if status == RS_NORMAL:
824 if not _VERIFY_FN[fdef.kind](value):
825 errs.append("normal field %s fails validation (value is %s)" %
827 elif value is not None:
828 errs.append("abnormal field %s has a non-None value" % fdef.name)
829 assert not errs, ("Failed validation: %s in row %s" %
830 (utils.CommaJoin(errs), row))
833 def _FieldDictKey((fdef, _, flags, fn)):
834 """Generates key for field dictionary.
837 assert fdef.name and fdef.title, "Name and title are required"
838 assert FIELD_NAME_RE.match(fdef.name)
839 assert TITLE_RE.match(fdef.title)
840 assert (DOC_RE.match(fdef.doc) and len(fdef.doc.splitlines()) == 1 and
841 fdef.doc.strip() == fdef.doc), \
842 "Invalid description for field '%s'" % fdef.name
844 assert (flags & ~QFF_ALL) == 0, "Unknown flags for field '%s'" % fdef.name
849 def _PrepareFieldList(fields, aliases):
850 """Prepares field list for use by L{Query}.
852 Converts the list to a dictionary and does some verification.
854 @type fields: list of tuples; (L{objects.QueryFieldDefinition}, data
855 kind, retrieval function)
856 @param fields: List of fields, see L{Query.__init__} for a better
858 @type aliases: list of tuples; (alias, target)
859 @param aliases: list of tuples containing aliases; for each
860 alias/target pair, a duplicate will be created in the field list
862 @return: Field dictionary for L{Query}
866 duplicates = utils.FindDuplicates(fdef.title.lower()
867 for (fdef, _, _, _) in fields)
868 assert not duplicates, "Duplicate title(s) found: %r" % duplicates
870 result = utils.SequenceToDict(fields, key=_FieldDictKey)
872 for alias, target in aliases:
873 assert alias not in result, "Alias %s overrides an existing field" % alias
874 assert target in result, "Missing target %s for alias %s" % (target, alias)
875 (fdef, k, flags, fn) = result[target]
878 result[alias] = (fdef, k, flags, fn)
880 assert len(result) == len(fields) + len(aliases)
881 assert compat.all(name == fdef.name
882 for (name, (fdef, _, _, _)) in result.items())
887 def GetQueryResponse(query, ctx, sort_by_name=True):
888 """Prepares the response for a query.
890 @type query: L{Query}
891 @param ctx: Data container, see L{Query.Query}
892 @type sort_by_name: boolean
893 @param sort_by_name: Whether to sort by name or keep the input data's
897 return objects.QueryResponse(data=query.Query(ctx, sort_by_name=sort_by_name),
898 fields=query.GetFields()).ToDict()
901 def QueryFields(fielddefs, selected):
902 """Returns list of available fields.
904 @type fielddefs: dict
905 @param fielddefs: Field definitions
906 @type selected: list of strings
907 @param selected: List of selected fields
908 @return: List of L{objects.QueryFieldDefinition}
912 # Client requests all fields, sort by name
913 fdefs = utils.NiceSort(GetAllFields(fielddefs.values()),
914 key=operator.attrgetter("name"))
916 # Keep order as requested by client
917 fdefs = Query(fielddefs, selected).GetFields()
919 return objects.QueryFieldsResponse(fields=fdefs).ToDict()
922 def _MakeField(name, title, kind, doc):
923 """Wrapper for creating L{objects.QueryFieldDefinition} instances.
925 @param name: Field name as a regular expression
926 @param title: Human-readable title
927 @param kind: Field type
928 @param doc: Human-readable description
931 return objects.QueryFieldDefinition(name=name, title=title, kind=kind,
935 def _StaticValueInner(value, ctx, _): # pylint: disable=W0613
936 """Returns a static value.
942 def _StaticValue(value):
943 """Prepares a function to return a static value.
946 return compat.partial(_StaticValueInner, value)
949 def _GetNodeRole(node, master_name):
950 """Determine node role.
952 @type node: L{objects.Node}
953 @param node: Node object
954 @type master_name: string
955 @param master_name: Master node name
958 if node.name == master_name:
959 return constants.NR_MASTER
960 elif node.master_candidate:
961 return constants.NR_MCANDIDATE
963 return constants.NR_DRAINED
965 return constants.NR_OFFLINE
967 return constants.NR_REGULAR
970 def _GetItemAttr(attr):
971 """Returns a field function to return an attribute of the item.
973 @param attr: Attribute name
976 getter = operator.attrgetter(attr)
977 return lambda _, item: getter(item)
980 def _GetItemMaybeAttr(attr):
981 """Returns a field function to return a not-None attribute of the item.
983 If the value is None, then C{_FS_UNAVAIL} will be returned instead.
985 @param attr: Attribute name
989 val = getattr(obj, attr)
997 def _GetNDParam(name):
998 """Return a field function to return an ND parameter out of the context.
1001 def _helper(ctx, _):
1002 if ctx.ndparams is None:
1005 return ctx.ndparams.get(name, None)
1009 def _BuildNDFields(is_group):
1010 """Builds all the ndparam fields.
1012 @param is_group: whether this is called at group or node level
1016 field_kind = GQ_CONFIG
1018 field_kind = NQ_GROUP
1019 return [(_MakeField("ndp/%s" % name,
1020 constants.NDS_PARAMETER_TITLES.get(name,
1022 _VTToQFT[kind], "The \"%s\" node parameter" % name),
1023 field_kind, 0, _GetNDParam(name))
1024 for name, kind in constants.NDS_PARAMETER_TYPES.items()]
1027 def _ConvWrapInner(convert, fn, ctx, item):
1028 """Wrapper for converting values.
1030 @param convert: Conversion function receiving value as single parameter
1031 @param fn: Retrieval function
1034 value = fn(ctx, item)
1036 # Is the value an abnormal status?
1037 if compat.any(value is fs for fs in _FS_ALL):
1041 # TODO: Should conversion function also receive context, item or both?
1042 return convert(value)
1045 def _ConvWrap(convert, fn):
1046 """Convenience wrapper for L{_ConvWrapInner}.
1048 @param convert: Conversion function receiving value as single parameter
1049 @param fn: Retrieval function
1052 return compat.partial(_ConvWrapInner, convert, fn)
1055 def _GetItemTimestamp(getter):
1056 """Returns function for getting timestamp of item.
1058 @type getter: callable
1059 @param getter: Function to retrieve timestamp attribute
1063 """Returns a timestamp of item.
1066 timestamp = getter(item)
1067 if timestamp is None:
1068 # Old configs might not have all timestamps
1076 def _GetItemTimestampFields(datatype):
1077 """Returns common timestamp fields.
1079 @param datatype: Field data type for use by L{Query.RequestedData}
1083 (_MakeField("ctime", "CTime", QFT_TIMESTAMP, "Creation timestamp"),
1084 datatype, 0, _GetItemTimestamp(operator.attrgetter("ctime"))),
1085 (_MakeField("mtime", "MTime", QFT_TIMESTAMP, "Modification timestamp"),
1086 datatype, 0, _GetItemTimestamp(operator.attrgetter("mtime"))),
1090 class NodeQueryData:
1091 """Data container for node data queries.
1094 def __init__(self, nodes, live_data, master_name, node_to_primary,
1095 node_to_secondary, groups, oob_support, cluster):
1096 """Initializes this class.
1100 self.live_data = live_data
1101 self.master_name = master_name
1102 self.node_to_primary = node_to_primary
1103 self.node_to_secondary = node_to_secondary
1104 self.groups = groups
1105 self.oob_support = oob_support
1106 self.cluster = cluster
1108 # Used for individual rows
1109 self.curlive_data = None
1110 self.ndparams = None
1113 """Iterate over all nodes.
1115 This function has side-effects and only one instance of the resulting
1116 generator should be used at a time.
1119 for node in self.nodes:
1120 group = self.groups.get(node.group, None)
1122 self.ndparams = None
1124 self.ndparams = self.cluster.FillND(node, group)
1126 self.curlive_data = self.live_data.get(node.name, None)
1128 self.curlive_data = None
1132 #: Fields that are direct attributes of an L{objects.Node} object
1133 _NODE_SIMPLE_FIELDS = {
1134 "drained": ("Drained", QFT_BOOL, 0, "Whether node is drained"),
1135 "master_candidate": ("MasterC", QFT_BOOL, 0,
1136 "Whether node is a master candidate"),
1137 "master_capable": ("MasterCapable", QFT_BOOL, 0,
1138 "Whether node can become a master candidate"),
1139 "name": ("Node", QFT_TEXT, QFF_HOSTNAME, "Node name"),
1140 "offline": ("Offline", QFT_BOOL, 0, "Whether node is marked offline"),
1141 "serial_no": ("SerialNo", QFT_NUMBER, 0, _SERIAL_NO_DOC % "Node"),
1142 "uuid": ("UUID", QFT_TEXT, 0, "Node UUID"),
1143 "vm_capable": ("VMCapable", QFT_BOOL, 0, "Whether node can host instances"),
1147 #: Fields requiring talking to the node
1148 # Note that none of these are available for non-vm_capable nodes
1149 _NODE_LIVE_FIELDS = {
1150 "bootid": ("BootID", QFT_TEXT, "bootid",
1151 "Random UUID renewed for each system reboot, can be used"
1152 " for detecting reboots by tracking changes"),
1153 "cnodes": ("CNodes", QFT_NUMBER, "cpu_nodes",
1154 "Number of NUMA domains on node (if exported by hypervisor)"),
1155 "csockets": ("CSockets", QFT_NUMBER, "cpu_sockets",
1156 "Number of physical CPU sockets (if exported by hypervisor)"),
1157 "ctotal": ("CTotal", QFT_NUMBER, "cpu_total", "Number of logical processors"),
1158 "dfree": ("DFree", QFT_UNIT, "vg_free",
1159 "Available disk space in volume group"),
1160 "dtotal": ("DTotal", QFT_UNIT, "vg_size",
1161 "Total disk space in volume group used for instance disk"
1163 "mfree": ("MFree", QFT_UNIT, "memory_free",
1164 "Memory available for instance allocations"),
1165 "mnode": ("MNode", QFT_UNIT, "memory_dom0",
1166 "Amount of memory used by node (dom0 for Xen)"),
1167 "mtotal": ("MTotal", QFT_UNIT, "memory_total",
1168 "Total amount of memory of physical machine"),
1173 """Build function for calling another function with an node group.
1175 @param cb: The callback to be called with the nodegroup
1179 """Get group data for a node.
1181 @type ctx: L{NodeQueryData}
1182 @type inst: L{objects.Node}
1183 @param inst: Node object
1186 ng = ctx.groups.get(node.group, None)
1188 # Nodes always have a group, or the configuration is corrupt
1191 return cb(ctx, node, ng)
1196 def _GetNodeGroup(ctx, node, ng): # pylint: disable=W0613
1197 """Returns the name of a node's group.
1199 @type ctx: L{NodeQueryData}
1200 @type node: L{objects.Node}
1201 @param node: Node object
1202 @type ng: L{objects.NodeGroup}
1203 @param ng: The node group this node belongs to
1209 def _GetNodePower(ctx, node):
1210 """Returns the node powered state
1212 @type ctx: L{NodeQueryData}
1213 @type node: L{objects.Node}
1214 @param node: Node object
1217 if ctx.oob_support[node.name]:
1223 def _GetNdParams(ctx, node, ng):
1224 """Returns the ndparams for this node.
1226 @type ctx: L{NodeQueryData}
1227 @type node: L{objects.Node}
1228 @param node: Node object
1229 @type ng: L{objects.NodeGroup}
1230 @param ng: The node group this node belongs to
1233 return ctx.cluster.SimpleFillND(ng.FillND(node))
1236 def _GetLiveNodeField(field, kind, ctx, node):
1237 """Gets the value of a "live" field from L{NodeQueryData}.
1239 @param field: Live field name
1240 @param kind: Data kind, one of L{constants.QFT_ALL}
1241 @type ctx: L{NodeQueryData}
1242 @type node: L{objects.Node}
1243 @param node: Node object
1249 if not node.vm_capable:
1252 if not ctx.curlive_data:
1255 return _GetStatsField(field, kind, ctx.curlive_data)
1258 def _GetStatsField(field, kind, data):
1259 """Gets a value from live statistics.
1261 If the value is not found, L{_FS_UNAVAIL} is returned. If the field kind is
1262 numeric a conversion to integer is attempted. If that fails, L{_FS_UNAVAIL}
1265 @param field: Live field name
1266 @param kind: Data kind, one of L{constants.QFT_ALL}
1268 @param data: Statistics
1276 if kind == QFT_TEXT:
1279 assert kind in (QFT_NUMBER, QFT_UNIT)
1281 # Try to convert into number
1284 except (ValueError, TypeError):
1285 logging.exception("Failed to convert node field '%s' (value %r) to int",
1290 def _GetNodeHvState(_, node):
1291 """Converts node's hypervisor state for query result.
1294 hv_state = node.hv_state
1296 if hv_state is None:
1299 return dict((name, value.ToDict()) for (name, value) in hv_state.items())
1302 def _GetNodeDiskState(_, node):
1303 """Converts node's disk state for query result.
1306 disk_state = node.disk_state
1308 if disk_state is None:
1311 return dict((disk_kind, dict((name, value.ToDict())
1312 for (name, value) in kind_state.items()))
1313 for (disk_kind, kind_state) in disk_state.items())
1316 def _BuildNodeFields():
1317 """Builds list of fields for node queries.
1321 (_MakeField("pip", "PrimaryIP", QFT_TEXT, "Primary IP address"),
1322 NQ_CONFIG, 0, _GetItemAttr("primary_ip")),
1323 (_MakeField("sip", "SecondaryIP", QFT_TEXT, "Secondary IP address"),
1324 NQ_CONFIG, 0, _GetItemAttr("secondary_ip")),
1325 (_MakeField("tags", "Tags", QFT_OTHER, "Tags"), NQ_CONFIG, 0,
1326 lambda ctx, node: list(node.GetTags())),
1327 (_MakeField("master", "IsMaster", QFT_BOOL, "Whether node is master"),
1328 NQ_CONFIG, 0, lambda ctx, node: node.name == ctx.master_name),
1329 (_MakeField("group", "Group", QFT_TEXT, "Node group"), NQ_GROUP, 0,
1330 _GetGroup(_GetNodeGroup)),
1331 (_MakeField("group.uuid", "GroupUUID", QFT_TEXT, "UUID of node group"),
1332 NQ_CONFIG, 0, _GetItemAttr("group")),
1333 (_MakeField("powered", "Powered", QFT_BOOL,
1334 "Whether node is thought to be powered on"),
1335 NQ_OOB, 0, _GetNodePower),
1336 (_MakeField("ndparams", "NodeParameters", QFT_OTHER,
1337 "Merged node parameters"),
1338 NQ_GROUP, 0, _GetGroup(_GetNdParams)),
1339 (_MakeField("custom_ndparams", "CustomNodeParameters", QFT_OTHER,
1340 "Custom node parameters"),
1341 NQ_GROUP, 0, _GetItemAttr("ndparams")),
1342 (_MakeField("hv_state", "HypervisorState", QFT_OTHER, "Hypervisor state"),
1343 NQ_CONFIG, 0, _GetNodeHvState),
1344 (_MakeField("disk_state", "DiskState", QFT_OTHER, "Disk state"),
1345 NQ_CONFIG, 0, _GetNodeDiskState),
1348 fields.extend(_BuildNDFields(False))
1351 role_values = (constants.NR_MASTER, constants.NR_MCANDIDATE,
1352 constants.NR_REGULAR, constants.NR_DRAINED,
1353 constants.NR_OFFLINE)
1354 role_doc = ("Node role; \"%s\" for master, \"%s\" for master candidate,"
1355 " \"%s\" for regular, \"%s\" for drained, \"%s\" for offline" %
1357 fields.append((_MakeField("role", "Role", QFT_TEXT, role_doc), NQ_CONFIG, 0,
1358 lambda ctx, node: _GetNodeRole(node, ctx.master_name)))
1359 assert set(role_values) == constants.NR_ALL
1361 def _GetLength(getter):
1362 return lambda ctx, node: len(getter(ctx)[node.name])
1364 def _GetList(getter):
1365 return lambda ctx, node: utils.NiceSort(list(getter(ctx)[node.name]))
1367 # Add fields operating on instance lists
1368 for prefix, titleprefix, docword, getter in \
1369 [("p", "Pri", "primary", operator.attrgetter("node_to_primary")),
1370 ("s", "Sec", "secondary", operator.attrgetter("node_to_secondary"))]:
1371 # TODO: Allow filterting by hostname in list
1373 (_MakeField("%sinst_cnt" % prefix, "%sinst" % prefix.upper(), QFT_NUMBER,
1374 "Number of instances with this node as %s" % docword),
1375 NQ_INST, 0, _GetLength(getter)),
1376 (_MakeField("%sinst_list" % prefix, "%sInstances" % titleprefix,
1378 "List of instances with this node as %s" % docword),
1379 NQ_INST, 0, _GetList(getter)),
1384 (_MakeField(name, title, kind, doc), NQ_CONFIG, flags, _GetItemAttr(name))
1385 for (name, (title, kind, flags, doc)) in _NODE_SIMPLE_FIELDS.items()])
1387 # Add fields requiring live data
1389 (_MakeField(name, title, kind, doc), NQ_LIVE, 0,
1390 compat.partial(_GetLiveNodeField, nfield, kind))
1391 for (name, (title, kind, nfield, doc)) in _NODE_LIVE_FIELDS.items()])
1394 fields.extend(_GetItemTimestampFields(NQ_CONFIG))
1396 return _PrepareFieldList(fields, [])
1399 class InstanceQueryData:
1400 """Data container for instance data queries.
1403 def __init__(self, instances, cluster, disk_usage, offline_nodes, bad_nodes,
1404 live_data, wrongnode_inst, console, nodes, groups, networks):
1405 """Initializes this class.
1407 @param instances: List of instance objects
1408 @param cluster: Cluster object
1409 @type disk_usage: dict; instance name as key
1410 @param disk_usage: Per-instance disk usage
1411 @type offline_nodes: list of strings
1412 @param offline_nodes: List of offline nodes
1413 @type bad_nodes: list of strings
1414 @param bad_nodes: List of faulty nodes
1415 @type live_data: dict; instance name as key
1416 @param live_data: Per-instance live data
1417 @type wrongnode_inst: set
1418 @param wrongnode_inst: Set of instances running on wrong node(s)
1419 @type console: dict; instance name as key
1420 @param console: Per-instance console information
1421 @type nodes: dict; node name as key
1422 @param nodes: Node objects
1423 @type networks: dict; net_uuid as key
1424 @param networks: Network objects
1427 assert len(set(bad_nodes) & set(offline_nodes)) == len(offline_nodes), \
1428 "Offline nodes not included in bad nodes"
1429 assert not (set(live_data.keys()) & set(bad_nodes)), \
1430 "Found live data for bad or offline nodes"
1432 self.instances = instances
1433 self.cluster = cluster
1434 self.disk_usage = disk_usage
1435 self.offline_nodes = offline_nodes
1436 self.bad_nodes = bad_nodes
1437 self.live_data = live_data
1438 self.wrongnode_inst = wrongnode_inst
1439 self.console = console
1441 self.groups = groups
1442 self.networks = networks
1444 # Used for individual rows
1445 self.inst_hvparams = None
1446 self.inst_beparams = None
1447 self.inst_osparams = None
1448 self.inst_nicparams = None
1451 """Iterate over all instances.
1453 This function has side-effects and only one instance of the resulting
1454 generator should be used at a time.
1457 for inst in self.instances:
1458 self.inst_hvparams = self.cluster.FillHV(inst, skip_globals=True)
1459 self.inst_beparams = self.cluster.FillBE(inst)
1460 self.inst_osparams = self.cluster.SimpleFillOS(inst.os, inst.osparams)
1461 self.inst_nicparams = [self.cluster.SimpleFillNIC(nic.nicparams)
1462 for nic in inst.nics]
1467 def _GetInstOperState(ctx, inst):
1468 """Get instance's operational status.
1470 @type ctx: L{InstanceQueryData}
1471 @type inst: L{objects.Instance}
1472 @param inst: Instance object
1475 # Can't use RS_OFFLINE here as it would describe the instance to
1476 # be offline when we actually don't know due to missing data
1477 if inst.primary_node in ctx.bad_nodes:
1480 return bool(ctx.live_data.get(inst.name))
1483 def _GetInstLiveData(name):
1484 """Build function for retrieving live data.
1487 @param name: Live data field name
1491 """Get live data for an instance.
1493 @type ctx: L{InstanceQueryData}
1494 @type inst: L{objects.Instance}
1495 @param inst: Instance object
1498 if (inst.primary_node in ctx.bad_nodes or
1499 inst.primary_node in ctx.offline_nodes):
1500 # Can't use RS_OFFLINE here as it would describe the instance to be
1501 # offline when we actually don't know due to missing data
1504 if inst.name in ctx.live_data:
1505 data = ctx.live_data[inst.name]
1514 def _GetInstStatus(ctx, inst):
1515 """Get instance status.
1517 @type ctx: L{InstanceQueryData}
1518 @type inst: L{objects.Instance}
1519 @param inst: Instance object
1522 if inst.primary_node in ctx.offline_nodes:
1523 return constants.INSTST_NODEOFFLINE
1525 if inst.primary_node in ctx.bad_nodes:
1526 return constants.INSTST_NODEDOWN
1528 if bool(ctx.live_data.get(inst.name)):
1529 if inst.name in ctx.wrongnode_inst:
1530 return constants.INSTST_WRONGNODE
1531 elif inst.admin_state == constants.ADMINST_UP:
1532 return constants.INSTST_RUNNING
1534 return constants.INSTST_ERRORUP
1536 if inst.admin_state == constants.ADMINST_UP:
1537 return constants.INSTST_ERRORDOWN
1538 elif inst.admin_state == constants.ADMINST_DOWN:
1539 return constants.INSTST_ADMINDOWN
1541 return constants.INSTST_ADMINOFFLINE
1544 def _GetInstDiskSize(index):
1545 """Build function for retrieving disk size.
1548 @param index: Disk index
1552 """Get size of a disk.
1554 @type inst: L{objects.Instance}
1555 @param inst: Instance object
1559 return inst.disks[index].size
1566 def _GetInstNic(index, cb):
1567 """Build function for calling another function with an instance NIC.
1570 @param index: NIC index
1576 """Call helper function with instance NIC.
1578 @type ctx: L{InstanceQueryData}
1579 @type inst: L{objects.Instance}
1580 @param inst: Instance object
1584 nic = inst.nics[index]
1588 return cb(ctx, index, nic)
1593 def _GetInstNicNetworkName(ctx, _, nic): # pylint: disable=W0613
1594 """Get a NIC's Network.
1596 @type ctx: L{InstanceQueryData}
1597 @type nic: L{objects.NIC}
1598 @param nic: NIC object
1601 if nic.network is None:
1604 return ctx.networks[nic.network].name
1607 def _GetInstNicNetwork(ctx, _, nic): # pylint: disable=W0613
1608 """Get a NIC's Network.
1610 @type ctx: L{InstanceQueryData}
1611 @type nic: L{objects.NIC}
1612 @param nic: NIC object
1615 if nic.network is None:
1621 def _GetInstNicIp(ctx, _, nic): # pylint: disable=W0613
1622 """Get a NIC's IP address.
1624 @type ctx: L{InstanceQueryData}
1625 @type nic: L{objects.NIC}
1626 @param nic: NIC object
1635 def _GetInstNicBridge(ctx, index, _):
1636 """Get a NIC's bridge.
1638 @type ctx: L{InstanceQueryData}
1640 @param index: NIC index
1643 assert len(ctx.inst_nicparams) >= index
1645 nicparams = ctx.inst_nicparams[index]
1647 if nicparams[constants.NIC_MODE] == constants.NIC_MODE_BRIDGED:
1648 return nicparams[constants.NIC_LINK]
1653 def _GetInstAllNicNetworkNames(ctx, inst):
1654 """Get all network names for an instance.
1656 @type ctx: L{InstanceQueryData}
1657 @type inst: L{objects.Instance}
1658 @param inst: Instance object
1663 for nic in inst.nics:
1666 name = ctx.networks[nic.network].name
1669 assert len(result) == len(inst.nics)
1674 def _GetInstAllNicBridges(ctx, inst):
1675 """Get all network bridges for an instance.
1677 @type ctx: L{InstanceQueryData}
1678 @type inst: L{objects.Instance}
1679 @param inst: Instance object
1682 assert len(ctx.inst_nicparams) == len(inst.nics)
1686 for nicp in ctx.inst_nicparams:
1687 if nicp[constants.NIC_MODE] == constants.NIC_MODE_BRIDGED:
1688 result.append(nicp[constants.NIC_LINK])
1692 assert len(result) == len(inst.nics)
1697 def _GetInstNicParam(name):
1698 """Build function for retrieving a NIC parameter.
1701 @param name: Parameter name
1704 def fn(ctx, index, _):
1705 """Get a NIC's bridge.
1707 @type ctx: L{InstanceQueryData}
1708 @type inst: L{objects.Instance}
1709 @param inst: Instance object
1710 @type nic: L{objects.NIC}
1711 @param nic: NIC object
1714 assert len(ctx.inst_nicparams) >= index
1715 return ctx.inst_nicparams[index][name]
1720 def _GetInstanceNetworkFields():
1721 """Get instance fields involving network interfaces.
1723 @return: Tuple containing list of field definitions used as input for
1724 L{_PrepareFieldList} and a list of aliases
1727 nic_mac_fn = lambda ctx, _, nic: nic.mac
1728 nic_mode_fn = _GetInstNicParam(constants.NIC_MODE)
1729 nic_link_fn = _GetInstNicParam(constants.NIC_LINK)
1733 (_MakeField("nic.count", "NICs", QFT_NUMBER,
1734 "Number of network interfaces"),
1735 IQ_CONFIG, 0, lambda ctx, inst: len(inst.nics)),
1736 (_MakeField("nic.macs", "NIC_MACs", QFT_OTHER,
1737 "List containing each network interface's MAC address"),
1738 IQ_CONFIG, 0, lambda ctx, inst: [nic.mac for nic in inst.nics]),
1739 (_MakeField("nic.ips", "NIC_IPs", QFT_OTHER,
1740 "List containing each network interface's IP address"),
1741 IQ_CONFIG, 0, lambda ctx, inst: [nic.ip for nic in inst.nics]),
1742 (_MakeField("nic.modes", "NIC_modes", QFT_OTHER,
1743 "List containing each network interface's mode"), IQ_CONFIG, 0,
1744 lambda ctx, inst: [nicp[constants.NIC_MODE]
1745 for nicp in ctx.inst_nicparams]),
1746 (_MakeField("nic.links", "NIC_links", QFT_OTHER,
1747 "List containing each network interface's link"), IQ_CONFIG, 0,
1748 lambda ctx, inst: [nicp[constants.NIC_LINK]
1749 for nicp in ctx.inst_nicparams]),
1750 (_MakeField("nic.bridges", "NIC_bridges", QFT_OTHER,
1751 "List containing each network interface's bridge"),
1752 IQ_CONFIG, 0, _GetInstAllNicBridges),
1753 (_MakeField("nic.networks", "NIC_networks", QFT_OTHER,
1754 "List containing each interface's network"), IQ_CONFIG, 0,
1755 lambda ctx, inst: [nic.network for nic in inst.nics]),
1756 (_MakeField("nic.networks.names", "NIC_networks_names", QFT_OTHER,
1757 "List containing each interface's network"),
1758 IQ_NETWORKS, 0, _GetInstAllNicNetworkNames)
1762 for i in range(constants.MAX_NICS):
1763 numtext = utils.FormatOrdinal(i + 1)
1765 (_MakeField("nic.ip/%s" % i, "NicIP/%s" % i, QFT_TEXT,
1766 "IP address of %s network interface" % numtext),
1767 IQ_CONFIG, 0, _GetInstNic(i, _GetInstNicIp)),
1768 (_MakeField("nic.mac/%s" % i, "NicMAC/%s" % i, QFT_TEXT,
1769 "MAC address of %s network interface" % numtext),
1770 IQ_CONFIG, 0, _GetInstNic(i, nic_mac_fn)),
1771 (_MakeField("nic.mode/%s" % i, "NicMode/%s" % i, QFT_TEXT,
1772 "Mode of %s network interface" % numtext),
1773 IQ_CONFIG, 0, _GetInstNic(i, nic_mode_fn)),
1774 (_MakeField("nic.link/%s" % i, "NicLink/%s" % i, QFT_TEXT,
1775 "Link of %s network interface" % numtext),
1776 IQ_CONFIG, 0, _GetInstNic(i, nic_link_fn)),
1777 (_MakeField("nic.bridge/%s" % i, "NicBridge/%s" % i, QFT_TEXT,
1778 "Bridge of %s network interface" % numtext),
1779 IQ_CONFIG, 0, _GetInstNic(i, _GetInstNicBridge)),
1780 (_MakeField("nic.network/%s" % i, "NicNetwork/%s" % i, QFT_TEXT,
1781 "Network of %s network interface" % numtext),
1782 IQ_CONFIG, 0, _GetInstNic(i, _GetInstNicNetwork)),
1783 (_MakeField("nic.network.name/%s" % i, "NicNetworkName/%s" % i, QFT_TEXT,
1784 "Network name of %s network interface" % numtext),
1785 IQ_NETWORKS, 0, _GetInstNic(i, _GetInstNicNetworkName)),
1789 # Legacy fields for first NIC
1791 ("mac", "nic.mac/0"),
1792 ("bridge", "nic.bridge/0"),
1793 ("nic_mode", "nic.mode/0"),
1794 ("nic_link", "nic.link/0"),
1795 ("nic_network", "nic.network/0"),
1798 return (fields, aliases)
1801 def _GetInstDiskUsage(ctx, inst):
1802 """Get disk usage for an instance.
1804 @type ctx: L{InstanceQueryData}
1805 @type inst: L{objects.Instance}
1806 @param inst: Instance object
1809 usage = ctx.disk_usage[inst.name]
1817 def _GetInstanceConsole(ctx, inst):
1818 """Get console information for instance.
1820 @type ctx: L{InstanceQueryData}
1821 @type inst: L{objects.Instance}
1822 @param inst: Instance object
1825 consinfo = ctx.console[inst.name]
1827 if consinfo is None:
1833 def _GetInstanceDiskFields():
1834 """Get instance fields involving disks.
1836 @return: List of field definitions used as input for L{_PrepareFieldList}
1840 (_MakeField("disk_usage", "DiskUsage", QFT_UNIT,
1841 "Total disk space used by instance on each of its nodes;"
1842 " this is not the disk size visible to the instance, but"
1843 " the usage on the node"),
1844 IQ_DISKUSAGE, 0, _GetInstDiskUsage),
1845 (_MakeField("disk.count", "Disks", QFT_NUMBER, "Number of disks"),
1846 IQ_CONFIG, 0, lambda ctx, inst: len(inst.disks)),
1847 (_MakeField("disk.sizes", "Disk_sizes", QFT_OTHER, "List of disk sizes"),
1848 IQ_CONFIG, 0, lambda ctx, inst: [disk.size for disk in inst.disks]),
1853 (_MakeField("disk.size/%s" % i, "Disk/%s" % i, QFT_UNIT,
1854 "Disk size of %s disk" % utils.FormatOrdinal(i + 1)),
1855 IQ_CONFIG, 0, _GetInstDiskSize(i))
1856 for i in range(constants.MAX_DISKS)])
1861 def _GetInstanceParameterFields():
1862 """Get instance fields involving parameters.
1864 @return: List of field definitions used as input for L{_PrepareFieldList}
1869 (_MakeField("hvparams", "HypervisorParameters", QFT_OTHER,
1870 "Hypervisor parameters (merged)"),
1871 IQ_CONFIG, 0, lambda ctx, _: ctx.inst_hvparams),
1872 (_MakeField("beparams", "BackendParameters", QFT_OTHER,
1873 "Backend parameters (merged)"),
1874 IQ_CONFIG, 0, lambda ctx, _: ctx.inst_beparams),
1875 (_MakeField("osparams", "OpSysParameters", QFT_OTHER,
1876 "Operating system parameters (merged)"),
1877 IQ_CONFIG, 0, lambda ctx, _: ctx.inst_osparams),
1879 # Unfilled parameters
1880 (_MakeField("custom_hvparams", "CustomHypervisorParameters", QFT_OTHER,
1881 "Custom hypervisor parameters"),
1882 IQ_CONFIG, 0, _GetItemAttr("hvparams")),
1883 (_MakeField("custom_beparams", "CustomBackendParameters", QFT_OTHER,
1884 "Custom backend parameters",),
1885 IQ_CONFIG, 0, _GetItemAttr("beparams")),
1886 (_MakeField("custom_osparams", "CustomOpSysParameters", QFT_OTHER,
1887 "Custom operating system parameters",),
1888 IQ_CONFIG, 0, _GetItemAttr("osparams")),
1889 (_MakeField("custom_nicparams", "CustomNicParameters", QFT_OTHER,
1890 "Custom network interface parameters"),
1891 IQ_CONFIG, 0, lambda ctx, inst: [nic.nicparams for nic in inst.nics]),
1895 def _GetInstHvParam(name):
1896 return lambda ctx, _: ctx.inst_hvparams.get(name, _FS_UNAVAIL)
1899 (_MakeField("hv/%s" % name,
1900 constants.HVS_PARAMETER_TITLES.get(name, "hv/%s" % name),
1901 _VTToQFT[kind], "The \"%s\" hypervisor parameter" % name),
1902 IQ_CONFIG, 0, _GetInstHvParam(name))
1903 for name, kind in constants.HVS_PARAMETER_TYPES.items()
1904 if name not in constants.HVC_GLOBALS])
1907 def _GetInstBeParam(name):
1908 return lambda ctx, _: ctx.inst_beparams.get(name, None)
1911 (_MakeField("be/%s" % name,
1912 constants.BES_PARAMETER_TITLES.get(name, "be/%s" % name),
1913 _VTToQFT[kind], "The \"%s\" backend parameter" % name),
1914 IQ_CONFIG, 0, _GetInstBeParam(name))
1915 for name, kind in constants.BES_PARAMETER_TYPES.items()])
1920 _INST_SIMPLE_FIELDS = {
1921 "disk_template": ("Disk_template", QFT_TEXT, 0, "Instance disk template"),
1922 "hypervisor": ("Hypervisor", QFT_TEXT, 0, "Hypervisor name"),
1923 "name": ("Instance", QFT_TEXT, QFF_HOSTNAME, "Instance name"),
1924 # Depending on the hypervisor, the port can be None
1925 "network_port": ("Network_port", QFT_OTHER, 0,
1926 "Instance network port if available (e.g. for VNC console)"),
1927 "os": ("OS", QFT_TEXT, 0, "Operating system"),
1928 "serial_no": ("SerialNo", QFT_NUMBER, 0, _SERIAL_NO_DOC % "Instance"),
1929 "uuid": ("UUID", QFT_TEXT, 0, "Instance UUID"),
1933 def _GetInstNodeGroup(ctx, default, node_name):
1934 """Gets group UUID of an instance node.
1936 @type ctx: L{InstanceQueryData}
1937 @param default: Default value
1938 @type node_name: string
1939 @param node_name: Node name
1943 node = ctx.nodes[node_name]
1950 def _GetInstNodeGroupName(ctx, default, node_name):
1951 """Gets group name of an instance node.
1953 @type ctx: L{InstanceQueryData}
1954 @param default: Default value
1955 @type node_name: string
1956 @param node_name: Node name
1960 node = ctx.nodes[node_name]
1965 group = ctx.groups[node.group]
1972 def _BuildInstanceFields():
1973 """Builds list of fields for instance queries.
1977 (_MakeField("pnode", "Primary_node", QFT_TEXT, "Primary node"),
1978 IQ_CONFIG, QFF_HOSTNAME, _GetItemAttr("primary_node")),
1979 (_MakeField("pnode.group", "PrimaryNodeGroup", QFT_TEXT,
1980 "Primary node's group"),
1982 lambda ctx, inst: _GetInstNodeGroupName(ctx, _FS_UNAVAIL,
1983 inst.primary_node)),
1984 (_MakeField("pnode.group.uuid", "PrimaryNodeGroupUUID", QFT_TEXT,
1985 "Primary node's group UUID"),
1987 lambda ctx, inst: _GetInstNodeGroup(ctx, _FS_UNAVAIL, inst.primary_node)),
1988 # TODO: Allow filtering by secondary node as hostname
1989 (_MakeField("snodes", "Secondary_Nodes", QFT_OTHER,
1990 "Secondary nodes; usually this will just be one node"),
1991 IQ_CONFIG, 0, lambda ctx, inst: list(inst.secondary_nodes)),
1992 (_MakeField("snodes.group", "SecondaryNodesGroups", QFT_OTHER,
1993 "Node groups of secondary nodes"),
1995 lambda ctx, inst: map(compat.partial(_GetInstNodeGroupName, ctx, None),
1996 inst.secondary_nodes)),
1997 (_MakeField("snodes.group.uuid", "SecondaryNodesGroupsUUID", QFT_OTHER,
1998 "Node group UUIDs of secondary nodes"),
2000 lambda ctx, inst: map(compat.partial(_GetInstNodeGroup, ctx, None),
2001 inst.secondary_nodes)),
2002 (_MakeField("admin_state", "InstanceState", QFT_TEXT,
2003 "Desired state of instance"),
2004 IQ_CONFIG, 0, _GetItemAttr("admin_state")),
2005 (_MakeField("admin_up", "Autostart", QFT_BOOL,
2006 "Desired state of instance"),
2007 IQ_CONFIG, 0, lambda ctx, inst: inst.admin_state == constants.ADMINST_UP),
2008 (_MakeField("tags", "Tags", QFT_OTHER, "Tags"), IQ_CONFIG, 0,
2009 lambda ctx, inst: list(inst.GetTags())),
2010 (_MakeField("console", "Console", QFT_OTHER,
2011 "Instance console information"), IQ_CONSOLE, 0,
2012 _GetInstanceConsole),
2017 (_MakeField(name, title, kind, doc), IQ_CONFIG, flags, _GetItemAttr(name))
2018 for (name, (title, kind, flags, doc)) in _INST_SIMPLE_FIELDS.items()])
2020 # Fields requiring talking to the node
2022 (_MakeField("oper_state", "Running", QFT_BOOL, "Actual state of instance"),
2023 IQ_LIVE, 0, _GetInstOperState),
2024 (_MakeField("oper_ram", "Memory", QFT_UNIT,
2025 "Actual memory usage as seen by hypervisor"),
2026 IQ_LIVE, 0, _GetInstLiveData("memory")),
2027 (_MakeField("oper_vcpus", "VCPUs", QFT_NUMBER,
2028 "Actual number of VCPUs as seen by hypervisor"),
2029 IQ_LIVE, 0, _GetInstLiveData("vcpus")),
2033 status_values = (constants.INSTST_RUNNING, constants.INSTST_ADMINDOWN,
2034 constants.INSTST_WRONGNODE, constants.INSTST_ERRORUP,
2035 constants.INSTST_ERRORDOWN, constants.INSTST_NODEDOWN,
2036 constants.INSTST_NODEOFFLINE, constants.INSTST_ADMINOFFLINE)
2037 status_doc = ("Instance status; \"%s\" if instance is set to be running"
2038 " and actually is, \"%s\" if instance is stopped and"
2039 " is not running, \"%s\" if instance running, but not on its"
2040 " designated primary node, \"%s\" if instance should be"
2041 " stopped, but is actually running, \"%s\" if instance should"
2042 " run, but doesn't, \"%s\" if instance's primary node is down,"
2043 " \"%s\" if instance's primary node is marked offline,"
2044 " \"%s\" if instance is offline and does not use dynamic"
2045 " resources" % status_values)
2046 fields.append((_MakeField("status", "Status", QFT_TEXT, status_doc),
2047 IQ_LIVE, 0, _GetInstStatus))
2048 assert set(status_values) == constants.INSTST_ALL, \
2049 "Status documentation mismatch"
2051 (network_fields, network_aliases) = _GetInstanceNetworkFields()
2053 fields.extend(network_fields)
2054 fields.extend(_GetInstanceParameterFields())
2055 fields.extend(_GetInstanceDiskFields())
2056 fields.extend(_GetItemTimestampFields(IQ_CONFIG))
2059 ("vcpus", "be/vcpus"),
2060 ("be/memory", "be/maxmem"),
2061 ("sda_size", "disk.size/0"),
2062 ("sdb_size", "disk.size/1"),
2065 return _PrepareFieldList(fields, aliases)
2068 class LockQueryData:
2069 """Data container for lock data queries.
2072 def __init__(self, lockdata):
2073 """Initializes this class.
2076 self.lockdata = lockdata
2079 """Iterate over all locks.
2082 return iter(self.lockdata)
2085 def _GetLockOwners(_, data):
2086 """Returns a sorted list of a lock's current owners.
2089 (_, _, owners, _) = data
2092 owners = utils.NiceSort(owners)
2097 def _GetLockPending(_, data):
2098 """Returns a sorted list of a lock's pending acquires.
2101 (_, _, _, pending) = data
2104 pending = [(mode, utils.NiceSort(names))
2105 for (mode, names) in pending]
2110 def _BuildLockFields():
2111 """Builds list of fields for lock queries.
2114 return _PrepareFieldList([
2115 # TODO: Lock names are not always hostnames. Should QFF_HOSTNAME be used?
2116 (_MakeField("name", "Name", QFT_TEXT, "Lock name"), None, 0,
2117 lambda ctx, (name, mode, owners, pending): name),
2118 (_MakeField("mode", "Mode", QFT_OTHER,
2119 "Mode in which the lock is currently acquired"
2120 " (exclusive or shared)"),
2121 LQ_MODE, 0, lambda ctx, (name, mode, owners, pending): mode),
2122 (_MakeField("owner", "Owner", QFT_OTHER, "Current lock owner(s)"),
2123 LQ_OWNER, 0, _GetLockOwners),
2124 (_MakeField("pending", "Pending", QFT_OTHER,
2125 "Threads waiting for the lock"),
2126 LQ_PENDING, 0, _GetLockPending),
2130 class GroupQueryData:
2131 """Data container for node group data queries.
2134 def __init__(self, cluster, groups, group_to_nodes, group_to_instances,
2136 """Initializes this class.
2138 @param cluster: Cluster object
2139 @param groups: List of node group objects
2140 @type group_to_nodes: dict; group UUID as key
2141 @param group_to_nodes: Per-group list of nodes
2142 @type group_to_instances: dict; group UUID as key
2143 @param group_to_instances: Per-group list of (primary) instances
2144 @type want_diskparams: bool
2145 @param want_diskparams: Whether diskparamters should be calculated
2148 self.groups = groups
2149 self.group_to_nodes = group_to_nodes
2150 self.group_to_instances = group_to_instances
2151 self.cluster = cluster
2152 self.want_diskparams = want_diskparams
2154 # Used for individual rows
2155 self.group_ipolicy = None
2156 self.ndparams = None
2157 self.group_dp = None
2160 """Iterate over all node groups.
2162 This function has side-effects and only one instance of the resulting
2163 generator should be used at a time.
2166 for group in self.groups:
2167 self.group_ipolicy = self.cluster.SimpleFillIPolicy(group.ipolicy)
2168 self.ndparams = self.cluster.SimpleFillND(group.ndparams)
2169 if self.want_diskparams:
2170 self.group_dp = self.cluster.SimpleFillDP(group.diskparams)
2172 self.group_dp = None
2176 _GROUP_SIMPLE_FIELDS = {
2177 "alloc_policy": ("AllocPolicy", QFT_TEXT, "Allocation policy for group"),
2178 "name": ("Group", QFT_TEXT, "Group name"),
2179 "serial_no": ("SerialNo", QFT_NUMBER, _SERIAL_NO_DOC % "Group"),
2180 "uuid": ("UUID", QFT_TEXT, "Group UUID"),
2184 def _BuildGroupFields():
2185 """Builds list of fields for node group queries.
2189 fields = [(_MakeField(name, title, kind, doc), GQ_CONFIG, 0,
2191 for (name, (title, kind, doc)) in _GROUP_SIMPLE_FIELDS.items()]
2193 def _GetLength(getter):
2194 return lambda ctx, group: len(getter(ctx)[group.uuid])
2196 def _GetSortedList(getter):
2197 return lambda ctx, group: utils.NiceSort(getter(ctx)[group.uuid])
2199 group_to_nodes = operator.attrgetter("group_to_nodes")
2200 group_to_instances = operator.attrgetter("group_to_instances")
2202 # Add fields for nodes
2204 (_MakeField("node_cnt", "Nodes", QFT_NUMBER, "Number of nodes"),
2205 GQ_NODE, 0, _GetLength(group_to_nodes)),
2206 (_MakeField("node_list", "NodeList", QFT_OTHER, "List of nodes"),
2207 GQ_NODE, 0, _GetSortedList(group_to_nodes)),
2210 # Add fields for instances
2212 (_MakeField("pinst_cnt", "Instances", QFT_NUMBER,
2213 "Number of primary instances"),
2214 GQ_INST, 0, _GetLength(group_to_instances)),
2215 (_MakeField("pinst_list", "InstanceList", QFT_OTHER,
2216 "List of primary instances"),
2217 GQ_INST, 0, _GetSortedList(group_to_instances)),
2222 (_MakeField("tags", "Tags", QFT_OTHER, "Tags"), GQ_CONFIG, 0,
2223 lambda ctx, group: list(group.GetTags())),
2224 (_MakeField("ipolicy", "InstancePolicy", QFT_OTHER,
2225 "Instance policy limitations (merged)"),
2226 GQ_CONFIG, 0, lambda ctx, _: ctx.group_ipolicy),
2227 (_MakeField("custom_ipolicy", "CustomInstancePolicy", QFT_OTHER,
2228 "Custom instance policy limitations"),
2229 GQ_CONFIG, 0, _GetItemAttr("ipolicy")),
2230 (_MakeField("custom_ndparams", "CustomNDParams", QFT_OTHER,
2231 "Custom node parameters"),
2232 GQ_CONFIG, 0, _GetItemAttr("ndparams")),
2233 (_MakeField("ndparams", "NDParams", QFT_OTHER,
2235 GQ_CONFIG, 0, lambda ctx, _: ctx.ndparams),
2236 (_MakeField("diskparams", "DiskParameters", QFT_OTHER,
2237 "Disk parameters (merged)"),
2238 GQ_DISKPARAMS, 0, lambda ctx, _: ctx.group_dp),
2239 (_MakeField("custom_diskparams", "CustomDiskParameters", QFT_OTHER,
2240 "Custom disk parameters"),
2241 GQ_CONFIG, 0, _GetItemAttr("diskparams")),
2245 fields.extend(_BuildNDFields(True))
2247 fields.extend(_GetItemTimestampFields(GQ_CONFIG))
2249 return _PrepareFieldList(fields, [])
2252 class OsInfo(objects.ConfigObject):
2265 def _BuildOsFields():
2266 """Builds list of fields for operating system queries.
2270 (_MakeField("name", "Name", QFT_TEXT, "Operating system name"),
2271 None, 0, _GetItemAttr("name")),
2272 (_MakeField("valid", "Valid", QFT_BOOL,
2273 "Whether operating system definition is valid"),
2274 None, 0, _GetItemAttr("valid")),
2275 (_MakeField("hidden", "Hidden", QFT_BOOL,
2276 "Whether operating system is hidden"),
2277 None, 0, _GetItemAttr("hidden")),
2278 (_MakeField("blacklisted", "Blacklisted", QFT_BOOL,
2279 "Whether operating system is blacklisted"),
2280 None, 0, _GetItemAttr("blacklisted")),
2281 (_MakeField("variants", "Variants", QFT_OTHER,
2282 "Operating system variants"),
2283 None, 0, _ConvWrap(utils.NiceSort, _GetItemAttr("variants"))),
2284 (_MakeField("api_versions", "ApiVersions", QFT_OTHER,
2285 "Operating system API versions"),
2286 None, 0, _ConvWrap(sorted, _GetItemAttr("api_versions"))),
2287 (_MakeField("parameters", "Parameters", QFT_OTHER,
2288 "Operating system parameters"),
2289 None, 0, _ConvWrap(compat.partial(utils.NiceSort, key=compat.fst),
2290 _GetItemAttr("parameters"))),
2291 (_MakeField("node_status", "NodeStatus", QFT_OTHER,
2292 "Status from node"),
2293 None, 0, _GetItemAttr("node_status")),
2296 return _PrepareFieldList(fields, [])
2299 class ExtStorageInfo(objects.ConfigObject):
2308 def _BuildExtStorageFields():
2309 """Builds list of fields for extstorage provider queries.
2313 (_MakeField("name", "Name", QFT_TEXT, "ExtStorage provider name"),
2314 None, 0, _GetItemAttr("name")),
2315 (_MakeField("node_status", "NodeStatus", QFT_OTHER,
2316 "Status from node"),
2317 None, 0, _GetItemAttr("node_status")),
2318 (_MakeField("nodegroup_status", "NodegroupStatus", QFT_OTHER,
2319 "Overall Nodegroup status"),
2320 None, 0, _GetItemAttr("nodegroup_status")),
2321 (_MakeField("parameters", "Parameters", QFT_OTHER,
2322 "ExtStorage provider parameters"),
2323 None, 0, _GetItemAttr("parameters")),
2326 return _PrepareFieldList(fields, [])
2329 def _JobUnavailInner(fn, ctx, (job_id, job)): # pylint: disable=W0613
2330 """Return L{_FS_UNAVAIL} if job is None.
2332 When listing specifc jobs (e.g. "gnt-job list 1 2 3"), a job may not be
2333 found, in which case this function converts it to L{_FS_UNAVAIL}.
2342 def _JobUnavail(inner):
2343 """Wrapper for L{_JobUnavailInner}.
2346 return compat.partial(_JobUnavailInner, inner)
2349 def _PerJobOpInner(fn, job):
2350 """Executes a function per opcode in a job.
2353 return map(fn, job.ops)
2357 """Wrapper for L{_PerJobOpInner}.
2360 return _JobUnavail(compat.partial(_PerJobOpInner, fn))
2363 def _JobTimestampInner(fn, job):
2364 """Converts unavailable timestamp to L{_FS_UNAVAIL}.
2369 if timestamp is None:
2375 def _JobTimestamp(fn):
2376 """Wrapper for L{_JobTimestampInner}.
2379 return _JobUnavail(compat.partial(_JobTimestampInner, fn))
2382 def _BuildJobFields():
2383 """Builds list of fields for job queries.
2387 (_MakeField("id", "ID", QFT_NUMBER, "Job ID"),
2388 None, QFF_JOB_ID, lambda _, (job_id, job): job_id),
2389 (_MakeField("status", "Status", QFT_TEXT, "Job status"),
2390 None, 0, _JobUnavail(lambda job: job.CalcStatus())),
2391 (_MakeField("priority", "Priority", QFT_NUMBER,
2392 ("Current job priority (%s to %s)" %
2393 (constants.OP_PRIO_LOWEST, constants.OP_PRIO_HIGHEST))),
2394 None, 0, _JobUnavail(lambda job: job.CalcPriority())),
2395 (_MakeField("archived", "Archived", QFT_BOOL, "Whether job is archived"),
2396 JQ_ARCHIVED, 0, lambda _, (job_id, job): job.archived),
2397 (_MakeField("ops", "OpCodes", QFT_OTHER, "List of all opcodes"),
2398 None, 0, _PerJobOp(lambda op: op.input.__getstate__())),
2399 (_MakeField("opresult", "OpCode_result", QFT_OTHER,
2400 "List of opcodes results"),
2401 None, 0, _PerJobOp(operator.attrgetter("result"))),
2402 (_MakeField("opstatus", "OpCode_status", QFT_OTHER,
2403 "List of opcodes status"),
2404 None, 0, _PerJobOp(operator.attrgetter("status"))),
2405 (_MakeField("oplog", "OpCode_log", QFT_OTHER,
2406 "List of opcode output logs"),
2407 None, 0, _PerJobOp(operator.attrgetter("log"))),
2408 (_MakeField("opstart", "OpCode_start", QFT_OTHER,
2409 "List of opcode start timestamps (before acquiring locks)"),
2410 None, 0, _PerJobOp(operator.attrgetter("start_timestamp"))),
2411 (_MakeField("opexec", "OpCode_exec", QFT_OTHER,
2412 "List of opcode execution start timestamps (after acquiring"
2414 None, 0, _PerJobOp(operator.attrgetter("exec_timestamp"))),
2415 (_MakeField("opend", "OpCode_end", QFT_OTHER,
2416 "List of opcode execution end timestamps"),
2417 None, 0, _PerJobOp(operator.attrgetter("end_timestamp"))),
2418 (_MakeField("oppriority", "OpCode_prio", QFT_OTHER,
2419 "List of opcode priorities"),
2420 None, 0, _PerJobOp(operator.attrgetter("priority"))),
2421 (_MakeField("summary", "Summary", QFT_OTHER,
2422 "List of per-opcode summaries"),
2423 None, 0, _PerJobOp(lambda op: op.input.Summary())),
2427 for (name, attr, title, desc) in [
2428 ("received_ts", "received_timestamp", "Received",
2429 "Timestamp of when job was received"),
2430 ("start_ts", "start_timestamp", "Start", "Timestamp of job start"),
2431 ("end_ts", "end_timestamp", "End", "Timestamp of job end"),
2433 getter = operator.attrgetter(attr)
2435 (_MakeField(name, title, QFT_OTHER,
2436 "%s (tuple containing seconds and microseconds)" % desc),
2437 None, QFF_SPLIT_TIMESTAMP, _JobTimestamp(getter)),
2440 return _PrepareFieldList(fields, [])
2443 def _GetExportName(_, (node_name, expname)): # pylint: disable=W0613
2444 """Returns an export name if available.
2453 def _BuildExportFields():
2454 """Builds list of fields for exports.
2458 (_MakeField("node", "Node", QFT_TEXT, "Node name"),
2459 None, QFF_HOSTNAME, lambda _, (node_name, expname): node_name),
2460 (_MakeField("export", "Export", QFT_TEXT, "Export name"),
2461 None, 0, _GetExportName),
2464 return _PrepareFieldList(fields, [])
2467 _CLUSTER_VERSION_FIELDS = {
2468 "software_version": ("SoftwareVersion", QFT_TEXT, constants.RELEASE_VERSION,
2469 "Software version"),
2470 "protocol_version": ("ProtocolVersion", QFT_NUMBER,
2471 constants.PROTOCOL_VERSION,
2472 "RPC protocol version"),
2473 "config_version": ("ConfigVersion", QFT_NUMBER, constants.CONFIG_VERSION,
2474 "Configuration format version"),
2475 "os_api_version": ("OsApiVersion", QFT_NUMBER, max(constants.OS_API_VERSIONS),
2476 "API version for OS template scripts"),
2477 "export_version": ("ExportVersion", QFT_NUMBER, constants.EXPORT_VERSION,
2478 "Import/export file format version"),
2482 _CLUSTER_SIMPLE_FIELDS = {
2483 "cluster_name": ("Name", QFT_TEXT, QFF_HOSTNAME, "Cluster name"),
2484 "master_node": ("Master", QFT_TEXT, QFF_HOSTNAME, "Master node name"),
2485 "volume_group_name": ("VgName", QFT_TEXT, 0, "LVM volume group name"),
2489 class ClusterQueryData:
2490 def __init__(self, cluster, drain_flag, watcher_pause):
2491 """Initializes this class.
2493 @type cluster: L{objects.Cluster}
2494 @param cluster: Instance of cluster object
2495 @type drain_flag: bool
2496 @param drain_flag: Whether job queue is drained
2497 @type watcher_pause: number
2498 @param watcher_pause: Until when watcher is paused (Unix timestamp)
2501 self._cluster = cluster
2502 self.drain_flag = drain_flag
2503 self.watcher_pause = watcher_pause
2506 return iter([self._cluster])
2509 def _ClusterWatcherPause(ctx, _):
2510 """Returns until when watcher is paused (if available).
2513 if ctx.watcher_pause is None:
2516 return ctx.watcher_pause
2519 def _BuildClusterFields():
2520 """Builds list of fields for cluster information.
2524 (_MakeField("tags", "Tags", QFT_OTHER, "Tags"), CQ_CONFIG, 0,
2525 lambda ctx, cluster: list(cluster.GetTags())),
2526 (_MakeField("architecture", "ArchInfo", QFT_OTHER,
2527 "Architecture information"), None, 0,
2528 lambda ctx, _: runtime.GetArchInfo()),
2529 (_MakeField("drain_flag", "QueueDrained", QFT_BOOL,
2530 "Flag whether job queue is drained"), CQ_QUEUE_DRAINED, 0,
2531 lambda ctx, _: ctx.drain_flag),
2532 (_MakeField("watcher_pause", "WatcherPause", QFT_TIMESTAMP,
2533 "Until when watcher is paused"), CQ_WATCHER_PAUSE, 0,
2534 _ClusterWatcherPause),
2539 (_MakeField(name, title, kind, doc), CQ_CONFIG, flags, _GetItemAttr(name))
2540 for (name, (title, kind, flags, doc)) in _CLUSTER_SIMPLE_FIELDS.items()
2545 (_MakeField(name, title, kind, doc), None, 0, _StaticValue(value))
2546 for (name, (title, kind, value, doc)) in _CLUSTER_VERSION_FIELDS.items()])
2549 fields.extend(_GetItemTimestampFields(CQ_CONFIG))
2551 return _PrepareFieldList(fields, [
2552 ("name", "cluster_name")])
2555 class NetworkQueryData:
2556 """Data container for network data queries.
2559 def __init__(self, networks, network_to_groups,
2560 network_to_instances, stats):
2561 """Initializes this class.
2563 @param networks: List of network objects
2564 @type network_to_groups: dict; network UUID as key
2565 @param network_to_groups: Per-network list of groups
2566 @type network_to_instances: dict; network UUID as key
2567 @param network_to_instances: Per-network list of instances
2568 @type stats: dict; network UUID as key
2569 @param stats: Per-network usage statistics
2572 self.networks = networks
2573 self.network_to_groups = network_to_groups
2574 self.network_to_instances = network_to_instances
2578 """Iterate over all networks.
2581 for net in self.networks:
2583 self.curstats = self.stats.get(net.uuid, None)
2585 self.curstats = None
2589 _NETWORK_SIMPLE_FIELDS = {
2590 "name": ("Network", QFT_TEXT, 0, "Name"),
2591 "network": ("Subnet", QFT_TEXT, 0, "IPv4 subnet"),
2592 "gateway": ("Gateway", QFT_OTHER, 0, "IPv4 gateway"),
2593 "network6": ("IPv6Subnet", QFT_OTHER, 0, "IPv6 subnet"),
2594 "gateway6": ("IPv6Gateway", QFT_OTHER, 0, "IPv6 gateway"),
2595 "mac_prefix": ("MacPrefix", QFT_OTHER, 0, "MAC address prefix"),
2596 "serial_no": ("SerialNo", QFT_NUMBER, 0, _SERIAL_NO_DOC % "Network"),
2597 "uuid": ("UUID", QFT_TEXT, 0, "Network UUID"),
2601 _NETWORK_STATS_FIELDS = {
2602 "free_count": ("FreeCount", QFT_NUMBER, 0, "Number of available addresses"),
2604 ("ReservedCount", QFT_NUMBER, 0, "Number of reserved addresses"),
2605 "map": ("Map", QFT_TEXT, 0, "Actual mapping"),
2606 "external_reservations":
2607 ("ExternalReservations", QFT_TEXT, 0, "External reservations"),
2611 def _GetNetworkStatsField(field, kind, ctx, _):
2612 """Gets the value of a "stats" field from L{NetworkQueryData}.
2614 @param field: Field name
2615 @param kind: Data kind, one of L{constants.QFT_ALL}
2616 @type ctx: L{NetworkQueryData}
2619 return _GetStatsField(field, kind, ctx.curstats)
2622 def _BuildNetworkFields():
2623 """Builds list of fields for network queries.
2627 (_MakeField("tags", "Tags", QFT_OTHER, "Tags"), IQ_CONFIG, 0,
2628 lambda ctx, inst: list(inst.GetTags())),
2633 (_MakeField(name, title, kind, doc),
2634 NETQ_CONFIG, 0, _GetItemMaybeAttr(name))
2635 for (name, (title, kind, _, doc)) in _NETWORK_SIMPLE_FIELDS.items()])
2637 def _GetLength(getter):
2638 return lambda ctx, network: len(getter(ctx)[network.uuid])
2640 def _GetSortedList(getter):
2641 return lambda ctx, network: utils.NiceSort(getter(ctx)[network.uuid])
2643 network_to_groups = operator.attrgetter("network_to_groups")
2644 network_to_instances = operator.attrgetter("network_to_instances")
2646 # Add fields for node groups
2648 (_MakeField("group_cnt", "NodeGroups", QFT_NUMBER, "Number of nodegroups"),
2649 NETQ_GROUP, 0, _GetLength(network_to_groups)),
2650 (_MakeField("group_list", "GroupList", QFT_OTHER,
2651 "List of nodegroups (group name, NIC mode, NIC link)"),
2652 NETQ_GROUP, 0, lambda ctx, network: network_to_groups(ctx)[network.uuid]),
2655 # Add fields for instances
2657 (_MakeField("inst_cnt", "Instances", QFT_NUMBER, "Number of instances"),
2658 NETQ_INST, 0, _GetLength(network_to_instances)),
2659 (_MakeField("inst_list", "InstanceList", QFT_OTHER, "List of instances"),
2660 NETQ_INST, 0, _GetSortedList(network_to_instances)),
2663 # Add fields for usage statistics
2665 (_MakeField(name, title, kind, doc), NETQ_STATS, 0,
2666 compat.partial(_GetNetworkStatsField, name, kind))
2667 for (name, (title, kind, _, doc)) in _NETWORK_STATS_FIELDS.items()])
2669 return _PrepareFieldList(fields, [])
2671 #: Fields for cluster information
2672 CLUSTER_FIELDS = _BuildClusterFields()
2674 #: Fields available for node queries
2675 NODE_FIELDS = _BuildNodeFields()
2677 #: Fields available for instance queries
2678 INSTANCE_FIELDS = _BuildInstanceFields()
2680 #: Fields available for lock queries
2681 LOCK_FIELDS = _BuildLockFields()
2683 #: Fields available for node group queries
2684 GROUP_FIELDS = _BuildGroupFields()
2686 #: Fields available for operating system queries
2687 OS_FIELDS = _BuildOsFields()
2689 #: Fields available for extstorage provider queries
2690 EXTSTORAGE_FIELDS = _BuildExtStorageFields()
2692 #: Fields available for job queries
2693 JOB_FIELDS = _BuildJobFields()
2695 #: Fields available for exports
2696 EXPORT_FIELDS = _BuildExportFields()
2698 #: Fields available for network queries
2699 NETWORK_FIELDS = _BuildNetworkFields()
2701 #: All available resources
2703 constants.QR_CLUSTER: CLUSTER_FIELDS,
2704 constants.QR_INSTANCE: INSTANCE_FIELDS,
2705 constants.QR_NODE: NODE_FIELDS,
2706 constants.QR_LOCK: LOCK_FIELDS,
2707 constants.QR_GROUP: GROUP_FIELDS,
2708 constants.QR_OS: OS_FIELDS,
2709 constants.QR_EXTSTORAGE: EXTSTORAGE_FIELDS,
2710 constants.QR_JOB: JOB_FIELDS,
2711 constants.QR_EXPORT: EXPORT_FIELDS,
2712 constants.QR_NETWORK: NETWORK_FIELDS,
2715 #: All available field lists
2716 ALL_FIELD_LISTS = ALL_FIELDS.values()