Function CallStr

tensorflow/stream_executor/stream.cc:234–252

Used together with PARAM to VLOG calls made to the stream. Intended to be used like this: VLOG(1) << CallStr("MyFunction", this, {PARAM(a), PARAM(b)}); where a and b are the parameters to MyFunction. See VLOG_CALL for a short-hand for this. This way of doing it saves a tremendous amount of boilerplate code given how many functions there are on Stream and how many parameters they each have.

// a tremendous amount of boilerplate code given how many functions
// there are on Stream and how many parameters they each have.
string CallStr(const char *function_name, Stream *stream,
               std::vector<std::pair<const char *, string>> params) {
  // Do not call this function unless VLOG is on since just
  // constructing all the strings in params is expensive.
  CHECK(VLOG_IS_ON(1));

  string str = absl::StrCat(stream->DebugStreamPointers(),
                            " Called Stream::", function_name, "(");
  const char *separator = "";
  for (const auto &param : params) {
    absl::StrAppend(&str, separator, param.first, "=", param.second);
    separator = ", ";
  }
  absl::StrAppend(&str, ")");
  if (VLOG_IS_ON(10)) {
    absl::StrAppend(&str, " ", port::CurrentStackTrace(), "\n");
  }
  return str;
}

// Use this macro to avoid having to type every parameter twice to log
// it with VLOG and CallStr.