check_locking.c

   1 /*
   2  * sparse/check_locking.c
   3  *
   4  * Copyright (C) 2009 Dan Carpenter.
   5  *
   6  *  Licensed under the Open Software License version 1.1
   7  *
   8  */
   9
  10 /*
  11  * This test checks that locks are held the same across all returns.
  12  *
  13  * Of course, some functions are designed to only hold the locks on success.
  14  * Oh well... We can rewrite it later if we want.
  15  *
  16  * The list of wine locking functions came from an earlier script written
  17  * by Michael Stefaniuc.
  18  *
  19  */
  20
  21 #include "parse.h"
  22 #include "smatch.h"
  23 #include "smatch_slist.h"
  24
  25 static int my_id;
  26
  27 STATE(locked);
  28 STATE(start_state);
  29 STATE(unlocked);
  30
  31 enum action {
  32         LOCK,
  33         UNLOCK,
  34 };
  35
  36 enum return_type {
  37         ret_any,
  38         ret_non_zero,
  39         ret_zero,
  40 };
  41
  42 #define RETURN_VAL -1
  43 #define NO_ARG -2
  44
  45 struct lock_info {
  46         const char *function;
  47         enum action action;
  48         const char *name;
  49         int arg;
  50         enum return_type return_type;
  51 };
  52
  53 static struct lock_info wine_lock_table[] = {
  54         {"create_window_handle", LOCK, "create_window_handle", RETURN_VAL, ret_non_zero},
  55         {"WIN_GetPtr", LOCK, "create_window_handle", RETURN_VAL, ret_non_zero},
  56         {"WIN_ReleasePtr", UNLOCK, "create_window_handle", 0, ret_any},
  57         {"EnterCriticalSection", LOCK, "CriticalSection", 0, ret_any},
  58         {"LeaveCriticalSection", UNLOCK, "CriticalSection", 0, ret_any},
  59         {"RtlEnterCriticalSection", LOCK, "RtlCriticalSection", 0, ret_any},
  60         {"RtlLeaveCriticalSection", UNLOCK, "RtlCriticalSection", 0, ret_any},
  61         {"GDI_GetObjPtr", LOCK, "GDI_Get", 0, ret_non_zero},
  62         {"GDI_ReleaseObj", UNLOCK, "GDI_Get", 0, ret_any},
  63         {"LdrLockLoaderLock", LOCK, "LdrLockLoaderLock", 2, ret_any},
  64         {"LdrUnlockLoaderLock", UNLOCK, "LdrLockLoaderLock", 1, ret_any},
  65         {"_lock", LOCK, "_lock", 0, ret_any},
  66         {"_unlock", UNLOCK, "_lock", 0, ret_any},
  67         {"msiobj_lock", LOCK, "msiobj_lock", 0, ret_any},
  68         {"msiobj_unlock", UNLOCK, "msiobj_lock", 0, ret_any},
  69         {"RtlAcquirePebLock", LOCK, "PebLock", NO_ARG, ret_any},
  70         {"RtlReleasePebLock", UNLOCK, "PebLock", NO_ARG, ret_any},
  71         {"server_enter_uninterrupted_section", LOCK, "server_uninterrupted_section", 0, ret_any},
  72         {"server_leave_uninterrupted_section", UNLOCK, "server_uninterrupted_section", 0, ret_any},
  73         {"RtlLockHeap", LOCK, "RtlLockHeap", 0, ret_any},
  74         {"RtlUnlockHeap", UNLOCK, "RtlLockHeap", 0, ret_any},
  75         {"_EnterSysLevel", LOCK, "SysLevel", 0, ret_any},
  76         {"_LeaveSysLevel", UNLOCK, "SysLevel", 0, ret_any},
  77         {"USER_Lock", LOCK, "USER_Lock", NO_ARG, ret_any},
  78         {"USER_Unlock", UNLOCK, "USER_Lock", NO_ARG, ret_any},
  79         {"wine_tsx11_lock", LOCK, "wine_tsx11_lock", NO_ARG, ret_any},
  80         {"wine_tsx11_unlock", UNLOCK, "wine_tsx11_lock", NO_ARG, ret_any},
  81         {"wine_tsx11_lock_ptr", LOCK, "wine_tsx11_lock_ptr", NO_ARG, ret_any},
  82         {"wine_tsx11_unlock_ptr", UNLOCK, "wine_tsx11_lock_ptr", NO_ARG, ret_any},
  83         {"wined3d_mutex_lock", LOCK, "wined3d_mutex_lock", NO_ARG, ret_any},
  84         {"wined3d_mutex_unlock", UNLOCK, "wined3d_mutex_lock", NO_ARG, ret_any},
  85         {"X11DRV_DIB_Lock", LOCK, "X11DRV_DIB_Lock", 0, ret_any},
  86         {"X11DRV_DIB_Unlock", UNLOCK, "X11DRV_DIB_Lock", 0, ret_any},
  87 };
  88
  89 static struct lock_info kernel_lock_table[] = {
  90         {"lock_kernel",   LOCK,   "BKL", NO_ARG, ret_any},
  91         {"unlock_kernel", UNLOCK, "BKL", NO_ARG, ret_any},
  92
  93         {"spin_lock",                  LOCK,   "spin_lock", 0, ret_any},
  94         {"spin_unlock",                UNLOCK, "spin_lock", 0, ret_any},
  95         {"spin_lock_nested",           LOCK,   "spin_lock", 0, ret_any},
  96         {"_spin_lock",                 LOCK,   "spin_lock", 0, ret_any},
  97         {"_spin_unlock",               UNLOCK, "spin_lock", 0, ret_any},
  98         {"_spin_lock_nested",          LOCK,   "spin_lock", 0, ret_any},
  99         {"__spin_lock",                LOCK,   "spin_lock", 0, ret_any},
 100         {"__spin_unlock",              UNLOCK, "spin_lock", 0, ret_any},
 101         {"__spin_lock_nested",         LOCK,   "spin_lock", 0, ret_any},
 102         {"raw_spin_lock",              LOCK,   "spin_lock", 0, ret_any},
 103         {"raw_spin_unlock",            UNLOCK, "spin_lock", 0, ret_any},
 104         {"_raw_spin_lock",             LOCK,   "spin_lock", 0, ret_any},
 105         {"_raw_spin_unlock",           UNLOCK, "spin_lock", 0, ret_any},
 106         {"__raw_spin_lock",            LOCK,   "spin_lock", 0, ret_any},
 107         {"__raw_spin_unlock",          UNLOCK, "spin_lock", 0, ret_any},
 108
 109         {"spin_lock_irq",              LOCK,   "spin_lock", 0, ret_any},
 110         {"spin_unlock_irq",            UNLOCK, "spin_lock", 0, ret_any},
 111         {"_spin_lock_irq",             LOCK,   "spin_lock", 0, ret_any},
 112         {"_spin_unlock_irq",           UNLOCK, "spin_lock", 0, ret_any},
 113         {"__spin_lock_irq",            LOCK,   "spin_lock", 0, ret_any},
 114         {"__spin_unlock_irq",          UNLOCK, "spin_lock", 0, ret_any},
 115         {"_raw_spin_lock_irq",         LOCK,   "spin_lock", 0, ret_any},
 116         {"_raw_spin_unlock_irq",       UNLOCK, "spin_lock", 0, ret_any},
 117         {"spin_lock_irqsave",          LOCK,   "spin_lock", 0, ret_any},
 118         {"spin_unlock_irqrestore",     UNLOCK, "spin_lock", 0, ret_any},
 119         {"_spin_lock_irqsave",         LOCK,   "spin_lock", 0, ret_any},
 120         {"_spin_unlock_irqrestore",    UNLOCK, "spin_lock", 0, ret_any},
 121         {"__spin_lock_irqsave",        LOCK,   "spin_lock", 0, ret_any},
 122         {"__spin_unlock_irqrestore",   UNLOCK, "spin_lock", 0, ret_any},
 123         {"_raw_spin_lock_irqsave",     LOCK,   "spin_lock", 0, ret_any},
 124         {"_raw_spin_unlock_irqrestore", UNLOCK, "spin_lock", 0, ret_any},
 125         {"__raw_spin_lock_irqsave",    LOCK,   "spin_lock", 0, ret_any},
 126         {"__raw_spin_unlock_irqrestore", UNLOCK, "spin_lock", 0, ret_any},
 127         {"spin_lock_irqsave_nested",   LOCK,   "spin_lock", 0, ret_any},
 128         {"_spin_lock_irqsave_nested",  LOCK,   "spin_lock", 0, ret_any},
 129         {"__spin_lock_irqsave_nested", LOCK,   "spin_lock", 0, ret_any},
 130         {"_raw_spin_lock_irqsave_nested", LOCK, "spin_lock", 0, ret_any},
 131         {"spin_lock_bh",               LOCK,   "spin_lock", 0, ret_any},
 132         {"spin_unlock_bh",             UNLOCK, "spin_lock", 0, ret_any},
 133         {"_spin_lock_bh",              LOCK,   "spin_lock", 0, ret_any},
 134         {"_spin_unlock_bh",            UNLOCK, "spin_lock", 0, ret_any},
 135         {"__spin_lock_bh",             LOCK,   "spin_lock", 0, ret_any},
 136         {"__spin_unlock_bh",           UNLOCK, "spin_lock", 0, ret_any},
 137
 138         {"spin_trylock",               LOCK,   "spin_lock", 0, ret_non_zero},
 139         {"_spin_trylock",              LOCK,   "spin_lock", 0, ret_non_zero},
 140         {"__spin_trylock",             LOCK,   "spin_lock", 0, ret_non_zero},
 141         {"raw_spin_trylock",           LOCK,   "spin_lock", 0, ret_non_zero},
 142         {"_raw_spin_trylock",          LOCK,   "spin_lock", 0, ret_non_zero},
 143         {"spin_trylock_irq",           LOCK,   "spin_lock", 0, ret_non_zero},
 144         {"spin_trylock_bh",            LOCK,   "spin_lock", 0, ret_non_zero},
 145         {"_spin_trylock_bh",           LOCK,   "spin_lock", 0, ret_non_zero},
 146         {"__spin_trylock_bh",          LOCK,   "spin_lock", 0, ret_non_zero},
 147         {"__raw_spin_trylock",         LOCK,   "spin_lock", 0, ret_non_zero},
 148
 149         {"read_lock",                 LOCK,   "read_lock", 0, ret_any},
 150         {"read_unlock",               UNLOCK, "read_lock", 0, ret_any},
 151         {"_read_lock",                LOCK,   "read_lock", 0, ret_any},
 152         {"_read_unlock",              UNLOCK, "read_lock", 0, ret_any},
 153         {"__read_lock",               LOCK,   "read_lock", 0, ret_any},
 154         {"__read_unlock",             UNLOCK, "read_lock", 0, ret_any},
 155         {"read_lock_irq",             LOCK,   "read_lock", 0, ret_any},
 156         {"read_unlock_irq" ,          UNLOCK, "read_lock", 0, ret_any},
 157         {"_read_lock_irq",            LOCK,   "read_lock", 0, ret_any},
 158         {"_read_unlock_irq",          UNLOCK, "read_lock", 0, ret_any},
 159         {"__read_lock_irq",           LOCK,   "read_lock", 0, ret_any},
 160         {"__read_unlock_irq",         UNLOCK, "read_lock", 0, ret_any},
 161         {"read_lock_irqsave",         LOCK,   "read_lock", 0, ret_any},
 162         {"read_unlock_irqrestore",    UNLOCK, "read_lock", 0, ret_any},
 163         {"_read_lock_irqsave",        LOCK,   "read_lock", 0, ret_any},
 164         {"_read_unlock_irqrestore",   UNLOCK, "read_lock", 0, ret_any},
 165         {"__read_lock_irqsave",       LOCK,   "read_lock", 0, ret_any},
 166         {"__read_unlock_irqrestore",  UNLOCK, "read_lock", 0, ret_any},
 167         {"read_lock_bh",              LOCK,   "read_lock", 0, ret_any},
 168         {"read_unlock_bh",            UNLOCK, "read_lock", 0, ret_any},
 169         {"_read_lock_bh",             LOCK,   "read_lock", 0, ret_any},
 170         {"_read_unlock_bh",           UNLOCK, "read_lock", 0, ret_any},
 171         {"__read_lock_bh",            LOCK,   "read_lock", 0, ret_any},
 172         {"__read_unlock_bh",          UNLOCK, "read_lock", 0, ret_any},
 173
 174         {"generic__raw_read_trylock", LOCK,   "read_lock", 0, ret_non_zero},
 175         {"read_trylock",              LOCK,   "read_lock", 0, ret_non_zero},
 176         {"_read_trylock",             LOCK,   "read_lock", 0, ret_non_zero},
 177         {"raw_read_trylock",          LOCK,   "read_lock", 0, ret_non_zero},
 178         {"_raw_read_trylock",         LOCK,   "read_lock", 0, ret_non_zero},
 179         {"__raw_read_trylock",        LOCK,   "read_lock", 0, ret_non_zero},
 180         {"__read_trylock",            LOCK,   "read_lock", 0, ret_non_zero},
 181
 182         {"write_lock",                LOCK,   "write_lock", 0, ret_any},
 183         {"write_unlock",              UNLOCK, "write_lock", 0, ret_any},
 184         {"_write_lock",               LOCK,   "write_lock", 0, ret_any},
 185         {"_write_unlock",             UNLOCK, "write_lock", 0, ret_any},
 186         {"__write_lock",              LOCK,   "write_lock", 0, ret_any},
 187         {"__write_unlock",            UNLOCK, "write_lock", 0, ret_any},
 188         {"write_lock_irq",            LOCK,   "write_lock", 0, ret_any},
 189         {"write_unlock_irq",          UNLOCK, "write_lock", 0, ret_any},
 190         {"_write_lock_irq",           LOCK,   "write_lock", 0, ret_any},
 191         {"_write_unlock_irq",         UNLOCK, "write_lock", 0, ret_any},
 192         {"__write_lock_irq",          LOCK,   "write_lock", 0, ret_any},
 193         {"__write_unlock_irq",        UNLOCK, "write_lock", 0, ret_any},
 194         {"write_lock_irqsave",        LOCK,   "write_lock", 0, ret_any},
 195         {"write_unlock_irqrestore",   UNLOCK, "write_lock", 0, ret_any},
 196         {"_write_lock_irqsave",       LOCK,   "write_lock", 0, ret_any},
 197         {"_write_unlock_irqrestore",  UNLOCK, "write_lock", 0, ret_any},
 198         {"__write_lock_irqsave",      LOCK,   "write_lock", 0, ret_any},
 199         {"__write_unlock_irqrestore", UNLOCK, "write_lock", 0, ret_any},
 200         {"write_lock_bh",             LOCK,   "write_lock", 0, ret_any},
 201         {"write_unlock_bh",           UNLOCK, "write_lock", 0, ret_any},
 202         {"_write_lock_bh",            LOCK,   "write_lock", 0, ret_any},
 203         {"_write_unlock_bh",          UNLOCK, "write_lock", 0, ret_any},
 204         {"__write_lock_bh",           LOCK,   "write_lock", 0, ret_any},
 205         {"__write_unlock_bh",         UNLOCK, "write_lock", 0, ret_any},
 206
 207         {"write_trylock",             LOCK,   "write_lock", 0, ret_non_zero},
 208         {"_write_trylock",            LOCK,   "write_lock", 0, ret_non_zero},
 209         {"raw_write_trylock",         LOCK,   "write_lock", 0, ret_non_zero},
 210         {"_raw_write_trylock",        LOCK,   "write_lock", 0, ret_non_zero},
 211         {"__write_trylock",           LOCK,   "write_lock", 0, ret_non_zero},
 212         {"__raw_write_trylock",       LOCK,   "write_lock", 0, ret_non_zero},
 213
 214         {"down",               LOCK,   "sem", 0, ret_any},
 215         {"up",                 UNLOCK, "sem", 0, ret_any},
 216         {"down_trylock",       LOCK,   "sem", 0, ret_zero},
 217         {"down_interruptible", LOCK,   "sem", 0, ret_zero},
 218
 219         {"mutex_lock",                      LOCK,   "mutex", 0, ret_any},
 220         {"mutex_unlock",                    UNLOCK, "mutex", 0, ret_any},
 221         {"mutex_lock_nested",               LOCK,   "mutex", 0, ret_any},
 222
 223         {"mutex_lock_interruptible",        LOCK,   "mutex", 0, ret_zero},
 224         {"mutex_lock_interruptible_nested", LOCK,   "mutex", 0, ret_zero},
 225         {"mutex_lock_killable",             LOCK,   "mutex", 0, ret_zero},
 226         {"mutex_lock_killable_nested",      LOCK,   "mutex", 0, ret_zero},
 227
 228         {"mutex_trylock",                   LOCK,   "mutex", 0, ret_non_zero},
 229
 230         {"raw_local_irq_disable", LOCK,   "irq", NO_ARG, ret_any},
 231         {"raw_local_irq_enable",  UNLOCK, "irq", NO_ARG, ret_any},
 232         {"spin_lock_irq",         LOCK,   "irq", NO_ARG, ret_any},
 233         {"spin_unlock_irq",       UNLOCK, "irq", NO_ARG, ret_any},
 234         {"_spin_lock_irq",        LOCK,   "irq", NO_ARG, ret_any},
 235         {"_spin_unlock_irq",      UNLOCK, "irq", NO_ARG, ret_any},
 236         {"__spin_lock_irq",       LOCK,   "irq", NO_ARG, ret_any},
 237         {"__spin_unlock_irq",     UNLOCK, "irq", NO_ARG, ret_any},
 238         {"_raw_spin_lock_irq",    LOCK,   "irq", NO_ARG, ret_any},
 239         {"_raw_spin_unlock_irq",  UNLOCK, "irq", NO_ARG, ret_any},
 240         {"spin_trylock_irq",      LOCK,   "irq", NO_ARG, ret_non_zero},
 241         {"read_lock_irq",         LOCK,   "irq", NO_ARG, ret_any},
 242         {"read_unlock_irq",       UNLOCK, "irq", NO_ARG, ret_any},
 243         {"_read_lock_irq",        LOCK,   "irq", NO_ARG, ret_any},
 244         {"_read_unlock_irq",      UNLOCK, "irq", NO_ARG, ret_any},
 245         {"__read_lock_irq",       LOCK,   "irq", NO_ARG, ret_any},
 246         {"__read_unlock_irq",     UNLOCK, "irq", NO_ARG, ret_any},
 247         {"write_lock_irq",        LOCK,   "irq", NO_ARG, ret_any},
 248         {"write_unlock_irq",      UNLOCK, "irq", NO_ARG, ret_any},
 249         {"_write_lock_irq",       LOCK,   "irq", NO_ARG, ret_any},
 250         {"_write_unlock_irq",     UNLOCK, "irq", NO_ARG, ret_any},
 251         {"__write_lock_irq",      LOCK,   "irq", NO_ARG, ret_any},
 252         {"__write_unlock_irq",    UNLOCK, "irq", NO_ARG, ret_any},
 253
 254         {"__raw_local_irq_save",       LOCK,   "irqsave", RETURN_VAL, ret_any},
 255         {"raw_local_irq_restore",      UNLOCK, "irqsave", 0, ret_any},
 256         {"spin_lock_irqsave_nested",   LOCK,   "irqsave", RETURN_VAL, ret_any},
 257         {"spin_lock_irqsave",          LOCK,   "irqsave", RETURN_VAL, ret_any},
 258         {"spin_lock_irqsave",          LOCK,   "irqsave", 1, ret_any},
 259         {"spin_unlock_irqrestore",     UNLOCK, "irqsave", 1, ret_any},
 260         {"_spin_lock_irqsave_nested",  LOCK,   "irqsave", RETURN_VAL, ret_any},
 261         {"_spin_lock_irqsave",         LOCK,   "irqsave", RETURN_VAL, ret_any},
 262         {"_spin_lock_irqsave",         LOCK,   "irqsave", 1, ret_any},
 263         {"_spin_unlock_irqrestore",    UNLOCK, "irqsave", 1, ret_any},
 264         {"__spin_lock_irqsave_nested", LOCK,   "irqsave", 1, ret_any},
 265         {"__spin_lock_irqsave",        LOCK,   "irqsave", 1, ret_any},
 266         {"__spin_unlock_irqrestore",   UNLOCK, "irqsave", 1, ret_any},
 267         {"_raw_spin_lock_irqsave",     LOCK,   "irqsave", RETURN_VAL, ret_any},
 268         {"_raw_spin_lock_irqsave",     LOCK,   "irqsave", 1, ret_any},
 269         {"_raw_spin_unlock_irqrestore",UNLOCK, "irqsave", 1, ret_any},
 270         {"__raw_spin_lock_irqsave",    LOCK,   "irqsave", RETURN_VAL, ret_any},
 271         {"__raw_spin_unlock_irqrestore",UNLOCK, "irqsave", 1, ret_any},
 272         {"_raw_spin_lock_irqsave_nested", LOCK, "irqsave", RETURN_VAL, ret_any},
 273         {"read_lock_irqsave",          LOCK,   "irqsave", RETURN_VAL, ret_any},
 274         {"read_lock_irqsave",          LOCK,   "irqsave", 1, ret_any},
 275         {"read_unlock_irqrestore",     UNLOCK, "irqsave", 1, ret_any},
 276         {"_read_lock_irqsave",         LOCK,   "irqsave", RETURN_VAL, ret_any},
 277         {"_read_lock_irqsave",         LOCK,   "irqsave", 1, ret_any},
 278         {"_read_unlock_irqrestore",    UNLOCK, "irqsave", 1, ret_any},
 279         {"__read_lock_irqsave",        LOCK,   "irqsave", RETURN_VAL, ret_any},
 280         {"__read_unlock_irqrestore",   UNLOCK, "irqsave", 1, ret_any},
 281         {"write_lock_irqsave",         LOCK,   "irqsave", RETURN_VAL, ret_any},
 282         {"write_lock_irqsave",         LOCK,   "irqsave", 1, ret_any},
 283         {"write_unlock_irqrestore",    UNLOCK, "irqsave", 1, ret_any},
 284         {"_write_lock_irqsave",        LOCK,   "irqsave", RETURN_VAL, ret_any},
 285         {"_write_lock_irqsave",        LOCK,   "irqsave", 1, ret_any},
 286         {"_write_unlock_irqrestore",   UNLOCK, "irqsave", 1, ret_any},
 287         {"__write_lock_irqsave",       LOCK,   "irqsave", RETURN_VAL, ret_any},
 288         {"__write_unlock_irqrestore",  UNLOCK, "irqsave", 1, ret_any},
 289
 290         {"spin_lock_bh",      LOCK,   "bottom_half", NO_ARG, ret_any},
 291         {"spin_unlock_bh",    UNLOCK, "bottom_half", NO_ARG, ret_any},
 292         {"_spin_lock_bh",     LOCK,   "bottom_half", NO_ARG, ret_any},
 293         {"_spin_unlock_bh",   UNLOCK, "bottom_half", NO_ARG, ret_any},
 294         {"__spin_lock_bh",    LOCK,   "bottom_half", NO_ARG, ret_any},
 295         {"__spin_unlock_bh",  UNLOCK, "bottom_half", NO_ARG, ret_any},
 296         {"read_lock_bh",      LOCK,   "bottom_half", NO_ARG, ret_any},
 297         {"read_unlock_bh",    UNLOCK, "bottom_half", NO_ARG, ret_any},
 298         {"_read_lock_bh",     LOCK,   "bottom_half", NO_ARG, ret_any},
 299         {"_read_unlock_bh",   UNLOCK, "bottom_half", NO_ARG, ret_any},
 300         {"__read_lock_bh",    LOCK,   "bottom_half", NO_ARG, ret_any},
 301         {"__read_unlock_bh",  UNLOCK, "bottom_half", NO_ARG, ret_any},
 302         {"write_lock_bh",     LOCK,   "bottom_half", NO_ARG, ret_any},
 303         {"write_unlock_bh",   UNLOCK, "bottom_half", NO_ARG, ret_any},
 304         {"_write_lock_bh",    LOCK,   "bottom_half", NO_ARG, ret_any},
 305         {"_write_unlock_bh",  UNLOCK, "bottom_half", NO_ARG, ret_any},
 306         {"__write_lock_bh",   LOCK,   "bottom_half", NO_ARG, ret_any},
 307         {"__write_unlock_bh", UNLOCK, "bottom_half", NO_ARG, ret_any},
 308         {"spin_trylock_bh",   LOCK,   "bottom_half", NO_ARG, ret_non_zero},
 309         {"_spin_trylock_bh",  LOCK,   "bottom_half", NO_ARG, ret_non_zero},
 310         {"__spin_trylock_bh", LOCK,   "bottom_half", NO_ARG, ret_non_zero},
 311 };
 312
 313 static struct lock_info *lock_table;
 314
 315 static struct tracker_list *starts_locked;
 316 static struct tracker_list *starts_unlocked;
 317
 318 struct locks_on_return {
 319         int line;
 320         struct tracker_list *locked;
 321         struct tracker_list *unlocked;
 322 };
 323 DECLARE_PTR_LIST(return_list, struct locks_on_return);
 324 static struct return_list *all_returns;
 325
 326 static char *make_full_name(const char *lock, const char *var)
 327 {
 328         static char tmp_buf[512];
 329
 330         snprintf(tmp_buf, 512, "%s:%s", lock, var);
 331         tmp_buf[511] = '\0';
 332         return alloc_string(tmp_buf);
 333 }
 334
 335 static struct expression *remove_spinlock_check(struct expression *expr)
 336 {
 337         if (expr->type != EXPR_CALL)
 338                 return expr;
 339         if (expr->fn->type != EXPR_SYMBOL)
 340                 return expr;
 341         if (strcmp(expr->fn->symbol_name->name, "spinlock_check"))
 342                 return expr;
 343         expr = get_argument_from_call_expr(expr->args, 0);
 344         return expr;
 345 }
 346
 347 static char *get_full_name(struct expression *expr, int index)
 348 {
 349         struct expression *arg;
 350         char *name = NULL;
 351         char *full_name = NULL;
 352         struct lock_info *lock = &lock_table[index];
 353
 354         if (lock->arg == RETURN_VAL) {
 355                 name = get_variable_from_expr(expr->left, NULL);
 356                 full_name = make_full_name(lock->name, name);
 357         } else if (lock->arg == NO_ARG) {
 358                 full_name = make_full_name(lock->name, "");
 359         } else {
 360                 arg = get_argument_from_call_expr(expr->args, lock->arg);
 361                 if (!arg)
 362                         goto free;
 363                 arg = remove_spinlock_check(arg);
 364                 name = get_variable_from_expr(arg, NULL);
 365                 if (!name)
 366                         goto free;
 367                 full_name = make_full_name(lock->name, name);
 368         }
 369 free:
 370         free_string(name);
 371         return full_name;
 372 }
 373
 374 static struct smatch_state *get_start_state(struct sm_state *sm)
 375 {
 376        int is_locked = 0;
 377        int is_unlocked = 0;
 378
 379        if (in_tracker_list(starts_locked, my_id, sm->name, sm->sym))
 380                is_locked = 1;
 381        if (in_tracker_list(starts_unlocked, my_id, sm->name, sm->sym))
 382                is_unlocked = 1;
 383        if (is_locked && is_unlocked)
 384                return &undefined;
 385        if (is_locked)
 386                return &locked;
 387        if (is_unlocked)
 388                return &unlocked;
 389         return &undefined;
 390 }
 391
 392 static struct smatch_state *unmatched_state(struct sm_state *sm)
 393 {
 394         return &start_state;
 395 }
 396
 397 static void do_lock(const char *name)
 398 {
 399         struct sm_state *sm;
 400
 401         sm = get_sm_state(my_id, name, NULL);
 402         if (!sm)
 403                 add_tracker(&starts_unlocked, my_id, name, NULL);
 404         if (sm && slist_has_state(sm->possible, &locked))
 405                 sm_msg("error: double lock '%s'", name);
 406         set_state(my_id, name, NULL, &locked);
 407 }
 408
 409 static void do_lock_failed(const char *name)
 410 {
 411         struct sm_state *sm;
 412
 413         sm = get_sm_state(my_id, name, NULL);
 414         if (!sm)
 415                 add_tracker(&starts_unlocked, my_id, name, NULL);
 416         set_state(my_id, name, NULL, &unlocked);
 417 }
 418
 419 static void do_unlock(const char *name)
 420 {
 421         struct sm_state *sm;
 422
 423         sm = get_sm_state(my_id, name, NULL);
 424         if (!sm)
 425                 add_tracker(&starts_locked, my_id, name, NULL);
 426         if (sm && slist_has_state(sm->possible, &unlocked))
 427                 sm_msg("error: double unlock '%s'", name);
 428         set_state(my_id, name, NULL, &unlocked);
 429
 430 }
 431
 432 static void match_lock_held(const char *fn, struct expression *call_expr,
 433                         struct expression *assign_expr, void *_index)
 434 {
 435         int index = (int)_index;
 436         char *lock_name;
 437         struct lock_info *lock = &lock_table[index];
 438
 439         if (lock->arg == NO_ARG) {
 440                 lock_name = get_full_name(NULL, index);
 441         } else if (lock->arg == RETURN_VAL) {
 442                 if (!assign_expr)
 443                         return;
 444                 lock_name = get_full_name(assign_expr, index);
 445         } else {
 446                 lock_name = get_full_name(call_expr, index);
 447         }
 448         if (!lock_name)
 449                 return;
 450         do_lock(lock_name);
 451         free_string(lock_name);
 452 }
 453
 454 static void match_lock_failed(const char *fn, struct expression *call_expr,
 455                         struct expression *assign_expr, void *_index)
 456 {
 457         int index = (int)_index;
 458         char *lock_name;
 459         struct lock_info *lock = &lock_table[index];
 460
 461         if (lock->arg == NO_ARG) {
 462                 lock_name = get_full_name(NULL, index);
 463         } else if (lock->arg == RETURN_VAL) {
 464                 if (!assign_expr)
 465                         return;
 466                 lock_name = get_full_name(assign_expr, index);
 467         } else {
 468                 lock_name = get_full_name(call_expr, index);
 469         }
 470         if (!lock_name)
 471                 return;
 472         do_lock_failed(lock_name);
 473         free_string(lock_name);
 474 }
 475
 476 static void match_returns_locked(const char *fn, struct expression *expr,
 477                                       void *_index)
 478 {
 479         char *full_name = NULL;
 480         int index = (int)_index;
 481         struct lock_info *lock = &lock_table[index];
 482
 483         if (lock->arg != RETURN_VAL)
 484                 return;
 485         full_name = get_full_name(expr, index);
 486         do_lock(full_name);
 487 }
 488
 489 static void match_lock_unlock(const char *fn, struct expression *expr, void *_index)
 490 {
 491         char *full_name = NULL;
 492         int index = (int)_index;
 493         struct lock_info *lock = &lock_table[index];
 494
 495         full_name = get_full_name(expr, index);
 496         if (!full_name)
 497                 return;
 498         if (lock->action == LOCK)
 499                 do_lock(full_name);
 500         else
 501                 do_unlock(full_name);
 502         free_string(full_name);
 503 }
 504
 505 static struct locks_on_return *alloc_return(int line)
 506 {
 507         struct locks_on_return *ret;
 508
 509         ret = malloc(sizeof(*ret));
 510         ret->line = line;
 511         ret->locked = NULL;
 512         ret->unlocked = NULL;
 513         return ret;
 514 }
 515
 516 static void check_possible(struct sm_state *sm)
 517 {
 518         struct sm_state *tmp;
 519         int islocked = 0;
 520         int isunlocked = 0;
 521         int undef = 0;
 522
 523         if (!option_spammy)
 524                 return;
 525
 526         FOR_EACH_PTR(sm->possible, tmp) {
 527                 if (tmp->state == &locked)
 528                         islocked = 1;
 529                 if (tmp->state == &unlocked)
 530                         isunlocked = 1;
 531                 if (tmp->state == &start_state) {
 532                         struct smatch_state *s;
 533
 534                         s = get_start_state(tmp);
 535                         if (s == &locked)
 536                                 islocked = 1;
 537                         else if (s == &unlocked)
 538                                 isunlocked = 1;
 539                         else
 540                                 undef = 1;
 541                 }
 542                 if (tmp->state == &undefined)
 543                         undef = 1;  // i don't think this is possible any more.
 544         } END_FOR_EACH_PTR(tmp);
 545         if ((islocked && isunlocked) || undef)
 546                 sm_msg("warn: '%s' is sometimes locked here and sometimes unlocked.", sm->name);
 547 }
 548
 549 static void match_return(struct expression *ret_value)
 550 {
 551         struct locks_on_return *ret;
 552         struct state_list *slist;
 553         struct sm_state *tmp;
 554
 555         if (!final_pass)
 556                 return;
 557
 558         ret = alloc_return(get_lineno());
 559
 560         slist = get_all_states(my_id);
 561         FOR_EACH_PTR(slist, tmp) {
 562                 if (tmp->state == &locked) {
 563                         add_tracker(&ret->locked, tmp->owner, tmp->name,
 564                                 tmp->sym);
 565                 } else if (tmp->state == &unlocked) {
 566                         add_tracker(&ret->unlocked, tmp->owner, tmp->name,
 567                                 tmp->sym);
 568                 } else if (tmp->state == &start_state) {
 569                         struct smatch_state *s;
 570
 571                         s = get_start_state(tmp);
 572                         if (s == &locked)
 573                                 add_tracker(&ret->locked, tmp->owner, tmp->name,
 574                                             tmp->sym);
 575                         if (s == &unlocked)
 576                                 add_tracker(&ret->unlocked, tmp->owner,tmp->name,
 577                                              tmp->sym);
 578                 }else {
 579                         check_possible(tmp);
 580                 }
 581         } END_FOR_EACH_PTR(tmp);
 582         free_slist(&slist);
 583         add_ptr_list(&all_returns, ret);
 584 }
 585
 586 static void print_inconsistent_returns(struct tracker *lock,
 587                                 struct smatch_state *start)
 588 {
 589         struct locks_on_return *tmp;
 590         int i;
 591
 592         sm_printf("%s +%d %s(%d) ", get_filename(), get_lineno(), get_function(), get_func_pos());
 593         sm_printf("warn: inconsistent returns %s:", lock->name);
 594         sm_printf(" locked (");
 595         i = 0;
 596         FOR_EACH_PTR(all_returns, tmp) {
 597                 if (in_tracker_list(tmp->unlocked, lock->owner, lock->name, lock->sym))
 598                         continue;
 599                 if (in_tracker_list(tmp->locked, lock->owner, lock->name, lock->sym)) {
 600                         if (i++)
 601                                 sm_printf(",");
 602                         sm_printf("%d", tmp->line);
 603                         continue;
 604                 }
 605                 if (start == &locked) {
 606                         if (i++)
 607                                 sm_printf(",");
 608                         sm_printf("%d", tmp->line);
 609                 }
 610         } END_FOR_EACH_PTR(tmp);
 611
 612         sm_printf(") unlocked (");
 613         i = 0;
 614         FOR_EACH_PTR(all_returns, tmp) {
 615                 if (in_tracker_list(tmp->unlocked, lock->owner, lock->name, lock->sym)) {
 616                         if (i++)
 617                                 sm_printf(",");
 618                         sm_printf("%d", tmp->line);
 619                         continue;
 620                 }
 621                 if (in_tracker_list(tmp->locked, lock->owner, lock->name, lock->sym)) {
 622                         continue;
 623                 }
 624                 if (start == &unlocked) {
 625                         if (i++)
 626                                 sm_printf(",");
 627                         sm_printf("%d", tmp->line);
 628                 }
 629         } END_FOR_EACH_PTR(tmp);
 630         sm_printf(")\n");
 631 }
 632
 633 static void check_returns_consistently(struct tracker *lock,
 634                                 struct smatch_state *start)
 635 {
 636         int returns_locked = 0;
 637         int returns_unlocked = 0;
 638         struct locks_on_return *tmp;
 639
 640         FOR_EACH_PTR(all_returns, tmp) {
 641                 if (in_tracker_list(tmp->unlocked, lock->owner, lock->name,
 642                                         lock->sym))
 643                         returns_unlocked = tmp->line;
 644                 else if (in_tracker_list(tmp->locked, lock->owner, lock->name,
 645                                                 lock->sym))
 646                         returns_locked = tmp->line;
 647                 else if (start == &locked)
 648                         returns_locked = tmp->line;
 649                 else if (start == &unlocked)
 650                         returns_unlocked = tmp->line;
 651         } END_FOR_EACH_PTR(tmp);
 652
 653         if (returns_locked && returns_unlocked)
 654                 print_inconsistent_returns(lock, start);
 655 }
 656
 657 static void check_consistency(struct symbol *sym)
 658 {
 659         struct tracker *tmp;
 660
 661         if (is_reachable())
 662                 match_return(NULL);
 663
 664         FOR_EACH_PTR(starts_locked, tmp) {
 665                 if (in_tracker_list(starts_unlocked, tmp->owner, tmp->name,
 666                                         tmp->sym))
 667                         sm_msg("error:  locking inconsistency.  We assume "
 668                                    "'%s' is both locked and unlocked at the "
 669                                    "start.",
 670                                 tmp->name);
 671         } END_FOR_EACH_PTR(tmp);
 672
 673         FOR_EACH_PTR(starts_locked, tmp) {
 674                 check_returns_consistently(tmp, &locked);
 675         } END_FOR_EACH_PTR(tmp);
 676
 677         FOR_EACH_PTR(starts_unlocked, tmp) {
 678                 check_returns_consistently(tmp, &unlocked);
 679         } END_FOR_EACH_PTR(tmp);
 680
 681 }
 682
 683 static void clear_lists(void)
 684 {
 685         struct locks_on_return *tmp;
 686
 687         free_trackers_and_list(&starts_locked);
 688         free_trackers_and_list(&starts_unlocked);
 689
 690         FOR_EACH_PTR(all_returns, tmp) {
 691                 free_trackers_and_list(&tmp->locked);
 692                 free_trackers_and_list(&tmp->unlocked);
 693                 free(tmp);
 694         } END_FOR_EACH_PTR(tmp);
 695         __free_ptr_list((struct ptr_list **)&all_returns);
 696 }
 697
 698 static void match_func_end(struct symbol *sym)
 699 {
 700         check_consistency(sym);
 701         clear_lists();
 702 }
 703
 704 static void register_lock(int index)
 705 {
 706         struct lock_info *lock = &lock_table[index];
 707         void *idx = (void *)index;
 708
 709         if (lock->return_type == ret_non_zero) {
 710                 return_implies_state(lock->function, 1, POINTER_MAX, &match_lock_held, idx);
 711                 return_implies_state(lock->function, 0, 0, &match_lock_failed, idx);
 712         } else if (lock->return_type == ret_any && lock->arg == RETURN_VAL) {
 713                 add_function_assign_hook(lock->function, &match_returns_locked, idx);
 714         } else if (lock->return_type == ret_any) {
 715                 add_function_hook(lock->function, &match_lock_unlock, idx);
 716         } else if (lock->return_type == ret_zero) {
 717                 return_implies_state(lock->function, 0, 0, &match_lock_held, idx);
 718                 return_implies_state(lock->function, whole_range.min, -1, &match_lock_failed, idx);
 719         }
 720 }
 721
 722 static void load_table(struct lock_info *_lock_table, int size)
 723 {
 724         int i;
 725
 726         lock_table = _lock_table;
 727
 728         for (i = 0; i < size; i++) {
 729                 if (lock_table[i].action == LOCK)
 730                         register_lock(i);
 731                 else
 732                         add_function_hook(lock_table[i].function, &match_lock_unlock, (void *)i);
 733         }
 734 }
 735
 736 /* print_held_locks() is used in check_call_tree.c */
 737 void print_held_locks()
 738 {
 739         struct state_list *slist;
 740         struct sm_state *sm;
 741         int i = 0;
 742
 743         slist = get_all_states(my_id);
 744         FOR_EACH_PTR(slist, sm) {
 745                 if (sm->state != &locked)
 746                         continue;
 747                 if (i++)
 748                         sm_printf(" ");
 749                 sm_printf("'%s'", sm->name);
 750         } END_FOR_EACH_PTR(sm);
 751         free_slist(&slist);
 752 }
 753
 754 void check_locking(int id)
 755 {
 756         my_id = id;
 757
 758         if (option_project == PROJ_WINE)
 759                 load_table(wine_lock_table, ARRAY_SIZE(wine_lock_table));
 760         else if (option_project == PROJ_KERNEL)
 761                 load_table(kernel_lock_table, ARRAY_SIZE(kernel_lock_table));
 762         else
 763                 return;
 764
 765         add_unmatched_state_hook(my_id, &unmatched_state);
 766         add_hook(&match_return, RETURN_HOOK);
 767         add_hook(&match_func_end, END_FUNC_HOOK);
 768 }