File: event_name.cpp

package info (click to toggle)
ltt-control 2.14.1-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 22,400 kB
  • sloc: cpp: 192,720; sh: 29,271; ansic: 10,960; python: 7,419; makefile: 3,534; java: 109; xml: 46
file content (283 lines) | stat: -rw-r--r-- 9,245 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
/*
 * SPDX-FileCopyrightText: 2023 Kienan Stewart <kstewart@efficios.com>
 *
 * SPDX-License-Identifier: LGPL-2.1-only
 *
 */

#include "../utils.hpp"
#include "event_name.hpp"

#include <common/container-wrapper.hpp>
#include <common/macros.hpp>
#include <common/make-unique.hpp>

#include <assert.h>
#include <babeltrace2/babeltrace.h>
#include <cstdint>
#include <exception>
#include <stdlib.h>
#include <string.h>
#include <string>
#include <unordered_set>

class event_name_set_operations {
public:
	static const char *get(const bt_value *array, std::size_t index)
	{
		const auto *names_entry =
			bt_value_array_borrow_element_by_index_const(array, index);

		if (bt_value_get_type(names_entry) != BT_VALUE_TYPE_STRING) {
			throw std::runtime_error(
				"All members of the 'names' parameter array must be strings");
		}

		return bt_value_string_get(names_entry);
	}

	static std::size_t size(const bt_value *array)
	{
		return bt_value_array_get_length(array);
	}
};

class event_name_set
	: public lttng::utils::random_access_container_wrapper<const bt_value *,
							       const char *,
							       event_name_set_operations> {
public:
	friend event_name_set_operations;

	event_name_set() :
		lttng::utils::random_access_container_wrapper<const bt_value *,
							      const char *,
							      event_name_set_operations>(nullptr)
	{
	}

	event_name_set(event_name_set&& original) noexcept :
		lttng::utils::random_access_container_wrapper<const bt_value *,
							      const char *,
							      event_name_set_operations>(
			original._container)
	{
	}

	explicit event_name_set(const bt_value *names) :
		lttng::utils::random_access_container_wrapper<const bt_value *,
							      const char *,
							      event_name_set_operations>(names)
	{
		if (bt_value_get_type(names) != BT_VALUE_TYPE_ARRAY) {
			throw std::invalid_argument("'names' parameter must be an array");
		}
	}
};

class event_name_filter {
public:
	event_name_filter(bt_self_component_port_input *input_port_,
			  const event_name_set& name_set) :
		input_port{ input_port_ }, _names{ name_set.begin(), name_set.end() }
	{
	}

	bool event_name_is_allowed(const char *event_name) const noexcept
	{
		return _names.find(event_name) != _names.end();
	}

	/* weak reference */
	bt_self_component_port_input *const input_port;

private:
	const std::unordered_set<std::string> _names;
};

struct event_name_iterator_data {
	event_name_iterator_data(lttng::bt2::message_iterator_ref iterator_,
				 const class event_name_filter& event_name_filter_) :
		upstream_iterator{ std::move(iterator_) }, event_name_filter{ event_name_filter_ }
	{
	}

	~event_name_iterator_data() = default;

	const lttng::bt2::message_iterator_ref upstream_iterator;
	const class event_name_filter& event_name_filter;
};

namespace {
bool message_passes(const bt_message *message, const event_name_filter& event_name_filter)
{
	if (bt_message_get_type(message) != BT_MESSAGE_TYPE_EVENT) {
		return true;
	}

	const bt_event *event = bt_message_event_borrow_event_const(message);
	const bt_event_class *event_class = bt_event_borrow_class_const(event);
	const char *event_name = bt_event_class_get_name(event_class);

	if (event_name == nullptr) {
		return false;
	}

	return event_name_filter.event_name_is_allowed(event_name);
}
} /* namespace */

bt_component_class_initialize_method_status
event_name_initialize(bt_self_component_filter *self_comp,
		      bt_self_component_filter_configuration *,
		      const bt_value *params,
		      void *)
{
	bt_self_component_port_input *input_port;
	std::unique_ptr<class event_name_filter> event_name_filter;

	auto self = bt_self_component_filter_as_self_component(self_comp);
	if (bt_self_component_filter_add_input_port(self_comp, "in", nullptr, &input_port) !=
	    BT_SELF_COMPONENT_ADD_PORT_STATUS_OK) {
		BT_CURRENT_THREAD_ERROR_APPEND_CAUSE_FROM_COMPONENT(self,
								    "Failed to add input port");
		return BT_COMPONENT_CLASS_INITIALIZE_METHOD_STATUS_ERROR;
	}

	if (bt_self_component_filter_add_output_port(self_comp, "out", nullptr, nullptr) !=
	    BT_SELF_COMPONENT_ADD_PORT_STATUS_OK) {
		BT_CURRENT_THREAD_ERROR_APPEND_CAUSE_FROM_COMPONENT(self,
								    "Failed to add output port");
		return BT_COMPONENT_CLASS_INITIALIZE_METHOD_STATUS_ERROR;
	}

	const auto names_param = bt_value_map_borrow_entry_value_const(params, "names");
	if (names_param == nullptr) {
		BT_CURRENT_THREAD_ERROR_APPEND_CAUSE_FROM_COMPONENT(
			self, "'names' parameter is required");
		return BT_COMPONENT_CLASS_INITIALIZE_METHOD_STATUS_ERROR;
	}

	try {
		const event_name_set event_names{ names_param };
		if (event_names.empty()) {
			BT_CURRENT_THREAD_ERROR_APPEND_CAUSE_FROM_COMPONENT(
				bt_self_component_filter_as_self_component(self_comp),
				"'names' parameter must not be empty");
			return BT_COMPONENT_CLASS_INITIALIZE_METHOD_STATUS_ERROR;
		}

		event_name_filter =
			lttng::make_unique<class event_name_filter>(input_port, event_names);
	} catch (const std::bad_alloc&) {
		BT_CURRENT_THREAD_ERROR_APPEND_CAUSE_FROM_COMPONENT(
			self, "Failed to allocate memory for private component data");
		return BT_COMPONENT_CLASS_INITIALIZE_METHOD_STATUS_MEMORY_ERROR;
	} catch (const std::exception& ex) {
		BT_CURRENT_THREAD_ERROR_APPEND_CAUSE_FROM_COMPONENT(self, "%s", ex.what());
		return BT_COMPONENT_CLASS_INITIALIZE_METHOD_STATUS_ERROR;
	}

	/* Ownership of event_name is transferred to the component. */
	bt_self_component_set_data(self, event_name_filter.release());
	return BT_COMPONENT_CLASS_INITIALIZE_METHOD_STATUS_OK;
}

void event_name_finalize(bt_self_component_filter *self_comp)
{
	class event_name_filter *event_name_filter =
		(class event_name_filter *) bt_self_component_get_data(
			bt_self_component_filter_as_self_component(self_comp));

	delete event_name_filter;
}

bt_message_iterator_class_initialize_method_status
event_name_message_iterator_initialize(bt_self_message_iterator *self_message_iterator,
				       bt_self_message_iterator_configuration *,
				       bt_self_component_port_output *)
{
	const auto& event_name_filter =
		*static_cast<class event_name_filter *>(bt_self_component_get_data(
			bt_self_message_iterator_borrow_component(self_message_iterator)));

	bt_message_iterator *raw_iterator;
	if (bt_message_iterator_create_from_message_iterator(
		    self_message_iterator, event_name_filter.input_port, &raw_iterator) !=
	    BT_MESSAGE_ITERATOR_CREATE_FROM_MESSAGE_ITERATOR_STATUS_OK) {
		return BT_MESSAGE_ITERATOR_CLASS_INITIALIZE_METHOD_STATUS_ERROR;
	}

	lttng::bt2::message_iterator_ref iterator(raw_iterator);
	raw_iterator = nullptr;

	std::unique_ptr<event_name_iterator_data> iter_data;
	try {
		iter_data = lttng::make_unique<event_name_iterator_data>(std::move(iterator),
									 event_name_filter);
	} catch (const std::bad_alloc&) {
		BT_CURRENT_THREAD_ERROR_APPEND_CAUSE_FROM_MESSAGE_ITERATOR(
			self_message_iterator, "Failed to allocate event_name iterator data");
		return BT_MESSAGE_ITERATOR_CLASS_INITIALIZE_METHOD_STATUS_ERROR;
	}

	/* Transfer the ownership of iter_data to the iterator. */
	bt_self_message_iterator_set_data(self_message_iterator, iter_data.release());
	return BT_MESSAGE_ITERATOR_CLASS_INITIALIZE_METHOD_STATUS_OK;
}

void event_name_message_iterator_finalize(bt_self_message_iterator *self_message)
{
	event_name_iterator_data *iter_data = static_cast<event_name_iterator_data *>(
		bt_self_message_iterator_get_data(self_message));

	LTTNG_ASSERT(iter_data);
	delete iter_data;
}

bt_message_iterator_class_next_method_status
event_name_message_iterator_next(bt_self_message_iterator *self_message_iterator,
				 bt_message_array_const messages_to_deliver_downstream,
				 uint64_t,
				 uint64_t *_messages_to_deliver_count)
{
	std::uint64_t messages_to_deliver_count = 0;
	auto *iter_data = static_cast<event_name_iterator_data *>(
		bt_self_message_iterator_get_data(self_message_iterator));
	const auto& event_name_filter =
		*static_cast<class event_name_filter *>(bt_self_component_get_data(
			bt_self_message_iterator_borrow_component(self_message_iterator)));

	LTTNG_ASSERT(iter_data);

	/* Retry until we have at least one message to deliver downstream. */
	while (messages_to_deliver_count == 0) {
		bt_message_array_const upstream_messages;
		bt_message_iterator_next_status next_status;
		uint64_t upstream_message_count;

		next_status = bt_message_iterator_next(iter_data->upstream_iterator.get(),
						       &upstream_messages,
						       &upstream_message_count);
		if (next_status != BT_MESSAGE_ITERATOR_NEXT_STATUS_OK) {
			return static_cast<bt_message_iterator_class_next_method_status>(
				next_status);
		}

		for (std::uint64_t upstream_index = 0; upstream_index < upstream_message_count;
		     upstream_index++) {
			lttng::bt2::message_const_ref upstream_message(
				upstream_messages[upstream_index]);

			if (message_passes(upstream_message.get(), event_name_filter)) {
				/* Reference transferred to downstream message batch. */
				messages_to_deliver_downstream[messages_to_deliver_count] =
					upstream_message.release();
				messages_to_deliver_count++;
			}
		}
	}

	*_messages_to_deliver_count = messages_to_deliver_count;
	return BT_MESSAGE_ITERATOR_CLASS_NEXT_METHOD_STATUS_OK;
}