3 ;;; Method combination implementation
5 ;;; (c) 2009 Straylight/Edgeware
8 ;;;----- Licensing notice ---------------------------------------------------
10 ;;; This file is part of the Sensble Object Design, an object system for C.
12 ;;; SOD is free software; you can redistribute it and/or modify
13 ;;; it under the terms of the GNU General Public License as published by
14 ;;; the Free Software Foundation; either version 2 of the License, or
15 ;;; (at your option) any later version.
17 ;;; SOD is distributed in the hope that it will be useful,
18 ;;; but WITHOUT ANY WARRANTY; without even the implied warranty of
19 ;;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
20 ;;; GNU General Public License for more details.
22 ;;; You should have received a copy of the GNU General Public License
23 ;;; along with SOD; if not, write to the Free Software Foundation,
24 ;;; Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
28 ;;;--------------------------------------------------------------------------
31 (export 'basic-message)
32 (defclass basic-message (sod-message)
33 ((argument-tail :type list :reader sod-message-argument-tail)
34 (no-varargs-tail :type list :reader sod-message-no-varargs-tail))
36 "Base class for built-in message classes.
38 Provides the basic functionality for the built-in method combinations.
39 This is a separate class so that `special effect' messages can avoid
40 inheriting its default behaviour.
42 The function type protocol is implemented on `basic-message' using slot
43 reader methods. The actual values are computed on demand."))
45 (define-on-demand-slot basic-message argument-tail (message)
48 (if (or (eq arg :ellipsis) (argument-name arg)) arg
49 (make-argument (make-instance 'temporary-argument
52 (argument-type arg))))
53 (c-function-arguments (sod-message-type message)))))
55 (define-on-demand-slot basic-message no-varargs-tail (message)
57 (if (eq arg :ellipsis)
58 (make-argument *sod-ap* (c-type va-list))
60 (sod-message-argument-tail message)))
62 (defmethod sod-message-method-class
63 ((message basic-message) (class sod-class) pset)
64 (let ((role (get-property pset :role :keyword nil)))
66 ((:before :after) 'daemon-direct-method)
67 (:around 'delegating-direct-method)
68 ((nil) (error "How odd: a primary method slipped through the net"))
69 (t (error "Unknown method role ~A" role)))))
71 (export 'simple-message)
72 (defclass simple-message (basic-message)
75 "Base class for messages with `simple' method combinations.
77 A simple method combination is one which has only one method role other
78 than the `before', `after' and `around' methods provided by
79 `basic-message'. We call these `primary' methods, and the programmer
80 designates them by not specifying an explicit role.
82 If the programmer doesn't define any primary methods then the effective
83 method is null -- i.e., the method entry pointer shows up as a null
86 (defmethod sod-message-method-class
87 ((message simple-message) (class sod-class) pset)
88 (if (get-property pset :role :keyword nil)
90 (primary-method-class message)))
92 (defmethod primary-method-class ((message simple-message))
95 ;;;--------------------------------------------------------------------------
96 ;;; Direct method classes.
98 (export 'basic-direct-method)
99 (defclass basic-direct-method (sod-method)
100 ((role :initarg :role :type symbol :reader sod-method-role)
101 (function-type :type c-function-type :reader sod-method-function-type))
103 "Base class for built-in direct method classes.
105 Provides the basic functionality for the built-in direct-method classes.
106 This is a separate class so that `special effect' methods can avoid
107 inheriting its default behaviour and slots.
109 A basic method can be assigned a `role', which may be set either as an
110 initarg or using the `:role' property. Roles are used for method
113 The function type protocol is implemented on `basic-direct-method' using
114 slot reader methods."))
116 (defmethod shared-initialize :after
117 ((method basic-direct-method) slot-names &key pset)
118 (declare (ignore slot-names))
119 (default-slot (method 'role) (get-property pset :role :keyword nil)))
121 (define-on-demand-slot basic-direct-method function-type (method)
122 (let ((type (sod-method-type method)))
123 (c-type (fun (lisp (c-type-subtype type))
124 ("me" (* (class (sod-method-class method))))
125 . (c-function-arguments type)))))
127 (defmethod sod-method-function-name ((method basic-direct-method))
128 (with-slots ((class %class) role message) method
129 (format nil "~A__~@[~(~A~)_~]method_~A__~A" class role
130 (sod-class-nickname (sod-message-class message))
131 (sod-message-name message))))
133 (export 'daemon-direct-method)
134 (defclass daemon-direct-method (basic-direct-method)
137 "A daemon direct method is invoked for side effects and cannot override.
139 This is the direct method class for `before' and `after' methods, which
140 cannot choose to override the remaining methods and are not involved in
141 the computation of the final result.
143 In C terms, a daemon method must return `void', and is not passed a
144 `next_method' pointer."))
146 (defmethod check-method-type ((method daemon-direct-method)
147 (message sod-message)
148 (type c-function-type))
149 (with-slots ((msgtype %type)) message
150 (unless (c-type-equal-p (c-type-subtype type) (c-type void))
151 (error "Method return type ~A must be `void'" (c-type-subtype type)))
152 (unless (argument-lists-compatible-p (c-function-arguments msgtype)
153 (c-function-arguments type))
154 (error "Method arguments ~A don't match message ~A" type msgtype))))
156 (export 'delegating-direct-method)
157 (defclass delegating-direct-method (basic-direct-method)
158 ((next-method-type :type c-function-type
159 :reader sod-method-next-method-type))
161 "A delegating direct method can choose to override other methods.
163 This is the direct method class for `around' and standard-method-
164 combination primary methods, which are given the choice of computing the
165 entire method's result or delegating to (usually) less-specific methods.
167 In C terms, a delegating method is passed a `next_method' pointer so that
168 it can delegate part of its behaviour. (A delegating direct method for a
169 varargs message is also given an additional `va_list' argument,
170 conventionally named `sod__ap_master', which it is expected to pass on to
171 its `next_method' function if necessary.)
173 The function type protocol is implemented on `delegating-direct-method'
174 using slot reader methods.."))
176 (define-on-demand-slot delegating-direct-method next-method-type (method)
177 (let* ((message (sod-method-message method))
178 (return-type (c-type-subtype (sod-message-type message)))
179 (msgargs (sod-message-argument-tail message))
180 (arguments (if (varargs-message-p message)
181 (cons (make-argument *sod-master-ap*
185 (c-type (fun (lisp return-type)
186 ("me" (* (class (sod-method-class method))))
189 (define-on-demand-slot delegating-direct-method function-type (method)
190 (let* ((message (sod-method-message method))
191 (type (sod-method-type method))
192 (method-args (c-function-arguments type)))
193 (c-type (fun (lisp (c-type-subtype type))
194 ("me" (* (class (sod-method-class method))))
195 ("next_method" (* (lisp (commentify-function-type
196 (sod-method-next-method-type
199 (if (varargs-message-p message)
200 (cons (make-argument *sod-master-ap*
205 ;;;--------------------------------------------------------------------------
206 ;;; Effective method classes.
208 (export 'basic-effective-method)
209 (defclass basic-effective-method (effective-method)
210 ((around-methods :initarg :around-methods :initform nil
211 :type list :reader effective-method-around-methods)
212 (before-methods :initarg :before-methods :initform nil
213 :type list :reader effective-method-before-methods)
214 (after-methods :initarg :after-methods :initform nil
215 :type list :reader effective-method-after-methods)
216 (basic-argument-names :type list
217 :reader effective-method-basic-argument-names)
218 (functions :type list :reader effective-method-functions))
220 "Base class for built-in effective method classes.
222 This class maintains lists of the applicable `before', `after' and
223 `around' methods and provides behaviour for invoking these methods
226 The argument names protocol is implemented on `basic-effective-method'
227 using a slot reader method."))
229 (define-on-demand-slot basic-effective-method basic-argument-names (method)
230 (let ((message (effective-method-message method)))
231 (mapcar #'argument-name
232 (sod-message-no-varargs-tail message))))
234 (defmethod effective-method-function-name ((method effective-method))
235 (let* ((class (effective-method-class method))
236 (message (effective-method-message method))
237 (message-class (sod-message-class message)))
238 (format nil "~A__emethod_~A__~A"
240 (sod-class-nickname message-class)
241 (sod-message-name message))))
243 (define-on-demand-slot basic-effective-method functions (method)
244 (compute-method-entry-functions method))
246 (export 'simple-effective-method)
247 (defclass simple-effective-method (basic-effective-method)
248 ((primary-methods :initarg :primary-methods :initform nil
249 :type list :reader effective-method-primary-methods))
251 "Effective method counterpart to `simple-message'."))
253 (defmethod shared-initialize :after
254 ((method simple-effective-method) slot-names &key direct-methods)
255 (declare (ignore slot-names))
256 (categorize (method direct-methods :bind ((role (sod-method-role method))))
257 ((primary (null role))
258 (before (eq role :before))
259 (after (eq role :after))
260 (around (eq role :around)))
261 (with-slots (primary-methods before-methods after-methods around-methods)
263 (setf primary-methods primary
264 before-methods before
265 after-methods (reverse after)
266 around-methods around))))
268 ;;;--------------------------------------------------------------------------
271 (defmethod shared-initialize :after
272 ((codegen method-codegen) slot-names &key)
273 (declare (ignore slot-names))
274 (with-slots (message target) codegen
276 (if (eq (c-type-subtype (sod-message-type message)) (c-type void))
280 ;;;--------------------------------------------------------------------------
281 ;;; Invoking direct methods.
283 (export 'basic-effective-method-body)
284 (defun basic-effective-method-body (codegen target method body)
285 "Build the common method-invocation structure.
287 Writes to CODEGEN some basic method-invocation instructions. It invokes
288 the `around' methods, from most- to least-specific. If they all delegate,
289 then the `before' methods are run, most-specific first; next, the
290 instructions generated by BODY (invoked with a target argument); then, the
291 `after' methods are run, least-specific first; and, finally, the value
292 delivered by the BODY is returned to the `around' methods. The result
293 returned by the outermost `around' method -- or, if there are none,
294 delivered by the BODY -- is finally delivered to the TARGET."
296 (with-slots (message (class %class)
297 before-methods after-methods around-methods)
299 (let* ((message-type (sod-message-type message))
300 (return-type (c-type-subtype message-type))
301 (basic-tail (effective-method-basic-argument-names method)))
302 (flet ((method-kernel (target)
303 (dolist (before before-methods)
304 (invoke-method codegen :void basic-tail before))
305 (if (null after-methods)
306 (funcall body target)
307 (convert-stmts codegen target return-type
309 (funcall body target)
310 (dolist (after (reverse after-methods))
311 (invoke-method codegen :void
312 basic-tail after)))))))
313 (invoke-delegation-chain codegen target basic-tail
314 around-methods #'method-kernel)))))
316 ;;;--------------------------------------------------------------------------
317 ;;; Method entry points.
319 (defparameter *method-entry-inline-threshold* 200
320 "Threshold below which effective method bodies are inlined into entries.
322 After the effective method body has been computed, we calculate its
323 metric, multiply by the number of entries we need to generate, and compare
324 it with this threshold. If the metric is below the threshold then we
325 fold the method body into the entry functions; otherwise we split the
326 effective method out into its own function.")
328 (defmethod method-entry-function-name
329 ((method effective-method) (chain-head sod-class) role)
330 (let* ((class (effective-method-class method))
331 (message (effective-method-message method))
332 (message-class (sod-message-class message)))
333 (if (or (not (slot-boundp method 'functions))
334 (slot-value method 'functions))
335 (format nil "~A__mentry~@[__~(~A~)~]_~A__~A__chain_~A"
337 (sod-class-nickname message-class)
338 (sod-message-name message)
339 (sod-class-nickname chain-head))
342 (defmethod method-entry-slot-name ((entry method-entry))
343 (let* ((method (method-entry-effective-method entry))
344 (message (effective-method-message method))
345 (name (sod-message-name message))
346 (role (method-entry-role entry)))
347 (method-entry-slot-name-by-role entry role name)))
349 (defmethod method-entry-function-type ((entry method-entry))
350 (let* ((method (method-entry-effective-method entry))
351 (message (effective-method-message method))
352 (type (sod-message-type message))
353 (tail (ecase (method-entry-role entry)
354 ((nil) (sod-message-argument-tail message))
355 (:valist (sod-message-no-varargs-tail message)))))
356 (c-type (fun (lisp (c-type-subtype type))
357 ("me" (* (class (method-entry-chain-tail entry))))
360 (defmethod make-method-entries ((method basic-effective-method)
361 (chain-head sod-class)
362 (chain-tail sod-class))
364 (message (effective-method-message method)))
366 (push (make-instance 'method-entry
367 :method method :role role
368 :chain-head chain-head
369 :chain-tail chain-tail)
371 (when (varargs-message-p message) (make :valist))
375 (defmethod compute-method-entry-functions ((method basic-effective-method))
377 ;; OK, there's quite a lot of this, so hold tight.
379 ;; The first thing we need to do is find all of the related objects. This
380 ;; is a bit verbose but fairly straightforward.
382 ;; Next, we generate the effective method body -- using `compute-effective-
383 ;; method-body' of all things. This gives us the declarations and body for
384 ;; an effective method function, but we don't have an actual function yet.
386 ;; Now we look at the chains which are actually going to need a method
387 ;; entry: only those chains whose tail (most specific) class is a
388 ;; superclass of the class which defined the message need an entry. We
389 ;; build a list of these tail classes.
391 ;; Having done this, we decide whether it's better to generate a standalone
392 ;; effective-method function and call it from each of the method entries,
393 ;; or to inline the effective method body into each of the entries.
395 ;; Most of the complexity here comes from (a) dealing with the two
396 ;; different strategies for constructing method entry functions and (b)
397 ;; (unsurprisingly) the mess involved with dealing with varargs messages.
399 (let* ((message (effective-method-message method))
400 (class (effective-method-class method))
401 (message-class (sod-message-class message))
402 (return-type (c-type-subtype (sod-message-type message)))
403 (codegen (make-instance 'method-codegen
408 ;; Method entry details.
409 (chain-tails (remove-if-not (lambda (super)
410 (sod-subclass-p super message-class))
412 (sod-class-chains class))))
413 (n-entries (length chain-tails))
414 (raw-entry-args (sod-message-argument-tail message))
415 (entry-args (sod-message-no-varargs-tail message))
416 (parm-n (let ((tail (last raw-entry-args 2)))
417 (and tail (eq (cadr tail) :ellipsis) (car tail))))
418 (entry-target (codegen-target codegen))
420 ;; Effective method function details.
421 (emf-name (effective-method-function-name method))
422 (ilayout-type (c-type (* (struct (ilayout-struct-tag class)))))
423 (emf-arg-tail (sod-message-no-varargs-tail message))
424 (emf-type (c-type (fun (lisp return-type)
425 ("sod__obj" (lisp ilayout-type))
428 (flet ((setup-entry (tail)
429 (let ((head (sod-class-chain-head tail)))
430 (codegen-push codegen)
431 (ensure-var codegen "sod__obj" ilayout-type
432 (make-convert-to-ilayout-inst class
435 (let* ((head (sod-class-chain-head tail))
436 (role (if parm-n :valist nil))
437 (name (method-entry-function-name method head role))
438 (type (c-type (fun (lisp return-type)
439 ("me" (* (class tail)))
441 (codegen-pop-function codegen name type)
443 ;; If this is a varargs method then we've made the
444 ;; `:valist' role. Also make the `nil' role.
446 (let ((call (make-call-inst name
448 (mapcar #'argument-name
450 (main (method-entry-function-name method head nil))
451 (main-type (c-type (fun (lisp return-type)
452 ("me" (* (class tail)))
454 (codegen-push codegen)
455 (ensure-var codegen *sod-ap* (c-type va-list))
457 (make-va-start-inst *sod-ap*
458 (argument-name parm-n)))
459 (convert-stmts codegen entry-target return-type
461 (deliver-expr codegen target call)))
462 (emit-inst codegen (make-va-end-inst *sod-ap*))
463 (codegen-pop-function codegen main main-type))))))
465 ;; Generate the method body. We'll work out what to do with it later.
466 (codegen-push codegen)
467 (let* ((result (if (eq return-type c-type-void) nil
468 (temporary-var codegen return-type)))
469 (emf-target (or result :void)))
470 (compute-effective-method-body method codegen emf-target)
471 (multiple-value-bind (vars insts) (codegen-pop codegen)
472 (cond ((or (= n-entries 1)
473 (<= (* n-entries (reduce #'+ insts :key #'inst-metric))
474 *method-entry-inline-threshold*))
476 ;; The effective method body is simple -- or there's only
477 ;; one of them. We'll inline the method body into the entry
479 (dolist (tail chain-tails)
482 (if (typep var 'var-inst)
483 (ensure-var codegen (inst-name var)
484 (inst-type var) (inst-init var))
485 (emit-decl codegen var)))
486 (emit-insts codegen insts)
487 (deliver-expr codegen entry-target result)
488 (finish-entry tail)))
492 ;; The effective method body is complicated and we'd need
493 ;; more than one copy. We'll generate an effective method
494 ;; function and call it a lot.
495 (codegen-build-function codegen emf-name emf-type vars
496 (nconc insts (and result
497 (list (make-return-inst result)))))
499 (let ((call (make-call-inst emf-name
500 (cons "sod__obj" (mapcar #'argument-name
502 (dolist (tail chain-tails)
504 (deliver-expr codegen entry-target call)
505 (finish-entry tail)))))))
507 (codegen-functions codegen))))
509 (defmethod compute-method-entry-functions
510 ((method simple-effective-method))
511 (if (effective-method-primary-methods method)
515 (defmethod compute-effective-method-body
516 ((method simple-effective-method) codegen target)
517 (basic-effective-method-body codegen target method
519 (simple-method-body method
523 ;;;--------------------------------------------------------------------------
524 ;;; Standard method combination.
526 (export 'standard-message)
527 (defclass standard-message (simple-message)
530 "Message class for standard method combinations.
532 Standard method combination is a simple method combination where the
533 primary methods are invoked as a delegation chain, from most- to
536 (export 'standard-effective-method)
537 (defclass standard-effective-method (simple-effective-method) ()
538 (:documentation "Effective method counterpart to `standard-message'."))
540 (defmethod primary-method-class ((message standard-message))
541 'delegating-direct-method)
543 (defmethod message-effective-method-class ((message standard-message))
544 'standard-effective-method)
546 (defmethod simple-method-body
547 ((method standard-effective-method) codegen target)
548 (invoke-delegation-chain codegen
550 (effective-method-basic-argument-names method)
551 (effective-method-primary-methods method)
554 ;;;----- That's all, folks --------------------------------------------------