2016-05-10 23:17:51 +00:00
|
|
|
/*-
|
|
|
|
* 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.
|
|
|
|
*/
|
|
|
|
|
2017-05-02 18:18:25 +00:00
|
|
|
#include "spdk/stdinc.h"
|
|
|
|
|
2016-08-18 19:52:48 +00:00
|
|
|
#include "spdk/env.h"
|
2017-08-11 23:27:04 +00:00
|
|
|
#include "spdk/string.h"
|
2016-05-10 23:17:51 +00:00
|
|
|
#include "spdk/trace.h"
|
2018-11-15 17:07:01 +00:00
|
|
|
#include "spdk/util.h"
|
2018-11-15 03:01:51 +00:00
|
|
|
#include "spdk/barrier.h"
|
2016-05-10 23:17:51 +00:00
|
|
|
|
2018-03-09 17:08:57 +00:00
|
|
|
static int g_trace_fd = -1;
|
2016-05-10 23:17:51 +00:00
|
|
|
static char g_shm_name[64];
|
|
|
|
|
2018-08-31 21:02:11 +00:00
|
|
|
struct spdk_trace_histories *g_trace_histories;
|
2016-05-10 23:17:51 +00:00
|
|
|
|
|
|
|
void
|
2018-08-31 20:34:33 +00:00
|
|
|
_spdk_trace_record(uint64_t tsc, uint16_t tpoint_id, uint16_t poller_id, uint32_t size,
|
2018-08-31 21:02:11 +00:00
|
|
|
uint64_t object_id, uint64_t arg1)
|
2016-05-10 23:17:51 +00:00
|
|
|
{
|
|
|
|
struct spdk_trace_history *lcore_history;
|
|
|
|
struct spdk_trace_entry *next_entry;
|
2016-07-22 00:11:15 +00:00
|
|
|
unsigned lcore;
|
2018-11-15 03:01:51 +00:00
|
|
|
uint64_t next_circular_entry;
|
2016-05-10 23:17:51 +00:00
|
|
|
|
2017-12-11 22:47:00 +00:00
|
|
|
lcore = spdk_env_get_current_core();
|
2016-07-22 00:11:15 +00:00
|
|
|
if (lcore >= SPDK_TRACE_MAX_LCORE) {
|
|
|
|
return;
|
|
|
|
}
|
|
|
|
|
2018-11-15 17:07:01 +00:00
|
|
|
lcore_history = spdk_get_per_lcore_history(g_trace_histories, lcore);
|
2018-08-31 20:34:33 +00:00
|
|
|
if (tsc == 0) {
|
|
|
|
tsc = spdk_get_ticks();
|
|
|
|
}
|
2016-05-10 23:17:51 +00:00
|
|
|
|
|
|
|
lcore_history->tpoint_count[tpoint_id]++;
|
|
|
|
|
2018-11-15 03:01:51 +00:00
|
|
|
/* Get next entry index in the circular buffer */
|
|
|
|
next_circular_entry = lcore_history->next_entry & (lcore_history->num_entries - 1);
|
|
|
|
next_entry = &lcore_history->entries[next_circular_entry];
|
2016-05-10 23:17:51 +00:00
|
|
|
next_entry->tsc = tsc;
|
|
|
|
next_entry->tpoint_id = tpoint_id;
|
|
|
|
next_entry->poller_id = poller_id;
|
|
|
|
next_entry->size = size;
|
|
|
|
next_entry->object_id = object_id;
|
|
|
|
next_entry->arg1 = arg1;
|
|
|
|
|
2018-11-15 03:01:51 +00:00
|
|
|
/* Ensure all elements of the trace entry are visible to outside trace tools */
|
|
|
|
spdk_smp_wmb();
|
2016-05-10 23:17:51 +00:00
|
|
|
lcore_history->next_entry++;
|
|
|
|
}
|
|
|
|
|
2018-03-09 17:08:57 +00:00
|
|
|
int
|
2018-11-13 17:23:16 +00:00
|
|
|
spdk_trace_init(const char *shm_name, uint64_t num_entries)
|
2016-05-10 23:17:51 +00:00
|
|
|
{
|
|
|
|
int i = 0;
|
2018-11-15 17:07:01 +00:00
|
|
|
int histories_size;
|
|
|
|
uint64_t lcore_offsets[SPDK_TRACE_MAX_LCORE + 1];
|
|
|
|
|
|
|
|
lcore_offsets[0] = sizeof(struct spdk_trace_flags);
|
|
|
|
for (i = 1; i < (int)SPDK_COUNTOF(lcore_offsets); i++) {
|
|
|
|
lcore_offsets[i] = spdk_get_trace_history_size(num_entries) + lcore_offsets[i - 1];
|
|
|
|
}
|
|
|
|
histories_size = sizeof(struct spdk_trace_flags) + lcore_offsets[SPDK_TRACE_MAX_LCORE];
|
2016-05-10 23:17:51 +00:00
|
|
|
|
2017-02-10 17:39:12 +00:00
|
|
|
snprintf(g_shm_name, sizeof(g_shm_name), "%s", shm_name);
|
2016-05-10 23:17:51 +00:00
|
|
|
|
2018-03-09 17:08:57 +00:00
|
|
|
g_trace_fd = shm_open(shm_name, O_RDWR | O_CREAT, 0600);
|
|
|
|
if (g_trace_fd == -1) {
|
2016-05-10 23:17:51 +00:00
|
|
|
fprintf(stderr, "could not shm_open spdk_trace\n");
|
2017-11-07 12:56:52 +00:00
|
|
|
fprintf(stderr, "errno=%d %s\n", errno, spdk_strerror(errno));
|
2018-03-09 17:08:57 +00:00
|
|
|
return 1;
|
2016-05-10 23:17:51 +00:00
|
|
|
}
|
|
|
|
|
2018-11-13 17:23:16 +00:00
|
|
|
if (ftruncate(g_trace_fd, histories_size) != 0) {
|
2016-05-10 23:17:51 +00:00
|
|
|
fprintf(stderr, "could not truncate shm\n");
|
2018-03-09 17:08:57 +00:00
|
|
|
goto trace_init_err;
|
2016-05-10 23:17:51 +00:00
|
|
|
}
|
|
|
|
|
2018-11-13 17:23:16 +00:00
|
|
|
g_trace_histories = mmap(NULL, histories_size, PROT_READ | PROT_WRITE,
|
2018-03-09 17:08:57 +00:00
|
|
|
MAP_SHARED, g_trace_fd, 0);
|
2018-03-28 18:07:54 +00:00
|
|
|
if (g_trace_histories == MAP_FAILED) {
|
2016-05-10 23:17:51 +00:00
|
|
|
fprintf(stderr, "could not mmap shm\n");
|
2018-03-09 17:08:57 +00:00
|
|
|
goto trace_init_err;
|
2016-05-10 23:17:51 +00:00
|
|
|
}
|
|
|
|
|
2018-09-03 00:20:02 +00:00
|
|
|
/* TODO: On FreeBSD, mlock on shm_open'd memory doesn't seem to work. Docs say that kern.ipc.shm_use_phys=1
|
|
|
|
* should allow it, but forcing that doesn't seem to work either. So for now just skip mlock on FreeBSD
|
|
|
|
* altogether.
|
|
|
|
*/
|
|
|
|
#if defined(__linux__)
|
2018-11-13 17:23:16 +00:00
|
|
|
if (mlock(g_trace_histories, histories_size) != 0) {
|
2018-09-03 00:20:02 +00:00
|
|
|
fprintf(stderr, "Could not mlock shm for tracing - %s.\n", spdk_strerror(errno));
|
|
|
|
if (errno == ENOMEM) {
|
|
|
|
fprintf(stderr, "Check /dev/shm for old tracing files that can be deleted.\n");
|
|
|
|
}
|
|
|
|
goto trace_init_err;
|
|
|
|
}
|
|
|
|
#endif
|
|
|
|
|
2018-11-13 17:23:16 +00:00
|
|
|
memset(g_trace_histories, 0, histories_size);
|
2016-05-10 23:17:51 +00:00
|
|
|
|
2017-09-12 14:50:24 +00:00
|
|
|
g_trace_flags = &g_trace_histories->flags;
|
|
|
|
|
|
|
|
g_trace_flags->tsc_rate = spdk_get_ticks_hz();
|
2016-05-10 23:17:51 +00:00
|
|
|
|
2016-07-22 00:11:15 +00:00
|
|
|
for (i = 0; i < SPDK_TRACE_MAX_LCORE; i++) {
|
2018-11-13 17:23:16 +00:00
|
|
|
struct spdk_trace_history *lcore_history;
|
|
|
|
|
2018-11-15 17:07:01 +00:00
|
|
|
g_trace_flags->lcore_history_offsets[i] = lcore_offsets[i];
|
|
|
|
lcore_history = spdk_get_per_lcore_history(g_trace_histories, i);
|
2018-11-13 17:23:16 +00:00
|
|
|
lcore_history->lcore = i;
|
2018-11-15 17:07:01 +00:00
|
|
|
lcore_history->num_entries = num_entries;
|
2016-05-10 23:17:51 +00:00
|
|
|
}
|
2018-11-15 17:07:01 +00:00
|
|
|
g_trace_flags->lcore_history_offsets[SPDK_TRACE_MAX_LCORE] = lcore_offsets[SPDK_TRACE_MAX_LCORE];
|
2016-05-10 23:17:51 +00:00
|
|
|
|
2017-09-12 14:50:24 +00:00
|
|
|
spdk_trace_flags_init();
|
2018-03-09 17:08:57 +00:00
|
|
|
|
|
|
|
return 0;
|
|
|
|
|
|
|
|
trace_init_err:
|
2018-09-03 00:20:02 +00:00
|
|
|
if (g_trace_histories != MAP_FAILED) {
|
2018-11-13 17:23:16 +00:00
|
|
|
munmap(g_trace_histories, histories_size);
|
2018-09-03 00:20:02 +00:00
|
|
|
}
|
2018-03-09 17:08:57 +00:00
|
|
|
close(g_trace_fd);
|
|
|
|
g_trace_fd = -1;
|
|
|
|
shm_unlink(shm_name);
|
2018-09-03 00:20:02 +00:00
|
|
|
g_trace_histories = NULL;
|
2018-03-09 17:08:57 +00:00
|
|
|
|
|
|
|
return 1;
|
|
|
|
|
2016-05-10 23:17:51 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
void
|
|
|
|
spdk_trace_cleanup(void)
|
|
|
|
{
|
2018-08-31 22:16:39 +00:00
|
|
|
bool unlink;
|
2018-11-29 11:12:26 +00:00
|
|
|
int i;
|
|
|
|
struct spdk_trace_history *lcore_history;
|
2018-08-31 22:16:39 +00:00
|
|
|
|
|
|
|
if (g_trace_histories == NULL) {
|
|
|
|
return;
|
|
|
|
}
|
|
|
|
|
|
|
|
/*
|
2018-11-29 11:12:26 +00:00
|
|
|
* Only unlink the shm if there were no trace_entry recorded. This ensures the file
|
2018-08-31 22:16:39 +00:00
|
|
|
* can be used after this process exits/crashes for debugging.
|
|
|
|
* Note that we have to calculate this value before g_trace_histories gets unmapped.
|
|
|
|
*/
|
2018-11-29 11:12:26 +00:00
|
|
|
for (i = 0; i < SPDK_TRACE_MAX_LCORE; i++) {
|
|
|
|
lcore_history = spdk_get_per_lcore_history(g_trace_histories, i);
|
|
|
|
unlink = lcore_history->entries[0].tsc == 0;
|
|
|
|
if (!unlink) {
|
|
|
|
break;
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
2018-08-31 22:16:39 +00:00
|
|
|
munmap(g_trace_histories, sizeof(struct spdk_trace_histories));
|
|
|
|
g_trace_histories = NULL;
|
|
|
|
close(g_trace_fd);
|
|
|
|
|
|
|
|
if (unlink) {
|
|
|
|
shm_unlink(g_shm_name);
|
2018-02-22 23:50:51 +00:00
|
|
|
}
|
2016-05-10 23:17:51 +00:00
|
|
|
}
|