src/bindings/python/bt2/bt2/utils.py

   1 # The MIT License (MIT)
   2 #
   3 # Copyright (c) 2017 Philippe Proulx <pproulx@efficios.com>
   4 #
   5 # Permission is hereby granted, free of charge, to any person obtaining a copy
   6 # of this software and associated documentation files (the "Software"), to deal
   7 # in the Software without restriction, including without limitation the rights
   8 # to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
   9 # copies of the Software, and to permit persons to whom the Software is
  10 # furnished to do so, subject to the following conditions:
  11 #
  12 # The above copyright notice and this permission notice shall be included in
  13 # all copies or substantial portions of the Software.
  14 #
  15 # THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  16 # IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  17 # FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
  18 # AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  19 # LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
  20 # OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
  21 # THE SOFTWARE.
  22
  23 import bt2
  24 import bt2.logging
  25 from bt2 import native_bt
  26
  27
  28 def _check_bool(o):
  29     if not isinstance(o, bool):
  30         raise TypeError("'{}' is not a 'bool' object".format(o.__class__.__name__))
  31
  32
  33 def _check_int(o):
  34     if not isinstance(o, int):
  35         raise TypeError("'{}' is not an 'int' object".format(o.__class__.__name__))
  36
  37
  38 def _check_float(o):
  39     if not isinstance(o, float):
  40         raise TypeError("'{}' is not a 'float' object".format(o.__class__.__name__))
  41
  42
  43 def _check_str(o):
  44     if not isinstance(o, str):
  45         raise TypeError("'{}' is not a 'str' object".format(o.__class__.__name__))
  46
  47
  48 def _check_type(o, expected_type):
  49     if not isinstance(o, expected_type):
  50         raise TypeError(
  51             "'{}' is not a '{}' object".format(o.__class__.__name__, expected_type)
  52         )
  53
  54
  55 def _is_in_int64_range(v):
  56     assert isinstance(v, int)
  57     return v >= -(2 ** 63) and v <= (2 ** 63 - 1)
  58
  59
  60 def _is_int64(v):
  61     if not isinstance(v, int):
  62         return False
  63
  64     return _is_in_int64_range(v)
  65
  66
  67 def _is_in_uint64_range(v):
  68     assert isinstance(v, int)
  69     return v >= 0 and v <= (2 ** 64 - 1)
  70
  71
  72 def _is_uint64(v):
  73     if not isinstance(v, int):
  74         return False
  75
  76     return _is_in_uint64_range(v)
  77
  78
  79 def _check_int64(v, msg=None):
  80     _check_int(v)
  81
  82     if not _is_in_int64_range(v):
  83         if msg is None:
  84             msg = 'expecting a signed 64-bit integral value'
  85
  86         msg += ' (got {})'.format(v)
  87         raise ValueError(msg)
  88
  89
  90 def _check_uint64(v, msg=None):
  91     _check_int(v)
  92
  93     if not _is_in_uint64_range(v):
  94         if msg is None:
  95             msg = 'expecting an unsigned 64-bit integral value'
  96
  97         msg += ' (got {})'.format(v)
  98         raise ValueError(msg)
  99
 100
 101 def _is_m1ull(v):
 102     return v == 18446744073709551615
 103
 104
 105 def _is_pow2(v):
 106     return v != 0 and ((v & (v - 1)) == 0)
 107
 108
 109 def _check_alignment(a):
 110     _check_uint64(a)
 111
 112     if not _is_pow2(a):
 113         raise ValueError('{} is not a power of two'.format(a))
 114
 115
 116 def _raise_bt2_error(msg):
 117     if msg is None:
 118         raise bt2.Error
 119     else:
 120         raise bt2.Error(msg)
 121
 122
 123 def _handle_ptr(ptr, msg=None):
 124     if ptr is None:
 125         _raise_bt2_error(msg)
 126
 127
 128 def _check_log_level(log_level):
 129     _check_int(log_level)
 130
 131     log_levels = (
 132         bt2.logging.LoggingLevel.TRACE,
 133         bt2.logging.LoggingLevel.DEBUG,
 134         bt2.logging.LoggingLevel.INFO,
 135         bt2.logging.LoggingLevel.WARNING,
 136         bt2.logging.LoggingLevel.ERROR,
 137         bt2.logging.LoggingLevel.FATAL,
 138         bt2.logging.LoggingLevel.NONE,
 139     )
 140
 141     if log_level not in log_levels:
 142         raise ValueError("'{}' is not a valid logging level".format(log_level))
 143
 144
 145 def _handle_func_status(status, msg=None):
 146     if status == native_bt.__BT_FUNC_STATUS_OK:
 147         # no error
 148         return
 149
 150     if (
 151         status == native_bt.__BT_FUNC_STATUS_ERROR
 152         or status == native_bt.__BT_FUNC_STATUS_MEMORY_ERROR
 153     ):
 154         if msg is None:
 155             raise bt2.Error
 156         else:
 157             raise bt2.Error(msg)
 158     elif status == native_bt.__BT_FUNC_STATUS_END:
 159         if msg is None:
 160             raise bt2.Stop
 161         else:
 162             raise bt2.Stop(msg)
 163     elif status == native_bt.__BT_FUNC_STATUS_AGAIN:
 164         if msg is None:
 165             raise bt2.TryAgain
 166         else:
 167             raise bt2.TryAgain(msg)
 168     elif status == native_bt.__BT_FUNC_STATUS_CANCELED:
 169         if msg is None:
 170             raise bt2.Canceled
 171         else:
 172             raise bt2.Canceled(msg)
 173     elif status == native_bt.__BT_FUNC_STATUS_LOADING_ERROR:
 174         if msg is None:
 175             raise bt2.LoadingError
 176         else:
 177             raise bt2.LoadingError(msg)
 178     elif status == native_bt.__BT_FUNC_STATUS_OVERFLOW:
 179         if msg is None:
 180             raise bt2.OverflowError
 181         else:
 182             raise bt2.OverflowError(msg)
 183     elif status == native_bt.__BT_FUNC_STATUS_INVALID_OBJECT:
 184         if msg is None:
 185             raise bt2.InvalidObject
 186         else:
 187             raise bt2.InvalidObject(msg)
 188     elif status == native_bt.__BT_FUNC_STATUS_INVALID_PARAMS:
 189         if msg is None:
 190             raise bt2.InvalidParams
 191         else:
 192             raise bt2.InvalidParams(msg)
 193     elif status == native_bt.__BT_FUNC_STATUS_UNSUPPORTED:
 194         if msg is None:
 195             raise bt2.Unsupported
 196         else:
 197             raise bt2.Unsupported(msg)
 198     else:
 199         assert False