2 * Copyright (C) 2017 - Jérémie Galarneau <jeremie.galarneau@efficios.com>
3 * Copyright (C) 2018 - Francis Deslauriers <francis.deslauriers@efficios.com>
5 * This library is free software; you can redistribute it and/or modify it
6 * under the terms of the GNU Lesser General Public License, version 2.1 only,
7 * as published by the Free Software Foundation.
9 * This library is distributed in the hope that it will be useful, but WITHOUT
10 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
11 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License
14 * You should have received a copy of the GNU Lesser General Public License
15 * along with this library; if not, write to the Free Software Foundation,
16 * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
19 #ifndef LTTNG_USERSPACE_PROBE_INTERNAL_H
20 #define LTTNG_USERSPACE_PROBE_INTERNAL_H
22 #include <lttng/userspace-probe.h>
23 #include <common/macros.h>
24 #include <common/dynamic-buffer.h>
25 #include <common/buffer-view.h>
28 * No elf-specific comm structure is defined since no elf-specific payload is
31 struct lttng_userspace_probe_location_lookup_method_comm
{
32 /* enum lttng_userspace_probe_location_lookup_method_type */
34 /* type-specific payload */
38 /* Common ancestor of all userspace probe location lookup methods. */
39 struct lttng_userspace_probe_location_lookup_method
{
40 enum lttng_userspace_probe_location_lookup_method_type type
;
43 struct lttng_userspace_probe_location_lookup_method_elf
{
44 struct lttng_userspace_probe_location_lookup_method parent
;
47 struct lttng_userspace_probe_location_lookup_method_sdt
{
48 struct lttng_userspace_probe_location_lookup_method parent
;
51 struct lttng_userspace_probe_location_comm
{
52 /* enum lttng_userspace_probe_location_type */
55 * Payload is composed of, in that order,
56 * - type-specific payload
57 * - struct lttng_userspace_probe_location_lookup_method_comm
62 struct lttng_userspace_probe_location_function_comm
{
63 /* Both lengths include the trailing \0. */
64 uint32_t function_name_len
;
65 uint32_t binary_path_len
;
67 * Payload is composed of, in that order,
68 * - function name (with trailing \0),
69 * - absolute binary path (with trailing \0)
74 struct lttng_userspace_probe_location_tracepoint_comm
{
75 /* The three lengths include the trailing \0. */
76 uint32_t probe_name_len
;
77 uint32_t provider_name_len
;
78 uint32_t binary_path_len
;
80 * Payload is composed of, in that order,
81 * - probe name (with trailing \0),
82 * - provider name (with trailing \0),
83 * - absolute binary path (with trailing \0)
88 /* Common ancestor of all userspace probe locations. */
89 struct lttng_userspace_probe_location
{
90 enum lttng_userspace_probe_location_type type
;
91 struct lttng_userspace_probe_location_lookup_method
*lookup_method
;
94 struct lttng_userspace_probe_location_function
{
95 struct lttng_userspace_probe_location parent
;
99 * binary_fd is a file descriptor to the executable file. It's open
100 * early on to keep the backing inode valid over the course of the
101 * intrumentation and use. It prevents deletion and reuse races.
102 * Set to -1 if not open.
105 enum lttng_userspace_probe_location_function_instrumentation_type instrumentation_type
;
108 struct lttng_userspace_probe_location_tracepoint
{
109 struct lttng_userspace_probe_location parent
;
114 * binary_fd is a file descriptor to the executable file. It's open
115 * early on to keep the backing inode valid over the course of the
116 * intrumentation and use. It prevents deletion and reuse races.
117 * Set to -1 if not open.
123 int lttng_userspace_probe_location_serialize(
124 const struct lttng_userspace_probe_location
*location
,
125 struct lttng_dynamic_buffer
*buffer
,
129 int lttng_userspace_probe_location_create_from_buffer(
130 const struct lttng_buffer_view
*buffer
,
131 struct lttng_userspace_probe_location
**probe_location
);
134 int lttng_userspace_probe_location_function_set_binary_fd(
135 struct lttng_userspace_probe_location
*location
, int binary_fd
);
138 int lttng_userspace_probe_location_tracepoint_set_binary_fd(
139 struct lttng_userspace_probe_location
*location
, int binary_fd
);
142 * Returns a version of the location that is serialized to a contiguous region
143 * of memory. Pass NULL to buffer to only get the storage requirement of the
144 * flattened userspace probe location.
147 int lttng_userspace_probe_location_flatten(
148 const struct lttng_userspace_probe_location
*location
,
149 struct lttng_dynamic_buffer
*buffer
);
152 struct lttng_userspace_probe_location
*lttng_userspace_probe_location_copy(
153 const struct lttng_userspace_probe_location
*location
);
155 #endif /* LTTNG_USERSPACE_PROBE_INTERNAL_H */