1 /*
2 * Copyright (C) 2015 Cyril Hrubis <chrubis@suse.cz>
3 *
4 * This program is free software; you can redistribute it and/or modify it
5 * under the terms of version 2 of the GNU General Public License as
6 * published by the Free Software Foundation.
7 *
8 * This program is distributed in the hope that it would be useful, but
9 * WITHOUT ANY WARRANTY; without even the implied warranty of
10 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
11 *
12 * Further, this software is distributed without any warranty that it is
13 * free of the rightful claim of any third person regarding infringement
14 * or the like. Any license provided herein, whether implied or
15 * otherwise, applies only to this software file. Patent licenses, if
16 * any, provided herein do not apply to combinations of this program with
17 * other software, or any other product whatsoever.
18 *
19 * You should have received a copy of the GNU General Public License along
20 * with this program; if not, write the Free Software Foundation, Inc.,
21 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
22 */
23
24 #include <stdint.h>
25 #include <limits.h>
26 #include <errno.h>
27 #include <sys/syscall.h>
28 #include <linux/futex.h>
29
30 #include "test.h"
31 #include "safe_macros.h"
32 #include "lapi/futex.h"
33
34 #define DEFAULT_MSEC_TIMEOUT 10000
35
36 futex_t *tst_futexes;
37 unsigned int tst_max_futexes;
38
tst_checkpoint_init(const char * file,const int lineno,void (* cleanup_fn)(void))39 void tst_checkpoint_init(const char *file, const int lineno,
40 void (*cleanup_fn)(void))
41 {
42 int fd;
43 unsigned int page_size;
44
45 if (tst_futexes) {
46 tst_brkm_(file, lineno, TBROK, cleanup_fn,
47 "checkpoints already initialized");
48 return;
49 }
50
51 /*
52 * The parent test process is responsible for creating the temporary
53 * directory and therefore must pass non-zero cleanup (to remove the
54 * directory if something went wrong).
55 *
56 * We cannot do this check unconditionally because if we need to init
57 * the checkpoint from a binary that was started by exec() the
58 * tst_tmpdir_created() will return false because the tmpdir was
59 * created by parent. In this case we expect the subprogram can call
60 * the init as a first function with NULL as cleanup function.
61 */
62 if (cleanup_fn && !tst_tmpdir_created()) {
63 tst_brkm_(file, lineno, TBROK, cleanup_fn,
64 "You have to create test temporary directory "
65 "first (call tst_tmpdir())");
66 return;
67 }
68
69 page_size = getpagesize();
70
71 fd = SAFE_OPEN(cleanup_fn, "checkpoint_futex_base_file",
72 O_RDWR | O_CREAT, 0666);
73
74 SAFE_FTRUNCATE(cleanup_fn, fd, page_size);
75
76 tst_futexes = SAFE_MMAP(cleanup_fn, NULL, page_size,
77 PROT_READ | PROT_WRITE, MAP_SHARED, fd, 0);
78
79 tst_max_futexes = page_size / sizeof(uint32_t);
80
81 SAFE_CLOSE(cleanup_fn, fd);
82 }
83
tst_checkpoint_wait(unsigned int id,unsigned int msec_timeout)84 int tst_checkpoint_wait(unsigned int id, unsigned int msec_timeout)
85 {
86 struct timespec timeout;
87 int ret;
88
89 if (!tst_max_futexes)
90 tst_brkm(TBROK, NULL, "Set test.needs_checkpoints = 1");
91
92 if (id >= tst_max_futexes) {
93 errno = EOVERFLOW;
94 return -1;
95 }
96
97 timeout.tv_sec = msec_timeout/1000;
98 timeout.tv_nsec = (msec_timeout%1000) * 1000000;
99
100 do {
101 ret = syscall(SYS_futex, &tst_futexes[id], FUTEX_WAIT,
102 tst_futexes[id], &timeout);
103 } while (ret == -1 && errno == EINTR);
104
105 return ret;
106 }
107
tst_checkpoint_wake(unsigned int id,unsigned int nr_wake,unsigned int msec_timeout)108 int tst_checkpoint_wake(unsigned int id, unsigned int nr_wake,
109 unsigned int msec_timeout)
110 {
111 unsigned int msecs = 0, waked = 0;
112
113 if (!tst_max_futexes)
114 tst_brkm(TBROK, NULL, "Set test.needs_checkpoints = 1");
115
116 if (id >= tst_max_futexes) {
117 errno = EOVERFLOW;
118 return -1;
119 }
120
121 for (;;) {
122 waked += syscall(SYS_futex, &tst_futexes[id], FUTEX_WAKE,
123 INT_MAX, NULL);
124
125 if (waked == nr_wake)
126 break;
127
128 usleep(1000);
129 msecs++;
130
131 if (msecs >= msec_timeout) {
132 errno = ETIMEDOUT;
133 return -1;
134 }
135 }
136
137 return 0;
138 }
139
tst_safe_checkpoint_wait(const char * file,const int lineno,void (* cleanup_fn)(void),unsigned int id,unsigned int msec_timeout)140 void tst_safe_checkpoint_wait(const char *file, const int lineno,
141 void (*cleanup_fn)(void), unsigned int id,
142 unsigned int msec_timeout)
143 {
144 int ret;
145
146 if (!msec_timeout)
147 msec_timeout = DEFAULT_MSEC_TIMEOUT;
148
149 ret = tst_checkpoint_wait(id, msec_timeout);
150
151 if (ret) {
152 tst_brkm_(file, lineno, TBROK | TERRNO, cleanup_fn,
153 "tst_checkpoint_wait(%u, %i) failed", id,
154 msec_timeout);
155 }
156 }
157
tst_safe_checkpoint_wake(const char * file,const int lineno,void (* cleanup_fn)(void),unsigned int id,unsigned int nr_wake)158 void tst_safe_checkpoint_wake(const char *file, const int lineno,
159 void (*cleanup_fn)(void), unsigned int id,
160 unsigned int nr_wake)
161 {
162 int ret = tst_checkpoint_wake(id, nr_wake, DEFAULT_MSEC_TIMEOUT);
163
164 if (ret) {
165 tst_brkm_(file, lineno, TBROK | TERRNO, cleanup_fn,
166 "tst_checkpoint_wake(%u, %u, %i) failed", id, nr_wake,
167 DEFAULT_MSEC_TIMEOUT);
168 }
169 }
170