smatch_data/db/fixup_kernel.sh

   1 #!/bin/bash
   2
   3 db_file=$1
   4 cat << EOF | sqlite3 $db_file
   5 /* we only care about the main ->read/write() functions. */
   6 delete from caller_info where function = '(struct file_operations)->read' and file != 'fs/read_write.c';
   7 delete from caller_info where function = '(struct file_operations)->write' and file != 'fs/read_write.c';
   8 delete from function_ptr where function = '(struct file_operations)->read';
   9 delete from function_ptr where function = '(struct file_operations)->write';
  10 delete from caller_info where function = '(struct file_operations)->write' and caller = 'do_loop_readv_writev';
  11 delete from caller_info where caller = '__kernel_write';
  12 delete from caller_info where function = 'do_splice_from' and caller = 'direct_splice_actor';
  13 delete from caller_info where function = 'vfs_write' and type = 8017 and parameter = 0;
  14 delete from caller_info where function = 'vfs_read' and type = 8017 and parameter = 0;
  15
  16 /* delete these function pointers which cause false positives */
  17 delete from caller_info where function = '(struct file_operations)->open' and type != 0;
  18 delete from caller_info where function = '(struct notifier_block)->notifier_call' and type != 0;
  19 delete from caller_info where function = '(struct mISDNchannel)->send' and type != 0;
  20 delete from caller_info where function = '(struct irq_router)->get' and type != 0;
  21 delete from caller_info where function = '(struct irq_router)->set' and type != 0;
  22 delete from caller_info where function = '(struct net_device_ops)->ndo_change_mtu' and caller = 'i40e_dbg_netdev_ops_write';
  23 delete from caller_info where function = '(struct timer_list)->function' and type != 0;
  24 delete from caller_info where function = '(struct work_struct)->func' and type != 0;
  25
  26 /* 8017 is USER_DATA and  9017 is USER_DATA_SET */
  27 delete from caller_info where function = 'dev_hard_start_xmit' and type = 8017;
  28 delete from return_states where function='vscnprintf' and type = 9017;
  29 delete from return_states where function='scnprintf' and type = 9017;
  30 delete from return_states where function='vsnprintf' and type = 9017;
  31 delete from return_states where function='snprintf' and type = 9017;
  32 delete from return_states where function='sprintf' and type = 9017;
  33 delete from return_states where function='vscnprintf' and type = 8017;
  34 delete from return_states where function='scnprintf' and type = 8017;
  35 delete from return_states where function='vsnprintf' and type = 8017;
  36 delete from return_states where function='snprintf' and type = 8017;
  37 delete from return_states where function='sprintf' and type = 8017;
  38 delete from return_states where function='poly1305_update' and type = 8017 and key = '\$->buflen';
  39 /* There is something setting skb->sk->sk_mark and friends to user_data and */
  40 /* because of recursion it gets passed to everything and is impossible to debug */
  41 delete from caller_info where function = '__dev_queue_xmit' and type = 8017;
  42 delete from caller_info where function = '__netdev_start_xmit' and type = 8017;
  43 delete from caller_info where function = '(struct net_device_ops)->ndo_start_xmit' and type = 8017;
  44 delete from caller_info where function = '(struct packet_type)->func' and type = 8017;
  45 delete from caller_info where function = '(struct bio)->bi_end_io' and type = 8017;
  46 delete from caller_info where function = '(struct mISDNchannel)->recv' and type = 8017;
  47 delete from caller_info where type = 8017 and key = '*\$->bi_private';
  48 delete from caller_info where type = 8017 and key = '\$->bi_private';
  49 delete from caller_info where caller = 'NF_HOOK_COND' and type = 8017;
  50 delete from caller_info where caller = 'NF_HOOK' and type = 8017;
  51 delete from caller_info where caller = 'bus_for_each_drv' and type = 8017;
  52 /* comparison doesn't deal with chunks, I guess.  */
  53 delete from return_states where function='get_tty_driver' and type = 8017;
  54 delete from caller_info where caller = 'snd_ctl_elem_write' and function = '(struct snd_kcontrol)->put' and type = 8017;
  55 delete from caller_info where caller = 'snd_ctl_elem_read' and function = '(struct snd_kcontrol)->get' and type = 8017;
  56 delete from caller_info where function = 'nf_tables_newexpr' and type = 8017 and key = '\$->family';
  57 delete from caller_info where caller = 'fb_set_var' and function = '(struct fb_ops)->fb_set_par' and type = 8017 and parameter = 0;
  58 delete from return_states where function = 'tty_lookup_driver' and parameter = 2 and type = 8017;
  59 delete from caller_info where function = 'iomap_apply' and type = 8017 and key = '*\$';
  60 delete from caller_info where function = '(struct inet6_protocol)->handler' and type = 9018;
  61 delete from caller_info where function = 'do_dentry_open param 2' and type = 8017;
  62 delete from caller_info where function = 'do_dentry_open param 2' and type = 9018;
  63 # this is just too complicated for Smatch.  See how snd_ctl_find_id() is called.
  64 delete from caller_info where function = 'snd_ctl_notify_one' and type = 8017;
  65
  66 insert into caller_info values ('userspace', '', 'compat_sys_ioctl', 0, 0, 8017, 0, '\$', '1');
  67 insert into caller_info values ('userspace', '', 'compat_sys_ioctl', 0, 0, 8017, 1, '\$', '1');
  68 insert into caller_info values ('userspace', '', 'compat_sys_ioctl', 0, 0, 8017, 2, '\$', '1');
  69
  70 delete from caller_info where function = '(struct timer_list)->function' and parameter = 0;
  71
  72 /*
  73  * rw_verify_area is a very central function for the kernel.  The 1000000000
  74  * isn't accurate but I've picked it so that we can add "pos + count" without
  75  * wrapping on 32 bits.
  76  */
  77 delete from return_states where function = 'rw_verify_area';
  78 insert into return_states values ('faked', 'rw_verify_area', 0, 1, '0-1000000000[<=\$3]', 0, 0,   -1,      '', '');
  79 insert into return_states values ('faked', 'rw_verify_area', 0, 1, '0-1000000000[<=\$3]', 0, 104,  2, '*\$', '0-1000000000');
  80 insert into return_states values ('faked', 'rw_verify_area', 0, 1, '0-1000000000[<=\$3]', 0, 103, 3,  '\$', '0-1000000000');
  81 insert into return_states values ('faked', 'rw_verify_area', 0, 2, '(-4095)-(-1)',     0, 0,   -1,      '', '');
  82
  83 delete from return_states where function = 'is_kernel_rodata';
  84 insert into return_states values ('faked', 'is_kernel_rodata', 0, 1, '1', 0, 0,   -1,  '', '');
  85 insert into return_states values ('faked', 'is_kernel_rodata', 0, 1, '1', 0, 103,  0,  '\$', '4096-ptr_max');
  86 insert into return_states values ('faked', 'is_kernel_rodata', 0, 2, '0', 0, 0,   -1,  '', '');
  87
  88 /*
  89  * Other kmalloc hacking.
  90  */
  91 delete from return_states where function = 'vmalloc';
  92 insert into return_states values ('faked', 'vmalloc', 0, 1, '4096-ptr_max', 0,    0, -1, '', '');
  93 insert into return_states values ('faked', 'vmalloc', 0, 1, '4096-ptr_max', 0, 103,  0, '\$', '1-128000000');
  94 insert into return_states values ('faked', 'vmalloc', 0, 2, '0', 0,    0,  -1, '', '');
  95
  96 delete from return_states where function = 'ksize';
  97 insert into return_states values ('faked', 'ksize', 0, 1, '0', 0,    0, -1, '', '');
  98 insert into return_states values ('faked', 'ksize', 0, 1, '0', 0, 103,  0, '\$', '16');
  99 insert into return_states values ('faked', 'ksize', 0, 2, '1-4000000', 0,    0,  -1, '', '');
 100
 101 update return_states set return = '0-8' where function = '__arch_hweight8';
 102 update return_states set return = '0-16' where function = '__arch_hweight16';
 103 update return_states set return = '0-32' where function = '__arch_hweight32';
 104 update return_states set return = '0-64' where function = '__arch_hweight64';
 105
 106 /*
 107  * Preserve the value across byte swapping.  By the time we use it for math it
 108  * will be byte swapped back to CPU endian.
 109  */
 110 update return_states set return = '0-u64max[==\$0]' where function = '__fswab64';
 111 update return_states set return = '0-u32max[==\$0]' where function = '__fswab32';
 112 update return_states set return = '0-u16max[==\$0]' where function = '__fswab16';
 113 update return_states set return = '0-u64max[==\$0]' where function = '__builtin_bswap64';
 114 update return_states set return = '0-u32max[==\$0]' where function = '__builtin_bswap32';
 115 update return_states set return = '0-u16max[==\$0]' where function = '__builtin_bswap16';
 116
 117 delete from return_states where function = 'bitmap_allocate_region' and return = '1';
 118 /* Just delete a lot of returns that everyone ignores */
 119 delete from return_states where file = 'drivers/pci/access.c' and (return >= 129 and return <= 137);
 120
 121 /* Smatch can't parse wait_for_completion() */
 122 update return_states set return = '(-108),(-22),0' where function = '__spi_sync' and return = '(-115),(-108),(-22)';
 123
 124 /* We sometimes use pre-allocated 4097 byte buffers for performance critical code but pretend it is always PAGE_SIZE */
 125 update caller_info set value = 4096 where caller='kernfs_file_direct_read' and function='(struct kernfs_ops)->read' and type = 1002 and parameter = 1;
 126 /* let's pretend firewire doesn't exist */
 127 delete from caller_info where caller='init_fw_attribute_group' and function='(struct device_attribute)->show';
 128 /* and let's fake the next dev_attr_show() call entirely */
 129 delete from caller_info where caller='sysfs_kf_seq_show' and function='(struct sysfs_ops)->show';
 130 insert into caller_info values ('fake', 'sysfs_kf_seq_show', '(struct sysfs_ops)->show', 0, 0, 1001, 0, '\$', '4096-ptr_max');
 131 insert into caller_info values ('fake', 'sysfs_kf_seq_show', '(struct sysfs_ops)->show', 0, 0, 1002, 2, '\$', '4096');
 132 insert into caller_info values ('fake', 'sysfs_kf_seq_show', '(struct sysfs_ops)->show', 0, 0, 1001, 2, '\$', '4096-ptr_max');
 133 insert into caller_info values ('fake', 'sysfs_kf_seq_show', '(struct sysfs_ops)->show', 0, 0, 0,   -1, ''  , '');
 134 /* config fs confuses smatch a little */
 135 update caller_info set value = 4096 where caller='fill_read_buffer' and function='(struct configfs_item_operations)->show_attribute' and type = 1002 and parameter = 2;
 136
 137 /* smatch sees the memset() but not the subsequent changes */
 138 update return_states set value = "" where function = 'gfs2_ea_find' and return = '0' and type = 101 and parameter = 3;
 139
 140 delete from type_value where type = '(struct fd)->file';
 141 delete from type_value where type = '(struct fd)->flags';
 142
 143 /* This is sometimes an enum or a u64 */
 144 delete from type_value where type = '(struct mc_cmd_header)->status';
 145
 146 /* this is handled in check_kernel.c */
 147 delete from return_states where function = "__write_once_size";
 148
 149 update return_states set value = "s32min-s32max[\$1]" where function = 'atomic_set' and parameter = 0 and type = 1025;
 150
 151 /* other atomic stuff */
 152 delete from return_states where function = 'sg_common_write' and type = 8023;
 153 delete from return_states where function = 'schedule' and type = 8024;
 154 delete from return_states where function = '__mutex_lock_common' and type = 8024;
 155 delete from return_states where function = 'mutex_unlock' and type = 8024;
 156 delete from return_states where function = 'printk' and type = 8024;
 157 delete from return_states where function = 'vsnprintf' and type = 8024;
 158
 159 update return_states set return = '0-32,2147483648-2147483690' where function = '_parse_integer' and return = '0';
 160 update return_states set value = '0-u64max' where function = '_parse_integer' and type = 1025 and parameter = 2 and key = '*$';
 161
 162 /* delete some function pointers which are sometimes byte units */
 163 delete from caller_info where function = '(struct i2c_algorithm)->master_xfer' and type = 1027;
 164
 165 /* this if from READ_ONCE().  We can't know anything about the data.  */
 166 delete from type_info where key = '(union anonymous)->__val';
 167
 168 /* This is RIO_BAD_SIZE */
 169 delete from return_states where file = 'drivers/rapidio/rio-access.c' and return = '129';
 170
 171 /* Smatch sucks at loops */
 172 delete from return_states where function = 'ata_dev_next' and type = 103;
 173
 174 /* The problem is that parsing big function pointers is hard. */
 175 delete from return_states where function = 'vfs_get_tree' and type = 1024;
 176
 177 /* Locking stuff goes here.  */
 178 update return_states set parameter = -1, key = '\$' where function = 'ipmi_ssif_lock_cond' and type = 8020 and parameter = 1;
 179 update return_states set parameter = 1, key = '\$->tree->tree_lock' where function = 'hfs_find_init' and type = 8020 and parameter = 0;
 180 delete from return_states where function = '__oom_kill_process' and type = 8021;
 181
 182 /* These can not return NULL */
 183 delete from return_states where function='ext4_append' and return = '0';
 184
 185 delete from return_states where function = 'fib6_tables_dump' and return = '1';
 186
 187 delete from return_states where function = 'bus_for_each_dev' and return = '1';
 188
 189 EOF
 190
 191 for i in $(echo "select distinct return from return_states where function = 'clear_user';" | sqlite3 $db_file ) ; do
 192     echo "update return_states set return = \"$i[<=\$1]\" where return = \"$i\" and function = 'clear_user';" | sqlite3 $db_file
 193 done
 194
 195 echo "select distinct file, function from function_ptr where ptr='(struct rtl_hal_ops)->set_hw_reg';" \
 196         | sqlite3 $db_file | sed -e 's/|/ /' | while read file function ; do
 197
 198     drv=$(echo $file | perl -ne 's/.*\/rtlwifi\/(.*?)\/sw.c/$1/; print')
 199     if [ $drv = "" ] ; then
 200         continue
 201     fi
 202
 203     echo "update caller_info
 204           set function = '$drv (struct rtl_hal_ops)->set_hw_reg'
 205           where function = '(struct rtl_hal_ops)->set_hw_reg' and file like 'drivers/net/wireless/rtlwifi/$drv/%';" \
 206          | sqlite3 $db_file
 207
 208     echo "insert into function_ptr values ('$file', '$function', '$drv (struct rtl_hal_ops)->set_hw_reg', 1);" \
 209          | sqlite3 $db_file
 210 done
 211
 212 for func in __kmalloc __kmalloc_track_caller ; do
 213
 214     cat << EOF | sqlite3 $db_file
 215 delete from return_states where function = '$func';
 216 insert into return_states values ('faked', '$func', 0, 1, '16', 0,    0,  -1, '', '');
 217 insert into return_states values ('faked', '$func', 0, 1, '16', 0, 103,   0, '\$', '0');
 218 insert into return_states values ('faked', '$func', 0, 2, '4096-ptr_max', 0,    0, -1, '', '');
 219 insert into return_states values ('faked', '$func', 0, 2, '4096-ptr_max', 0, 103,  0, '\$', '1-4000000');
 220 insert into return_states values ('faked', '$func', 0, 2, '4096-ptr_max', 0, 1037,  -1, '', 400);
 221 insert into return_states values ('faked', '$func', 0, 3, '0', 0,    0,  -1, '', '');
 222 insert into return_states values ('faked', '$func', 0, 3, '0', 0,    103,  0, '\$', '1-long_max');
 223 EOF
 224 done
 225