Fix: Python bindings array access functions write out of bounds
[babeltrace.git] / bindings / python / babeltrace.i.in
index 4b3439f2a726a3df835746214f80a0d84011fd4c..a2ba374db185067dca24b2a7d597b11a0f0d1ff4 100644 (file)
@@ -54,6 +54,36 @@ typedef unsigned long long uint64_t;
 typedef long long int64_t;
 typedef int bt_intern_str;
 
+/* =================================================================
+               PYTHON-COMPLEMENTS.H
+               ¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯
+*/
+
+FILE *_bt_file_open(char *file_path, char *mode);
+void _bt_file_close(FILE *fp);
+struct bt_definition **_bt_python_field_listcaller(
+               const struct bt_ctf_event *ctf_event,
+               const struct bt_definition *scope,
+               unsigned int *OUTPUT);
+struct bt_definition *_bt_python_field_one_from_list(
+               struct bt_definition **list, int index);
+struct bt_ctf_event_decl **_bt_python_event_decl_listcaller(
+               int handle_id,
+               struct bt_context *ctx,
+               unsigned int *OUTPUT);
+struct bt_ctf_event_decl *_bt_python_decl_one_from_list(
+               struct bt_ctf_event_decl **list, int index);
+struct bt_ctf_field_decl **_by_python_field_decl_listcaller(
+               struct bt_ctf_event_decl *event_decl,
+               enum bt_ctf_scope scope,
+               unsigned int *OUTPUT);
+struct bt_ctf_field_decl *_bt_python_field_decl_one_from_list(
+               struct bt_ctf_field_decl **list, int index);
+struct definition_array *_bt_python_get_array_from_def(
+               struct bt_definition *field);
+struct definition_sequence *_bt_python_get_sequence_from_def(
+               struct bt_definition *field);
+
 /* =================================================================
                CONTEXT.H, CONTEXT-INTERNAL.H
                ¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯
@@ -568,6 +598,8 @@ struct bt_ctf_event *bt_ctf_iter_read_event(struct bt_ctf_iter *iter);
 %rename("_bt_ctf_get_int64") bt_ctf_get_int64(const struct bt_definition *field);
 %rename("_bt_ctf_get_char_array") bt_ctf_get_char_array(const struct bt_definition *field);
 %rename("_bt_ctf_get_string") bt_ctf_get_string(const struct bt_definition *field);
+%rename("_bt_ctf_get_float") bt_ctf_get_float(const struct bt_definition *field);
+%rename("_bt_ctf_get_variant") bt_ctf_get_variant(const struct bt_definition *field);
 %rename("_bt_ctf_field_get_error") bt_ctf_field_get_error(void);
 %rename("_bt_ctf_get_decl_event_name") bt_ctf_get_decl_event_name(const struct
                bt_ctf_event_decl *event);
@@ -578,6 +610,8 @@ struct bt_ctf_event *bt_ctf_iter_read_event(struct bt_ctf_iter *iter);
 %rename("_bt_array_index") bt_array_index(struct definition_array *array, uint64_t i);
 %rename("_bt_sequence_len")  bt_sequence_len(struct definition_sequence *sequence);
 %rename("_bt_sequence_index") bt_sequence_index(struct definition_sequence *sequence, uint64_t i);
+%rename("_bt_ctf_get_struct_field_count") bt_ctf_get_struct_field_count(const struct bt_definition *structure);
+%rename("_bt_ctf_get_struct_field_index") bt_ctf_get_struct_field_index(const struct bt_definition *structure, uint64_t i);
 
 const struct bt_definition *bt_ctf_get_top_level_scope(const struct bt_ctf_event *ctf_event,
                enum bt_ctf_scope scope);
@@ -605,12 +639,16 @@ uint64_t bt_ctf_get_uint64(const struct bt_definition *field);
 int64_t bt_ctf_get_int64(const struct bt_definition *field);
 char *bt_ctf_get_char_array(const struct bt_definition *field);
 char *bt_ctf_get_string(const struct bt_definition *field);
+double bt_ctf_get_float(const struct bt_definition *field);
+const struct bt_definition *bt_ctf_get_variant(const struct bt_definition *field);
 int bt_ctf_field_get_error(void);
 const char *bt_ctf_get_decl_event_name(const struct bt_ctf_event_decl *event);
 const char *bt_ctf_get_decl_field_name(const struct bt_ctf_field_decl *field);
 const struct bt_declaration *bt_ctf_get_decl_from_def(const struct bt_definition *field);
 uint64_t bt_sequence_len(struct definition_sequence *sequence);
 struct bt_definition *bt_sequence_index(struct definition_sequence *sequence, uint64_t i);
+uint64_t bt_ctf_get_struct_field_count(const struct bt_definition *structure);
+const struct bt_definition *bt_ctf_get_struct_field_index(const struct bt_definition *structure, uint64_t i);
 
 %pythoncode%{
 
@@ -632,6 +670,15 @@ class ctf:
                SEQUENCE = 9
                NR_CTF_TYPES = 10
 
+               def get_type_id_name(id):
+                       name = "UNKNOWN"
+                       constants = [attr for attr in dir(ctf.type_id) if not callable(getattr(ctf.type_id, attr)) and not attr.startswith("__")]
+                       for attr in constants:
+                               if getattr(ctf.type_id, attr) == id:
+                                       name = attr
+                                       break
+                       return name
+
        class scope:
                TRACE_PACKET_HEADER = 0
                STREAM_PACKET_CONTEXT = 1
@@ -799,7 +846,7 @@ class ctf:
                        Return None on error.
                        """
                        try:
-                               field_lc = _bt_python_field_listcaller(self._e, scope._d)
+                               field_lc, count = _bt_python_field_listcaller(self._e, scope._d)
                        except AttributeError:
                                raise TypeError("in get_field_list, argument 2 must be a "
                                        "Definition (scope) instance")
@@ -808,19 +855,12 @@ class ctf:
                                return None
 
                        def_list = []
-                       i = 0
-                       while True:
+                       for i in range(count):
                                tmp = ctf.Definition.__new__(ctf.Definition)
                                tmp._d = _bt_python_field_one_from_list(field_lc, i)
-
-                               if tmp._d is None:
-                                       #Last item of list is None, assured in
-                                       #_bt_python_field_listcaller
-                                       break
-
                                tmp._s = scope
                                def_list.append(tmp)
-                               i += 1
+
                        return def_list
 
                def get_field_list(self):
@@ -884,6 +924,12 @@ class ctf:
                        else:
                                return ctx
 
+       class FieldError(Exception):
+               def __init__(self, value):
+                       self.value = value
+
+               def __str__(self):
+                       return repr(self.value)
 
        class Definition(object):
                """Definition class.  Do not instantiate."""
@@ -1021,35 +1067,84 @@ class ctf:
                        """
                        return _bt_ctf_get_string(self._d)
 
+               def get_float(self):
+                       """
+                       Return the value associated with the field.
+                       If the field does not exist or is not of the type requested,
+                       the value returned is undefined. To check if an error occured,
+                       use the ctf.field_error() function after accessing a field.
+                       """
+                       return _bt_ctf_get_float(self._d)
+
+               def get_variant(self):
+                       """
+                       Return the variant's selected field.
+                       If the field does not exist or is not of the type requested,
+                       the value returned is undefined. To check if an error occured,
+                       use the ctf.field_error() function after accessing a field.
+                       """
+                       return _bt_ctf_get_variant(self._d)
+
+               def get_struct_field_count(self):
+                       """
+                       Return the number of fields contained in the structure.
+                       If the field does not exist or is not of the type requested,
+                       the value returned is undefined.
+                       """
+                       return _bt_ctf_get_struct_field_count(self._d)
+
+               def get_struct_field_at(self, i):
+                       """
+                       Return the structure's field at position i.
+                       If the field does not exist or is not of the type requested,
+                       the value returned is undefined. To check if an error occured,
+                       use the ctf.field_error() function after accessing a field.
+                       """
+                       return _bt_ctf_get_struct_field_index(self._d, i)
+
                def get_value(self):
                        """
                        Return the value associated with the field according to its type.
                        Return None on error.
                        """
                        id = self.field_type()
+                       value = None
                        if id == ctf.type_id.STRING:
-                               return self.get_str()
-                       if id == ctf.type_id.ARRAY:
-                               array = []
+                               value = self.get_str()
+                       elif id == ctf.type_id.ARRAY:
+                               value = []
                                for i in range(self.get_array_len()):
                                        element = self.get_array_element_at(i)
-                                       array.append(element.get_value())
-                               return array
-                       if id == ctf.type_id.INTEGER:
+                                       value.append(element.get_value())
+                       elif id == ctf.type_id.INTEGER:
                                if self.get_int_signedness() == 0:
-                                       return self.get_uint64()
+                                       value = self.get_uint64()
                                else:
-                                       return self.get_int64()
-                       if id == ctf.type_id.ENUM:
-                               return self.get_enum_str()
-                       if id == ctf.type_id.SEQUENCE:
+                                       value = self.get_int64()
+                       elif id == ctf.type_id.ENUM:
+                               value = self.get_enum_str()
+                       elif id == ctf.type_id.SEQUENCE:
                                seq_len = self.get_sequence_len()
-                               values = []
+                               value = []
                                for i in range(seq_len):
                                        evDef = self.get_sequence_element_at(i)
-                                       values.append(evDef.get_value())
-                               return values
-                       return None
+                                       value.append(evDef.get_value())
+                       elif id == ctf.type_id.FLOAT:
+                               value = self.get_float()
+                       elif id == ctf.type_id.VARIANT:
+                               variant = ctf.Definition.__new__(ctf.Definition)
+                               variant._d = self.get_variant();
+                               value = variant.get_value()
+                       elif id == ctf.type_id.STRUCT:
+                               value = {}
+                               for i in range(self.get_struct_field_count()):
+                                       member = ctf.Definition.__new__(ctf.Definition)
+                                       member._d = self.get_struct_field_at(i);
+                                       value[member.field_name()] = member.get_value()
+
+                       if ctf.field_error():
+                               raise ctf.FieldError("Error occured while accessing field {} of type {}".format(self.field_name(), ctf.type_id.get_type_id_name(self.field_type())))
+                       return value
 
                def get_scope(self):
                        """Return the scope of a field or None on error."""
@@ -1129,7 +1224,7 @@ class ctf:
                                raise TypeError("in get_event_decl_list, "
                                        "argument 1 must be a TraceHandle instance")
                try:
-                       ptr_list = _bt_python_event_decl_listcaller(handle_id, context._c)
+                       ptr_list, count = _bt_python_event_decl_listcaller(handle_id, context._c)
                except AttributeError:
                                raise TypeError("in get_event_decl_list, "
                                        "argument 2 must be a Context instance")
@@ -1138,17 +1233,11 @@ class ctf:
                        return None
 
                decl_list = []
-               i = 0
-               while True:
+               for i in range(count):
                        tmp = ctf.EventDecl.__new__(ctf.EventDecl)
                        tmp._d =  _bt_python_decl_one_from_list(ptr_list, i)
-
-                       if tmp._d is None:
-                               #Last item of list is None
-                               break
-
                        decl_list.append(tmp)
-                       i += 1
+
                return decl_list
 
 %}
@@ -1161,8 +1250,6 @@ class ctf:
 //                        python-complements.h
 // =================================================================
 
-%include python-complements.c
-
 %pythoncode %{
 
 class File(object):
This page took 0.027151 seconds and 4 git commands to generate.