[gforth] / gforth / prof-inline.fs  

gforth: gforth/prof-inline.fs


1 : anton 1.1 \ get some data on potential (partial) inlining
2 :    
3 :     \ Copyright (C) 2004 Free Software Foundation, Inc.
4 :    
5 :     \ This file is part of Gforth.
6 :    
7 :     \ Gforth is free software; you can redistribute it and/or
8 :     \ modify it under the terms of the GNU General Public License
9 :     \ as published by the Free Software Foundation; either version 2
10 :     \ of the License, or (at your option) any later version.
11 :    
12 :     \ This program is distributed in the hope that it will be useful,
13 :     \ but WITHOUT ANY WARRANTY; without even the implied warranty of
14 :     \ MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 :     \ GNU General Public License for more details.
16 :    
17 :     \ You should have received a copy of the GNU General Public License
18 :     \ along with this program; if not, write to the Free Software
19 :     \ Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111, USA.
20 :    
21 :    
22 :     \ relies on some Gforth internals
23 :    
24 :     \ !! assumption: each file is included only once; otherwise you get
25 :     \ the counts for just one of the instances of the file. This can be
26 :     \ fixed by making sure that every source position occurs only once as
27 :     \ a profile point.
28 :    
29 :     true constant count-calls? \ do some profiling of colon definitions etc.
30 :    
31 :     \ for true COUNT-CALLS?:
32 :    
33 :     \ What data do I need for evaluating the effectiveness of (partial) inlining?
34 :    
35 :     \ static and dynamic counts of everything:
36 :    
37 :     \ original BB length (histogram and average)
38 :     \ BB length with partial inlining (histogram and average)
39 :     \ since we cannot partially inline library calls, we use a parameter
40 :     \ that represents the amount of partial inlining we can expect there.
41 :     \ number of tail calls (original and after partial inlining)
42 :     \ number of calls (original and after partial inlining)
43 :     \ reason for BB end: call, return, execute, branch
44 :    
45 :     \ how many static calls are there to a word? How many of the dynamic
46 :     \ calls call just a single word?
47 :    
48 : anton 1.2 \ how much does inlining called-once words help?
49 :     \ how much does inlining words without control flow help?
50 :     \ how much does partial inlining help?
51 :     \ what's the overlap?
52 :     \ optimizing return-to-returns (tail calls), return-to-calls, call-to-calls
53 :    
54 : anton 1.1 struct
55 : anton 1.3 cell% field list-next
56 : anton 1.2 end-struct list%
57 :    
58 :     list%
59 : anton 1.1 cell% 2* field profile-count
60 :     cell% 2* field profile-sourcepos
61 : anton 1.6 cell% field profile-char \ character position in line
62 :     cell% field profile-bblen \ number of primitives in BB
63 :     cell% field profile-colondef? \ is this a colon definition start
64 :     cell% field profile-calls \ static calls to the colon def (calls%)
65 :     cell% field profile-straight-line \ may contain calls, but no other CF
66 :     cell% field profile-calls-from \ static calls in the colon def
67 : anton 1.1 end-struct profile% \ profile point
68 :    
69 : anton 1.2 list%
70 : anton 1.3 cell% field calls-call \ ptr to profile point of bb containing the call
71 : anton 1.2 end-struct calls%
72 :    
73 : anton 1.1 variable profile-points \ linked list of profile%
74 :     0 profile-points !
75 :     variable next-profile-point-p \ the address where the next pp will be stored
76 :     profile-points next-profile-point-p !
77 : anton 1.3 variable last-colondef-profile \ pointer to the pp of last colon definition
78 :     variable current-profile-point
79 : anton 1.5 variable library-calls 0 library-calls ! \ list of calls to library colon defs
80 : anton 1.4 variable in-compile,? in-compile,? off
81 : anton 1.6 variable all-bbs 0 all-bbs ! \ list of all basic blocks
82 : anton 1.2
83 :     \ list stuff
84 :    
85 : anton 1.3 : map-list ( ... list xt -- ... )
86 :     { xt } begin { list }
87 :     list while
88 :     list xt execute
89 :     list list-next @
90 :     repeat ;
91 :    
92 :     : drop-1+ drop 1+ ;
93 :    
94 :     : list-length ( list -- u )
95 :     0 swap ['] drop-1+ map-list ;
96 :    
97 :     : insert-list ( listp listpp -- )
98 :     \ insert list node listp into list pointed to by listpp in front
99 :     tuck @ over list-next !
100 :     swap ! ;
101 :    
102 :     : insert-list-end ( listp listppp -- )
103 :     \ insert list node listp into list, with listppp indicating the
104 :     \ position to insert at, and indicating the position behind the
105 :     \ new element afterwards.
106 :     2dup @ insert-list
107 :     swap list-next swap ! ;
108 : anton 1.2
109 : anton 1.3 \ calls
110 :    
111 :     : new-call ( profile-point -- call )
112 :     calls% %alloc tuck calls-call ! ;
113 : anton 1.2
114 :     \ profile-point stuff
115 :    
116 : anton 1.1 : new-profile-point ( -- addr )
117 :     profile% %alloc >r
118 :     0. r@ profile-count 2!
119 :     current-sourcepos r@ profile-sourcepos 2!
120 :     >in @ r@ profile-char !
121 : anton 1.6 r@ profile-colondef? off
122 :     0 r@ profile-bblen !
123 :     0 r@ profile-calls !
124 :     r@ profile-straight-line on
125 :     0 r@ profile-calls-from !
126 : anton 1.3 r@ next-profile-point-p insert-list-end
127 :     r@ current-profile-point !
128 : anton 1.6 r@ new-call all-bbs insert-list
129 : anton 1.1 r> ;
130 :    
131 :     : print-profile ( -- )
132 :     profile-points @ begin
133 :     dup while
134 :     dup >r
135 :     r@ profile-sourcepos 2@ .sourcepos ." :"
136 :     r@ profile-char @ 0 .r ." : "
137 :     r@ profile-count 2@ 0 d.r cr
138 : anton 1.2 r> list-next @
139 : anton 1.1 repeat
140 :     drop ;
141 :    
142 :     : print-profile-coldef ( -- )
143 :     profile-points @ begin
144 :     dup while
145 :     dup >r
146 :     r@ profile-colondef? @ if
147 :     r@ profile-sourcepos 2@ .sourcepos ." :"
148 :     r@ profile-char @ 3 .r ." : "
149 :     r@ profile-count 2@ 10 d.r
150 :     r@ profile-straight-line @ space 2 .r
151 : anton 1.3 r@ profile-calls @ list-length 4 .r
152 : anton 1.1 cr
153 :     endif
154 : anton 1.2 r> list-next @
155 : anton 1.1 repeat
156 :     drop ;
157 :    
158 : anton 1.3 : 1= ( u -- f )
159 :     1 = ;
160 :    
161 :     : 2= ( u -- f )
162 :     2 = ;
163 :    
164 :     : 3= ( u -- f )
165 :     3 = ;
166 :    
167 :     : 1u> ( u -- f )
168 :     1 u> ;
169 :    
170 :     : call-count+ ( ud1 callp -- ud2 )
171 :     calls-call @ profile-count 2@ d+ ;
172 :    
173 : anton 1.5 : count-dyncalls ( calls -- ud )
174 :     0. rot ['] call-count+ map-list ;
175 :    
176 :     : add-calls ( statistics1 xt-test profpp -- statistics2 xt-test )
177 :     \ add statistics for callee profpp up, if the number of static
178 :     \ calls to profpp satisfies xt-test ( u -- f ); see below for what
179 :     \ statistics are computed.
180 : anton 1.3 { xt-test p }
181 : anton 1.5 p profile-colondef? @ if
182 : anton 1.3 p profile-calls @ { calls }
183 :     calls list-length { stat }
184 : anton 1.5 stat xt-test execute if
185 :     { d: ud-dyn-callee d: ud-dyn-caller u-stat u-exec-callees u-callees }
186 :     ud-dyn-callee p profile-count 2@ 2dup { d: de } d+
187 :     ud-dyn-caller calls count-dyncalls 2dup { d: dr } d+
188 :     u-stat stat +
189 :     u-exec-callees de dr d<> -
190 :     u-callees 1+
191 : anton 1.3 endif
192 :     endif
193 :     xt-test ;
194 :    
195 :     : print-stat-line ( xt -- )
196 : anton 1.5 >r 0. 0. 0 0 0 r> profile-points @ ['] add-calls map-list drop
197 : anton 1.3 ( ud-dyn-callee ud-dyn-caller u-stat )
198 : anton 1.5 6 u.r 7 u.r 7 u.r 12 ud.r 12 ud.r space ;
199 :    
200 :     : print-library-stats ( -- )
201 :     library-calls @ list-length 20 u.r \ static callers
202 :     library-calls @ count-dyncalls 12 ud.r \ dynamic callers
203 :     13 spaces ;
204 : anton 1.3
205 : anton 1.6 : bblen+ ( u1 callp -- u2 )
206 :     calls-call @ profile-bblen @ + ;
207 :    
208 :     : dyn-bblen+ ( ud1 callp -- ud2 )
209 :     calls-call @ dup profile-count 2@ rot profile-bblen @ 1 m*/ d+ ;
210 :    
211 :     : print-bb-statistics ( -- )
212 :     ." static dynamic" cr
213 :     all-bbs @ list-length 6 u.r all-bbs @ count-dyncalls 12 ud.r ." basic blocks" cr
214 :     0 all-bbs @ ['] bblen+ map-list 6 u.r
215 :     0. all-bbs @ ['] dyn-bblen+ map-list 12 ud.r ." primitives" cr
216 :     ;
217 :    
218 : anton 1.3 : print-statistics ( -- )
219 : anton 1.5 ." callee exec'd static dyn-caller dyn-callee condition" cr
220 : anton 1.3 ['] 0= print-stat-line ." calls to coldefs with 0 callers" cr
221 :     ['] 1= print-stat-line ." calls to coldefs with 1 callers" cr
222 :     ['] 2= print-stat-line ." calls to coldefs with 2 callers" cr
223 :     ['] 3= print-stat-line ." calls to coldefs with 3 callers" cr
224 :     ['] 1u> print-stat-line ." calls to coldefs with >1 callers" cr
225 : anton 1.5 print-library-stats ." library calls" cr
226 : anton 1.6 print-bb-statistics
227 : anton 1.3 ;
228 :    
229 : anton 1.1 : dinc ( profilep -- )
230 :     \ increment double pointed to by d-addr
231 :     profile-count dup 2@ 1. d+ rot 2! ;
232 :    
233 :     : profile-this ( -- )
234 : anton 1.4 in-compile,? @ in-compile,? on
235 :     new-profile-point POSTPONE literal POSTPONE dinc
236 :     in-compile,? ! ;
237 : anton 1.1
238 :     \ Various words trigger PROFILE-THIS. In order to avoid getting
239 :     \ several calls to PROFILE-THIS from a compiling word (like ?EXIT), we
240 :     \ just wait until the next word is parsed by the text interpreter (in
241 :     \ compile state) and call PROFILE-THIS only once then. The whole
242 :     \ BEFORE-WORD hooking etc. is there for this.
243 :    
244 :     \ The reason that we do this is because we use the source position for
245 :     \ the profiling information, and there's only one source position for
246 :     \ ?EXIT. If we used the threaded code position instead, we would see
247 :     \ that ?EXIT compiles to several threaded-code words, and could use
248 :     \ different profile points for them. However, usually dealing with
249 :     \ the source is more practical.
250 :    
251 :     \ Another benefit is that we can ask for profiling anywhere in a
252 :     \ control-flow word (even before it compiles its own stuff).
253 :    
254 :     \ Potential problem: Consider "COMPILING ] [" where COMPILING compiles
255 :     \ a whole colon definition (and triggers our profiler), but during the
256 :     \ compilation of the colon definition there is no parsing. Afterwards
257 :     \ you get interpret state at first (no profiling, either), but after
258 :     \ the "]" you get parsing in compile state, and PROFILE-THIS gets
259 :     \ called (and compiles code that is never executed). It would be
260 :     \ better if we had a way of knowing whether we are in a colon def or
261 :     \ not (and used that knowledge instead of STATE).
262 :    
263 : anton 1.6 Defer before-word-profile ( -- )
264 :     ' noop IS before-word-profile
265 : anton 1.1
266 : anton 1.6 : before-word1 ( -- )
267 :     before-word-profile defers before-word ;
268 : anton 1.1
269 : anton 1.6 ' before-word1 IS before-word
270 : anton 1.1
271 : anton 1.6 : profile-this-compiling ( -- )
272 :     state @ if
273 :     profile-this
274 :     ['] noop IS before-word-profile
275 :     endif ;
276 :    
277 :     : cock-profiler ( -- )
278 :     \ as in cock the gun - pull the trigger
279 :     ['] profile-this-compiling IS before-word-profile
280 :     [ count-calls? ] [if] \ we are at a non-colondef profile point
281 :     last-colondef-profile @ profile-straight-line off
282 :     [endif]
283 :     ;
284 : anton 1.1
285 :     : hook-profiling-into ( "name" -- )
286 :     \ make (deferred word) "name" call cock-profiler, too
287 :     ' >body >r :noname
288 : anton 1.6 POSTPONE cock-profiler
289 : anton 1.1 r@ @ compile, \ old hook behaviour
290 :     POSTPONE ;
291 :     r> ! ; \ change hook behaviour
292 :    
293 :     : note-execute ( -- )
294 :     \ end of BB due to execute
295 :     ;
296 :    
297 :     : note-call ( addr -- )
298 :     \ addr is the body address of a called colon def or does handler
299 : anton 1.5 dup ['] (does>2) >body = if \ adjust does handler address
300 :     4 cells here 1 cells - +!
301 : anton 1.1 endif
302 : anton 1.5 profile-this current-profile-point @ new-call
303 :     over 3 cells + @ ['] dinc >body = if ( addr call-prof-point )
304 :     \ non-library call
305 :     swap cell+ @ profile-calls insert-list
306 :     else ( addr call-prof-point )
307 :     library-calls insert-list drop
308 :     endif ;
309 : anton 1.4
310 : anton 1.1 : prof-compile, ( xt -- )
311 : anton 1.4 in-compile,? @ if
312 :     DEFERS compile, EXIT
313 :     endif
314 : anton 1.6 1 current-profile-point @ profile-bblen +!
315 : anton 1.1 dup >does-code if
316 :     dup >does-code note-call
317 :     then
318 :     dup >code-address CASE
319 :     docol: OF dup >body note-call ENDOF
320 :     dodefer: OF note-execute ENDOF
321 :     \ dofield: OF >body @ POSTPONE literal ['] + peephole-compile, EXIT ENDOF
322 :     \ code words and ;code-defined words (code words could be optimized):
323 :     ENDCASE
324 :     DEFERS compile, ;
325 :    
326 : anton 1.4 : :-hook-profile ( -- )
327 :     defers :-hook
328 :     next-profile-point-p @
329 :     profile-this
330 :     @ dup last-colondef-profile !
331 :     profile-colondef? on ;
332 :    
333 : anton 1.6 hook-profiling-into then-like
334 :     \ hook-profiling-into if-like \ subsumed by other-control-flow
335 :     \ hook-profiling-into ahead-like \ subsumed by other-control-flow
336 :     hook-profiling-into other-control-flow
337 :     hook-profiling-into begin-like
338 :     hook-profiling-into again-like
339 :     hook-profiling-into until-like
340 : anton 1.1 ' :-hook-profile IS :-hook
341 : anton 1.4 ' prof-compile, IS compile,

CVS Admin

Powered by ViewCVS 1.0-dev
(Powered by ViewCVS)

ViewCVS and CVS Help