mirrors/pipewire
1
0
Fork 0
mirror of https://gitlab.freedesktop.org/pipewire/pipewire.git synced 2025-11-06 13:30:01 -05:00
Code Issues Projects Releases Packages Wiki Activity Actions

pw-profiler: add profiler tool

Browse source 
Add Profiler object and fields.
Add profiler extension API. It notifies Profiler objects with
real-time performance data.
Add module that implements the profiler extension.
Add pw-profiler tool that binds to the profiler API and dumps the
data into a log file, gnuplot files, a html page and a script to
generate svg graphs. This is almost the same as what JACK2
JackEngineProfiling does.
This commit is contained in:
Wim Taymans 2020-01-31 15:07:26 +01:00
parent 5a47652dc2
commit 3317af804b
13 changed files with 1182 additions and 1 deletions
Download patch file Download diff file Expand all files Collapse all files

10
src/modules/meson.build
View file

@ -13,6 +13,16 @@ pipewire_module_access = shared_library('pipewire-module-access', [ 'module-acce
dependencies : [mathlib, dl_lib, pipewire_dep],
)
pipewire_module_profiler = shared_library('pipewire-module-profiler',
[ 'module-profiler.c',
'module-profiler/protocol-native.c', ],
c_args : pipewire_module_c_args,
include_directories : [configinc, spa_inc],
install : true,
install_dir : modules_install_dir,
dependencies : [mathlib, dl_lib, pipewire_dep],
)
if dbus_dep.found()
pipewire_module_rtkit = shared_library('pipewire-module-rtkit', [ 'module-rtkit.c' ],
c_args : pipewire_module_c_args,

372
src/modules/module-profiler.c Normal file
View file

@ -0,0 +1,372 @@
/* PipeWire
*
* Copyright © 2020 Wim Taymans
*
* Permission is hereby granted, free of charge, to any person obtaining a
* copy of this software and associated documentation files (the "Software"),
* to deal in the Software without restriction, including without limitation
* the rights to use, copy, modify, merge, publish, distribute, sublicense,
* and/or sell copies of the Software, and to permit persons to whom the
* Software is furnished to do so, subject to the following conditions:
*
* The above copyright notice and this permission notice (including the next
* paragraph) shall be included in all copies or substantial portions of the
* Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
* THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
* FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
* DEALINGS IN THE SOFTWARE.
*/
#include <string.h>
#include <stdio.h>
#include <errno.h>
#include <sys/types.h>
#include <sys/stat.h>
#include <fcntl.h>
#include <unistd.h>
#include "config.h"
#include <spa/utils/result.h>
#include <spa/utils/ringbuffer.h>
#include <spa/param/profiler.h>
#include <spa/debug/pod.h>
#include <pipewire/private.h>
#include <pipewire/impl.h>
#include <extensions/profiler.h>
#define NAME "profiler"
#define MAX_BUFFER (8 * 1024 * 1024)
#define MIN_FLUSH (16 * 1024)
#define DEFAULT_IDLE 5
#define DEFAULT_INTERVAL 1
int pw_protocol_native_ext_profiler_init(struct pw_context *context);
#define pw_profiler_resource(r,m,v,...) \
pw_resource_call(r,struct pw_profiler_events,m,v,__VA_ARGS__)
#define pw_profiler_resource_profile(r,...) \
pw_profiler_resource(r,profile,0,__VA_ARGS__)
static const struct spa_dict_item module_props[] = {
{ PW_KEY_MODULE_AUTHOR, "Wim Taymans <wim.taymans@gmail.com>" },
{ PW_KEY_MODULE_DESCRIPTION, "Generate Profiling data" },
{ PW_KEY_MODULE_VERSION, PACKAGE_VERSION },
};
struct impl {
struct pw_context *context;
struct pw_properties *properties;
struct spa_hook context_listener;
struct spa_hook module_listener;
struct pw_global *global;
int64_t count;
uint32_t busy;
uint32_t empty;
struct spa_source *flush_timeout;
unsigned int flushing:1;
unsigned int listening:1;
struct spa_ringbuffer buffer;
uint8_t data[MAX_BUFFER];
};
struct resource_data {
struct impl *impl;
struct pw_resource *resource;
struct spa_hook resource_listener;
};
static void start_flush(struct impl *impl)
{
struct timespec value, interval;
value.tv_sec = 0;
value.tv_nsec = 1;
interval.tv_sec = DEFAULT_INTERVAL;
interval.tv_nsec = 0;
pw_loop_update_timer(impl->context->main_loop,
impl->flush_timeout, &value, &interval, false);
impl->flushing = true;
}
static void stop_flush(struct impl *impl)
{
struct timespec value, interval;
if (!impl->flushing)
return;
value.tv_sec = 0;
value.tv_nsec = 0;
interval.tv_sec = 0;
interval.tv_nsec = 0;
pw_loop_update_timer(impl->context->main_loop,
impl->flush_timeout, &value, &interval, false);
impl->flushing = false;
}
static void flush_timeout(void *data, uint64_t expirations)
{
struct impl *impl = data;
int32_t avail, size;
uint32_t idx;
struct spa_pod_struct *p;
struct pw_resource *resource;
avail = spa_ringbuffer_get_read_index(&impl->buffer, &idx);
pw_log_trace(NAME"%p avail %d", impl, avail);
if (avail <= 0) {
if (++impl->empty == DEFAULT_IDLE)
stop_flush(impl);
return;
}
impl->empty = 0;
size = avail + sizeof(struct spa_pod_struct);
p = alloca(size);
*p = SPA_POD_INIT_Struct(avail);
spa_ringbuffer_read_data(&impl->buffer, impl->data, MAX_BUFFER,
idx % MAX_BUFFER,
SPA_MEMBER(p, sizeof(struct spa_pod_struct), void), avail);
spa_ringbuffer_read_update(&impl->buffer, idx + avail);
spa_list_for_each(resource, &impl->global->resource_list, link)
pw_profiler_resource_profile(resource, &p->pod);
}
static void context_start(void *data, struct pw_impl_node *node)
{
struct impl *impl = data;
char buffer[4096];
struct spa_pod_builder b;
struct spa_pod_frame f[2];
struct pw_node_activation *a = node->rt.activation;
struct spa_io_position *pos = &a->position;
struct pw_node_target *t;
int32_t filled;
uint32_t idx, avail;
spa_pod_builder_init(&b, buffer, sizeof(buffer));
spa_pod_builder_push_object(&b, &f[0],
SPA_TYPE_OBJECT_Profiler, 0);
spa_pod_builder_prop(&b, SPA_PROFILER_driverBlock, 0);
spa_pod_builder_add_struct(&b,
SPA_POD_Long(impl->count),
SPA_POD_Int(node->info.id),
SPA_POD_String(node->name),
SPA_POD_Float(a->cpu_load[0]),
SPA_POD_Float(a->cpu_load[1]),
SPA_POD_Float(a->cpu_load[2]),
SPA_POD_Long(pos->clock.nsec),
SPA_POD_Fraction(&pos->clock.rate),
SPA_POD_Long(pos->clock.position),
SPA_POD_Long(pos->clock.duration),
SPA_POD_Long(pos->clock.delay),
SPA_POD_Double(pos->clock.rate_diff),
SPA_POD_Long(pos->clock.next_nsec),
SPA_POD_Long(a->prev_signal_time),
SPA_POD_Long(a->signal_time),
SPA_POD_Long(a->awake_time),
SPA_POD_Long(a->finish_time),
SPA_POD_Int(a->status));
spa_list_for_each(t, &node->rt.target_list, link) {
struct pw_impl_node *n = t->node;
struct pw_node_activation *na;
if (n == NULL || n == node)
continue;
na = n->rt.activation;
spa_pod_builder_prop(&b, SPA_PROFILER_followerBlock, 0);
spa_pod_builder_add_struct(&b,
SPA_POD_Int(n->info.id),
SPA_POD_String(n->name),
SPA_POD_Long(na->signal_time),
SPA_POD_Long(na->awake_time),
SPA_POD_Long(na->finish_time),
SPA_POD_Int(na->status));
}
spa_pod_builder_pop(&b, &f[0]);
filled = spa_ringbuffer_get_write_index(&impl->buffer, &idx);
if (filled < 0 || filled > MAX_BUFFER) {
pw_log_warn(NAME " %p: queue xrun %d", impl, filled);
goto done;
}
avail = MAX_BUFFER - filled;
if (avail < b.state.offset) {
pw_log_warn(NAME " %p: queue full %d < %d", impl, avail, b.state.offset);
goto done;
}
spa_ringbuffer_write_data(&impl->buffer,
impl->data, MAX_BUFFER,
idx % MAX_BUFFER,
b.data, b.state.offset);
spa_ringbuffer_write_update(&impl->buffer, idx + b.state.offset);
if (!impl->flushing || filled + b.state.offset > MIN_FLUSH)
start_flush(impl);
done:
impl->count++;
}
static const struct pw_context_driver_events context_events = {
PW_VERSION_CONTEXT_DRIVER_EVENTS,
.start = context_start,
};
static int do_stop(struct spa_loop *loop,
bool async, uint32_t seq, const void *data, size_t size, void *user_data)
{
struct impl *impl = user_data;
spa_hook_remove(&impl->context_listener);
return 0;
}
static void stop_listener(struct impl *impl)
{
if (impl->listening) {
pw_loop_invoke(impl->context->data_loop,
do_stop, SPA_ID_INVALID, NULL, 0, true, impl);
impl->listening = false;
}
}
static void resource_destroy(void *data)
{
struct impl *impl = data;
if (--impl->busy == 0) {
pw_log_info(NAME" %p: stopping profiler", impl);
stop_listener(impl);
}
}
static const struct pw_resource_events resource_events = {
PW_VERSION_RESOURCE_EVENTS,
.destroy = resource_destroy,
};
static int
do_start(struct spa_loop *loop,
bool async, uint32_t seq, const void *data, size_t size, void *user_data)
{
struct impl *impl = user_data;
spa_hook_list_append(&impl->context->driver_listener_list,
&impl->context_listener,
&context_events, impl);
return 0;
}
static int
global_bind(void *_data, struct pw_impl_client *client, uint32_t permissions,
uint32_t version, uint32_t id)
{
struct impl *impl = _data;
struct pw_global *global = impl->global;
struct pw_resource *resource;
struct resource_data *data;
resource = pw_resource_new(client, id, permissions,
PW_TYPE_INTERFACE_Profiler, version, sizeof(*data));
if (resource == NULL)
return -errno;
data = pw_resource_get_user_data(resource);
data->impl = impl;
data->resource = resource;
pw_global_add_resource(global, resource);
pw_resource_add_listener(resource, &data->resource_listener,
&resource_events, impl);
if (++impl->busy == 1) {
pw_log_info(NAME" %p: starting profiler", impl);
pw_loop_invoke(impl->context->data_loop,
do_start, SPA_ID_INVALID, NULL, 0, false, impl);
impl->listening = true;
}
return 0;
}
static void module_destroy(void *data)
{
struct impl *impl = data;
pw_global_destroy(impl->global);
spa_hook_remove(&impl->module_listener);
if (impl->properties)
pw_properties_free(impl->properties);
free(impl);
}
static const struct pw_impl_module_events module_events = {
PW_VERSION_IMPL_MODULE_EVENTS,
.destroy = module_destroy,
};
SPA_EXPORT
int pipewire__module_init(struct pw_impl_module *module, const char *args)
{
struct pw_context *context = pw_impl_module_get_context(module);
struct pw_properties *props;
struct impl *impl;
struct pw_loop *main_loop = pw_context_get_main_loop(context);
impl = calloc(1, sizeof(struct impl));
if (impl == NULL)
return -errno;
pw_protocol_native_ext_profiler_init(context);
pw_log_debug("module %p: new %s", impl, args);
if (args)
props = pw_properties_new_string(args);
else
props = pw_properties_new(NULL, NULL);
impl->context = context;
impl->properties = props;
spa_ringbuffer_init(&impl->buffer);
impl->global = pw_global_new(context,
PW_TYPE_INTERFACE_Profiler,
PW_VERSION_PROFILER,
pw_properties_copy(props),
global_bind, impl);
if (impl->global == NULL) {
free(impl);
return -errno;
}
impl->flush_timeout = pw_loop_add_timer(main_loop, flush_timeout, impl);
pw_impl_module_add_listener(module, &impl->module_listener, &module_events, impl);
pw_impl_module_update_properties(module, &SPA_DICT_INIT_ARRAY(module_props));
pw_global_register(impl->global);
return 0;
}

125
src/modules/module-profiler/protocol-native.c Normal file
View file

@ -0,0 +1,125 @@
/* PipeWire
*
* Copyright © 2019 Wim Taymans
*
* Permission is hereby granted, free of charge, to any person obtaining a
* copy of this software and associated documentation files (the "Software"),
* to deal in the Software without restriction, including without limitation
* the rights to use, copy, modify, merge, publish, distribute, sublicense,
* and/or sell copies of the Software, and to permit persons to whom the
* Software is furnished to do so, subject to the following conditions:
*
* The above copyright notice and this permission notice (including the next
* paragraph) shall be included in all copies or substantial portions of the
* Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
* THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
* FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
* DEALINGS IN THE SOFTWARE.
*/
#include <errno.h>
#include <spa/pod/builder.h>
#include <spa/pod/parser.h>
#include <spa/utils/result.h>
#include <pipewire/pipewire.h>
#include <extensions/protocol-native.h>
#include <extensions/profiler.h>
static int profiler_proxy_marshal_add_listener(void *object,
struct spa_hook *listener,
const struct pw_profiler_events *events,
void *data)
{
struct pw_proxy *proxy = object;
pw_proxy_add_object_listener(proxy, listener, events, data);
return 0;
}
static int profiler_demarshal_add_listener(void *object,
const struct pw_protocol_native_message *msg)
{
return -ENOTSUP;
}
static int profiler_resource_marshal_profile(void *object, const struct spa_pod *pod)
{
struct pw_resource *resource = object;
struct spa_pod_builder *b;
b = pw_protocol_native_begin_resource(resource, PW_PROFILER_EVENT_PROFILE, NULL);
spa_pod_builder_add_struct(b, SPA_POD_Pod(pod));
return pw_protocol_native_end_resource(resource, b);
}
static int profiler_proxy_demarshal_profile(void *object,
const struct pw_protocol_native_message *msg)
{
struct pw_proxy *proxy = object;
struct spa_pod_parser prs;
struct spa_pod *pod;
spa_pod_parser_init(&prs, msg->data, msg->size);
if (spa_pod_parser_get_struct(&prs, SPA_POD_Pod(&pod)) < 0)
return -EINVAL;
pw_proxy_notify(proxy, struct pw_profiler_events, profile, 0, pod);
return 0;
}
static const struct pw_profiler_methods pw_protocol_native_profiler_client_method_marshal = {
PW_VERSION_PROFILER_METHODS,
.add_listener = &profiler_proxy_marshal_add_listener,
};
static const struct pw_protocol_native_demarshal
pw_protocol_native_profiler_server_method_demarshal[PW_PROFILER_METHOD_NUM] =
{
[PW_PROFILER_METHOD_ADD_LISTENER] = { &profiler_demarshal_add_listener, 0 },
};
static const struct pw_profiler_events pw_protocol_native_profiler_server_event_marshal = {
PW_VERSION_PROFILER_EVENTS,
.profile = &profiler_resource_marshal_profile,
};
static const struct pw_protocol_native_demarshal
pw_protocol_native_profiler_client_event_demarshal[PW_PROFILER_EVENT_NUM] =
{
[PW_PROFILER_EVENT_PROFILE] = { &profiler_proxy_demarshal_profile, 0 },
};
static const struct pw_protocol_marshal pw_protocol_native_profiler_marshal = {
PW_TYPE_INTERFACE_Profiler,
PW_VERSION_PROFILER,
0,
PW_PROFILER_METHOD_NUM,
PW_PROFILER_EVENT_NUM,
.client_marshal = &pw_protocol_native_profiler_client_method_marshal,
.server_demarshal = pw_protocol_native_profiler_server_method_demarshal,
.server_marshal = &pw_protocol_native_profiler_server_event_marshal,
.client_demarshal = pw_protocol_native_profiler_client_event_demarshal,
};
int pw_protocol_native_ext_profiler_init(struct pw_context *context)
{
struct pw_protocol *protocol;
protocol = pw_context_find_protocol(context, PW_TYPE_INFO_PROTOCOL_Native);
if (protocol == NULL)
return -EPROTO;
pw_protocol_add_marshal(protocol, &pw_protocol_native_profiler_marshal);
return 0;
}