numam-spdk/include/spdk/trace.h
Daniel Verkamp bdece622f5 trace: add tracepoint library and app
Change-Id: I472fb7e7a82e1337c6c06b1d3bb4e8a2a13d884a
Signed-off-by: Daniel Verkamp <daniel.verkamp@intel.com>
2016-05-11 10:43:09 -07:00

185 lines
5.6 KiB
C

/*-
* BSD LICENSE
*
* Copyright (c) Intel Corporation.
* All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
*
* * Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
* * 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.
* * Neither the name of Intel Corporation nor the names of its
* contributors may be used to endorse or promote products derived
* from this software without specific prior written permission.
*
* 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
* OWNER 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.
*/
/**
* \file
* Tracepoint library
*/
#ifndef _SPDK_TRACE_H_
#define _SPDK_TRACE_H_
#include <inttypes.h>
#include <limits.h>
#include <rte_config.h>
#include <rte_lcore.h>
#ifdef __cplusplus
extern "C" {
#endif
#define SPDK_TRACE_SIZE (32 * 1024)
struct spdk_trace_entry {
uint64_t tsc;
uint16_t tpoint_id;
uint16_t poller_id;
uint32_t size;
uint64_t object_id;
uint64_t arg1;
};
/* If type changes from a uint8_t, change this value. */
#define SPDK_TRACE_MAX_OWNER (UCHAR_MAX + 1)
struct spdk_trace_owner {
uint8_t type;
char id_prefix;
};
/* If type changes from a uint8_t, change this value. */
#define SPDK_TRACE_MAX_OBJECT (UCHAR_MAX + 1)
struct spdk_trace_object {
uint8_t type;
char id_prefix;
};
#define SPDK_TRACE_MAX_GROUP_ID 16
#define SPDK_TRACE_MAX_TPOINT_ID (SPDK_TRACE_MAX_GROUP_ID * 64)
#define SPDK_TPOINT_ID(group, tpoint) ((group * 64) + tpoint)
struct spdk_trace_tpoint {
char name[24];
char short_name[4];
uint16_t tpoint_id;
uint8_t owner_type;
uint8_t object_type;
uint8_t new_object;
uint8_t arg1_is_ptr;
uint8_t arg1_is_alias;
char arg1_name[8];
};
struct spdk_trace_history {
/** Logical core number associated with this structure instance. */
int lcore;
/**
* Circular buffer of spdk_trace_entry structures for tracing
* tpoints on this core. Debug tool spdk_trace reads this
* buffer from shared memory to post-process the tpoint entries and
* display in a human-readable format.
*/
struct spdk_trace_entry entries[SPDK_TRACE_SIZE];
/**
* Running count of number of occurrences of each tracepoint on this
* lcore. Debug tools can use this to easily count tracepoints such as
* number of SCSI tasks completed or PDUs read.
*/
uint64_t tpoint_count[SPDK_TRACE_MAX_TPOINT_ID];
/** Index to next spdk_trace_entry to fill in the circular buffer. */
uint32_t next_entry;
};
struct spdk_trace_histories {
uint64_t tsc_rate;
uint64_t tpoint_mask[SPDK_TRACE_MAX_GROUP_ID];
struct spdk_trace_history per_lcore_history[RTE_MAX_LCORE];
struct spdk_trace_owner owner[UCHAR_MAX + 1];
struct spdk_trace_object object[UCHAR_MAX + 1];
struct spdk_trace_tpoint tpoint[SPDK_TRACE_MAX_TPOINT_ID];
};
void spdk_trace_record(uint16_t tpoint_id, uint16_t poller_id, uint32_t size,
uint64_t object_id, uint64_t arg1);
/** Returns the current tpoint mask. */
uint64_t spdk_trace_get_tpoint_mask(uint32_t group_id);
/** Adds the specified tpoints to the current tpoint mask for the given tpoint group. */
void spdk_trace_set_tpoints(uint32_t group_id, uint64_t tpoint_mask);
/** Clears the specified tpoints from the current tpoint mask for the given tpoint group. */
void spdk_trace_clear_tpoints(uint32_t group_id, uint64_t tpoint_mask);
/** Returns a mask of all tracepoint groups which have at least one tracepoint enabled. */
uint64_t spdk_trace_get_tpoint_group_mask(void);
/** For each tpoint group specified in the group mask, enable all of its tpoints. */
void spdk_trace_set_tpoint_group_mask(uint64_t tpoint_group_mask);
void spdk_trace_init(const char *shm_name);
void spdk_trace_cleanup(void);
#define OWNER_NONE 0
#define OBJECT_NONE 0
void spdk_trace_register_owner(uint8_t type, char id_prefix);
void spdk_trace_register_object(uint8_t type, char id_prefix);
void spdk_trace_register_description(const char *name, const char *short_name,
uint16_t tpoint_id, uint8_t owner_type,
uint8_t object_type, uint8_t new_object,
uint8_t arg1_is_ptr, uint8_t arg1_is_alias,
const char *arg1_name);
struct spdk_trace_register_fn {
void (*reg_fn)(void);
struct spdk_trace_register_fn *next;
};
void spdk_trace_add_register_fn(struct spdk_trace_register_fn *reg_fn);
#define SPDK_TRACE_REGISTER_FN(fn) \
static void fn(void); \
struct spdk_trace_register_fn reg_ ## fn = { \
.reg_fn = fn, \
.next = NULL, \
}; \
__attribute__((constructor)) static void _ ## fn(void) \
{ \
spdk_trace_add_register_fn(&reg_ ## fn); \
} \
static void fn(void)
#ifdef __cplusplus
}
#endif
#endif