1 # The MIT License (MIT)
3 # Copyright (c) 2016-2017 Philippe Proulx <pproulx@efficios.com>
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:
12 # The above copyright notice and this permission notice shall be included in
13 # all copies or substantial portions of the Software.
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
23 from bt2
import native_bt
, object, utils
24 import bt2
.clock_class
28 import bt2
.clock_value
35 def _create_from_ptr(ptr
):
36 # recreate the event class wrapper of this event's class (the
37 # identity could be different, but the underlying address should be
39 event_class_ptr
= native_bt
.event_get_class(ptr
)
40 utils
._handle
_ptr
(event_class_ptr
, "cannot get event object's class")
41 event_class
= bt2
.EventClass
._create
_from
_ptr
(event_class_ptr
)
42 event
= _Event
._create
_from
_ptr
(ptr
)
43 event
._event
_class
= event_class
47 class _Event(object._Object
):
49 def event_class(self
):
50 return self
._event
_class
54 return self
._event
_class
.name
58 return self
._event
_class
.id
62 packet_ptr
= native_bt
.event_get_packet(self
._ptr
)
64 if packet_ptr
is None:
67 return bt2
.packet
._Packet
._create
_from
_ptr
(packet_ptr
)
70 def packet(self
, packet
):
71 utils
._check
_type
(packet
, bt2
.packet
._Packet
)
72 ret
= native_bt
.event_set_packet(self
._ptr
, packet
._ptr
)
73 utils
._handle
_ret
(ret
, "cannot set event object's packet object")
77 stream_ptr
= native_bt
.event_get_stream(self
._ptr
)
79 if stream_ptr
is None:
82 return bt2
.stream
._Stream
._create
_from
_ptr
(stream_ptr
)
85 def header_field(self
):
86 field_ptr
= native_bt
.event_get_header(self
._ptr
)
91 return bt2
.fields
._create
_from
_ptr
(field_ptr
)
94 def header_field(self
, header_field
):
95 header_field_ptr
= None
97 if header_field
is not None:
98 utils
._check
_type
(header_field
, bt2
.fields
._Field
)
99 header_field_ptr
= header_field
._ptr
101 ret
= native_bt
.event_set_header(self
._ptr
, header_field_ptr
)
102 utils
._handle
_ret
(ret
, "cannot set event object's header field")
105 def stream_event_context_field(self
):
106 field_ptr
= native_bt
.event_get_stream_event_context(self
._ptr
)
108 if field_ptr
is None:
111 return bt2
.fields
._create
_from
_ptr
(field_ptr
)
113 @stream_event_context_field.setter
114 def stream_event_context_field(self
, stream_event_context
):
115 stream_event_context_ptr
= None
117 if stream_event_context
is not None:
118 utils
._check
_type
(stream_event_context
, bt2
.fields
._Field
)
119 stream_event_context_ptr
= stream_event_context
._ptr
121 ret
= native_bt
.event_set_stream_event_context(self
._ptr
,
122 stream_event_context_ptr
)
123 utils
._handle
_ret
(ret
, "cannot set event object's stream event context field")
126 def context_field(self
):
127 field_ptr
= native_bt
.event_get_event_context(self
._ptr
)
129 if field_ptr
is None:
132 return bt2
.fields
._create
_from
_ptr
(field_ptr
)
134 @context_field.setter
135 def context_field(self
, context
):
138 if context
is not None:
139 utils
._check
_type
(context
, bt2
.fields
._Field
)
140 context_ptr
= context
._ptr
142 ret
= native_bt
.event_set_event_context(self
._ptr
, context_ptr
)
143 utils
._handle
_ret
(ret
, "cannot set event object's context field")
146 def payload_field(self
):
147 field_ptr
= native_bt
.event_get_event_payload(self
._ptr
)
149 if field_ptr
is None:
152 return bt2
.fields
._create
_from
_ptr
(field_ptr
)
154 @payload_field.setter
155 def payload_field(self
, payload
):
158 if payload
is not None:
159 utils
._check
_type
(payload
, bt2
.fields
._Field
)
160 payload_ptr
= payload
._ptr
162 ret
= native_bt
.event_set_event_payload(self
._ptr
, payload_ptr
)
163 utils
._handle
_ret
(ret
, "cannot set event object's payload field")
165 def _get_clock_value_cycles(self
, clock_class_ptr
):
166 clock_value_ptr
= native_bt
.event_get_clock_value(self
._ptr
,
169 if clock_value_ptr
is None:
172 ret
, cycles
= native_bt
.clock_value_get_value(clock_value_ptr
)
173 native_bt
.put(clock_value_ptr
)
174 utils
._handle
_ret
(ret
, "cannot get clock value object's cycles")
177 def clock_value(self
, clock_class
):
178 utils
._check
_type
(clock_class
, bt2
.ClockClass
)
179 clock_value_ptr
= native_bt
.event_get_clock_value(self
._ptr
,
182 if clock_value_ptr
is None:
185 clock_value
= bt2
.clock_value
._create
_clock
_value
_from
_ptr
(clock_value_ptr
)
188 def add_clock_value(self
, clock_value
):
189 utils
._check
_type
(clock_value
, bt2
.clock_value
._ClockValue
)
190 ret
= native_bt
.event_set_clock_value(self
._ptr
,
192 utils
._handle
_ret
(ret
, "cannot set event object's clock value")
194 def __getitem__(self
, key
):
195 utils
._check
_str
(key
)
196 payload_field
= self
.payload_field
198 if payload_field
is not None and key
in payload_field
:
199 return payload_field
[key
]
201 context_field
= self
.context_field
203 if context_field
is not None and key
in context_field
:
204 return context_field
[key
]
206 sec_field
= self
.stream_event_context_field
208 if sec_field
is not None and key
in sec_field
:
209 return sec_field
[key
]
211 header_field
= self
.header_field
213 if header_field
is not None and key
in header_field
:
214 return header_field
[key
]
221 pkt_context_field
= packet
.context_field
223 if pkt_context_field
is not None and key
in pkt_context_field
:
224 return pkt_context_field
[key
]
226 pkt_header_field
= packet
.header_field
228 if pkt_header_field
is not None and key
in pkt_header_field
:
229 return pkt_header_field
[key
]
234 def _clock_classes(self
):
235 stream_class
= self
.event_class
.stream_class
237 if stream_class
is None:
240 trace
= stream_class
.trace
247 for clock_class
in trace
.clock_classes
.values():
248 clock_classes
.append(clock_class
)
253 def _clock_class_ptrs(self
):
254 return [cc
._ptr
for cc
in self
._clock
_classes
]
256 def __eq__(self
, other
):
257 if type(other
) is not type(self
):
260 if self
.addr
== other
.addr
:
263 self_clock_values
= {}
264 other_clock_values
= {}
266 for clock_class_ptr
in self
._clock
_class
_ptrs
:
267 self_clock_values
[int(clock_class_ptr
)] = self
._get
_clock
_value
_cycles
(clock_class_ptr
)
269 for clock_class_ptr
in other
._clock
_class
_ptrs
:
270 other_clock_values
[int(clock_class_ptr
)] = self
._get
_clock
_value
_cycles
(clock_class_ptr
)
274 self
.stream_event_context_field
,
281 other
.stream_event_context_field
,
286 return self_props
== other_props
288 def _copy(self
, copy_func
):
289 cpy
= self
.event_class()
292 cpy
.header_field
= copy_func(self
.header_field
)
293 cpy
.stream_event_context_field
= copy_func(self
.stream_event_context_field
)
294 cpy
.context_field
= copy_func(self
.context_field
)
295 cpy
.payload_field
= copy_func(self
.payload_field
)
297 # Copy known clock value references. It's not necessary to copy
298 # clock class or clock value objects because once a clock value
299 # is created from a clock class, the clock class is frozen.
300 # Thus even if we copy the clock class, the user cannot modify
301 # it, therefore it's useless to copy it.
302 for clock_class
in self
._clock
_classes
:
303 clock_value
= self
.clock_value(clock_class
)
305 if clock_value
is not None:
306 cpy
.add_clock_value(clock_value
)
311 return self
._copy
(copy
.copy
)
313 def __deepcopy__(self
, memo
):
314 cpy
= self
._copy
(copy
.deepcopy
)