thread: note that spdk_thread_get_last_tsc(NULL) is allowed

The code has always supported this, it just wasn't
documented in the header file.  If caller passes NULL,
it will use the current thread to get the TSC.  This
is actually the most common case.

Signed-off-by: Jim Harris <james.r.harris@intel.com>
Change-Id: I39ba8260f0cb277b9272441bd336294c3327d5de
Reviewed-on: https://review.spdk.io/gerrit/c/spdk/spdk/+/14442
Tested-by: SPDK CI Jenkins <sys_sgci@intel.com>
Community-CI: Mellanox Build Bot
Reviewed-by: Ben Walker <benjamin.walker@intel.com>
Reviewed-by: Changpeng Liu <changpeng.liu@intel.com>
Reviewed-by: Shuhei Matsumoto <smatsumoto@nvidia.com>
This commit is contained in:
Jim Harris 2022-09-09 16:03:29 +00:00
parent 39ecb61ade
commit a8074147b5

View File

@ -439,7 +439,7 @@ int spdk_thread_get_stats(struct spdk_thread_stats *stats);
/**
* Return the TSC value from the end of the last time this thread was polled.
*
* \param thread Thread to query.
* \param thread Thread to query. If NULL, use current thread.
*
* \return TSC value from the end of the last time this thread was polled.
*/