Dmitry Vyukov | fb8ca81 | 2012-12-12 12:27:00 +0000 | [diff] [blame] | 1 | //===-- tsan_fd.cc --------------------------------------------------------===// |
| 2 | // |
| 3 | // The LLVM Compiler Infrastructure |
| 4 | // |
| 5 | // This file is distributed under the University of Illinois Open Source |
| 6 | // License. See LICENSE.TXT for details. |
| 7 | // |
| 8 | //===----------------------------------------------------------------------===// |
| 9 | // |
| 10 | // This file is a part of ThreadSanitizer (TSan), a race detector. |
| 11 | // |
| 12 | //===----------------------------------------------------------------------===// |
| 13 | |
| 14 | #include "tsan_fd.h" |
| 15 | #include "tsan_rtl.h" |
| 16 | #include <sanitizer_common/sanitizer_atomic.h> |
| 17 | |
| 18 | namespace __tsan { |
| 19 | |
| 20 | const int kTableSizeL1 = 1024; |
| 21 | const int kTableSizeL2 = 1024; |
| 22 | const int kTableSize = kTableSizeL1 * kTableSizeL2; |
| 23 | |
Dmitry Vyukov | c2234cd | 2012-12-18 06:57:34 +0000 | [diff] [blame] | 24 | struct FdSync { |
Dmitry Vyukov | fb8ca81 | 2012-12-12 12:27:00 +0000 | [diff] [blame] | 25 | atomic_uint64_t rc; |
| 26 | }; |
| 27 | |
Dmitry Vyukov | c2234cd | 2012-12-18 06:57:34 +0000 | [diff] [blame] | 28 | struct FdDesc { |
| 29 | FdSync *sync; |
| 30 | int creation_tid; |
| 31 | u32 creation_stack; |
| 32 | }; |
| 33 | |
Dmitry Vyukov | fb8ca81 | 2012-12-12 12:27:00 +0000 | [diff] [blame] | 34 | struct FdContext { |
| 35 | atomic_uintptr_t tab[kTableSizeL1]; |
| 36 | // Addresses used for synchronization. |
Dmitry Vyukov | c2234cd | 2012-12-18 06:57:34 +0000 | [diff] [blame] | 37 | FdSync globsync; |
| 38 | FdSync filesync; |
| 39 | FdSync socksync; |
Dmitry Vyukov | ed513f6 | 2012-12-14 20:01:58 +0000 | [diff] [blame] | 40 | u64 connectsync; |
Dmitry Vyukov | fb8ca81 | 2012-12-12 12:27:00 +0000 | [diff] [blame] | 41 | }; |
| 42 | |
| 43 | static FdContext fdctx; |
| 44 | |
Dmitry Vyukov | c2234cd | 2012-12-18 06:57:34 +0000 | [diff] [blame] | 45 | static FdSync *allocsync() { |
| 46 | FdSync *s = (FdSync*)internal_alloc(MBlockFD, sizeof(FdSync)); |
| 47 | atomic_store(&s->rc, 1, memory_order_relaxed); |
| 48 | return s; |
Dmitry Vyukov | fb8ca81 | 2012-12-12 12:27:00 +0000 | [diff] [blame] | 49 | } |
| 50 | |
Dmitry Vyukov | c2234cd | 2012-12-18 06:57:34 +0000 | [diff] [blame] | 51 | static FdSync *ref(FdSync *s) { |
| 52 | if (s && atomic_load(&s->rc, memory_order_relaxed) != (u64)-1) |
| 53 | atomic_fetch_add(&s->rc, 1, memory_order_relaxed); |
| 54 | return s; |
Dmitry Vyukov | fb8ca81 | 2012-12-12 12:27:00 +0000 | [diff] [blame] | 55 | } |
| 56 | |
Dmitry Vyukov | c2234cd | 2012-12-18 06:57:34 +0000 | [diff] [blame] | 57 | static void unref(ThreadState *thr, uptr pc, FdSync *s) { |
| 58 | if (s && atomic_load(&s->rc, memory_order_relaxed) != (u64)-1) { |
| 59 | if (atomic_fetch_sub(&s->rc, 1, memory_order_acq_rel) == 1) { |
| 60 | CHECK_NE(s, &fdctx.globsync); |
| 61 | CHECK_NE(s, &fdctx.filesync); |
| 62 | CHECK_NE(s, &fdctx.socksync); |
| 63 | SyncVar *v = CTX()->synctab.GetAndRemove(thr, pc, (uptr)s); |
| 64 | if (v) |
| 65 | DestroyAndFree(v); |
| 66 | internal_free(s); |
Dmitry Vyukov | fb8ca81 | 2012-12-12 12:27:00 +0000 | [diff] [blame] | 67 | } |
| 68 | } |
| 69 | } |
| 70 | |
Dmitry Vyukov | c2234cd | 2012-12-18 06:57:34 +0000 | [diff] [blame] | 71 | static FdDesc *fddesc(ThreadState *thr, uptr pc, int fd) { |
Dmitry Vyukov | fb8ca81 | 2012-12-12 12:27:00 +0000 | [diff] [blame] | 72 | CHECK_LT(fd, kTableSize); |
| 73 | atomic_uintptr_t *pl1 = &fdctx.tab[fd / kTableSizeL2]; |
| 74 | uptr l1 = atomic_load(pl1, memory_order_consume); |
| 75 | if (l1 == 0) { |
Dmitry Vyukov | c2234cd | 2012-12-18 06:57:34 +0000 | [diff] [blame] | 76 | uptr size = kTableSizeL2 * sizeof(FdDesc); |
Alexey Samsonov | 7733017 | 2013-04-19 08:04:46 +0000 | [diff] [blame^] | 77 | // We need this to reside in user memory to properly catch races on it. |
| 78 | void *p = user_alloc(thr, pc, size); |
Dmitry Vyukov | fb8ca81 | 2012-12-12 12:27:00 +0000 | [diff] [blame] | 79 | internal_memset(p, 0, size); |
Dmitry Vyukov | c2234cd | 2012-12-18 06:57:34 +0000 | [diff] [blame] | 80 | MemoryResetRange(thr, (uptr)&fddesc, (uptr)p, size); |
Dmitry Vyukov | fb8ca81 | 2012-12-12 12:27:00 +0000 | [diff] [blame] | 81 | if (atomic_compare_exchange_strong(pl1, &l1, (uptr)p, memory_order_acq_rel)) |
| 82 | l1 = (uptr)p; |
| 83 | else |
Alexey Samsonov | 7733017 | 2013-04-19 08:04:46 +0000 | [diff] [blame^] | 84 | user_free(thr, pc, p); |
Dmitry Vyukov | fb8ca81 | 2012-12-12 12:27:00 +0000 | [diff] [blame] | 85 | } |
Dmitry Vyukov | c2234cd | 2012-12-18 06:57:34 +0000 | [diff] [blame] | 86 | return &((FdDesc*)l1)[fd % kTableSizeL2]; // NOLINT |
Dmitry Vyukov | fb8ca81 | 2012-12-12 12:27:00 +0000 | [diff] [blame] | 87 | } |
| 88 | |
| 89 | // pd must be already ref'ed. |
Dmitry Vyukov | c2234cd | 2012-12-18 06:57:34 +0000 | [diff] [blame] | 90 | static void init(ThreadState *thr, uptr pc, int fd, FdSync *s) { |
| 91 | FdDesc *d = fddesc(thr, pc, fd); |
Dmitry Vyukov | fb8ca81 | 2012-12-12 12:27:00 +0000 | [diff] [blame] | 92 | // As a matter of fact, we don't intercept all close calls. |
| 93 | // See e.g. libc __res_iclose(). |
Dmitry Vyukov | 45d4324 | 2012-12-18 12:35:31 +0000 | [diff] [blame] | 94 | if (d->sync) { |
Dmitry Vyukov | c2234cd | 2012-12-18 06:57:34 +0000 | [diff] [blame] | 95 | unref(thr, pc, d->sync); |
Dmitry Vyukov | 45d4324 | 2012-12-18 12:35:31 +0000 | [diff] [blame] | 96 | d->sync = 0; |
| 97 | } |
Dmitry Vyukov | e3178e8 | 2012-12-18 12:20:55 +0000 | [diff] [blame] | 98 | if (flags()->io_sync == 0) { |
| 99 | unref(thr, pc, s); |
Dmitry Vyukov | e3178e8 | 2012-12-18 12:20:55 +0000 | [diff] [blame] | 100 | } else if (flags()->io_sync == 1) { |
| 101 | d->sync = s; |
| 102 | } else if (flags()->io_sync == 2) { |
| 103 | unref(thr, pc, s); |
| 104 | d->sync = &fdctx.globsync; |
| 105 | } |
Dmitry Vyukov | c2234cd | 2012-12-18 06:57:34 +0000 | [diff] [blame] | 106 | d->creation_tid = thr->tid; |
| 107 | d->creation_stack = CurrentStackId(thr, pc); |
Dmitry Vyukov | fb8ca81 | 2012-12-12 12:27:00 +0000 | [diff] [blame] | 108 | // To catch races between fd usage and open. |
Dmitry Vyukov | c2234cd | 2012-12-18 06:57:34 +0000 | [diff] [blame] | 109 | MemoryRangeImitateWrite(thr, pc, (uptr)d, 8); |
Dmitry Vyukov | fb8ca81 | 2012-12-12 12:27:00 +0000 | [diff] [blame] | 110 | } |
| 111 | |
| 112 | void FdInit() { |
Dmitry Vyukov | c2234cd | 2012-12-18 06:57:34 +0000 | [diff] [blame] | 113 | atomic_store(&fdctx.globsync.rc, (u64)-1, memory_order_relaxed); |
| 114 | atomic_store(&fdctx.filesync.rc, (u64)-1, memory_order_relaxed); |
| 115 | atomic_store(&fdctx.socksync.rc, (u64)-1, memory_order_relaxed); |
| 116 | } |
| 117 | |
Dmitry Vyukov | 4554b7a | 2012-12-18 14:44:44 +0000 | [diff] [blame] | 118 | void FdOnFork(ThreadState *thr, uptr pc) { |
| 119 | // On fork() we need to reset all fd's, because the child is going |
| 120 | // close all them, and that will cause races between previous read/write |
| 121 | // and the close. |
| 122 | for (int l1 = 0; l1 < kTableSizeL1; l1++) { |
| 123 | FdDesc *tab = (FdDesc*)atomic_load(&fdctx.tab[l1], memory_order_relaxed); |
| 124 | if (tab == 0) |
| 125 | break; |
| 126 | for (int l2 = 0; l2 < kTableSizeL2; l2++) { |
| 127 | FdDesc *d = &tab[l2]; |
| 128 | MemoryResetRange(thr, pc, (uptr)d, 8); |
| 129 | } |
| 130 | } |
| 131 | } |
| 132 | |
Dmitry Vyukov | c2234cd | 2012-12-18 06:57:34 +0000 | [diff] [blame] | 133 | bool FdLocation(uptr addr, int *fd, int *tid, u32 *stack) { |
| 134 | for (int l1 = 0; l1 < kTableSizeL1; l1++) { |
| 135 | FdDesc *tab = (FdDesc*)atomic_load(&fdctx.tab[l1], memory_order_relaxed); |
| 136 | if (tab == 0) |
| 137 | break; |
| 138 | if (addr >= (uptr)tab && addr < (uptr)(tab + kTableSizeL2)) { |
| 139 | int l2 = (addr - (uptr)tab) / sizeof(FdDesc); |
| 140 | FdDesc *d = &tab[l2]; |
| 141 | *fd = l1 * kTableSizeL1 + l2; |
| 142 | *tid = d->creation_tid; |
| 143 | *stack = d->creation_stack; |
| 144 | return true; |
| 145 | } |
| 146 | } |
| 147 | return false; |
Dmitry Vyukov | fb8ca81 | 2012-12-12 12:27:00 +0000 | [diff] [blame] | 148 | } |
| 149 | |
| 150 | void FdAcquire(ThreadState *thr, uptr pc, int fd) { |
Dmitry Vyukov | c2234cd | 2012-12-18 06:57:34 +0000 | [diff] [blame] | 151 | FdDesc *d = fddesc(thr, pc, fd); |
| 152 | FdSync *s = d->sync; |
| 153 | DPrintf("#%d: FdAcquire(%d) -> %p\n", thr->tid, fd, s); |
Dmitry Vyukov | 334553e | 2013-02-01 09:42:06 +0000 | [diff] [blame] | 154 | MemoryRead(thr, pc, (uptr)d, kSizeLog8); |
Dmitry Vyukov | c2234cd | 2012-12-18 06:57:34 +0000 | [diff] [blame] | 155 | if (s) |
| 156 | Acquire(thr, pc, (uptr)s); |
Dmitry Vyukov | fb8ca81 | 2012-12-12 12:27:00 +0000 | [diff] [blame] | 157 | } |
| 158 | |
| 159 | void FdRelease(ThreadState *thr, uptr pc, int fd) { |
Dmitry Vyukov | c2234cd | 2012-12-18 06:57:34 +0000 | [diff] [blame] | 160 | FdDesc *d = fddesc(thr, pc, fd); |
| 161 | FdSync *s = d->sync; |
| 162 | DPrintf("#%d: FdRelease(%d) -> %p\n", thr->tid, fd, s); |
| 163 | if (s) |
| 164 | Release(thr, pc, (uptr)s); |
Dmitry Vyukov | 334553e | 2013-02-01 09:42:06 +0000 | [diff] [blame] | 165 | MemoryRead(thr, pc, (uptr)d, kSizeLog8); |
Dmitry Vyukov | fb8ca81 | 2012-12-12 12:27:00 +0000 | [diff] [blame] | 166 | } |
| 167 | |
Dmitry Vyukov | a597258 | 2013-01-09 17:31:27 +0000 | [diff] [blame] | 168 | void FdAccess(ThreadState *thr, uptr pc, int fd) { |
| 169 | DPrintf("#%d: FdAccess(%d)\n", thr->tid, fd); |
| 170 | FdDesc *d = fddesc(thr, pc, fd); |
Dmitry Vyukov | 334553e | 2013-02-01 09:42:06 +0000 | [diff] [blame] | 171 | MemoryRead(thr, pc, (uptr)d, kSizeLog8); |
Dmitry Vyukov | a597258 | 2013-01-09 17:31:27 +0000 | [diff] [blame] | 172 | } |
| 173 | |
Dmitry Vyukov | fb8ca81 | 2012-12-12 12:27:00 +0000 | [diff] [blame] | 174 | void FdClose(ThreadState *thr, uptr pc, int fd) { |
| 175 | DPrintf("#%d: FdClose(%d)\n", thr->tid, fd); |
Dmitry Vyukov | c2234cd | 2012-12-18 06:57:34 +0000 | [diff] [blame] | 176 | FdDesc *d = fddesc(thr, pc, fd); |
Dmitry Vyukov | fb8ca81 | 2012-12-12 12:27:00 +0000 | [diff] [blame] | 177 | // To catch races between fd usage and close. |
Dmitry Vyukov | 334553e | 2013-02-01 09:42:06 +0000 | [diff] [blame] | 178 | MemoryWrite(thr, pc, (uptr)d, kSizeLog8); |
Dmitry Vyukov | fb8ca81 | 2012-12-12 12:27:00 +0000 | [diff] [blame] | 179 | // We need to clear it, because if we do not intercept any call out there |
| 180 | // that creates fd, we will hit false postives. |
Dmitry Vyukov | c2234cd | 2012-12-18 06:57:34 +0000 | [diff] [blame] | 181 | MemoryResetRange(thr, pc, (uptr)d, 8); |
| 182 | unref(thr, pc, d->sync); |
| 183 | d->sync = 0; |
| 184 | d->creation_tid = 0; |
| 185 | d->creation_stack = 0; |
Dmitry Vyukov | fb8ca81 | 2012-12-12 12:27:00 +0000 | [diff] [blame] | 186 | } |
| 187 | |
| 188 | void FdFileCreate(ThreadState *thr, uptr pc, int fd) { |
| 189 | DPrintf("#%d: FdFileCreate(%d)\n", thr->tid, fd); |
Dmitry Vyukov | c2234cd | 2012-12-18 06:57:34 +0000 | [diff] [blame] | 190 | init(thr, pc, fd, &fdctx.filesync); |
Dmitry Vyukov | fb8ca81 | 2012-12-12 12:27:00 +0000 | [diff] [blame] | 191 | } |
| 192 | |
| 193 | void FdDup(ThreadState *thr, uptr pc, int oldfd, int newfd) { |
| 194 | DPrintf("#%d: FdDup(%d, %d)\n", thr->tid, oldfd, newfd); |
| 195 | // Ignore the case when user dups not yet connected socket. |
Dmitry Vyukov | c2234cd | 2012-12-18 06:57:34 +0000 | [diff] [blame] | 196 | FdDesc *od = fddesc(thr, pc, oldfd); |
Dmitry Vyukov | 334553e | 2013-02-01 09:42:06 +0000 | [diff] [blame] | 197 | MemoryRead(thr, pc, (uptr)od, kSizeLog8); |
Dmitry Vyukov | fb8ca81 | 2012-12-12 12:27:00 +0000 | [diff] [blame] | 198 | FdClose(thr, pc, newfd); |
Dmitry Vyukov | c2234cd | 2012-12-18 06:57:34 +0000 | [diff] [blame] | 199 | init(thr, pc, newfd, ref(od->sync)); |
Dmitry Vyukov | fb8ca81 | 2012-12-12 12:27:00 +0000 | [diff] [blame] | 200 | } |
| 201 | |
| 202 | void FdPipeCreate(ThreadState *thr, uptr pc, int rfd, int wfd) { |
| 203 | DPrintf("#%d: FdCreatePipe(%d, %d)\n", thr->tid, rfd, wfd); |
Dmitry Vyukov | c2234cd | 2012-12-18 06:57:34 +0000 | [diff] [blame] | 204 | FdSync *s = allocsync(); |
Dmitry Vyukov | e3178e8 | 2012-12-18 12:20:55 +0000 | [diff] [blame] | 205 | init(thr, pc, rfd, ref(s)); |
Dmitry Vyukov | c2234cd | 2012-12-18 06:57:34 +0000 | [diff] [blame] | 206 | init(thr, pc, wfd, ref(s)); |
Dmitry Vyukov | e3178e8 | 2012-12-18 12:20:55 +0000 | [diff] [blame] | 207 | unref(thr, pc, s); |
Dmitry Vyukov | fb8ca81 | 2012-12-12 12:27:00 +0000 | [diff] [blame] | 208 | } |
| 209 | |
| 210 | void FdEventCreate(ThreadState *thr, uptr pc, int fd) { |
| 211 | DPrintf("#%d: FdEventCreate(%d)\n", thr->tid, fd); |
Dmitry Vyukov | c2234cd | 2012-12-18 06:57:34 +0000 | [diff] [blame] | 212 | init(thr, pc, fd, allocsync()); |
Dmitry Vyukov | fb8ca81 | 2012-12-12 12:27:00 +0000 | [diff] [blame] | 213 | } |
| 214 | |
Dmitry Vyukov | 45d4324 | 2012-12-18 12:35:31 +0000 | [diff] [blame] | 215 | void FdSignalCreate(ThreadState *thr, uptr pc, int fd) { |
| 216 | DPrintf("#%d: FdSignalCreate(%d)\n", thr->tid, fd); |
| 217 | init(thr, pc, fd, 0); |
| 218 | } |
| 219 | |
| 220 | void FdInotifyCreate(ThreadState *thr, uptr pc, int fd) { |
| 221 | DPrintf("#%d: FdInotifyCreate(%d)\n", thr->tid, fd); |
| 222 | init(thr, pc, fd, 0); |
| 223 | } |
| 224 | |
Dmitry Vyukov | fb8ca81 | 2012-12-12 12:27:00 +0000 | [diff] [blame] | 225 | void FdPollCreate(ThreadState *thr, uptr pc, int fd) { |
| 226 | DPrintf("#%d: FdPollCreate(%d)\n", thr->tid, fd); |
Dmitry Vyukov | c2234cd | 2012-12-18 06:57:34 +0000 | [diff] [blame] | 227 | init(thr, pc, fd, allocsync()); |
Dmitry Vyukov | fb8ca81 | 2012-12-12 12:27:00 +0000 | [diff] [blame] | 228 | } |
| 229 | |
| 230 | void FdSocketCreate(ThreadState *thr, uptr pc, int fd) { |
| 231 | DPrintf("#%d: FdSocketCreate(%d)\n", thr->tid, fd); |
| 232 | // It can be a UDP socket. |
Dmitry Vyukov | c2234cd | 2012-12-18 06:57:34 +0000 | [diff] [blame] | 233 | init(thr, pc, fd, &fdctx.socksync); |
Dmitry Vyukov | fb8ca81 | 2012-12-12 12:27:00 +0000 | [diff] [blame] | 234 | } |
| 235 | |
| 236 | void FdSocketAccept(ThreadState *thr, uptr pc, int fd, int newfd) { |
| 237 | DPrintf("#%d: FdSocketAccept(%d, %d)\n", thr->tid, fd, newfd); |
Dmitry Vyukov | ed513f6 | 2012-12-14 20:01:58 +0000 | [diff] [blame] | 238 | // Synchronize connect->accept. |
| 239 | Acquire(thr, pc, (uptr)&fdctx.connectsync); |
Dmitry Vyukov | c2234cd | 2012-12-18 06:57:34 +0000 | [diff] [blame] | 240 | init(thr, pc, newfd, &fdctx.socksync); |
Dmitry Vyukov | fb8ca81 | 2012-12-12 12:27:00 +0000 | [diff] [blame] | 241 | } |
| 242 | |
Dmitry Vyukov | ed513f6 | 2012-12-14 20:01:58 +0000 | [diff] [blame] | 243 | void FdSocketConnecting(ThreadState *thr, uptr pc, int fd) { |
| 244 | DPrintf("#%d: FdSocketConnecting(%d)\n", thr->tid, fd); |
| 245 | // Synchronize connect->accept. |
| 246 | Release(thr, pc, (uptr)&fdctx.connectsync); |
| 247 | } |
| 248 | |
Dmitry Vyukov | fb8ca81 | 2012-12-12 12:27:00 +0000 | [diff] [blame] | 249 | void FdSocketConnect(ThreadState *thr, uptr pc, int fd) { |
| 250 | DPrintf("#%d: FdSocketConnect(%d)\n", thr->tid, fd); |
Dmitry Vyukov | c2234cd | 2012-12-18 06:57:34 +0000 | [diff] [blame] | 251 | init(thr, pc, fd, &fdctx.socksync); |
Dmitry Vyukov | fb8ca81 | 2012-12-12 12:27:00 +0000 | [diff] [blame] | 252 | } |
| 253 | |
| 254 | uptr File2addr(char *path) { |
| 255 | (void)path; |
| 256 | static u64 addr; |
| 257 | return (uptr)&addr; |
| 258 | } |
| 259 | |
| 260 | uptr Dir2addr(char *path) { |
| 261 | (void)path; |
| 262 | static u64 addr; |
| 263 | return (uptr)&addr; |
| 264 | } |
| 265 | |
| 266 | } // namespace __tsan |