xref: /sqlite-3.40.0/tool/speed-check.sh (revision 91ea8cf4) 
1#!/bin/bash
2#
3# This is a template for a script used for day-to-day size and
4# performance monitoring of SQLite.  Typical usage:
5#
6#     sh run-speed-test.sh trunk  #  Baseline measurement of trunk
7#     sh run-speed-test.sh x1     # Measure some experimental change
8#     fossil test-diff --tk cout-trunk.txt cout-x1.txt   # View chanages
9#
10# There are multiple output files, all with a base name given by
11# the first argument:
12#
13#     summary-$BASE.txt           # Copy of standard output
14#     cout-$BASE.txt              # cachegrind output
15#     explain-$BASE.txt           # EXPLAIN listings (only with --explain)
16#
17if test "$1" = ""
18then
19  echo "Usage: $0 OUTPUTFILE [OPTIONS]"
20  exit
21fi
22NAME=$1
23shift
24#CC_OPTS="-DSQLITE_ENABLE_RTREE -DSQLITE_ENABLE_MEMSYS5"
25CC_OPTS="-DSQLITE_ENABLE_MEMSYS5"
26CC=gcc
27SPEEDTEST_OPTS="--shrink-memory --reprepare --stats --heap 10000000 64"
28SIZE=5
29LEAN_OPTS="-DSQLITE_THREADSAFE=0"
30LEAN_OPTS="$LEAN_OPTS -DSQLITE_DEFAULT_MEMSTATUS=0"
31LEAN_OPTS="$LEAN_OPTS -DSQLITE_DEFAULT_WAL_SYNCHRONOUS=1"
32LEAN_OPTS="$LEAN_OPTS -DSQLITE_LIKE_DOESNT_MATCH_BLOB"
33LEAN_OPTS="$LEAN_OPTS -DSQLITE_MAX_EXPR_DEPTH=0"
34LEAN_OPTS="$LEAN_OPTS -DSQLITE_OMIT_DECLTYPE"
35LEAN_OPTS="$LEAN_OPTS -DSQLITE_OMIT_DEPRECATED"
36LEAN_OPTS="$LEAN_OPTS -DSQLITE_OMIT_PROGRESS_CALLBACK"
37LEAN_OPTS="$LEAN_OPTS -DSQLITE_OMIT_SHARED_CACHE"
38LEAN_OPTS="$LEAN_OPTS -DSQLITE_USE_ALLOCA"
39doExplain=0
40doCachegrind=1
41while test "$1" != ""; do
42  case $1 in
43    --reprepare)
44        SPEEDTEST_OPTS="$SPEEDTEST_OPTS $1"
45        ;;
46    --autovacuum)
47        SPEEDTEST_OPTS="$SPEEDTEST_OPTS $1"
48        ;;
49    --utf16be)
50        SPEEDTEST_OPTS="$SPEEDTEST_OPTS $1"
51        ;;
52    --stats)
53        SPEEDTEST_OPTS="$SPEEDTEST_OPTS $1"
54        ;;
55    --without-rowid)
56        SPEEDTEST_OPTS="$SPEEDTEST_OPTS $1"
57        ;;
58    --nomemstat)
59        SPEEDTEST_OPTS="$SPEEDTEST_OPTS $1"
60        ;;
61    --temp)
62        SPEEDTEST_OPTS="$SPEEDTEST_OPTS --temp 6"
63        ;;
64    --wal)
65        SPEEDTEST_OPTS="$SPEEDTEST_OPTS --journal wal"
66        ;;
67    --size)
68        shift; SIZE=$1
69        ;;
70    --cachesize)
71        shift; SPEEDTEST_OPTS="$SPEEDTEST_OPTS --cachesize $1"
72        ;;
73    --explain)
74        doExplain=1
75        ;;
76    --vdbeprofile)
77        rm -f vdbe_profile.out
78        CC_OPTS="$CC_OPTS -DVDBE_PROFILE"
79        doCachegrind=0
80        ;;
81    --lean)
82        CC_OPTS="$CC_OPTS $LEAN_OPTS"
83        ;;
84    --clang)
85        CC=clang
86        ;;
87    --icc)
88        CC=/home/drh/intel/bin/icc
89        ;;
90    --gcc7)
91        CC=gcc-7
92        ;;
93    --heap)
94        CC_OPTS="$CC_OPTS -DSQLITE_ENABLE_MEMSYS5"
95        shift;
96        SPEEDTEST_OPTS="$SPEEDTEST_OPTS --heap $1 64"
97        ;;
98    --lookaside)
99        shift;
100        SPEEDTEST_OPTS="$SPEEDTEST_OPTS --lookaside $1 $2"
101        shift;
102        ;;
103    --repeat)
104        CC_OPTS="$CC_OPTS -DSQLITE_ENABLE_RCACHE"
105        shift;
106        SPEEDTEST_OPTS="$SPEEDTEST_OPTS --repeat $1"
107        ;;
108    --mmap)
109        shift;
110        SPEEDTEST_OPTS="$SPEEDTEST_OPTS --mmap $1"
111        ;;
112    --rtree)
113        SPEEDTEST_OPTS="$SPEEDTEST_OPTS --testset rtree"
114        CC_OPTS="$CC_OPTS -DSQLITE_ENABLE_RTREE"
115        ;;
116    --orm)
117        SPEEDTEST_OPTS="$SPEEDTEST_OPTS --testset orm"
118        ;;
119    *)
120        CC_OPTS="$CC_OPTS $1"
121        ;;
122  esac
123  shift
124done
125SPEEDTEST_OPTS="$SPEEDTEST_OPTS --size $SIZE"
126echo "NAME           = $NAME" | tee summary-$NAME.txt
127echo "SPEEDTEST_OPTS = $SPEEDTEST_OPTS" | tee -a summary-$NAME.txt
128echo "CC_OPTS        = $CC_OPTS" | tee -a summary-$NAME.txt
129rm -f cachegrind.out.* speedtest1 speedtest1.db sqlite3.o
130$CC -g -Os -Wall -I. $CC_OPTS -c sqlite3.c
131size sqlite3.o | tee -a summary-$NAME.txt
132if test $doExplain -eq 1; then
133  $CC -g -Os -Wall -I. $CC_OPTS \
134     -DSQLITE_ENABLE_EXPLAIN_COMMENTS \
135    ./shell.c ./sqlite3.c -o sqlite3 -ldl -lpthread
136fi
137SRC=./speedtest1.c
138$CC -g -Os -Wall -I. $CC_OPTS $SRC ./sqlite3.o -o speedtest1 -ldl -lpthread
139ls -l speedtest1 | tee -a summary-$NAME.txt
140if test $doCachegrind -eq 1; then
141  valgrind --tool=cachegrind ./speedtest1 speedtest1.db \
142      $SPEEDTEST_OPTS 2>&1 | tee -a summary-$NAME.txt
143else
144  ./speedtest1 speedtest1.db $SPEEDTEST_OPTS 2>&1 | tee -a summary-$NAME.txt
145fi
146size sqlite3.o | tee -a summary-$NAME.txt
147wc sqlite3.c
148if test $doCachegrind -eq 1; then
149  cg_anno.tcl cachegrind.out.* >cout-$NAME.txt
150fi
151if test $doExplain -eq 1; then
152  ./speedtest1 --explain $SPEEDTEST_OPTS | ./sqlite3 >explain-$NAME.txt
153fi
154if test "$NAME" != "trunk"; then
155  fossil test-diff --tk -c 20 cout-trunk.txt cout-$NAME.txt
156fi
157