check_locking.c

   1 /*
   2  * Copyright (C) 2009 Dan Carpenter.
   3  *
   4  * This program is free software; you can redistribute it and/or
   5  * modify it under the terms of the GNU General Public License
   6  * as published by the Free Software Foundation; either version 2
   7  * of the License, or (at your option) any later version.
   8  *
   9  * This program is distributed in the hope that it will be useful,
  10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12  * GNU General Public License for more details.
  13  *
  14  * You should have received a copy of the GNU General Public License
  15  * along with this program; if not, see http://www.gnu.org/copyleft/gpl.txt
  16  */
  17
  18 /*
  19  * This test checks that locks are held the same across all returns.
  20  *
  21  * Of course, some functions are designed to only hold the locks on success.
  22  * Oh well... We can rewrite it later if we want.
  23  *
  24  * The list of wine locking functions came from an earlier script written
  25  * by Michael Stefaniuc.
  26  *
  27  */
  28
  29 #include "parse.h"
  30 #include "smatch.h"
  31 #include "smatch_extra.h"
  32 #include "smatch_slist.h"
  33
  34 static int my_id;
  35
  36 static int func_has_transition;
  37
  38 STATE(locked);
  39 STATE(start_state);
  40 STATE(unlocked);
  41
  42 enum action {
  43         LOCK,
  44         UNLOCK,
  45 };
  46
  47 enum return_type {
  48         ret_any,
  49         ret_non_zero,
  50         ret_zero,
  51         ret_negative,
  52         ret_positive,
  53 };
  54
  55 #define RETURN_VAL -1
  56 #define NO_ARG -2
  57
  58 struct lock_info {
  59         const char *function;
  60         enum action action;
  61         const char *name;
  62         int arg;
  63         enum return_type return_type;
  64 };
  65
  66 static struct lock_info wine_lock_table[] = {
  67         {"create_window_handle", LOCK, "create_window_handle", RETURN_VAL, ret_non_zero},
  68         {"WIN_GetPtr", LOCK, "create_window_handle", RETURN_VAL, ret_non_zero},
  69         {"WIN_ReleasePtr", UNLOCK, "create_window_handle", 0, ret_any},
  70         {"EnterCriticalSection", LOCK, "CriticalSection", 0, ret_any},
  71         {"LeaveCriticalSection", UNLOCK, "CriticalSection", 0, ret_any},
  72         {"RtlEnterCriticalSection", LOCK, "RtlCriticalSection", 0, ret_any},
  73         {"RtlLeaveCriticalSection", UNLOCK, "RtlCriticalSection", 0, ret_any},
  74         {"GDI_GetObjPtr", LOCK, "GDI_Get", 0, ret_non_zero},
  75         {"GDI_ReleaseObj", UNLOCK, "GDI_Get", 0, ret_any},
  76         {"LdrLockLoaderLock", LOCK, "LdrLockLoaderLock", 2, ret_any},
  77         {"LdrUnlockLoaderLock", UNLOCK, "LdrLockLoaderLock", 1, ret_any},
  78         {"_lock", LOCK, "_lock", 0, ret_any},
  79         {"_unlock", UNLOCK, "_lock", 0, ret_any},
  80         {"msiobj_lock", LOCK, "msiobj_lock", 0, ret_any},
  81         {"msiobj_unlock", UNLOCK, "msiobj_lock", 0, ret_any},
  82         {"RtlAcquirePebLock", LOCK, "PebLock", NO_ARG, ret_any},
  83         {"RtlReleasePebLock", UNLOCK, "PebLock", NO_ARG, ret_any},
  84         {"server_enter_uninterrupted_section", LOCK, "server_uninterrupted_section", 0, ret_any},
  85         {"server_leave_uninterrupted_section", UNLOCK, "server_uninterrupted_section", 0, ret_any},
  86         {"RtlLockHeap", LOCK, "RtlLockHeap", 0, ret_any},
  87         {"RtlUnlockHeap", UNLOCK, "RtlLockHeap", 0, ret_any},
  88         {"_EnterSysLevel", LOCK, "SysLevel", 0, ret_any},
  89         {"_LeaveSysLevel", UNLOCK, "SysLevel", 0, ret_any},
  90         {"USER_Lock", LOCK, "USER_Lock", NO_ARG, ret_any},
  91         {"USER_Unlock", UNLOCK, "USER_Lock", NO_ARG, ret_any},
  92         {"wine_tsx11_lock", LOCK, "wine_tsx11_lock", NO_ARG, ret_any},
  93         {"wine_tsx11_unlock", UNLOCK, "wine_tsx11_lock", NO_ARG, ret_any},
  94         {"wine_tsx11_lock_ptr", LOCK, "wine_tsx11_lock_ptr", NO_ARG, ret_any},
  95         {"wine_tsx11_unlock_ptr", UNLOCK, "wine_tsx11_lock_ptr", NO_ARG, ret_any},
  96         {"wined3d_mutex_lock", LOCK, "wined3d_mutex_lock", NO_ARG, ret_any},
  97         {"wined3d_mutex_unlock", UNLOCK, "wined3d_mutex_lock", NO_ARG, ret_any},
  98         {"X11DRV_DIB_Lock", LOCK, "X11DRV_DIB_Lock", 0, ret_any},
  99         {"X11DRV_DIB_Unlock", UNLOCK, "X11DRV_DIB_Lock", 0, ret_any},
 100 };
 101
 102 static struct lock_info kernel_lock_table[] = {
 103         {"lock_kernel",   LOCK,   "BKL", NO_ARG, ret_any},
 104         {"unlock_kernel", UNLOCK, "BKL", NO_ARG, ret_any},
 105
 106         {"spin_lock",                  LOCK,   "spin_lock", 0, ret_any},
 107         {"spin_unlock",                UNLOCK, "spin_lock", 0, ret_any},
 108         {"spin_lock_nested",           LOCK,   "spin_lock", 0, ret_any},
 109         {"_spin_lock",                 LOCK,   "spin_lock", 0, ret_any},
 110         {"_spin_unlock",               UNLOCK, "spin_lock", 0, ret_any},
 111         {"_spin_lock_nested",          LOCK,   "spin_lock", 0, ret_any},
 112         {"__spin_lock",                LOCK,   "spin_lock", 0, ret_any},
 113         {"__spin_unlock",              UNLOCK, "spin_lock", 0, ret_any},
 114         {"__spin_lock_nested",         LOCK,   "spin_lock", 0, ret_any},
 115         {"raw_spin_lock",              LOCK,   "spin_lock", 0, ret_any},
 116         {"raw_spin_unlock",            UNLOCK, "spin_lock", 0, ret_any},
 117         {"_raw_spin_lock",             LOCK,   "spin_lock", 0, ret_any},
 118         {"_raw_spin_lock_nested",      LOCK,   "spin_lock", 0, ret_any},
 119         {"_raw_spin_unlock",           UNLOCK, "spin_lock", 0, ret_any},
 120         {"__raw_spin_lock",            LOCK,   "spin_lock", 0, ret_any},
 121         {"__raw_spin_unlock",          UNLOCK, "spin_lock", 0, ret_any},
 122
 123         {"spin_lock_irq",              LOCK,   "spin_lock", 0, ret_any},
 124         {"spin_unlock_irq",            UNLOCK, "spin_lock", 0, ret_any},
 125         {"_spin_lock_irq",             LOCK,   "spin_lock", 0, ret_any},
 126         {"_spin_unlock_irq",           UNLOCK, "spin_lock", 0, ret_any},
 127         {"__spin_lock_irq",            LOCK,   "spin_lock", 0, ret_any},
 128         {"__spin_unlock_irq",          UNLOCK, "spin_lock", 0, ret_any},
 129         {"_raw_spin_lock_irq",         LOCK,   "spin_lock", 0, ret_any},
 130         {"_raw_spin_unlock_irq",       UNLOCK, "spin_lock", 0, ret_any},
 131         {"__raw_spin_unlock_irq",      UNLOCK, "spin_lock", 0, ret_any},
 132         {"spin_lock_irqsave",          LOCK,   "spin_lock", 0, ret_any},
 133         {"spin_unlock_irqrestore",     UNLOCK, "spin_lock", 0, ret_any},
 134         {"_spin_lock_irqsave",         LOCK,   "spin_lock", 0, ret_any},
 135         {"_spin_unlock_irqrestore",    UNLOCK, "spin_lock", 0, ret_any},
 136         {"__spin_lock_irqsave",        LOCK,   "spin_lock", 0, ret_any},
 137         {"__spin_unlock_irqrestore",   UNLOCK, "spin_lock", 0, ret_any},
 138         {"_raw_spin_lock_irqsave",     LOCK,   "spin_lock", 0, ret_any},
 139         {"_raw_spin_unlock_irqrestore", UNLOCK, "spin_lock", 0, ret_any},
 140         {"__raw_spin_lock_irqsave",    LOCK,   "spin_lock", 0, ret_any},
 141         {"__raw_spin_unlock_irqrestore", UNLOCK, "spin_lock", 0, ret_any},
 142         {"spin_lock_irqsave_nested",   LOCK,   "spin_lock", 0, ret_any},
 143         {"_spin_lock_irqsave_nested",  LOCK,   "spin_lock", 0, ret_any},
 144         {"__spin_lock_irqsave_nested", LOCK,   "spin_lock", 0, ret_any},
 145         {"_raw_spin_lock_irqsave_nested", LOCK, "spin_lock", 0, ret_any},
 146         {"spin_lock_bh",               LOCK,   "spin_lock", 0, ret_any},
 147         {"spin_unlock_bh",             UNLOCK, "spin_lock", 0, ret_any},
 148         {"_spin_lock_bh",              LOCK,   "spin_lock", 0, ret_any},
 149         {"_spin_unlock_bh",            UNLOCK, "spin_lock", 0, ret_any},
 150         {"__spin_lock_bh",             LOCK,   "spin_lock", 0, ret_any},
 151         {"__spin_unlock_bh",           UNLOCK, "spin_lock", 0, ret_any},
 152
 153         {"spin_trylock",               LOCK,   "spin_lock", 0, ret_non_zero},
 154         {"_spin_trylock",              LOCK,   "spin_lock", 0, ret_non_zero},
 155         {"__spin_trylock",             LOCK,   "spin_lock", 0, ret_non_zero},
 156         {"raw_spin_trylock",           LOCK,   "spin_lock", 0, ret_non_zero},
 157         {"_raw_spin_trylock",          LOCK,   "spin_lock", 0, ret_non_zero},
 158         {"spin_trylock_irq",           LOCK,   "spin_lock", 0, ret_non_zero},
 159         {"spin_trylock_irqsave",       LOCK,   "spin_lock", 0, ret_non_zero},
 160         {"spin_trylock_bh",            LOCK,   "spin_lock", 0, ret_non_zero},
 161         {"_spin_trylock_bh",           LOCK,   "spin_lock", 0, ret_non_zero},
 162         {"__spin_trylock_bh",          LOCK,   "spin_lock", 0, ret_non_zero},
 163         {"__raw_spin_trylock",         LOCK,   "spin_lock", 0, ret_non_zero},
 164         {"_atomic_dec_and_lock",       LOCK,   "spin_lock", 1, ret_non_zero},
 165
 166         {"read_lock",                 LOCK,   "read_lock", 0, ret_any},
 167         {"read_unlock",               UNLOCK, "read_lock", 0, ret_any},
 168         {"_read_lock",                LOCK,   "read_lock", 0, ret_any},
 169         {"_read_unlock",              UNLOCK, "read_lock", 0, ret_any},
 170         {"__read_lock",               LOCK,   "read_lock", 0, ret_any},
 171         {"__read_unlock",             UNLOCK, "read_lock", 0, ret_any},
 172         {"_raw_read_lock",            LOCK,   "read_lock", 0, ret_any},
 173         {"_raw_read_unlock",          UNLOCK, "read_lock", 0, ret_any},
 174         {"read_lock_irq",             LOCK,   "read_lock", 0, ret_any},
 175         {"read_unlock_irq" ,          UNLOCK, "read_lock", 0, ret_any},
 176         {"_read_lock_irq",            LOCK,   "read_lock", 0, ret_any},
 177         {"_read_unlock_irq",          UNLOCK, "read_lock", 0, ret_any},
 178         {"__read_lock_irq",           LOCK,   "read_lock", 0, ret_any},
 179         {"__read_unlock_irq",         UNLOCK, "read_lock", 0, ret_any},
 180         {"read_lock_irqsave",         LOCK,   "read_lock", 0, ret_any},
 181         {"read_unlock_irqrestore",    UNLOCK, "read_lock", 0, ret_any},
 182         {"_read_lock_irqsave",        LOCK,   "read_lock", 0, ret_any},
 183         {"_read_unlock_irqrestore",   UNLOCK, "read_lock", 0, ret_any},
 184         {"__read_lock_irqsave",       LOCK,   "read_lock", 0, ret_any},
 185         {"__read_unlock_irqrestore",  UNLOCK, "read_lock", 0, ret_any},
 186         {"read_lock_bh",              LOCK,   "read_lock", 0, ret_any},
 187         {"read_unlock_bh",            UNLOCK, "read_lock", 0, ret_any},
 188         {"_read_lock_bh",             LOCK,   "read_lock", 0, ret_any},
 189         {"_read_unlock_bh",           UNLOCK, "read_lock", 0, ret_any},
 190         {"__read_lock_bh",            LOCK,   "read_lock", 0, ret_any},
 191         {"__read_unlock_bh",          UNLOCK, "read_lock", 0, ret_any},
 192         {"_raw_read_lock_bh",         LOCK,   "read_lock", 0, ret_any},
 193         {"_raw_read_unlock_bh",       UNLOCK, "read_lock", 0, ret_any},
 194
 195         {"generic__raw_read_trylock", LOCK,   "read_lock", 0, ret_non_zero},
 196         {"read_trylock",              LOCK,   "read_lock", 0, ret_non_zero},
 197         {"_read_trylock",             LOCK,   "read_lock", 0, ret_non_zero},
 198         {"raw_read_trylock",          LOCK,   "read_lock", 0, ret_non_zero},
 199         {"_raw_read_trylock",         LOCK,   "read_lock", 0, ret_non_zero},
 200         {"__raw_read_trylock",        LOCK,   "read_lock", 0, ret_non_zero},
 201         {"__read_trylock",            LOCK,   "read_lock", 0, ret_non_zero},
 202
 203         {"write_lock",                LOCK,   "write_lock", 0, ret_any},
 204         {"write_unlock",              UNLOCK, "write_lock", 0, ret_any},
 205         {"_write_lock",               LOCK,   "write_lock", 0, ret_any},
 206         {"_write_unlock",             UNLOCK, "write_lock", 0, ret_any},
 207         {"__write_lock",              LOCK,   "write_lock", 0, ret_any},
 208         {"__write_unlock",            UNLOCK, "write_lock", 0, ret_any},
 209         {"write_lock_irq",            LOCK,   "write_lock", 0, ret_any},
 210         {"write_unlock_irq",          UNLOCK, "write_lock", 0, ret_any},
 211         {"_write_lock_irq",           LOCK,   "write_lock", 0, ret_any},
 212         {"_write_unlock_irq",         UNLOCK, "write_lock", 0, ret_any},
 213         {"__write_lock_irq",          LOCK,   "write_lock", 0, ret_any},
 214         {"__write_unlock_irq",        UNLOCK, "write_lock", 0, ret_any},
 215         {"write_lock_irqsave",        LOCK,   "write_lock", 0, ret_any},
 216         {"write_unlock_irqrestore",   UNLOCK, "write_lock", 0, ret_any},
 217         {"_write_lock_irqsave",       LOCK,   "write_lock", 0, ret_any},
 218         {"_write_unlock_irqrestore",  UNLOCK, "write_lock", 0, ret_any},
 219         {"__write_lock_irqsave",      LOCK,   "write_lock", 0, ret_any},
 220         {"__write_unlock_irqrestore", UNLOCK, "write_lock", 0, ret_any},
 221         {"write_lock_bh",             LOCK,   "write_lock", 0, ret_any},
 222         {"write_unlock_bh",           UNLOCK, "write_lock", 0, ret_any},
 223         {"_write_lock_bh",            LOCK,   "write_lock", 0, ret_any},
 224         {"_write_unlock_bh",          UNLOCK, "write_lock", 0, ret_any},
 225         {"__write_lock_bh",           LOCK,   "write_lock", 0, ret_any},
 226         {"__write_unlock_bh",         UNLOCK, "write_lock", 0, ret_any},
 227
 228         {"write_trylock",             LOCK,   "write_lock", 0, ret_non_zero},
 229         {"_write_trylock",            LOCK,   "write_lock", 0, ret_non_zero},
 230         {"raw_write_trylock",         LOCK,   "write_lock", 0, ret_non_zero},
 231         {"_raw_write_trylock",        LOCK,   "write_lock", 0, ret_non_zero},
 232         {"__write_trylock",           LOCK,   "write_lock", 0, ret_non_zero},
 233         {"__raw_write_trylock",       LOCK,   "write_lock", 0, ret_non_zero},
 234
 235         {"down",               LOCK,   "sem", 0, ret_any},
 236         {"up",                 UNLOCK, "sem", 0, ret_any},
 237         {"down_trylock",       LOCK,   "sem", 0, ret_zero},
 238         {"down_interruptible", LOCK,   "sem", 0, ret_zero},
 239
 240         {"mutex_lock",                      LOCK,   "mutex", 0, ret_any},
 241         {"mutex_unlock",                    UNLOCK, "mutex", 0, ret_any},
 242         {"mutex_lock_nested",               LOCK,   "mutex", 0, ret_any},
 243
 244         {"mutex_lock_interruptible",        LOCK,   "mutex", 0, ret_zero},
 245         {"mutex_lock_interruptible_nested", LOCK,   "mutex", 0, ret_zero},
 246         {"mutex_lock_killable",             LOCK,   "mutex", 0, ret_zero},
 247         {"mutex_lock_killable_nested",      LOCK,   "mutex", 0, ret_zero},
 248
 249         {"mutex_trylock",                   LOCK,   "mutex", 0, ret_non_zero},
 250
 251         {"raw_local_irq_disable", LOCK,   "irq", NO_ARG, ret_any},
 252         {"raw_local_irq_enable",  UNLOCK, "irq", NO_ARG, ret_any},
 253         {"spin_lock_irq",         LOCK,   "irq", NO_ARG, ret_any},
 254         {"spin_unlock_irq",       UNLOCK, "irq", NO_ARG, ret_any},
 255         {"_spin_lock_irq",        LOCK,   "irq", NO_ARG, ret_any},
 256         {"_spin_unlock_irq",      UNLOCK, "irq", NO_ARG, ret_any},
 257         {"__spin_lock_irq",       LOCK,   "irq", NO_ARG, ret_any},
 258         {"__spin_unlock_irq",     UNLOCK, "irq", NO_ARG, ret_any},
 259         {"_raw_spin_lock_irq",    LOCK,   "irq", NO_ARG, ret_any},
 260         {"_raw_spin_unlock_irq",  UNLOCK, "irq", NO_ARG, ret_any},
 261         {"__raw_spin_unlock_irq", UNLOCK, "irq", NO_ARG, ret_any},
 262         {"spin_trylock_irq",      LOCK,   "irq", NO_ARG, ret_non_zero},
 263         {"read_lock_irq",         LOCK,   "irq", NO_ARG, ret_any},
 264         {"read_unlock_irq",       UNLOCK, "irq", NO_ARG, ret_any},
 265         {"_read_lock_irq",        LOCK,   "irq", NO_ARG, ret_any},
 266         {"_read_unlock_irq",      UNLOCK, "irq", NO_ARG, ret_any},
 267         {"__read_lock_irq",       LOCK,   "irq", NO_ARG, ret_any},
 268         {"__read_unlock_irq",     UNLOCK, "irq", NO_ARG, ret_any},
 269         {"write_lock_irq",        LOCK,   "irq", NO_ARG, ret_any},
 270         {"write_unlock_irq",      UNLOCK, "irq", NO_ARG, ret_any},
 271         {"_write_lock_irq",       LOCK,   "irq", NO_ARG, ret_any},
 272         {"_write_unlock_irq",     UNLOCK, "irq", NO_ARG, ret_any},
 273         {"__write_lock_irq",      LOCK,   "irq", NO_ARG, ret_any},
 274         {"__write_unlock_irq",    UNLOCK, "irq", NO_ARG, ret_any},
 275
 276         {"arch_local_irq_save",        LOCK,   "irqsave", RETURN_VAL, ret_any},
 277         {"arch_local_irq_restore",     UNLOCK, "irqsave", 0, ret_any},
 278         {"__raw_local_irq_save",       LOCK,   "irqsave", RETURN_VAL, ret_any},
 279         {"raw_local_irq_restore",      UNLOCK, "irqsave", 0, ret_any},
 280         {"spin_lock_irqsave_nested",   LOCK,   "irqsave", RETURN_VAL, ret_any},
 281         {"spin_lock_irqsave",          LOCK,   "irqsave", RETURN_VAL, ret_any},
 282         {"spin_lock_irqsave",          LOCK,   "irqsave", 1, ret_any},
 283         {"spin_unlock_irqrestore",     UNLOCK, "irqsave", 1, ret_any},
 284         {"_spin_lock_irqsave_nested",  LOCK,   "irqsave", RETURN_VAL, ret_any},
 285         {"_spin_lock_irqsave",         LOCK,   "irqsave", RETURN_VAL, ret_any},
 286         {"_spin_lock_irqsave",         LOCK,   "irqsave", 1, ret_any},
 287         {"_spin_unlock_irqrestore",    UNLOCK, "irqsave", 1, ret_any},
 288         {"__spin_lock_irqsave_nested", LOCK,   "irqsave", 1, ret_any},
 289         {"__spin_lock_irqsave",        LOCK,   "irqsave", 1, ret_any},
 290         {"__spin_unlock_irqrestore",   UNLOCK, "irqsave", 1, ret_any},
 291         {"_raw_spin_lock_irqsave",     LOCK,   "irqsave", RETURN_VAL, ret_any},
 292         {"_raw_spin_lock_irqsave",     LOCK,   "irqsave", 1, ret_any},
 293         {"_raw_spin_unlock_irqrestore",UNLOCK, "irqsave", 1, ret_any},
 294         {"__raw_spin_lock_irqsave",    LOCK,   "irqsave", RETURN_VAL, ret_any},
 295         {"__raw_spin_unlock_irqrestore",UNLOCK, "irqsave", 1, ret_any},
 296         {"_raw_spin_lock_irqsave_nested", LOCK, "irqsave", RETURN_VAL, ret_any},
 297         {"spin_trylock_irqsave",       LOCK,   "irqsave", 1, ret_non_zero},
 298         {"read_lock_irqsave",          LOCK,   "irqsave", RETURN_VAL, ret_any},
 299         {"read_lock_irqsave",          LOCK,   "irqsave", 1, ret_any},
 300         {"read_unlock_irqrestore",     UNLOCK, "irqsave", 1, ret_any},
 301         {"_read_lock_irqsave",         LOCK,   "irqsave", RETURN_VAL, ret_any},
 302         {"_read_lock_irqsave",         LOCK,   "irqsave", 1, ret_any},
 303         {"_read_unlock_irqrestore",    UNLOCK, "irqsave", 1, ret_any},
 304         {"__read_lock_irqsave",        LOCK,   "irqsave", RETURN_VAL, ret_any},
 305         {"__read_unlock_irqrestore",   UNLOCK, "irqsave", 1, ret_any},
 306         {"write_lock_irqsave",         LOCK,   "irqsave", RETURN_VAL, ret_any},
 307         {"write_lock_irqsave",         LOCK,   "irqsave", 1, ret_any},
 308         {"write_unlock_irqrestore",    UNLOCK, "irqsave", 1, ret_any},
 309         {"_write_lock_irqsave",        LOCK,   "irqsave", RETURN_VAL, ret_any},
 310         {"_write_lock_irqsave",        LOCK,   "irqsave", 1, ret_any},
 311         {"_write_unlock_irqrestore",   UNLOCK, "irqsave", 1, ret_any},
 312         {"__write_lock_irqsave",       LOCK,   "irqsave", RETURN_VAL, ret_any},
 313         {"__write_unlock_irqrestore",  UNLOCK, "irqsave", 1, ret_any},
 314
 315         {"local_bh_disable",    LOCK,   "bottom_half", NO_ARG, ret_any},
 316         {"_local_bh_disable",   LOCK,   "bottom_half", NO_ARG, ret_any},
 317         {"__local_bh_disable",  LOCK,   "bottom_half", NO_ARG, ret_any},
 318         {"local_bh_enable",     UNLOCK, "bottom_half", NO_ARG, ret_any},
 319         {"_local_bh_enable",    UNLOCK, "bottom_half", NO_ARG, ret_any},
 320         {"__local_bh_enable",   UNLOCK, "bottom_half", NO_ARG, ret_any},
 321         {"spin_lock_bh",        LOCK,   "bottom_half", NO_ARG, ret_any},
 322         {"spin_unlock_bh",      UNLOCK, "bottom_half", NO_ARG, ret_any},
 323         {"_spin_lock_bh",       LOCK,   "bottom_half", NO_ARG, ret_any},
 324         {"_spin_unlock_bh",     UNLOCK, "bottom_half", NO_ARG, ret_any},
 325         {"__spin_lock_bh",      LOCK,   "bottom_half", NO_ARG, ret_any},
 326         {"__spin_unlock_bh",    UNLOCK, "bottom_half", NO_ARG, ret_any},
 327         {"read_lock_bh",        LOCK,   "bottom_half", NO_ARG, ret_any},
 328         {"read_unlock_bh",      UNLOCK, "bottom_half", NO_ARG, ret_any},
 329         {"_read_lock_bh",       LOCK,   "bottom_half", NO_ARG, ret_any},
 330         {"_read_unlock_bh",     UNLOCK, "bottom_half", NO_ARG, ret_any},
 331         {"__read_lock_bh",      LOCK,   "bottom_half", NO_ARG, ret_any},
 332         {"__read_unlock_bh",    UNLOCK, "bottom_half", NO_ARG, ret_any},
 333         {"_raw_read_lock_bh",   LOCK,   "bottom_half", NO_ARG, ret_any},
 334         {"_raw_read_unlock_bh", UNLOCK, "bottom_half", NO_ARG, ret_any},
 335         {"write_lock_bh",       LOCK,   "bottom_half", NO_ARG, ret_any},
 336         {"write_unlock_bh",     UNLOCK, "bottom_half", NO_ARG, ret_any},
 337         {"_write_lock_bh",      LOCK,   "bottom_half", NO_ARG, ret_any},
 338         {"_write_unlock_bh",    UNLOCK, "bottom_half", NO_ARG, ret_any},
 339         {"__write_lock_bh",     LOCK,   "bottom_half", NO_ARG, ret_any},
 340         {"__write_unlock_bh",   UNLOCK, "bottom_half", NO_ARG, ret_any},
 341         {"spin_trylock_bh",     LOCK,   "bottom_half", NO_ARG, ret_non_zero},
 342         {"_spin_trylock_bh",    LOCK,   "bottom_half", NO_ARG, ret_non_zero},
 343         {"__spin_trylock_bh",   LOCK,   "bottom_half", NO_ARG, ret_non_zero},
 344
 345         {"ffs_mutex_lock",        LOCK,   "mutex", 0, ret_zero},
 346 };
 347
 348 static struct lock_info *lock_table;
 349
 350 static struct tracker_list *starts_locked;
 351 static struct tracker_list *starts_unlocked;
 352
 353 struct locks_on_return {
 354         int line;
 355         struct tracker_list *locked;
 356         struct tracker_list *unlocked;
 357         struct range_list *return_values;
 358 };
 359 DECLARE_PTR_LIST(return_list, struct locks_on_return);
 360 static struct return_list *all_returns;
 361
 362 static char *make_full_name(const char *lock, const char *var)
 363 {
 364         static char tmp_buf[512];
 365
 366         snprintf(tmp_buf, sizeof(tmp_buf), "%s:%s", lock, var);
 367         remove_parens(tmp_buf);
 368         return alloc_string(tmp_buf);
 369 }
 370
 371 static struct expression *remove_spinlock_check(struct expression *expr)
 372 {
 373         if (expr->type != EXPR_CALL)
 374                 return expr;
 375         if (expr->fn->type != EXPR_SYMBOL)
 376                 return expr;
 377         if (strcmp(expr->fn->symbol_name->name, "spinlock_check"))
 378                 return expr;
 379         expr = get_argument_from_call_expr(expr->args, 0);
 380         return expr;
 381 }
 382
 383 static char *get_full_name(struct expression *expr, int index)
 384 {
 385         struct expression *arg;
 386         char *name = NULL;
 387         char *full_name = NULL;
 388         struct lock_info *lock = &lock_table[index];
 389
 390         if (lock->arg == RETURN_VAL) {
 391                 name = expr_to_var(expr->left);
 392                 full_name = make_full_name(lock->name, name);
 393         } else if (lock->arg == NO_ARG) {
 394                 full_name = make_full_name(lock->name, "");
 395         } else {
 396                 arg = get_argument_from_call_expr(expr->args, lock->arg);
 397                 if (!arg)
 398                         goto free;
 399                 arg = remove_spinlock_check(arg);
 400                 name = expr_to_str(arg);
 401                 if (!name)
 402                         goto free;
 403                 full_name = make_full_name(lock->name, name);
 404         }
 405 free:
 406         free_string(name);
 407         return full_name;
 408 }
 409
 410 static struct smatch_state *get_start_state(struct sm_state *sm)
 411 {
 412        int is_locked = 0;
 413        int is_unlocked = 0;
 414
 415        if (in_tracker_list(starts_locked, my_id, sm->name, sm->sym))
 416                is_locked = 1;
 417        if (in_tracker_list(starts_unlocked, my_id, sm->name, sm->sym))
 418                is_unlocked = 1;
 419        if (is_locked && is_unlocked)
 420                return &undefined;
 421        if (is_locked)
 422                return &locked;
 423        if (is_unlocked)
 424                return &unlocked;
 425         return &undefined;
 426 }
 427
 428 static struct smatch_state *unmatched_state(struct sm_state *sm)
 429 {
 430         return &start_state;
 431 }
 432
 433 static void do_lock(const char *name)
 434 {
 435         struct sm_state *sm;
 436
 437         if (__inline_fn)
 438                 return;
 439
 440         sm = get_sm_state(my_id, name, NULL);
 441         if (!sm)
 442                 add_tracker(&starts_unlocked, my_id, name, NULL);
 443         if (sm && slist_has_state(sm->possible, &locked) &&
 444                         strcmp(name, "bottom_half:") != 0)
 445                 sm_msg("error: double lock '%s'", name);
 446         if (sm)
 447                 func_has_transition = TRUE;
 448         set_state(my_id, name, NULL, &locked);
 449 }
 450
 451 static void do_lock_failed(const char *name)
 452 {
 453         struct sm_state *sm;
 454
 455         if (__inline_fn)
 456                 return;
 457
 458         sm = get_sm_state(my_id, name, NULL);
 459         if (!sm)
 460                 add_tracker(&starts_unlocked, my_id, name, NULL);
 461         set_state(my_id, name, NULL, &unlocked);
 462 }
 463
 464 static void do_unlock(const char *name)
 465 {
 466         struct sm_state *sm;
 467
 468         if (__inline_fn)
 469                 return;
 470         if (__path_is_null())
 471                 return;
 472         sm = get_sm_state(my_id, name, NULL);
 473         if (!sm)
 474                 add_tracker(&starts_locked, my_id, name, NULL);
 475         if (sm && slist_has_state(sm->possible, &unlocked) &&
 476                         strcmp(name, "bottom_half:") != 0)
 477                 sm_msg("error: double unlock '%s'", name);
 478         if (sm)
 479                 func_has_transition = TRUE;
 480         set_state(my_id, name, NULL, &unlocked);
 481 }
 482
 483 static void match_lock_held(const char *fn, struct expression *call_expr,
 484                         struct expression *assign_expr, void *_index)
 485 {
 486         int index = PTR_INT(_index);
 487         char *lock_name;
 488         struct lock_info *lock = &lock_table[index];
 489
 490         if (lock->arg == NO_ARG) {
 491                 lock_name = get_full_name(NULL, index);
 492         } else if (lock->arg == RETURN_VAL) {
 493                 if (!assign_expr)
 494                         return;
 495                 lock_name = get_full_name(assign_expr, index);
 496         } else {
 497                 lock_name = get_full_name(call_expr, index);
 498         }
 499         if (!lock_name)
 500                 return;
 501         do_lock(lock_name);
 502         free_string(lock_name);
 503 }
 504
 505 static void match_lock_failed(const char *fn, struct expression *call_expr,
 506                         struct expression *assign_expr, void *_index)
 507 {
 508         int index = PTR_INT(_index);
 509         char *lock_name;
 510         struct lock_info *lock = &lock_table[index];
 511
 512         if (lock->arg == NO_ARG) {
 513                 lock_name = get_full_name(NULL, index);
 514         } else if (lock->arg == RETURN_VAL) {
 515                 if (!assign_expr)
 516                         return;
 517                 lock_name = get_full_name(assign_expr, index);
 518         } else {
 519                 lock_name = get_full_name(call_expr, index);
 520         }
 521         if (!lock_name)
 522                 return;
 523         do_lock_failed(lock_name);
 524         free_string(lock_name);
 525 }
 526
 527 static void match_returns_locked(const char *fn, struct expression *expr,
 528                                       void *_index)
 529 {
 530         char *full_name = NULL;
 531         int index = PTR_INT(_index);
 532         struct lock_info *lock = &lock_table[index];
 533
 534         if (lock->arg != RETURN_VAL)
 535                 return;
 536         full_name = get_full_name(expr, index);
 537         do_lock(full_name);
 538 }
 539
 540 static void match_lock_unlock(const char *fn, struct expression *expr, void *_index)
 541 {
 542         char *full_name = NULL;
 543         int index = PTR_INT(_index);
 544         struct lock_info *lock = &lock_table[index];
 545
 546         if (__inline_fn)
 547                 return;
 548
 549         full_name = get_full_name(expr, index);
 550         if (!full_name)
 551                 return;
 552         if (lock->action == LOCK)
 553                 do_lock(full_name);
 554         else
 555                 do_unlock(full_name);
 556         free_string(full_name);
 557 }
 558
 559 static struct locks_on_return *alloc_return(struct expression *expr)
 560 {
 561         struct locks_on_return *ret;
 562
 563         ret = malloc(sizeof(*ret));
 564         if (!get_implied_rl(expr, &ret->return_values))
 565                 ret->return_values = NULL;
 566         ret->line = get_lineno();
 567         ret->locked = NULL;
 568         ret->unlocked = NULL;
 569         return ret;
 570 }
 571
 572 static int check_possible(struct sm_state *sm)
 573 {
 574         struct sm_state *tmp;
 575         int islocked = 0;
 576         int isunlocked = 0;
 577         int undef = 0;
 578
 579         if (!option_spammy)
 580                 return 0;
 581
 582         FOR_EACH_PTR(sm->possible, tmp) {
 583                 if (tmp->state == &locked)
 584                         islocked = 1;
 585                 if (tmp->state == &unlocked)
 586                         isunlocked = 1;
 587                 if (tmp->state == &start_state) {
 588                         struct smatch_state *s;
 589
 590                         s = get_start_state(tmp);
 591                         if (s == &locked)
 592                                 islocked = 1;
 593                         else if (s == &unlocked)
 594                                 isunlocked = 1;
 595                         else
 596                                 undef = 1;
 597                 }
 598                 if (tmp->state == &undefined)
 599                         undef = 1;  // i don't think this is possible any more.
 600         } END_FOR_EACH_PTR(tmp);
 601         if ((islocked && isunlocked) || undef) {
 602                 sm_msg("warn: '%s' is sometimes locked here and sometimes unlocked.", sm->name);
 603                 return 1;
 604         }
 605         return 0;
 606 }
 607
 608 static struct position warned_pos;
 609
 610 static void match_return(int return_id, char *return_ranges, struct expression *expr)
 611 {
 612         struct locks_on_return *ret;
 613         struct stree *stree;
 614         struct sm_state *tmp;
 615
 616         if (!final_pass)
 617                 return;
 618         if (__inline_fn)
 619                 return;
 620
 621         if (expr && cmp_pos(expr->pos, warned_pos) == 0)
 622                 return;
 623
 624         ret = alloc_return(expr);
 625
 626         stree = __get_cur_stree();
 627         FOR_EACH_MY_SM(my_id, stree, tmp) {
 628                 if (tmp->state == &locked) {
 629                         add_tracker(&ret->locked, tmp->owner, tmp->name,
 630                                 tmp->sym);
 631                 } else if (tmp->state == &unlocked) {
 632                         add_tracker(&ret->unlocked, tmp->owner, tmp->name,
 633                                 tmp->sym);
 634                 } else if (tmp->state == &start_state) {
 635                         struct smatch_state *s;
 636
 637                         s = get_start_state(tmp);
 638                         if (s == &locked)
 639                                 add_tracker(&ret->locked, tmp->owner, tmp->name,
 640                                             tmp->sym);
 641                         if (s == &unlocked)
 642                                 add_tracker(&ret->unlocked, tmp->owner,tmp->name,
 643                                              tmp->sym);
 644                 } else {
 645                         if (check_possible(tmp)) {
 646                                 if (expr)
 647                                         warned_pos = expr->pos;
 648                         }
 649                 }
 650         } END_FOR_EACH_SM(tmp);
 651         add_ptr_list(&all_returns, ret);
 652 }
 653
 654 static void add_line(struct range_list **rl, int line)
 655 {
 656         sval_t sval = sval_type_val(&int_ctype, line);
 657
 658         add_range(rl, sval, sval);
 659 }
 660
 661 static int line_printed(struct range_list *rl, int line)
 662 {
 663         sval_t sval = sval_type_val(&int_ctype, line);
 664
 665         return rl_has_sval(rl, sval);
 666 }
 667
 668 static void print_inconsistent_returns(struct tracker *lock,
 669                                 struct smatch_state *start)
 670 {
 671         struct locks_on_return *tmp;
 672         struct range_list *printed = NULL;
 673         int i;
 674
 675         sm_msg("warn: inconsistent returns '%s'.", lock->name);
 676         sm_printf("  Locked on:   ");
 677
 678         i = 0;
 679         FOR_EACH_PTR(all_returns, tmp) {
 680                 if (line_printed(printed, tmp->line))
 681                         continue;
 682                 if (in_tracker_list(tmp->unlocked, lock->owner, lock->name, lock->sym))
 683                         continue;
 684                 if (in_tracker_list(tmp->locked, lock->owner, lock->name, lock->sym)) {
 685                         if (i++)
 686                                 sm_printf("               ");
 687                         sm_printf("line %d\n", tmp->line);
 688                         add_line(&printed, tmp->line);
 689                         continue;
 690                 }
 691                 if (start == &locked) {
 692                         if (i++)
 693                                 sm_printf("               ");
 694                         sm_printf("line %d\n", tmp->line);
 695                         add_line(&printed, tmp->line);
 696                 }
 697         } END_FOR_EACH_PTR(tmp);
 698
 699         sm_printf("  Unlocked on: ");
 700         printed = NULL;
 701         i = 0;
 702         FOR_EACH_PTR(all_returns, tmp) {
 703                 if (line_printed(printed, tmp->line))
 704                         continue;
 705                 if (in_tracker_list(tmp->unlocked, lock->owner, lock->name, lock->sym)) {
 706                         if (i++)
 707                                 sm_printf("               ");
 708                         sm_printf("line %d\n", tmp->line);
 709                         add_line(&printed, tmp->line);
 710                         continue;
 711                 }
 712                 if (in_tracker_list(tmp->locked, lock->owner, lock->name, lock->sym))
 713                         continue;
 714                 if (start == &unlocked) {
 715                         if (i++)
 716                                 sm_printf("               ");
 717                         sm_printf("line %d\n", tmp->line);
 718                         add_line(&printed, tmp->line);
 719                 }
 720         } END_FOR_EACH_PTR(tmp);
 721 }
 722
 723 static int matches_return_type(struct range_list *rl, enum return_type type)
 724 {
 725         sval_t zero_sval = ll_to_sval(0);
 726
 727         /* All these double negatives are super ugly!  */
 728
 729         switch (type) {
 730         case ret_zero:
 731                 return !possibly_true_rl(rl, SPECIAL_NOTEQUAL, alloc_rl(zero_sval, zero_sval));
 732         case ret_non_zero:
 733                 return !possibly_true_rl(rl, SPECIAL_EQUAL, alloc_rl(zero_sval, zero_sval));
 734         case ret_negative:
 735                 return !possibly_true_rl(rl, SPECIAL_GTE, alloc_rl(zero_sval, zero_sval));
 736         case ret_positive:
 737                 return !possibly_true_rl(rl, '<', alloc_rl(zero_sval, zero_sval));
 738         case ret_any:
 739         default:
 740                 return 1;
 741         }
 742 }
 743
 744 static int match_held(struct tracker *lock, struct locks_on_return *this_return, struct smatch_state *start)
 745 {
 746         if (in_tracker_list(this_return->unlocked, lock->owner, lock->name, lock->sym))
 747                 return 0;
 748         if (in_tracker_list(this_return->locked, lock->owner, lock->name, lock->sym))
 749                 return 1;
 750         if (start == &unlocked)
 751                 return 0;
 752         return 1;
 753 }
 754
 755 static int match_released(struct tracker *lock, struct locks_on_return *this_return, struct smatch_state *start)
 756 {
 757         if (in_tracker_list(this_return->unlocked, lock->owner, lock->name, lock->sym))
 758                 return 1;
 759         if (in_tracker_list(this_return->locked, lock->owner, lock->name, lock->sym))
 760                 return 0;
 761         if (start == &unlocked)
 762                 return 1;
 763         return 0;
 764 }
 765
 766 static int held_on_return(struct tracker *lock, struct smatch_state *start, enum return_type type)
 767 {
 768         struct locks_on_return *tmp;
 769
 770         FOR_EACH_PTR(all_returns, tmp) {
 771                 if (!matches_return_type(tmp->return_values, type))
 772                         continue;
 773                 if (match_held(lock, tmp, start))
 774                         return 1;
 775         } END_FOR_EACH_PTR(tmp);
 776         return 0;
 777 }
 778
 779 static int released_on_return(struct tracker *lock, struct smatch_state *start, enum return_type type)
 780 {
 781         struct locks_on_return *tmp;
 782
 783         FOR_EACH_PTR(all_returns, tmp) {
 784                 if (!matches_return_type(tmp->return_values, type))
 785                         continue;
 786                 if (match_released(lock, tmp, start))
 787                         return 1;
 788         } END_FOR_EACH_PTR(tmp);
 789         return 0;
 790 }
 791
 792 static void check_returns_consistently(struct tracker *lock,
 793                                 struct smatch_state *start)
 794 {
 795         struct symbol *type;
 796
 797         if (!held_on_return(lock, start, ret_any) ||
 798             !released_on_return(lock, start, ret_any))
 799                 return;
 800
 801         if (held_on_return(lock, start, ret_zero) &&
 802             !held_on_return(lock, start, ret_non_zero))
 803                 return;
 804
 805         if (held_on_return(lock, start, ret_positive) &&
 806             !held_on_return(lock, start, ret_zero))
 807                 return;
 808
 809         if (held_on_return(lock, start, ret_positive) &&
 810             !held_on_return(lock, start, ret_negative))
 811                 return;
 812
 813         type = cur_func_return_type();
 814         if (type && type->type == SYM_PTR) {
 815                 if (held_on_return(lock, start, ret_non_zero) &&
 816                     !held_on_return(lock, start, ret_zero))
 817                         return;
 818         }
 819
 820         print_inconsistent_returns(lock, start);
 821 }
 822
 823 static void check_consistency(struct symbol *sym)
 824 {
 825         struct tracker *tmp;
 826
 827         FOR_EACH_PTR(starts_locked, tmp) {
 828                 if (in_tracker_list(starts_unlocked, tmp->owner, tmp->name,
 829                                         tmp->sym))
 830                         sm_msg("error:  locking inconsistency.  We assume "
 831                                    "'%s' is both locked and unlocked at the "
 832                                    "start.",
 833                                 tmp->name);
 834         } END_FOR_EACH_PTR(tmp);
 835
 836         FOR_EACH_PTR(starts_locked, tmp) {
 837                 check_returns_consistently(tmp, &locked);
 838         } END_FOR_EACH_PTR(tmp);
 839
 840         FOR_EACH_PTR(starts_unlocked, tmp) {
 841                 check_returns_consistently(tmp, &unlocked);
 842         } END_FOR_EACH_PTR(tmp);
 843 }
 844
 845 static void clear_lists(void)
 846 {
 847         struct locks_on_return *tmp;
 848
 849         func_has_transition = FALSE;
 850
 851         free_trackers_and_list(&starts_locked);
 852         free_trackers_and_list(&starts_unlocked);
 853
 854         FOR_EACH_PTR(all_returns, tmp) {
 855                 free_trackers_and_list(&tmp->locked);
 856                 free_trackers_and_list(&tmp->unlocked);
 857                 free(tmp);
 858         } END_FOR_EACH_PTR(tmp);
 859         __free_ptr_list((struct ptr_list **)&all_returns);
 860 }
 861
 862 static void match_func_end(struct symbol *sym)
 863 {
 864         if (__inline_fn)
 865                 return;
 866
 867         if (func_has_transition)
 868                 check_consistency(sym);
 869         clear_lists();
 870 }
 871
 872 static void register_lock(int index)
 873 {
 874         struct lock_info *lock = &lock_table[index];
 875         void *idx = INT_PTR(index);
 876
 877         if (lock->return_type == ret_non_zero) {
 878                 return_implies_state(lock->function, valid_ptr_min, valid_ptr_max, &match_lock_held, idx);
 879                 return_implies_state(lock->function, 0, 0, &match_lock_failed, idx);
 880         } else if (lock->return_type == ret_any && lock->arg == RETURN_VAL) {
 881                 add_function_assign_hook(lock->function, &match_returns_locked, idx);
 882         } else if (lock->return_type == ret_any) {
 883                 add_function_hook(lock->function, &match_lock_unlock, idx);
 884         } else if (lock->return_type == ret_zero) {
 885                 return_implies_state(lock->function, 0, 0, &match_lock_held, idx);
 886                 return_implies_state(lock->function, -4095, -1, &match_lock_failed, idx);
 887         }
 888 }
 889
 890 static void load_table(struct lock_info *_lock_table, int size)
 891 {
 892         int i;
 893
 894         lock_table = _lock_table;
 895
 896         for (i = 0; i < size; i++) {
 897                 if (lock_table[i].action == LOCK)
 898                         register_lock(i);
 899                 else
 900                         add_function_hook(lock_table[i].function, &match_lock_unlock, INT_PTR(i));
 901         }
 902 }
 903
 904 /* print_held_locks() is used in check_call_tree.c */
 905 void print_held_locks(void)
 906 {
 907         struct stree *stree;
 908         struct sm_state *sm;
 909         int i = 0;
 910
 911         stree = __get_cur_stree();
 912         FOR_EACH_MY_SM(my_id, stree, sm) {
 913                 if (sm->state != &locked)
 914                         continue;
 915                 if (i++)
 916                         sm_printf(" ");
 917                 sm_printf("'%s'", sm->name);
 918         } END_FOR_EACH_SM(sm);
 919 }
 920
 921 void check_locking(int id)
 922 {
 923         my_id = id;
 924
 925         if (option_project == PROJ_WINE)
 926                 load_table(wine_lock_table, ARRAY_SIZE(wine_lock_table));
 927         else if (option_project == PROJ_KERNEL)
 928                 load_table(kernel_lock_table, ARRAY_SIZE(kernel_lock_table));
 929         else
 930                 return;
 931
 932         add_unmatched_state_hook(my_id, &unmatched_state);
 933         add_split_return_callback(match_return);
 934         add_hook(&match_func_end, END_FUNC_HOOK);
 935 }