Welcome to 2019
[ikiwiki.git] / doc / todo / should_optimise_pagespecs.mdwn
1 I think there is a problem in my "dependency graph". As an example, 
2 [here](http://poivron.org/~nil/misc/ikiwiki_buggy_index) is the index 
3 ikiwiki generated for [my site](http://poivron.org/~nil/misc/ikiwiki_buggy_index)
4 (note that the site changed since this index was generated).
5
6 Some **HUGE** dependencies appear, clearly non optimal, like
7
8     depends = A| B | A | C | A | D | A | E | A | F | A | G | ....
9
10 or 
11
12     depends= A | B | C | D | A | B | C | D | A | B | C | D | ....
13
14 Couldn't isolate the cause, but some sources for this problem may be:
15
16 * related to the img module
17 * easily observable in my sire because one of my pages includes 80 resized images
18
19 Other special things in my templates and site:
20
21 * a sidebar with \[[!include pages="notes/\*" template=foo]] while notes.mdwn has 
22   a \[[!include pages="notes/*"]] and uses the sidebar; removed it, doesn't change
23 * a template (biblio.tmpl) calling the "img" plugin with a template parameter as the
24   image filename; removed it, doesn't change
25 * some strange games with tags whose page calls a "map" directive to show other tags
26   shile tags are also used in tagclouds (in the sidebar and in the main pages)
27 * ...
28
29 I observed these problems (same *kind*, I didn't check in details) on
30  
31 * ikiwiki 2.00gpa1 + v5.8.4 + Debian 3.1
32 * ikiwiki 2.3 + v5.8.8 + Ubuntu 7.04
33
34 I can think about reducung the size of my wiki source and making it available online for analysis.
35
36 -- NicolasLimare
37
38 > As long as these dependencies don't grow over time (ie, when a page is
39 > edited and nothing changed that should add a dependency), I wouldn't
40 > worry about them. There are many things that can cause non-optimal
41 > dependencies to be recorded. For one thing, if you inline something, ikiwiki
42 > creates a dependency like:
43
44 > (PageSpec) or (file1 or file2 or file3 ...)
45
46 > Where fileN are all the files that the PageSpec currently matches. (This
47 > is ncessary to detect when a currently inlined file is deleted, and know
48 > the inlining page needs an update.) Now consider what it does if you have
49 > a single page with two inline statements, that inline the same set of
50 > stuff twice:
51
52 > ((PageSpec) or (file1 or file2 or file3 ...) or (PageSpec) or (file1 or file2 or file3 ...)
53 >
54 > Clearly non-optimal, indeed.
55
56 > Ikiwiki doesn't bother to simplify complex PageSpecs
57 > because it's difficult to do, and because all they use is some disk
58 > space. Consider what ikiwiki uses these dependencies for.
59 > All it wants to know is: does the PageSpec for this page it's considering
60 > rebuilding match any of the pages that have changed? Determining this is
61 > a simple operation -- the PageSpec is converted to perl code. The perl
62 > code is run.
63
64 > So the total impact of an ugly dependency like this is:
65
66 > 1. Some extra data read/written to disk.
67 > 2. Some extra space in memory.
68 > 3. A bit more data for the PageSpec translation code to handle. But that
69 >    code is quite fast.
70 > 4. Typically one extra function call when the generated perl code is run.
71 >    Ie, when the expression on the left-hand side fails, which typically
72 >    happens after one (inexpensive) function call, it has to check
73 >    the identical expression on the right hand side.
74
75 > So this is at best a wishlist todo item, not a bug. A PageSpec simplifier
76 > (or improved `pagespec_merge()` function) could be written and improve
77 > ikiwiki's memory and disk usage, but would it actually speed it up any?
78 > We'd have to see the code to the simplifier to know.
79
80 > --[[Joey]]
81
82 >> I've been looking at optimizing ikiwiki for a site using
83 >> [[plugins/contrib/album]] (which produces a lot of pages) and it seems
84 >> that checking which pages depend on which pages does take a significant
85 >> amount of time. The optimize-depends branch in my git repository
86 >> avoids using `pagespec_merge()` for this (indeed it's no longer used
87 >> at all), and instead represents dependencies as a list of pagespecs
88 >> rather than a single pagespec. This does turn out to be faster, although
89 >> not as much as I'd like. --[[smcv]]
90
91 >>> [[Merged|done]] --[[smcv]]
92
93 >>> I just wanted to note that there is a whole long discussion of dependencies and pagespecs on the [[todo/tracking_bugs_with_dependencies]] page. -- [[Will]]
94
95 >>>> Yeah, I had a look at that (as the only other mention of `pagespec_merge`).
96 >>>> I think I might have solved some of the problems mentioned there,
97 >>>> actually - `pagespec_merge` no longer needs to exist in my branch (although
98 >>>> I haven't actually deleted it), because the "or" operation is now done in
99 >>>> the Perl code, rather than by merging pagespecs and translating. --[[smcv]]
100
101 >>>>> I've now added a patch to the end of that branch that deletes
102 >>>>> `pagespec_merge` almost entirely (we do need to keep a copy around, in
103 >>>>> ikiwiki-transition, but that copy doesn't have to be optimal or support
104 >>>>> future features like [[tracking_bugs_with_dependencies]]). --[[smcv]]
105
106 ---
107
108 Some questions on your optimize-depends branch. --[[Joey]]
109
110 In saveindex it still or'd together the depends list, but the `{depends}`
111 field seems only useful for backwards compatability (ie, ikiwiki-transition
112 uses it still), and otherwise just bloats the index.
113
114 > If it's acceptable to declare that downgrading IkiWiki requires a complete
115 > rebuild, I'm happy with that. I'd prefer to keep the (simple form of the)
116 > transition done automatically during a load/save cycle, rather than
117 > requiring ikiwiki-transition to be run; we should probably say in NEWS
118 > that the performance increase won't fully apply until the next
119 > rebuild. --[[smcv]]
120
121 >> It is acceptable not to support downgrades.
122 >> I don't think we need a NEWS file update since any sort of refresh,
123 >> not just a full rebuild, will cause the indexdb to be loaded and saved,
124 >> enabling the optimisation. --[[Joey]]
125
126 >>> A refresh will load the current dependencies from `{depends}` and save
127 >>> them as-is as a one-element `{dependslist}`; only a rebuild will replace
128 >>> the single complex pagespec with a long list of simpler pagespecs.
129 >>> --[[smcv]]
130
131 Is an array the right data structure? `add_depends` has to loop through the
132 array to avoid dups, it would be better if a hash were used there. Since
133 inline (and other plugins) explicitly add all linked pages, each as a
134 separate item, the list can get rather long, and that single add_depends
135 loop has suddenly become O(N^2) to the number of pages, which is something
136 to avoid..
137
138 > I was also thinking about this (I've been playing with some stuff based on the
139 > `remove-pagespec-merge` branch).  A hash, by itself, is not optimal because
140 > the dependency list holds two things: page names and page specs.  The hash would
141 > work well for the page names, but you'll still need to iterate through the page specs.
142 > I was thinking of keeping a list and a hash.  You use the list for pagespecs
143 > and the hash for individual page names.  To make this work you need to adjust the
144 > API so it knows which you're adding.  -- [[Will]]
145
146 > I wasn't thinking about a lookup hash, just a dedup hash, FWIW.
147 > --[[Joey]]
148
149 >> I was under the impression from previous code review that you preferred
150 >> to represent unordered sets as lists, rather than hashes with dummy
151 >> values. If I was wrong, great, I'll fix that and it'll probably go
152 >> a bit faster. --[[smcv]]
153
154 >>> It depends, really. And it'd certianly make sense to benchmark such a
155 >>> change. --[[Joey]]
156
157 >>>> Benchmarked, below. --[[smcv]]
158
159 Also, since a lot of places are calling add_depends in a loop, it probably
160 makes sense to just make it accept a list of dependencies to add. It'll be
161 marginally faster, probably, and should allow for better optimisation
162 when adding a lot of depends at once.
163
164 > That'd be an API change; perhaps marginally faster, but I don't
165 > see how it would allow better optimisation if we're de-duplicating
166 > anyway? --[[smcv]]
167
168 >> Well, I was thinking that it might be sufficient to build a `%seen`
169 >> hash of dependencies inside `add_depends`, if the places that call
170 >> it lots were changed to just call it once. Of course the only way to
171 >> tell is benchmarking. --[[Joey]]
172
173 >>> It doesn't seem that it significantly affects performance either way.
174 >>> --[[smcv]]
175
176 In Render.pm, we now have a triply nested loop, which is a bit
177 scary for efficiency. It seems there should be a way to
178 rework this code so it can use the optimised `pagespec_match_list`,
179 and/or hoist some of the inner loop calculations (like the `pagename`)
180 out.
181
182 > I don't think the complexity is any greater than it was: I've just
183 > moved one level of "loop" out of the generated Perl, to be
184 > in visible code. I'll see whether some of it can be hoisted, though.
185 > --[[smcv]]
186
187 >> The call to `pagename` is the only part I can see that's clearly
188 >> run more often than before. That function is pretty inexpensive, but..
189 >> --[[Joey]]
190
191 >>> I don't see anything that can be hoisted without significant refactoring,
192 >>> actually. Beware that there are two pagename calls in the loop: one for
193 >>> `$f` (which is the page we might want to rebuild), and one for `$file`
194 >>> (which is the changed page that it might depend on). Note that I didn't
195 >>> choose those names!
196 >>>
197 >>> The three loops are over source files, their lists of dependency pagespecs,
198 >>> and files that might have changed. I see the following things we might be
199 >>> doing redundantly:
200 >>>
201 >>> * If `$file` is considered as a potential dependency for more than
202 >>>   one `$f`, we evaluate `pagename($file)` more than once. Potential fix:
203 >>>   cache them (this turns out to save about half a second on the docwiki,
204 >>>   see below).
205 >>> * If several pages depend on the same pagespec, we evaluate whether each
206 >>>   changed page matches that pagespec more than once: however, we do so
207 >>>   with a different location parameter every time, so repeated calls are,
208 >>>   in the general case, the only correct thing to do. Potential fix:
209 >>>   perhaps special-case "page x depends on page y and nothing else"
210 >>>   (i.e. globs that have no wildcards) into a separate hash? I haven't
211 >>>   done anything in this direction.
212 >>> * Any preparatory work done by pagespec_match (converting the pagespec
213 >>>   into Perl, mostly?) is done in the inner loop; switching to
214 >>>   pagespec_match_list (significant refactoring) saves more than half a
215 >>>   second on the docwiki.
216 >>>
217 >>> --[[smcv]]
218
219 Very good catch on img/meta using the wrong dependency; verified in the wild!
220 (I've cherry-picked those bug fixes.)
221
222 ----
223
224 Benchmarking results: I benchmarked by altering docwiki.setup to switch off
225 verbose, running "make clean && ./Makefile.PL && make", and timing one rebuild
226 of the docwiki followed by three refreshes. Before each refresh I used
227 `touch plugins/*.mdwn` to have something significant to refresh.
228
229 I'm assuming that "user" CPU time is the important thing here (system time was
230 relatively small in all cases, up to 0.35 seconds per run).
231
232 master at the time of rebasing: 14.20s to rebuild, 10.04/12.07/14.01s to
233 refresh. I think you can see the bug clearly here - the pagespecs are getting
234 more complicated every time!
235
236 > I can totally see a bug here, and it's one I didn't think existed. Ie,
237 > I thought that after the first refresh, the pagespec should stabalize,
238 > and what it stabalized to was probably unnecessarily long, but not
239 > growing w/o bounds!
240
241 > a) Explains why ikiwiki.info has been so slow lately. Well that and some
242 >    other things that overloaded the system.
243 > b) Suggests to me we will probably want to force a rebuild on upgrade
244 >    when fixing this (via the mechanism in the postinst).
245 >
246 > I've investigated why the pagespecs keep growing: When page A changes,
247 > its old depends are cleared. Then
248 > page B that inlines A gets rebuilt, and its old depends are also cleared.
249 > But page B also inlines page C; which means C gets re-rendered. And this
250 > happens w/o its old depends being cleared, so C's depends are doubled.
251 > --[[Joey]]
252
253 After the initial optimization: 14.27s to rebuild, 8.26/8.33/8.26 to refresh.
254 Success!
255
256 Not pre-joining dependencies actually took about ~0.2s more; I don't know why.
257 I'm worried that duplicates will just build up (again) in less simple cases,
258 though, so 0.2s is probably a small price to pay for that not happening (it
259 might well be experimental error, for that matter).
260
261 > It's weird that the suggested optimisations to
262 > `add_depends` had no effect. So, the commit message to
263 > b6fcb1cb0ef27e5a63184440675d465fad652acf is actually wrong.. ? --[[Joey]] 
264
265 >> I'll try benchmarking again on the non-public wiki where I had the 4%
266 >> speedup. The docwiki is so small that 4% is hard to measure... --[[smcv]]
267
268 Not saving {depends} to the index, using a hash instead of a list to
269 de-duplicate, and allowing add_depends to take an arrayref instead of a single
270 pagespec had no noticable positive or negative effect on this test.
271
272 > I see e4cd168ebedd95585290c97ff42234344bfed46c is still in your branch
273 > though. I don't like using an arrayref, it could just take `($page, @depends)`.
274 > and I don't see the need to keep it if it doesn't currently help.
275
276 >> I'll drop it. --[[smcv]]
277
278 > Is there any reason to keep 7227c2debfeef94b35f7d81f42900aa01820caa3
279 > if it doesn't improve speed?
280 > --[[Joey]] 
281
282 >> I'll try benchmarking on a more complex wiki and see whether it has a
283 >> positive or negative effect. It does avoid being O(n**2) in number of
284 >> dependencies. --[[smcv]]
285
286 Memoizing the results of pagename brought the rebuild time down to 14.06s
287 and the refresh time down to 7.96/7.92/7.92, a significant win.
288
289 > Ok, that seems safe to memoize. (It's a real function and it isn't
290 > called with a great many inputs.) Why did you chose to memoize it
291 > explicitly rather than adding it to the memoize list at the top?
292
293 >> It does depend on global variables, so using Memoize seemed like asking for
294 >> trouble. I suppose what I did is equivalent to Memoize though... --[[smcv]]
295
296 Refactoring to use pagespec_match_list looks more risky from a code churn
297 point of view; rebuild now takes 14.35s, but refresh is only 7.30/7.29/7.28,
298 another significant win.
299
300 --[[smcv]]
301
302 > I had mostly convinced myself that
303 > `pagespec_match_list` would not lead to a speed gain here. My reasoning
304 > was that you want to stop after finding one match, while `pagespec_match_list`
305 > checks all pages for matches. So what we're seeing is that
306 > on a rebuild, `@changed` is all pages, and not short-circuiting leads
307 > to unnecessary work. OTOH, on refresh, `@changed` is small and I suppose
308 > `pagespec_match_list`'s other slight efficiencies win out somehow.
309
310 > Welcome to the "I made ikiwiki twice as fast
311 > and all I got was this lousy git sha1sum" club BTW :-) --[[Joey]] 
312
313 [[!tag wishlist patch patch/core]]