2 * Copyright (C) 2019 Jonathan Rajotte <jonathan.rajotte-julien@efficios.com>
3 * Copyright (C) 2020 Jérémie Galarneau <jeremie.galarneau@efficios.com>
5 * SPDX-License-Identifier: LGPL-2.1-only
9 #include <lttng/domain.h>
10 #include <lttng/lttng-error.h>
11 #include <lttng/tracker.h>
13 #include <common/dynamic-array.h>
14 #include <common/error.h>
15 #include <common/hashtable/hashtable.h>
16 #include <common/hashtable/utils.h>
17 #include <common/tracker.h>
21 struct process_attr_tracker_values_comm_header
{
25 struct process_attr_tracker_value_comm
{
26 /* enum lttng_process_attr_value_type */
29 struct process_attr_integral_value_comm integral
;
30 /* Includes the '\0' terminator. */
35 #define GET_INTEGRAL_COMM_VALUE(value_ptr, as_type) \
36 ((as_type)(is_signed(as_type) ? (value_ptr)->u._signed : \
37 (value_ptr)->u._unsigned))
39 #define SET_INTEGRAL_COMM_VALUE(comm_value, value) \
40 if (is_signed(typeof(value))) { \
41 (comm_value)->u._signed = \
42 (typeof((comm_value)->u._signed)) value; \
44 (comm_value)->u._unsigned = \
45 (typeof((comm_value)->u._unsigned)) value; \
48 static inline bool is_virtual_process_attr(enum lttng_process_attr process_attr
)
50 return process_attr
== LTTNG_PROCESS_ATTR_VIRTUAL_PROCESS_ID
||
51 process_attr
== LTTNG_PROCESS_ATTR_VIRTUAL_USER_ID
||
52 process_attr
== LTTNG_PROCESS_ATTR_VIRTUAL_GROUP_ID
;
55 static inline bool is_value_type_name(
56 enum lttng_process_attr_value_type value_type
)
58 return value_type
== LTTNG_PROCESS_ATTR_VALUE_TYPE_USER_NAME
||
59 value_type
== LTTNG_PROCESS_ATTR_VALUE_TYPE_GROUP_NAME
;
63 enum lttng_error_code
process_attr_value_from_comm(
64 enum lttng_domain_type domain
,
65 enum lttng_process_attr process_attr
,
66 enum lttng_process_attr_value_type value_type
,
67 const struct process_attr_integral_value_comm
*integral_value
,
68 const struct lttng_buffer_view
*value_view
,
69 struct process_attr_value
**_value
)
72 enum lttng_error_code ret
= LTTNG_OK
;
73 struct process_attr_value
*value
= zmalloc(sizeof(*value
));
76 ret
= LTTNG_ERR_NOMEM
;
80 if (value_view
&& value_view
->size
> 0) {
81 if (value_view
->data
[value_view
->size
- 1] != '\0') {
82 ret
= LTTNG_ERR_INVALID
;
85 name
= strdup(value_view
->data
);
87 ret
= LTTNG_ERR_NOMEM
;
91 if (domain
!= LTTNG_DOMAIN_UST
&& domain
!= LTTNG_DOMAIN_KERNEL
) {
92 ERR("Only the user space and kernel space domains may be specified to configure process attribute trackers");
93 ret
= LTTNG_ERR_UNSUPPORTED_DOMAIN
;
97 if (!is_virtual_process_attr(process_attr
) &&
98 domain
!= LTTNG_DOMAIN_KERNEL
) {
99 ERR("Non-virtual process attributes can only be used in the kernel domain");
100 ret
= LTTNG_ERR_UNSUPPORTED_DOMAIN
;
104 /* Only expect a payload for name value types. */
105 if (is_value_type_name(value_type
) && value_view
->size
== 0) {
106 ret
= LTTNG_ERR_INVALID_PROTOCOL
;
108 } else if (!is_value_type_name(value_type
) && value_view
->size
!= 0) {
109 ret
= LTTNG_ERR_INVALID_PROTOCOL
;
113 value
->type
= value_type
;
114 switch (process_attr
) {
115 case LTTNG_PROCESS_ATTR_PROCESS_ID
:
116 case LTTNG_PROCESS_ATTR_VIRTUAL_PROCESS_ID
:
117 if (value_type
!= LTTNG_PROCESS_ATTR_VALUE_TYPE_PID
) {
118 ERR("Invalid value type used for process ID process attribute");
119 ret
= LTTNG_ERR_INVALID
;
123 GET_INTEGRAL_COMM_VALUE(integral_value
, pid_t
);
125 case LTTNG_PROCESS_ATTR_USER_ID
:
126 case LTTNG_PROCESS_ATTR_VIRTUAL_USER_ID
:
127 switch (value_type
) {
128 case LTTNG_PROCESS_ATTR_VALUE_TYPE_UID
:
129 value
->value
.uid
= GET_INTEGRAL_COMM_VALUE(
130 integral_value
, uid_t
);
132 case LTTNG_PROCESS_ATTR_VALUE_TYPE_USER_NAME
:
134 ret
= LTTNG_ERR_INVALID
;
138 value
->value
.user_name
= name
;
142 ERR("Invalid value type used for user ID process attribute");
143 ret
= LTTNG_ERR_INVALID
;
147 case LTTNG_PROCESS_ATTR_GROUP_ID
:
148 case LTTNG_PROCESS_ATTR_VIRTUAL_GROUP_ID
:
149 switch (value_type
) {
150 case LTTNG_PROCESS_ATTR_VALUE_TYPE_GID
:
151 value
->value
.gid
= GET_INTEGRAL_COMM_VALUE(
152 integral_value
, gid_t
);
154 case LTTNG_PROCESS_ATTR_VALUE_TYPE_GROUP_NAME
:
156 ret
= LTTNG_ERR_INVALID
;
160 value
->value
.group_name
= name
;
164 ERR("Invalid value type used for group ID process attribute");
165 ret
= LTTNG_ERR_INVALID
;
170 ret
= LTTNG_ERR_INVALID_PROTOCOL
;
179 process_attr_value_destroy(value
);
184 const char *lttng_process_attr_to_string(enum lttng_process_attr process_attr
)
186 switch (process_attr
) {
187 case LTTNG_PROCESS_ATTR_PROCESS_ID
:
189 case LTTNG_PROCESS_ATTR_VIRTUAL_PROCESS_ID
:
190 return "virtual process ID";
191 case LTTNG_PROCESS_ATTR_USER_ID
:
193 case LTTNG_PROCESS_ATTR_VIRTUAL_USER_ID
:
194 return "virtual user ID";
195 case LTTNG_PROCESS_ATTR_GROUP_ID
:
197 case LTTNG_PROCESS_ATTR_VIRTUAL_GROUP_ID
:
198 return "virtual group ID";
200 return "unknown process attribute";
204 static void process_attr_tracker_value_destructor(void *ptr
)
206 struct process_attr_value
*value
= (typeof(value
)) ptr
;
208 process_attr_value_destroy(value
);
212 struct lttng_process_attr_values
*lttng_process_attr_values_create(void)
214 struct lttng_process_attr_values
*values
= zmalloc(sizeof(*values
));
220 lttng_dynamic_pointer_array_init(
221 &values
->array
, process_attr_tracker_value_destructor
);
227 unsigned int _lttng_process_attr_values_get_count(
228 const struct lttng_process_attr_values
*values
)
230 return (unsigned int) lttng_dynamic_pointer_array_get_count(
235 const struct process_attr_value
*lttng_process_attr_tracker_values_get_at_index(
236 const struct lttng_process_attr_values
*values
,
239 return lttng_dynamic_pointer_array_get_pointer(&values
->array
, index
);
243 int process_attr_tracker_value_serialize(const struct process_attr_value
*value
,
244 struct lttng_dynamic_buffer
*buffer
)
247 struct process_attr_tracker_value_comm value_comm
= {
248 .type
= (int32_t) value
->type
,
250 const char *name
= NULL
;
252 switch (value
->type
) {
253 case LTTNG_PROCESS_ATTR_VALUE_TYPE_PID
:
254 SET_INTEGRAL_COMM_VALUE(
255 &value_comm
.value
.integral
, value
->value
.pid
);
257 case LTTNG_PROCESS_ATTR_VALUE_TYPE_UID
:
258 SET_INTEGRAL_COMM_VALUE(
259 &value_comm
.value
.integral
, value
->value
.uid
);
261 case LTTNG_PROCESS_ATTR_VALUE_TYPE_GID
:
262 SET_INTEGRAL_COMM_VALUE(
263 &value_comm
.value
.integral
, value
->value
.gid
);
265 case LTTNG_PROCESS_ATTR_VALUE_TYPE_USER_NAME
:
266 name
= value
->value
.user_name
;
268 case LTTNG_PROCESS_ATTR_VALUE_TYPE_GROUP_NAME
:
269 name
= value
->value
.group_name
;
276 value_comm
.value
.name_len
= strlen(name
) + 1;
279 ret
= lttng_dynamic_buffer_append(
280 buffer
, &value_comm
, sizeof(value_comm
));
286 ret
= lttng_dynamic_buffer_append(
287 buffer
, name
, value_comm
.value
.name_len
);
294 int lttng_process_attr_values_serialize(
295 const struct lttng_process_attr_values
*values
,
296 struct lttng_dynamic_buffer
*buffer
)
299 unsigned int count
, i
;
300 struct process_attr_tracker_values_comm_header header
= {};
302 count
= _lttng_process_attr_values_get_count(values
);
303 header
.count
= (uint32_t) count
;
305 ret
= lttng_dynamic_buffer_append(buffer
, &header
, sizeof(header
));
310 for (i
= 0; i
< count
; i
++) {
311 const struct process_attr_value
*value
=
312 lttng_process_attr_tracker_values_get_at_index(
315 ret
= process_attr_tracker_value_serialize(value
, buffer
);
325 ssize_t
lttng_process_attr_values_create_from_buffer(
326 enum lttng_domain_type domain
,
327 enum lttng_process_attr process_attr
,
328 const struct lttng_buffer_view
*buffer_view
,
329 struct lttng_process_attr_values
**_values
)
333 struct lttng_process_attr_values
*values
;
334 struct lttng_buffer_view header_view
;
335 const struct process_attr_tracker_values_comm_header
*header
;
337 values
= lttng_process_attr_values_create();
342 header_view
= lttng_buffer_view_from_view(
343 buffer_view
, 0, sizeof(*header
));
344 if (!header_view
.data
) {
347 offset
= header_view
.size
;
348 header
= (typeof(header
)) header_view
.data
;
351 * Check that the number of values is not absurdly large with respect to
352 * the received buffer's size.
354 if (buffer_view
->size
<
355 header
->count
* sizeof(struct process_attr_tracker_value_comm
)) {
358 for (i
= 0; i
< (unsigned int) header
->count
; i
++) {
360 enum lttng_error_code ret_code
;
361 const struct process_attr_tracker_value_comm
*value_comm
;
362 struct process_attr_value
*value
;
363 enum lttng_process_attr_value_type type
;
364 struct lttng_buffer_view value_view
;
365 struct lttng_buffer_view value_name_view
= {};
367 value_view
= lttng_buffer_view_from_view(
368 buffer_view
, offset
, sizeof(*value_comm
));
369 if (!value_view
.data
) {
373 offset
+= value_view
.size
;
374 value_comm
= (typeof(value_comm
)) value_view
.data
;
375 type
= (typeof(type
)) value_comm
->type
;
377 if (is_value_type_name(type
)) {
378 value_name_view
= lttng_buffer_view_from_view(
380 value_comm
->value
.name_len
);
381 offset
+= value_name_view
.size
;
383 ret_code
= process_attr_value_from_comm(domain
, process_attr
,
384 type
, &value_comm
->value
.integral
,
385 &value_name_view
, &value
);
386 if (ret_code
!= LTTNG_OK
) {
390 ret
= lttng_dynamic_pointer_array_add_pointer(
391 &values
->array
, value
);
393 process_attr_value_destroy(value
);
401 lttng_process_attr_values_destroy(values
);
406 void lttng_process_attr_values_destroy(struct lttng_process_attr_values
*values
)
411 lttng_dynamic_pointer_array_reset(&values
->array
);
416 struct process_attr_value
*process_attr_value_copy(
417 const struct process_attr_value
*value
)
419 struct process_attr_value
*new_value
= NULL
;
425 new_value
= zmalloc(sizeof(*new_value
));
429 if (is_value_type_name(value
->type
)) {
431 value
->type
== LTTNG_PROCESS_ATTR_VALUE_TYPE_USER_NAME
?
432 value
->value
.user_name
:
433 value
->value
.group_name
;
434 char **dst
= value
->type
== LTTNG_PROCESS_ATTR_VALUE_TYPE_USER_NAME
?
435 &new_value
->value
.user_name
:
436 &new_value
->value
.group_name
;
438 new_value
->type
= value
->type
;
454 unsigned long process_attr_value_hash(const struct process_attr_value
*a
)
456 unsigned long hash
= hash_key_ulong((void *) a
->type
, lttng_ht_seed
);
459 case LTTNG_PROCESS_ATTR_VALUE_TYPE_PID
:
460 hash
^= hash_key_ulong((void *) (unsigned long) a
->value
.pid
,
463 case LTTNG_PROCESS_ATTR_VALUE_TYPE_UID
:
464 hash
^= hash_key_ulong((void *) (unsigned long) a
->value
.uid
,
467 case LTTNG_PROCESS_ATTR_VALUE_TYPE_GID
:
468 hash
^= hash_key_ulong((void *) (unsigned long) a
->value
.gid
,
471 case LTTNG_PROCESS_ATTR_VALUE_TYPE_USER_NAME
:
472 hash
^= hash_key_str(a
->value
.user_name
, lttng_ht_seed
);
474 case LTTNG_PROCESS_ATTR_VALUE_TYPE_GROUP_NAME
:
475 hash
^= hash_key_str(a
->value
.group_name
, lttng_ht_seed
);
485 bool process_attr_tracker_value_equal(const struct process_attr_value
*a
,
486 const struct process_attr_value
*b
)
488 if (a
->type
!= b
->type
) {
492 case LTTNG_PROCESS_ATTR_VALUE_TYPE_PID
:
493 return a
->value
.pid
== b
->value
.pid
;
494 case LTTNG_PROCESS_ATTR_VALUE_TYPE_UID
:
495 return a
->value
.uid
== b
->value
.uid
;
496 case LTTNG_PROCESS_ATTR_VALUE_TYPE_GID
:
497 return a
->value
.gid
== b
->value
.gid
;
498 case LTTNG_PROCESS_ATTR_VALUE_TYPE_USER_NAME
:
499 return !strcmp(a
->value
.user_name
, b
->value
.user_name
);
500 case LTTNG_PROCESS_ATTR_VALUE_TYPE_GROUP_NAME
:
501 return !strcmp(a
->value
.group_name
, b
->value
.group_name
);
508 void process_attr_value_destroy(struct process_attr_value
*value
)
513 if (is_value_type_name(value
->type
)) {
514 free(value
->type
== LTTNG_PROCESS_ATTR_VALUE_TYPE_USER_NAME
?
515 value
->value
.user_name
:
516 value
->value
.group_name
);