File: instrument.rkt

package info (click to toggle)
racket-mode 20250711~git.8a80578-1
  • links: PTS, VCS
  • area: main
  • in suites: sid
  • size: 2,024 kB
  • sloc: lisp: 17,215; makefile: 106
file content (219 lines) | stat: -rw-r--r-- 7,912 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
;; Copyright (c) 2013-2025 by Greg Hendershott.
;; SPDX-License-Identifier: GPL-3.0-or-later

#lang at-exp racket/base

(require (only-in errortrace/errortrace-key
                  errortrace-key)
         (only-in errortrace/errortrace-lib
                  error-context-display-depth)
         errortrace/stacktrace
         racket/match
         racket/set
         racket/unit)

(provide make-instrumented-eval-handler
         error-context-display-depth
         get-error-trace
         instrumenting-enabled
         test-coverage-enabled
         clear-test-coverage-info!
         get-uncovered
         profiling-enabled
         clear-profile-info!
         get-profile)

;;; Core instrumenting

(define instrumenting-enabled (make-parameter #f))

(define (make-instrumented-eval-handler [orig-eval (current-eval)])
  ;; This is modeled after the one in DrRacket.
  (define (racket-mode-instrumented-eval-handler orig-exp)
    (cond
      [(or #;(not (instrumenting-enabled))
           (compiled-expression? (if (syntax? orig-exp)
                                     (syntax-e orig-exp)
                                     orig-exp)))
       (orig-eval orig-exp)]
      [else
       (let loop ([exp (if (syntax? orig-exp)
                           orig-exp
                           (namespace-syntax-introduce
                            (datum->syntax #f orig-exp)))])
         (let ([top-e (expand-syntax-to-top-form exp)])
           (syntax-case top-e (begin)
             [(begin expr ...)
              ;; Found a `begin', so expand/eval each contained
              ;; expression one at a time
              (let i-loop ([exprs (syntax->list #'(expr ...))]
                           [last-one (list (void))])
                (cond
                  [(null? exprs)
                   (apply values last-one)]
                  [else
                   (i-loop (cdr exprs)
                           (call-with-values
                            (λ ()
                              (call-with-continuation-prompt
                               (λ () (loop (car exprs)))
                               (default-continuation-prompt-tag)
                               (λ args
                                 (apply
                                  abort-current-continuation
                                  (default-continuation-prompt-tag)
                                  args))))
                            list))]))]
             [_else
              ;; Not `begin', so proceed with normal expand and eval
              (orig-eval (errortrace-annotate top-e #f))])))]))
  racket-mode-instrumented-eval-handler)

;;; Better stack traces ("basic errortrace")

(define (should-annotate? stx phase) ;stacktrace-filter^
  (and (syntax-source stx)
       (syntax-property stx 'errortrace:annotate)))

(define key-module-name 'errortrace/errortrace-key) ;^key-module-name

(define (with-mark mark expr phase) ;^stracktrace-imports
  ;; This is modeled after the one in errortrace-lib. Specifically,
  ;; use `make-st-mark' for its capture of the original syntax to show
  ;; in the stack trace error message.
  (match (make-st-mark mark phase)
    [#f expr]
    [mark
     (with-syntax ([expr expr]
                   [mark mark]
                   [etk errortrace-key]
                   [wcm (syntax-shift-phase-level #'with-continuation-mark phase)])
       (syntax (wcm etk mark expr)))]))

;; Functional alternative to print-error-trace.
(define (get-error-trace e)
  (for/list ([_ (error-context-display-depth)]
             [stx (in-list
                   (map st-mark-source
                        (continuation-mark-set->list (exn-continuation-marks e)
                                                     errortrace-key)))]
             #:when stx)
    (cons (syntax->datum stx)
          (srcloc (syntax-source stx)
                  (syntax-line stx)
                  (syntax-column stx)
                  (syntax-position stx)
                  (syntax-span stx)))))

;;; Test coverage

(define test-coverage-enabled (make-parameter #f)) ;stacktrace-imports^

(define test-coverage-info (make-hasheq)) ;(hash/c syntax? mpair?).
;; This approach taken from DrR. Presumably set-mcar! is faster than a
;; box, which in turn is faster than hash-set!. The cdr cell is
;; ignored.

(define (clear-test-coverage-info!)
  (hash-clear! test-coverage-info))

(define (initialize-test-coverage-point expr) ;stacktrace-imports^
  (hash-set! test-coverage-info expr (mcons #f #f)))

(define (test-covered expr) ;stacktrace-imports^
  (define v (hash-ref test-coverage-info expr #f))
  (and v (with-syntax ([v v])
           #'(#%plain-app set-mcar! v #t))))

(define (get-uncovered source)
  (for/set ([stx (in-list (get-uncovered-expressions source))])
    (define beg (syntax-position stx))
    (define end (+ beg (syntax-span stx)))
    (cons beg end)))

;; from sandbox-lib
(define (get-uncovered-expressions source)
  (let* ([xs (hash-map test-coverage-info
                       (lambda (k v) (cons k (mcar v))))]
         [xs (filter (lambda (x) (and (syntax-position (car x))
                                      (equal? (syntax-source (car x)) source)))
                     xs)]
         [xs (sort xs (lambda (x1 x2)
                        (let ([p1 (syntax-position (car x1))]
                              [p2 (syntax-position (car x2))])
                          (or (< p1 p2) ; earlier first
                              (and (= p1 p2)
                                   (> (syntax-span (car x1)) ; wider first
                                      (syntax-span (car x2))))))))]
         [xs (reverse xs)])
    (if (null? xs)
      xs
      (let loop ([xs (cdr xs)] [r (list (car xs))])
        (if (null? xs)
          (map car (filter (lambda (x) (not (cdr x))) r))
          (loop (cdr xs)
                (cond [(not (and (= (syntax-position (caar xs))
                                    (syntax-position (caar r)))
                                 (= (syntax-span (caar xs))
                                    (syntax-span (caar r)))))
                       (cons (car xs) r)]
                      [(cdar r) r]
                      [else (cons (car xs) (cdr r))])))))))

;;; Profiling

(define profile-key (gensym)) ;stacktrace-imports^

(define profiling-enabled (make-parameter #f)) ;stacktrace-imports^

(define profile-info (make-hasheq)) ;(hash/c any/c prof?)

(define (clear-profile-info!)
  (hash-clear! profile-info))

(struct prof
  (nest? ;guard nested calls
   num   ;exact-nonnegative-integer?
   time  ;exact-nonnegative-integer?
   name  ;(or/c #f symbol?)
   expr) ;syntax?
  #:mutable
  #:transparent)

(define (initialize-profile-point key name expr) ;stacktrace-imports^
  (hash-set! profile-info
             key
             (prof #f 0 0 (and (syntax? name) (syntax-e name)) expr)))

(define (register-profile-start key) ;stacktrace-imports^
  (define p (hash-ref profile-info key))
  (set-prof-num! p (add1 (prof-num p)))
  (cond [(prof-nest? p) #f]
        [else (set-prof-nest?! p #t)
              (current-process-milliseconds)]))

(define (register-profile-done key start) ;stacktrace-imports^
  (void
   (when start
     (define p (hash-ref profile-info key))
     (set-prof-nest?! p #f)
     (set-prof-time! p (+ (- (current-process-milliseconds) start)
                          (prof-time p))))))

(define (get-profile)
  (for/list ([x (in-list (hash-values profile-info))])
    (match-define (prof _nest? count msec name stx) x)
    (define src (syntax-source stx))
    (define beg (syntax-position stx))
    (define end (and beg (+ beg (syntax-span stx))))
    (list count
          msec
          (and name (symbol->string name))
          (and src (path? src) (path->string src))
          beg
          end)))


;;; Finally, invoke the unit

(define-values/invoke-unit/infer stacktrace/filter/errortrace-annotate@)