xref: /spdk/include/spdk_internal/thread.h (revision cc6920a4763d4b9a43aa40583c8397d8f14fa100)
1 /*-
2  *   BSD LICENSE
3  *
4  *   Copyright (c) Intel Corporation. All rights reserved.
5  *   Copyright (c) 2020 Mellanox Technologies LTD. All rights reserved.
6  *
7  *   Redistribution and use in source and binary forms, with or without
8  *   modification, are permitted provided that the following conditions
9  *   are met:
10  *
11  *     * Redistributions of source code must retain the above copyright
12  *       notice, this list of conditions and the following disclaimer.
13  *     * Redistributions in binary form must reproduce the above copyright
14  *       notice, this list of conditions and the following disclaimer in
15  *       the documentation and/or other materials provided with the
16  *       distribution.
17  *     * Neither the name of Intel Corporation nor the names of its
18  *       contributors may be used to endorse or promote products derived
19  *       from this software without specific prior written permission.
20  *
21  *   THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
22  *   "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
23  *   LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
24  *   A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
25  *   OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
26  *   SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
27  *   LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
28  *   DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
29  *   THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
30  *   (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
31  *   OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
32  */
33 
34 #ifndef SPDK_INTERNAL_THREAD_H_
35 #define SPDK_INTERNAL_THREAD_H_
36 
37 #include "spdk/stdinc.h"
38 #include "spdk/thread.h"
39 
40 struct spdk_poller;
41 
42 struct spdk_poller_stats {
43 	uint64_t	run_count;
44 	uint64_t	busy_count;
45 };
46 
47 struct io_device;
48 struct spdk_thread;
49 
50 const char *spdk_poller_get_name(struct spdk_poller *poller);
51 uint64_t spdk_poller_get_id(struct spdk_poller *poller);
52 const char *spdk_poller_get_state_str(struct spdk_poller *poller);
53 uint64_t spdk_poller_get_period_ticks(struct spdk_poller *poller);
54 void spdk_poller_get_stats(struct spdk_poller *poller, struct spdk_poller_stats *stats);
55 
56 const char *spdk_io_channel_get_io_device_name(struct spdk_io_channel *ch);
57 int spdk_io_channel_get_ref_count(struct spdk_io_channel *ch);
58 
59 const char *spdk_io_device_get_name(struct io_device *dev);
60 
61 struct spdk_poller *spdk_thread_get_first_active_poller(struct spdk_thread *thread);
62 struct spdk_poller *spdk_thread_get_next_active_poller(struct spdk_poller *prev);
63 struct spdk_poller *spdk_thread_get_first_timed_poller(struct spdk_thread *thread);
64 struct spdk_poller *spdk_thread_get_next_timed_poller(struct spdk_poller *prev);
65 struct spdk_poller *spdk_thread_get_first_paused_poller(struct spdk_thread *thread);
66 struct spdk_poller *spdk_thread_get_next_paused_poller(struct spdk_poller *prev);
67 
68 struct spdk_io_channel *spdk_thread_get_first_io_channel(struct spdk_thread *thread);
69 struct spdk_io_channel *spdk_thread_get_next_io_channel(struct spdk_io_channel *prev);
70 
71 #endif /* SPDK_INTERNAL_THREAD_H_ */
72