mirror of
https://github.com/varun-r-mallya/sysprof.git
synced 2025-12-31 20:36:25 +00:00
3a94170b0a
This is like sample but has an "enter/exit" flag with it. This can be useful when you want to provide tracing instead of sampling. We use a different frame type so that we can denote that this isn't traditional sampling, and the flag can be used to find the next exit for the current enter for calculating durations. The entire stack trace is provided to make things easier on tools which may want to deal with indirect functions that were not instrumented but can be unwound. That may allow for tooling to give the user some insight that it's not *just* this function entering, but some functions before it were entered too. This also adds a SysprofTracer instrument which will preload a libsysprof-tracer-6.so into the process providing the __cyg_profile_func_enter() and __cyg_profile_func_leave() hooks.
122 lines
6.9 KiB
C
122 lines
6.9 KiB
C
/* sysprof-collector.h
|
|
*
|
|
* Copyright 2020 Christian Hergert <chergert@redhat.com>
|
|
*
|
|
* Redistribution and use in source and binary forms, with or without
|
|
* modification, are permitted provided that the following conditions are
|
|
* met:
|
|
*
|
|
* 1. Redistributions of source code must retain the above copyright notice,
|
|
* this list of conditions and the following disclaimer.
|
|
*
|
|
* 2. Redistributions in binary form must reproduce the above copyright
|
|
* notice, this list of conditions and the following disclaimer in the
|
|
* documentation and/or other materials provided with the distribution.
|
|
*
|
|
* Subject to the terms and conditions of this license, each copyright holder
|
|
* and contributor hereby grants to those receiving rights under this license
|
|
* a perpetual, worldwide, non-exclusive, no-charge, royalty-free,
|
|
* irrevocable (except for failure to satisfy the conditions of this license)
|
|
* patent license to make, have made, use, offer to sell, sell, import, and
|
|
* otherwise transfer this software, where such license applies only to those
|
|
* patent claims, already acquired or hereafter acquired, licensable by such
|
|
* copyright holder or contributor that are necessarily infringed by:
|
|
*
|
|
* (a) their Contribution(s) (the licensed copyrights of copyright holders
|
|
* and non-copyrightable additions of contributors, in source or binary
|
|
* form) alone; or
|
|
*
|
|
* (b) combination of their Contribution(s) with the work of authorship to
|
|
* which such Contribution(s) was added by such copyright holder or
|
|
* contributor, if, at the time the Contribution is added, such addition
|
|
* causes such combination to be necessarily infringed. The patent license
|
|
* shall not apply to any other combinations which include the
|
|
* Contribution.
|
|
*
|
|
* Except as expressly stated above, no rights or licenses from any copyright
|
|
* holder or contributor is granted under this license, whether expressly, by
|
|
* implication, estoppel or otherwise.
|
|
*
|
|
* DISCLAIMER
|
|
*
|
|
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS
|
|
* IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
|
|
* THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
|
|
* PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDERS OR
|
|
* CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
|
|
* EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
|
|
* PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
|
|
* PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
|
|
* LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
|
|
* NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
|
|
* SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
|
|
*
|
|
* SPDX-License-Identifier: BSD-2-Clause-Patent
|
|
*/
|
|
|
|
#pragma once
|
|
|
|
#include <stdarg.h>
|
|
|
|
#include "sysprof-capture-types.h"
|
|
#include "sysprof-macros.h"
|
|
|
|
SYSPROF_BEGIN_DECLS
|
|
|
|
SYSPROF_AVAILABLE_IN_3_36
|
|
void sysprof_collector_init (void);
|
|
SYSPROF_AVAILABLE_IN_3_38
|
|
bool sysprof_collector_is_active (void);
|
|
SYSPROF_AVAILABLE_IN_3_36
|
|
void sysprof_collector_allocate (SysprofCaptureAddress alloc_addr,
|
|
int64_t alloc_size,
|
|
SysprofBacktraceFunc backtrace_func,
|
|
void *backtrace_data);
|
|
SYSPROF_AVAILABLE_IN_3_36
|
|
void sysprof_collector_sample (SysprofBacktraceFunc backtrace_func,
|
|
void *backtrace_data);
|
|
SYSPROF_AVAILABLE_IN_ALL
|
|
void sysprof_collector_trace (SysprofBacktraceFunc backtrace_func,
|
|
void *backtrace_data,
|
|
bool entering);
|
|
SYSPROF_AVAILABLE_IN_3_36
|
|
void sysprof_collector_mark (int64_t time,
|
|
int64_t duration,
|
|
const char *group,
|
|
const char *mark,
|
|
const char *message);
|
|
SYSPROF_AVAILABLE_IN_3_38
|
|
void sysprof_collector_mark_printf (int64_t time,
|
|
int64_t duration,
|
|
const char *group,
|
|
const char *mark,
|
|
const char *message_format,
|
|
...) SYSPROF_PRINTF(5, 6);
|
|
SYSPROF_AVAILABLE_IN_3_38
|
|
void sysprof_collector_mark_vprintf (int64_t time,
|
|
int64_t duration,
|
|
const char *group,
|
|
const char *mark,
|
|
const char *message_format,
|
|
va_list args) SYSPROF_PRINTF(5, 0);
|
|
SYSPROF_AVAILABLE_IN_3_36
|
|
void sysprof_collector_log (int severity,
|
|
const char *domain,
|
|
const char *message);
|
|
SYSPROF_AVAILABLE_IN_3_38
|
|
void sysprof_collector_log_printf (int severity,
|
|
const char *domain,
|
|
const char *format,
|
|
...) SYSPROF_PRINTF (3, 4);
|
|
SYSPROF_AVAILABLE_IN_3_38
|
|
unsigned int sysprof_collector_request_counters (unsigned int n_counters);
|
|
SYSPROF_AVAILABLE_IN_3_38
|
|
void sysprof_collector_define_counters (const SysprofCaptureCounter *counters,
|
|
unsigned int n_counters);
|
|
SYSPROF_AVAILABLE_IN_3_38
|
|
void sysprof_collector_set_counters (const unsigned int *counters_ids,
|
|
const SysprofCaptureCounterValue *values,
|
|
unsigned int n_counters);
|
|
|
|
SYSPROF_END_DECLS
|