xref: /spdk/test/common/lib/ut_multithread.c (revision 712a3f69d32632bf6c862f00200f7f437d3f7529)
1 /*-
2  *   BSD LICENSE
3  *
4  *   Copyright (c) Intel Corporation.
5  *   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 #include "spdk_cunit.h"
35 #include "spdk/thread.h"
36 #include "spdk_internal/mock.h"
37 #include "spdk_internal/thread.h"
38 
39 #include "common/lib/test_env.c"
40 
41 static uint32_t g_ut_num_threads;
42 
43 int allocate_threads(int num_threads);
44 void free_threads(void);
45 void poll_threads(void);
46 bool poll_thread(uintptr_t thread_id);
47 
48 struct ut_msg {
49 	spdk_msg_fn		fn;
50 	void			*ctx;
51 	TAILQ_ENTRY(ut_msg)	link;
52 };
53 
54 struct ut_thread {
55 	struct spdk_thread	*thread;
56 	struct spdk_io_channel	*ch;
57 };
58 
59 struct ut_thread *g_ut_threads;
60 
61 #define INVALID_THREAD 0x1000
62 
63 static uint64_t g_thread_id = INVALID_THREAD;
64 
65 static void
66 set_thread(uintptr_t thread_id)
67 {
68 	g_thread_id = thread_id;
69 	if (thread_id == INVALID_THREAD) {
70 		spdk_set_thread(NULL);
71 	} else {
72 		spdk_set_thread(g_ut_threads[thread_id].thread);
73 	}
74 
75 }
76 
77 int
78 allocate_threads(int num_threads)
79 {
80 	struct spdk_thread *thread;
81 	uint32_t i;
82 
83 	spdk_thread_lib_init(NULL, 0);
84 
85 	g_ut_num_threads = num_threads;
86 
87 	g_ut_threads = calloc(num_threads, sizeof(*g_ut_threads));
88 	assert(g_ut_threads != NULL);
89 
90 	for (i = 0; i < g_ut_num_threads; i++) {
91 		set_thread(i);
92 		thread = spdk_thread_create(NULL, NULL);
93 		assert(thread != NULL);
94 		g_ut_threads[i].thread = thread;
95 	}
96 
97 	set_thread(INVALID_THREAD);
98 	return 0;
99 }
100 
101 void
102 free_threads(void)
103 {
104 	uint32_t i;
105 	int rc __attribute__((unused));
106 
107 	for (i = 0; i < g_ut_num_threads; i++) {
108 		set_thread(i);
109 		if (!spdk_thread_is_exited(g_ut_threads[i].thread)) {
110 			rc = spdk_thread_exit(g_ut_threads[i].thread);
111 			assert(rc == 0);
112 		}
113 		spdk_thread_destroy(g_ut_threads[i].thread);
114 		g_ut_threads[i].thread = NULL;
115 	}
116 
117 	g_ut_num_threads = 0;
118 	free(g_ut_threads);
119 	g_ut_threads = NULL;
120 
121 	spdk_thread_lib_fini();
122 }
123 
124 bool
125 poll_thread(uintptr_t thread_id)
126 {
127 	bool busy = false;
128 	struct ut_thread *thread = &g_ut_threads[thread_id];
129 	uintptr_t original_thread_id;
130 
131 	assert(thread_id != (uintptr_t)INVALID_THREAD);
132 	assert(thread_id < g_ut_num_threads);
133 
134 	original_thread_id = g_thread_id;
135 	set_thread(INVALID_THREAD);
136 
137 	while (spdk_thread_poll(thread->thread, 0, 0) > 0) {
138 		busy = true;
139 	}
140 
141 	set_thread(original_thread_id);
142 
143 	return busy;
144 }
145 
146 void
147 poll_threads(void)
148 {
149 	while (true) {
150 		bool busy = false;
151 
152 		for (uint32_t i = 0; i < g_ut_num_threads; i++) {
153 			busy = busy || poll_thread(i);
154 		}
155 
156 		if (!busy) {
157 			break;
158 		}
159 	}
160 }
161