LCOV - code coverage report
Current view: top level - lib/trace_parser - trace.cpp (source / functions) Hit Total Coverage
Test: ut_cov_unit.info Lines: 0 188 0.0 %
Date: 2024-07-14 05:23:08 Functions: 0 21 0.0 %

          Line data    Source code
       1             : /*   SPDX-License-Identifier: BSD-3-Clause
       2             :  *   Copyright (C) 2021 Intel Corporation.
       3             :  *   All rights reserved.
       4             :  */
       5             : 
       6             : #include "spdk/stdinc.h"
       7             : #include "spdk/likely.h"
       8             : #include "spdk/log.h"
       9             : #include "spdk/trace_parser.h"
      10             : #include "spdk/util.h"
      11             : 
      12             : #include <exception>
      13             : #include <map>
      14             : #include <new>
      15             : 
      16             : struct entry_key {
      17           0 :         entry_key(uint16_t _lcore, uint64_t _tsc) : lcore(_lcore), tsc(_tsc) {}
      18             :         uint16_t lcore;
      19             :         uint64_t tsc;
      20             : };
      21             : 
      22             : class compare_entry_key
      23             : {
      24             : public:
      25           0 :         bool operator()(const entry_key &first, const entry_key &second) const
      26             :         {
      27           0 :                 if (first.tsc == second.tsc) {
      28           0 :                         return first.lcore < second.lcore;
      29             :                 } else {
      30           0 :                         return first.tsc < second.tsc;
      31             :                 }
      32             :         }
      33             : };
      34             : 
      35             : typedef std::map<entry_key, spdk_trace_entry *, compare_entry_key> entry_map;
      36             : 
      37             : struct argument_context {
      38             :         spdk_trace_entry        *entry;
      39             :         spdk_trace_entry_buffer *buffer;
      40             :         uint16_t                lcore;
      41             :         size_t                  offset;
      42             : 
      43           0 :         argument_context(spdk_trace_entry *entry, uint16_t lcore) :
      44           0 :                 entry(entry), lcore(lcore)
      45             :         {
      46           0 :                 buffer = reinterpret_cast<spdk_trace_entry_buffer *>(entry);
      47             : 
      48             :                 /* The first argument resides within the spdk_trace_entry structure, so the initial
      49             :                  * offset needs to be adjusted to the start of the spdk_trace_entry.args array
      50             :                  */
      51           0 :                 offset = offsetof(spdk_trace_entry, args) -
      52             :                          offsetof(spdk_trace_entry_buffer, data);
      53           0 :         }
      54             : };
      55             : 
      56             : struct object_stats {
      57             :         std::map<uint64_t, uint64_t>      index;
      58             :         std::map<uint64_t, uint64_t>      start;
      59             :         uint64_t                        counter;
      60             : 
      61           0 :         object_stats() : counter(0) {}
      62             : };
      63             : 
      64             : struct spdk_trace_parser {
      65             :         spdk_trace_parser(const spdk_trace_parser_opts *opts);
      66             :         ~spdk_trace_parser();
      67             :         spdk_trace_parser(const spdk_trace_parser &) = delete;
      68             :         spdk_trace_parser &operator=(const spdk_trace_parser &) = delete;
      69           0 :         const spdk_trace_flags *flags() const { return &_histories->flags; }
      70           0 :         uint64_t tsc_offset() const { return _tsc_offset; }
      71             :         bool next_entry(spdk_trace_parser_entry *entry);
      72             :         uint64_t entry_count(uint16_t lcore) const;
      73             : private:
      74             :         spdk_trace_entry_buffer *get_next_buffer(spdk_trace_entry_buffer *buf, uint16_t lcore);
      75             :         bool build_arg(argument_context *argctx, const spdk_trace_argument *arg, int argid,
      76             :                        spdk_trace_parser_entry *pe);
      77             :         void populate_events(spdk_trace_history *history, int num_entries);
      78             :         bool init(const spdk_trace_parser_opts *opts);
      79             :         void cleanup();
      80             : 
      81             :         spdk_trace_histories    *_histories;
      82             :         size_t                  _map_size;
      83             :         int                     _fd;
      84             :         uint64_t                _tsc_offset;
      85             :         entry_map               _entries;
      86             :         entry_map::iterator     _iter;
      87             :         object_stats            _stats[SPDK_TRACE_MAX_OBJECT];
      88             : };
      89             : 
      90             : uint64_t
      91           0 : spdk_trace_parser::entry_count(uint16_t lcore) const
      92             : {
      93             :         spdk_trace_history *history;
      94             : 
      95           0 :         if (lcore >= SPDK_TRACE_MAX_LCORE) {
      96           0 :                 return 0;
      97             :         }
      98             : 
      99           0 :         history = spdk_get_per_lcore_history(_histories, lcore);
     100             : 
     101           0 :         return history == NULL ? 0 : history->num_entries;
     102             : }
     103             : 
     104             : spdk_trace_entry_buffer *
     105           0 : spdk_trace_parser::get_next_buffer(spdk_trace_entry_buffer *buf, uint16_t lcore)
     106             : {
     107             :         spdk_trace_history *history;
     108             : 
     109           0 :         history = spdk_get_per_lcore_history(_histories, lcore);
     110           0 :         assert(history);
     111             : 
     112           0 :         if (spdk_unlikely(static_cast<void *>(buf) ==
     113             :                           static_cast<void *>(&history->entries[history->num_entries - 1]))) {
     114           0 :                 return reinterpret_cast<spdk_trace_entry_buffer *>(&history->entries[0]);
     115             :         } else {
     116           0 :                 return buf + 1;
     117             :         }
     118             : }
     119             : 
     120             : bool
     121           0 : spdk_trace_parser::build_arg(argument_context *argctx, const spdk_trace_argument *arg, int argid,
     122             :                              spdk_trace_parser_entry *pe)
     123             : {
     124           0 :         spdk_trace_entry *entry = argctx->entry;
     125           0 :         spdk_trace_entry_buffer *buffer = argctx->buffer;
     126             :         size_t curlen, argoff;
     127             : 
     128           0 :         argoff = 0;
     129             :         /* Make sure that if we only copy a 4-byte integer, that the upper bytes have already been
     130             :          * zeroed.
     131             :          */
     132           0 :         pe->args[argid].integer = 0;
     133           0 :         while (argoff < arg->size) {
     134           0 :                 if (argctx->offset == sizeof(buffer->data)) {
     135           0 :                         buffer = get_next_buffer(buffer, argctx->lcore);
     136           0 :                         if (spdk_unlikely(buffer->tpoint_id != SPDK_TRACE_MAX_TPOINT_ID ||
     137             :                                           buffer->tsc != entry->tsc)) {
     138           0 :                                 return false;
     139             :                         }
     140             : 
     141           0 :                         argctx->offset = 0;
     142           0 :                         argctx->buffer = buffer;
     143             :                 }
     144             : 
     145           0 :                 curlen = spdk_min(sizeof(buffer->data) - argctx->offset, arg->size - argoff);
     146           0 :                 if (argoff < sizeof(pe->args[0])) {
     147           0 :                         memcpy(&pe->args[argid].string[argoff], &buffer->data[argctx->offset],
     148           0 :                                spdk_min(curlen, sizeof(pe->args[0]) - argoff));
     149             :                 }
     150             : 
     151           0 :                 argctx->offset += curlen;
     152           0 :                 argoff += curlen;
     153             :         }
     154             : 
     155           0 :         return true;
     156             : }
     157             : 
     158             : bool
     159           0 : spdk_trace_parser::next_entry(spdk_trace_parser_entry *pe)
     160             : {
     161             :         spdk_trace_tpoint *tpoint;
     162             :         spdk_trace_entry *entry;
     163             :         object_stats *stats;
     164           0 :         std::map<uint64_t, uint64_t>::iterator related_kv;
     165             : 
     166           0 :         if (_iter == _entries.end()) {
     167           0 :                 return false;
     168             :         }
     169             : 
     170           0 :         pe->entry = entry = _iter->second;
     171           0 :         pe->lcore = _iter->first.lcore;
     172             :         /* Set related index to the max value to indicate "empty" state */
     173           0 :         pe->related_index = UINT64_MAX;
     174           0 :         pe->related_type = OBJECT_NONE;
     175           0 :         tpoint = &_histories->flags.tpoint[entry->tpoint_id];
     176           0 :         stats = &_stats[tpoint->object_type];
     177             : 
     178           0 :         if (tpoint->new_object) {
     179           0 :                 stats->index[entry->object_id] = stats->counter++;
     180           0 :                 stats->start[entry->object_id] = entry->tsc;
     181             :         }
     182             : 
     183           0 :         if (tpoint->object_type != OBJECT_NONE) {
     184           0 :                 if (spdk_likely(stats->start.find(entry->object_id) != stats->start.end())) {
     185           0 :                         pe->object_index = stats->index[entry->object_id];
     186           0 :                         pe->object_start = stats->start[entry->object_id];
     187             :                 } else {
     188           0 :                         pe->object_index = UINT64_MAX;
     189           0 :                         pe->object_start = UINT64_MAX;
     190             :                 }
     191             :         }
     192             : 
     193           0 :         argument_context argctx(entry, pe->lcore);
     194           0 :         for (uint8_t i = 0; i < tpoint->num_args; ++i) {
     195           0 :                 if (!build_arg(&argctx, &tpoint->args[i], i, pe)) {
     196           0 :                         SPDK_ERRLOG("Failed to parse tracepoint argument\n");
     197           0 :                         return false;
     198             :                 }
     199             :         }
     200             : 
     201           0 :         for (uint8_t i = 0; i < SPDK_TRACE_MAX_RELATIONS; ++i) {
     202             :                 /* The relations are stored inside a tpoint, which means there might be
     203             :                  * multiple objects bound to a single tpoint. */
     204           0 :                 if (tpoint->related_objects[i].object_type == OBJECT_NONE) {
     205           0 :                         break;
     206             :                 }
     207           0 :                 stats = &_stats[tpoint->related_objects[i].object_type];
     208           0 :                 related_kv = stats->index.find(reinterpret_cast<uint64_t>
     209           0 :                                                (pe->args[tpoint->related_objects[i].arg_index].pointer));
     210             :                 /* To avoid parsing the whole array, object index and type are stored
     211             :                  * directly inside spdk_trace_parser_entry. */
     212           0 :                 if (related_kv != stats->index.end()) {
     213           0 :                         pe->related_index = related_kv->second;
     214           0 :                         pe->related_type = tpoint->related_objects[i].object_type;
     215           0 :                         break;
     216             :                 }
     217             :         }
     218             : 
     219           0 :         _iter++;
     220           0 :         return true;
     221             : }
     222             : 
     223             : void
     224           0 : spdk_trace_parser::populate_events(spdk_trace_history *history, int num_entries)
     225             : {
     226             :         int i, num_entries_filled;
     227             :         spdk_trace_entry *e;
     228             :         int first, last, lcore;
     229             : 
     230           0 :         lcore = history->lcore;
     231           0 :         e = history->entries;
     232             : 
     233           0 :         num_entries_filled = num_entries;
     234           0 :         while (e[num_entries_filled - 1].tsc == 0) {
     235           0 :                 num_entries_filled--;
     236             :         }
     237             : 
     238           0 :         if (num_entries == num_entries_filled) {
     239           0 :                 first = last = 0;
     240           0 :                 for (i = 1; i < num_entries; i++) {
     241           0 :                         if (e[i].tsc < e[first].tsc) {
     242           0 :                                 first = i;
     243             :                         }
     244           0 :                         if (e[i].tsc > e[last].tsc) {
     245           0 :                                 last = i;
     246             :                         }
     247             :                 }
     248             :         } else {
     249           0 :                 first = 0;
     250           0 :                 last = num_entries_filled - 1;
     251             :         }
     252             : 
     253             :         /*
     254             :          * We keep track of the highest first TSC out of all reactors.
     255             :          *  We will ignore any events that occurred before this TSC on any
     256             :          *  other reactors.  This will ensure we only print data for the
     257             :          *  subset of time where we have data across all reactors.
     258             :          */
     259           0 :         if (e[first].tsc > _tsc_offset) {
     260           0 :                 _tsc_offset = e[first].tsc;
     261             :         }
     262             : 
     263           0 :         i = first;
     264             :         while (1) {
     265           0 :                 if (e[i].tpoint_id != SPDK_TRACE_MAX_TPOINT_ID) {
     266           0 :                         _entries[entry_key(lcore, e[i].tsc)] = &e[i];
     267             :                 }
     268           0 :                 if (i == last) {
     269           0 :                         break;
     270             :                 }
     271           0 :                 i++;
     272           0 :                 if (i == num_entries_filled) {
     273           0 :                         i = 0;
     274             :                 }
     275             :         }
     276           0 : }
     277             : 
     278             : bool
     279           0 : spdk_trace_parser::init(const spdk_trace_parser_opts *opts)
     280             : {
     281             :         spdk_trace_history *history;
     282           0 :         struct stat st;
     283             :         int rc, i;
     284             : 
     285           0 :         switch (opts->mode) {
     286           0 :         case SPDK_TRACE_PARSER_MODE_FILE:
     287           0 :                 _fd = open(opts->filename, O_RDONLY);
     288           0 :                 break;
     289           0 :         case SPDK_TRACE_PARSER_MODE_SHM:
     290           0 :                 _fd = shm_open(opts->filename, O_RDONLY, 0600);
     291           0 :                 break;
     292           0 :         default:
     293           0 :                 SPDK_ERRLOG("Invalid mode: %d\n", opts->mode);
     294           0 :                 return false;
     295             :         }
     296             : 
     297           0 :         if (_fd < 0) {
     298           0 :                 SPDK_ERRLOG("Could not open trace file: %s (%d)\n", opts->filename, errno);
     299           0 :                 return false;
     300             :         }
     301             : 
     302           0 :         rc = fstat(_fd, &st);
     303           0 :         if (rc < 0) {
     304           0 :                 SPDK_ERRLOG("Could not get size of trace file: %s\n", opts->filename);
     305           0 :                 return false;
     306             :         }
     307             : 
     308           0 :         if ((size_t)st.st_size < sizeof(*_histories)) {
     309           0 :                 SPDK_ERRLOG("Invalid trace file: %s\n", opts->filename);
     310           0 :                 return false;
     311             :         }
     312             : 
     313             :         /* Map the header of trace file */
     314           0 :         _map_size = sizeof(*_histories);
     315           0 :         _histories = static_cast<spdk_trace_histories *>(mmap(NULL, _map_size, PROT_READ,
     316             :                         MAP_SHARED, _fd, 0));
     317           0 :         if (_histories == MAP_FAILED) {
     318           0 :                 SPDK_ERRLOG("Could not mmap trace file: %s\n", opts->filename);
     319           0 :                 _histories = NULL;
     320           0 :                 return false;
     321             :         }
     322             : 
     323             :         /* Remap the entire trace file */
     324           0 :         _map_size = spdk_get_trace_histories_size(_histories);
     325           0 :         munmap(_histories, sizeof(*_histories));
     326           0 :         if ((size_t)st.st_size < _map_size) {
     327           0 :                 SPDK_ERRLOG("Trace file %s is not valid\n", opts->filename);
     328           0 :                 _histories = NULL;
     329           0 :                 return false;
     330             :         }
     331           0 :         _histories = static_cast<spdk_trace_histories *>(mmap(NULL, _map_size, PROT_READ,
     332             :                         MAP_SHARED, _fd, 0));
     333           0 :         if (_histories == MAP_FAILED) {
     334           0 :                 SPDK_ERRLOG("Could not mmap trace file: %s\n", opts->filename);
     335           0 :                 _histories = NULL;
     336           0 :                 return false;
     337             :         }
     338             : 
     339           0 :         if (opts->lcore == SPDK_TRACE_MAX_LCORE) {
     340           0 :                 for (i = 0; i < SPDK_TRACE_MAX_LCORE; i++) {
     341           0 :                         history = spdk_get_per_lcore_history(_histories, i);
     342           0 :                         if (history == NULL || history->num_entries == 0 || history->entries[0].tsc == 0) {
     343           0 :                                 continue;
     344             :                         }
     345             : 
     346           0 :                         populate_events(history, history->num_entries);
     347             :                 }
     348             :         } else {
     349           0 :                 history = spdk_get_per_lcore_history(_histories, opts->lcore);
     350           0 :                 if (history == NULL) {
     351           0 :                         SPDK_ERRLOG("Trace file %s has no trace history for lcore %d\n",
     352             :                                     opts->filename, opts->lcore);
     353           0 :                         return false;
     354             :                 }
     355           0 :                 if (history->num_entries > 0 && history->entries[0].tsc != 0) {
     356           0 :                         populate_events(history, history->num_entries);
     357             :                 }
     358             :         }
     359             : 
     360           0 :         _iter = _entries.begin();
     361           0 :         return true;
     362             : }
     363             : 
     364             : void
     365           0 : spdk_trace_parser::cleanup()
     366             : {
     367           0 :         if (_histories != NULL) {
     368           0 :                 munmap(_histories, _map_size);
     369             :         }
     370             : 
     371           0 :         if (_fd > 0) {
     372           0 :                 close(_fd);
     373             :         }
     374           0 : }
     375             : 
     376           0 : spdk_trace_parser::spdk_trace_parser(const spdk_trace_parser_opts *opts) :
     377             :         _histories(NULL),
     378             :         _map_size(0),
     379             :         _fd(-1),
     380           0 :         _tsc_offset(0)
     381             : {
     382           0 :         if (!init(opts)) {
     383           0 :                 cleanup();
     384           0 :                 throw std::exception();
     385             :         }
     386           0 : }
     387             : 
     388           0 : spdk_trace_parser::~spdk_trace_parser()
     389             : {
     390           0 :         cleanup();
     391           0 : }
     392             : 
     393             : struct spdk_trace_parser *
     394           0 : spdk_trace_parser_init(const struct spdk_trace_parser_opts *opts)
     395             : {
     396             :         try {
     397           0 :                 return new spdk_trace_parser(opts);
     398           0 :         } catch (...) {
     399           0 :                 return NULL;
     400             :         }
     401             : }
     402             : 
     403             : void
     404           0 : spdk_trace_parser_cleanup(struct spdk_trace_parser *parser)
     405             : {
     406           0 :         delete parser;
     407           0 : }
     408             : 
     409             : const struct spdk_trace_flags *
     410           0 : spdk_trace_parser_get_flags(const struct spdk_trace_parser *parser)
     411             : {
     412           0 :         return parser->flags();
     413             : }
     414             : 
     415             : uint64_t
     416           0 : spdk_trace_parser_get_tsc_offset(const struct spdk_trace_parser *parser)
     417             : {
     418           0 :         return parser->tsc_offset();
     419             : }
     420             : 
     421             : bool
     422           0 : spdk_trace_parser_next_entry(struct spdk_trace_parser *parser,
     423             :                              struct spdk_trace_parser_entry *entry)
     424             : {
     425           0 :         return parser->next_entry(entry);
     426             : }
     427             : 
     428             : uint64_t
     429           0 : spdk_trace_parser_get_entry_count(const struct spdk_trace_parser *parser, uint16_t lcore)
     430             : {
     431           0 :         return parser->entry_count(lcore);
     432             : }

Generated by: LCOV version 1.15