lib/thread: Update the comment for spdk_thread_exit() in the header file

By these patch series, spdk_thread_poll() runs normally even after
the thread is marked at exited. However, spdk_thread_send_msg(),
spdk_get_io_channel(), and spdk_get_io_channel() will fail after
the thread is marked at exited.

Update the comment for spdk_thread_exit() in the header file
accordingly. To avoid rebasing the patch series, append this to
the end of the patch series.

Signed-off-by: Shuhei Matsumoto <shuhei.matsumoto.xt@hitachi.com>
Change-Id: Ic03d3c5461feb3ad878749a4c71a582c8ef3f26c
Reviewed-on: https://review.spdk.io/gerrit/c/spdk/spdk/+/847
Tested-by: SPDK CI Jenkins <sys_sgci@intel.com>
Reviewed-by: Darek Stojaczyk <dariusz.stojaczyk@intel.com>
Reviewed-by: Ben Walker <benjamin.walker@intel.com>
Reviewed-by: Jim Harris <james.r.harris@intel.com>
Reviewed-by: Aleksey Marchuk <alexeymar@mellanox.com>
This commit is contained in:
Shuhei Matsumoto 2020-02-13 01:29:13 -05:00 committed by Tomasz Zawadzki
parent fb7129881a
commit 04f6e24ae3

View File

@ -221,8 +221,9 @@ struct spdk_thread *spdk_thread_create(const char *name, struct spdk_cpuset *cpu
void spdk_set_thread(struct spdk_thread *thread);
/**
* Mark the thread as exited, failing all future spdk_thread_poll() calls. May
* only be called within an spdk poller or message.
* Mark the thread as exited, failing all future spdk_thread_send_msg(),
* spdk_poller_register(), and spdk_get_io_channel() calls. May only be called
* within an spdk poller or message.
*
* All I/O channel references associated with the thread must be released using
* spdk_put_io_channel(), and all active pollers associated with the thread must