mirror of
https://gitlab.uni-freiburg.de/opensourcevdi/spice-common
synced 2026-01-07 09:37:19 +00:00
2e914f3305
Allow to use recorder library. See https://github.com/c3d/recorder for details. The main usage will be to collect statistics while the programs will run. By default the recorder will be disabled at compile time. The idea of the usage in SPICE is to collect data while the program run. Using current SPICE logging facility was discussed but not easy to filter data. Other solutions (SystemTap, LTTng) were discarded due to not cross platform. A printf based solution was discussed too but missing the additional tools which are useful. Currently we don't plan to use as extensively as to be a problem to be replaced or removed in the future. Both Autoconf and Meson build systems are supported. Autoconf requires the addition of SPICE_CHECK_RECORDER call in configure.ac. Meson requires to add recorder option. Signed-off-by: Frediano Ziglio <fziglio@redhat.com> Acked-by: Victor Toso <victortoso@redhat.com>
75 lines
2.6 KiB
C
75 lines
2.6 KiB
C
/*
|
|
Copyright (C) 2018 Red Hat, Inc.
|
|
|
|
This library is free software; you can redistribute it and/or
|
|
modify it under the terms of the GNU Lesser General Public
|
|
License as published by the Free Software Foundation; either
|
|
version 2.1 of the License, or (at your option) any later version.
|
|
|
|
This library is distributed in the hope that it will be useful,
|
|
but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
|
|
Lesser General Public License for more details.
|
|
|
|
You should have received a copy of the GNU Lesser General Public
|
|
License along with this library; if not, see <http://www.gnu.org/licenses/>.
|
|
*/
|
|
/* This file include recorder library headers or if disabled provide
|
|
* replacement declarations */
|
|
#ifndef ENABLE_RECORDER
|
|
|
|
#include <stdio.h>
|
|
#include <stdint.h>
|
|
|
|
/* Replacement declarations.
|
|
* There declarations should generate no code (beside when no optimization are
|
|
* selected) but catch some possible programming warnings/errors at
|
|
* compile/link time like:
|
|
* - usage of undeclared recorders;
|
|
* - recording formats and arguments;
|
|
* - matching RECORD_TIMING_BEGIN and RECORD_TIMING_END.
|
|
* The only exceptions are tweaks which just generate a variable to hold the
|
|
* value.
|
|
*/
|
|
|
|
typedef struct SpiceEmptyStruct {
|
|
char dummy[0];
|
|
} SpiceEmptyStruct;
|
|
|
|
typedef struct SpiceDummyTweak {
|
|
intptr_t tweak_value;
|
|
} SpiceDummyTweak;
|
|
|
|
#define RECORDER_DECLARE(rec) \
|
|
extern const SpiceEmptyStruct spice_recorder_ ## rec
|
|
#define RECORDER(rec, num_rings, comment) \
|
|
RECORDER_DEFINE(rec, num_rings, comment)
|
|
#define RECORDER_DEFINE(rec, num_rings, comment) \
|
|
const SpiceEmptyStruct spice_recorder_ ## rec = {}
|
|
#define RECORDER_TRACE(rec) \
|
|
(sizeof(spice_recorder_ ## rec) != sizeof(SpiceEmptyStruct))
|
|
#define RECORDER_TWEAK_DECLARE(rec) \
|
|
extern const SpiceDummyTweak spice_recorder_tweak_ ## rec
|
|
#define RECORDER_TWEAK_DEFINE(rec, value, comment) \
|
|
const SpiceDummyTweak spice_recorder_tweak_ ## rec = { (value) }
|
|
#define RECORDER_TWEAK(rec) \
|
|
((spice_recorder_tweak_ ## rec).tweak_value)
|
|
#define RECORD(rec, format, ...) do { \
|
|
if (sizeof((spice_recorder_ ## rec).dummy)) printf(format, ##__VA_ARGS__); \
|
|
} while(0)
|
|
#define RECORD_TIMING_BEGIN(rec) \
|
|
do { RECORD(rec, "begin");
|
|
#define RECORD_TIMING_END(rec, op, name, value) \
|
|
RECORD(rec, "end" op name); \
|
|
} while(0)
|
|
#define record(...) \
|
|
RECORD(__VA_ARGS__)
|
|
static inline void
|
|
recorder_dump_on_common_signals(unsigned add, unsigned remove)
|
|
{
|
|
}
|
|
|
|
#else
|
|
#include <common/recorder/recorder.h>
|
|
#endif
|