Bram Moolenaar | 209b8e3 | 2019-03-14 13:43:24 +0100 | [diff] [blame] | 1 | " Tests for memory usage. |
| 2 | |
Bram Moolenaar | b46fecd | 2019-06-15 17:58:09 +0200 | [diff] [blame] | 3 | source check.vim |
| 4 | CheckFeature terminal |
Bram Moolenaar | 8c5a278 | 2019-08-07 23:07:07 +0200 | [diff] [blame] | 5 | CheckNotGui |
Bram Moolenaar | b46fecd | 2019-06-15 17:58:09 +0200 | [diff] [blame] | 6 | |
Bram Moolenaar | bffc504 | 2019-06-15 16:34:21 +0200 | [diff] [blame] | 7 | if execute('version') =~# '-fsanitize=[a-z,]*\<address\>' |
Bram Moolenaar | 209b8e3 | 2019-03-14 13:43:24 +0100 | [diff] [blame] | 8 | " Skip tests on Travis CI ASAN build because it's difficult to estimate |
| 9 | " memory usage. |
Bram Moolenaar | b46fecd | 2019-06-15 17:58:09 +0200 | [diff] [blame] | 10 | throw 'Skipped: does not work with ASAN' |
Bram Moolenaar | 209b8e3 | 2019-03-14 13:43:24 +0100 | [diff] [blame] | 11 | endif |
| 12 | |
| 13 | source shared.vim |
| 14 | |
| 15 | func s:pick_nr(str) abort |
| 16 | return substitute(a:str, '[^0-9]', '', 'g') * 1 |
| 17 | endfunc |
| 18 | |
| 19 | if has('win32') |
| 20 | if !executable('wmic') |
Bram Moolenaar | b46fecd | 2019-06-15 17:58:09 +0200 | [diff] [blame] | 21 | throw 'Skipped: wmic program missing' |
Bram Moolenaar | 209b8e3 | 2019-03-14 13:43:24 +0100 | [diff] [blame] | 22 | endif |
| 23 | func s:memory_usage(pid) abort |
| 24 | let cmd = printf('wmic process where processid=%d get WorkingSetSize', a:pid) |
| 25 | return s:pick_nr(system(cmd)) / 1024 |
| 26 | endfunc |
| 27 | elseif has('unix') |
| 28 | if !executable('ps') |
Bram Moolenaar | b46fecd | 2019-06-15 17:58:09 +0200 | [diff] [blame] | 29 | throw 'Skipped: ps program missing' |
Bram Moolenaar | 209b8e3 | 2019-03-14 13:43:24 +0100 | [diff] [blame] | 30 | endif |
| 31 | func s:memory_usage(pid) abort |
| 32 | return s:pick_nr(system('ps -o rss= -p ' . a:pid)) |
| 33 | endfunc |
| 34 | else |
Bram Moolenaar | b46fecd | 2019-06-15 17:58:09 +0200 | [diff] [blame] | 35 | throw 'Skipped: not win32 or unix' |
Bram Moolenaar | 209b8e3 | 2019-03-14 13:43:24 +0100 | [diff] [blame] | 36 | endif |
| 37 | |
| 38 | " Wait for memory usage to level off. |
| 39 | func s:monitor_memory_usage(pid) abort |
| 40 | let proc = {} |
| 41 | let proc.pid = a:pid |
| 42 | let proc.hist = [] |
Bram Moolenaar | 209b8e3 | 2019-03-14 13:43:24 +0100 | [diff] [blame] | 43 | let proc.max = 0 |
| 44 | |
| 45 | func proc.op() abort |
| 46 | " Check the last 200ms. |
| 47 | let val = s:memory_usage(self.pid) |
Bram Moolenaar | f7e47af | 2019-03-21 21:16:36 +0100 | [diff] [blame] | 48 | if self.max < val |
Bram Moolenaar | 209b8e3 | 2019-03-14 13:43:24 +0100 | [diff] [blame] | 49 | let self.max = val |
| 50 | endif |
| 51 | call add(self.hist, val) |
| 52 | if len(self.hist) < 20 |
| 53 | return 0 |
| 54 | endif |
| 55 | let sample = remove(self.hist, 0) |
| 56 | return len(uniq([sample] + self.hist)) == 1 |
| 57 | endfunc |
| 58 | |
| 59 | call WaitFor({-> proc.op()}, 10000) |
Bram Moolenaar | f7e47af | 2019-03-21 21:16:36 +0100 | [diff] [blame] | 60 | return {'last': get(proc.hist, -1), 'max': proc.max} |
Bram Moolenaar | 209b8e3 | 2019-03-14 13:43:24 +0100 | [diff] [blame] | 61 | endfunc |
| 62 | |
| 63 | let s:term_vim = {} |
| 64 | |
| 65 | func s:term_vim.start(...) abort |
| 66 | let self.buf = term_start([GetVimProg()] + a:000) |
| 67 | let self.job = term_getjob(self.buf) |
| 68 | call WaitFor({-> job_status(self.job) ==# 'run'}) |
| 69 | let self.pid = job_info(self.job).process |
| 70 | endfunc |
| 71 | |
| 72 | func s:term_vim.stop() abort |
| 73 | call term_sendkeys(self.buf, ":qall!\<CR>") |
| 74 | call WaitFor({-> job_status(self.job) ==# 'dead'}) |
| 75 | exe self.buf . 'bwipe!' |
| 76 | endfunc |
| 77 | |
| 78 | func s:vim_new() abort |
| 79 | return copy(s:term_vim) |
| 80 | endfunc |
| 81 | |
| 82 | func Test_memory_func_capture_vargs() |
| 83 | " Case: if a local variable captures a:000, funccall object will be free |
| 84 | " just after it finishes. |
| 85 | let testfile = 'Xtest.vim' |
Bram Moolenaar | e7eb927 | 2019-06-24 00:58:07 +0200 | [diff] [blame] | 86 | let lines =<< trim END |
| 87 | func s:f(...) |
| 88 | let x = a:000 |
| 89 | endfunc |
| 90 | for _ in range(10000) |
| 91 | call s:f(0) |
| 92 | endfor |
| 93 | END |
| 94 | call writefile(lines, testfile) |
Bram Moolenaar | 209b8e3 | 2019-03-14 13:43:24 +0100 | [diff] [blame] | 95 | |
| 96 | let vim = s:vim_new() |
| 97 | call vim.start('--clean', '-c', 'set noswapfile', testfile) |
| 98 | let before = s:monitor_memory_usage(vim.pid).last |
| 99 | |
| 100 | call term_sendkeys(vim.buf, ":so %\<CR>") |
| 101 | call WaitFor({-> term_getcursor(vim.buf)[0] == 1}) |
| 102 | let after = s:monitor_memory_usage(vim.pid) |
| 103 | |
| 104 | " Estimate the limit of max usage as 2x initial usage. |
Bram Moolenaar | 5d508dd | 2019-05-31 20:23:25 +0200 | [diff] [blame] | 105 | " The lower limit can fluctuate a bit, use 97%. |
| 106 | call assert_inrange(before * 97 / 100, 2 * before, after.max) |
Bram Moolenaar | 3a731ee | 2019-03-27 21:41:36 +0100 | [diff] [blame] | 107 | |
| 108 | " In this case, garbage collecting is not needed. |
Bram Moolenaar | 5d508dd | 2019-05-31 20:23:25 +0200 | [diff] [blame] | 109 | " The value might fluctuate a bit, allow for 3% tolerance below and 5% above. |
| 110 | " Based on various test runs. |
Bram Moolenaar | f7e47af | 2019-03-21 21:16:36 +0100 | [diff] [blame] | 111 | let lower = after.last * 97 / 100 |
Bram Moolenaar | 5d508dd | 2019-05-31 20:23:25 +0200 | [diff] [blame] | 112 | let upper = after.last * 105 / 100 |
Bram Moolenaar | f7e47af | 2019-03-21 21:16:36 +0100 | [diff] [blame] | 113 | call assert_inrange(lower, upper, after.max) |
Bram Moolenaar | 209b8e3 | 2019-03-14 13:43:24 +0100 | [diff] [blame] | 114 | |
| 115 | call vim.stop() |
| 116 | call delete(testfile) |
| 117 | endfunc |
| 118 | |
| 119 | func Test_memory_func_capture_lvars() |
| 120 | " Case: if a local variable captures l: dict, funccall object will not be |
| 121 | " free until garbage collector runs, but after that memory usage doesn't |
| 122 | " increase so much even when rerun Xtest.vim since system memory caches. |
| 123 | let testfile = 'Xtest.vim' |
Bram Moolenaar | e7eb927 | 2019-06-24 00:58:07 +0200 | [diff] [blame] | 124 | let lines =<< trim END |
| 125 | func s:f() |
| 126 | let x = l: |
| 127 | endfunc |
| 128 | for _ in range(10000) |
| 129 | call s:f() |
| 130 | endfor |
| 131 | END |
| 132 | call writefile(lines, testfile) |
Bram Moolenaar | 209b8e3 | 2019-03-14 13:43:24 +0100 | [diff] [blame] | 133 | |
| 134 | let vim = s:vim_new() |
| 135 | call vim.start('--clean', '-c', 'set noswapfile', testfile) |
| 136 | let before = s:monitor_memory_usage(vim.pid).last |
| 137 | |
| 138 | call term_sendkeys(vim.buf, ":so %\<CR>") |
| 139 | call WaitFor({-> term_getcursor(vim.buf)[0] == 1}) |
| 140 | let after = s:monitor_memory_usage(vim.pid) |
| 141 | |
| 142 | " Rerun Xtest.vim. |
| 143 | for _ in range(3) |
| 144 | call term_sendkeys(vim.buf, ":so %\<CR>") |
| 145 | call WaitFor({-> term_getcursor(vim.buf)[0] == 1}) |
| 146 | let last = s:monitor_memory_usage(vim.pid).last |
| 147 | endfor |
| 148 | |
Bram Moolenaar | f7e47af | 2019-03-21 21:16:36 +0100 | [diff] [blame] | 149 | " The usage may be a bit less than the last value, use 80%. |
Bram Moolenaar | 6b6f7aa | 2019-03-22 14:36:59 +0100 | [diff] [blame] | 150 | " Allow for 20% tolerance at the upper limit. That's very permissive, but |
Bram Moolenaar | 1832d12 | 2020-01-01 15:17:25 +0100 | [diff] [blame] | 151 | " otherwise the test fails sometimes. On Cirrus CI with FreeBSD we need to |
| 152 | " be even more permissive. |
| 153 | if has('bsd') |
Bram Moolenaar | bb062c1 | 2020-01-01 15:26:32 +0100 | [diff] [blame] | 154 | let multiplier = 15 |
Bram Moolenaar | 1832d12 | 2020-01-01 15:17:25 +0100 | [diff] [blame] | 155 | else |
| 156 | let multiplier = 12 |
| 157 | endif |
Bram Moolenaar | 08cda65 | 2019-03-20 22:45:01 +0100 | [diff] [blame] | 158 | let lower = before * 8 / 10 |
Bram Moolenaar | 1832d12 | 2020-01-01 15:17:25 +0100 | [diff] [blame] | 159 | let upper = (after.max + (after.last - before)) * multiplier / 10 |
Bram Moolenaar | f7e47af | 2019-03-21 21:16:36 +0100 | [diff] [blame] | 160 | call assert_inrange(lower, upper, last) |
Bram Moolenaar | 209b8e3 | 2019-03-14 13:43:24 +0100 | [diff] [blame] | 161 | |
| 162 | call vim.stop() |
| 163 | call delete(testfile) |
| 164 | endfunc |