Re: [PATCH v4 02/24] tracing: Introduce trace remotes

[Steven Rostedt <rostedt@goodmis.org>]

On Tue,  6 May 2025 17:47:58 +0100
Vincent Donnefort <vdonnefort@google.com> wrote:

> +
> +static bool trace_remote_loaded(struct trace_remote *remote)
> +{
> +	return remote->trace_buffer;
> +}
> +
> +static bool trace_remote_busy(struct trace_remote *remote)

Can you add comments to what these functions are doing?

Doesn't need to be kerneldoc (it actually shouldn't be), but describe why
they would return true and why they would return false.

> +{
> +	return trace_remote_loaded(remote) &&
> +		(remote->nr_readers || remote->tracing_on ||
> +		 !ring_buffer_empty(remote->trace_buffer));
> +}
> +
> +static int trace_remote_load(struct trace_remote *remote)
> +{
> +	struct ring_buffer_remote *rb_remote = &remote->rb_remote;
> +
> +	lockdep_assert_held(&remote->lock);
> +
> +	if (trace_remote_loaded(remote))
> +		return 0;
> +
> +	remote->trace_buffer_desc = remote->cbs->load_trace_buffer(remote->trace_buffer_size,
> +								   remote->priv);
> +	if (!remote->trace_buffer_desc)
> +		return -ENOMEM;

The error may not be -ENOMEM, have the load_trace_buffer return an ERR_PTR
and then you can return:

	if (IS_ERR(remote->trace_buffer_desc)
		return PTR_ERR(remote->trace_buffer_desc);


> +
> +	rb_remote->desc = remote->trace_buffer_desc;
> +	rb_remote->swap_reader_page = remote->cbs->swap_reader_page;
> +	rb_remote->priv = remote->priv;
> +	remote->trace_buffer = ring_buffer_remote(rb_remote);
> +	if (!remote->trace_buffer) {

Same here.

> +		remote->cbs->unload_trace_buffer(remote->trace_buffer_desc, remote->priv);
> +		return -ENOMEM;
> +	}
> +
> +	return 0;
> +}
> +
> +static void trace_remote_unload(struct trace_remote *remote)
> +{
> +	lockdep_assert_held(&remote->lock);
> +
> +	if (!trace_remote_loaded(remote) || trace_remote_busy(remote))
> +		return;

Can this cause leaks? Should trace_remote_unload() return an error value to
let the caller know it wasn't unloaded?

> +
> +	ring_buffer_free(remote->trace_buffer);
> +	remote->trace_buffer = NULL;
> +	remote->cbs->unload_trace_buffer(remote->trace_buffer_desc, remote->priv);
> +}
> +

Short description of what trace_remote_start does.

> +static int trace_remote_start(struct trace_remote *remote)
> +{
> +	int ret;
> +
> +	lockdep_assert_held(&remote->lock);
> +
> +	if (remote->tracing_on)
> +		return 0;
> +
> +	ret = trace_remote_load(remote);
> +	if (ret)
> +		return ret;
> +
> +	ret = remote->cbs->enable_tracing(true, remote->priv);
> +	if (ret) {
> +		trace_remote_unload(remote);
> +		return ret;
> +	}
> +
> +	remote->tracing_on = true;
> +
> +	return 0;
> +}
> +

Same for stop.

-- Steve

> +static int trace_remote_stop(struct trace_remote *remote)
> +{
> +	int ret;
> +
> +	lockdep_assert_held(&remote->lock);
> +
> +	if (!remote->tracing_on)
> +		return 0;
> +
> +	ret = remote->cbs->enable_tracing(false, remote->priv);
> +	if (ret)
> +		return ret;
> +
> +	ring_buffer_poll_remote(remote->trace_buffer, RING_BUFFER_ALL_CPUS);
> +	remote->tracing_on = false;
> +	trace_remote_unload(remote);
> +
> +	return 0;
> +}