mirror of
https://github.com/open-goal/jak-project
synced 2026-07-30 07:55:01 -04:00
Tyler Wilding
d1ece445d4
Relates to #1353 This adds no new functionality or overhead to the compiler, yet. This is the preliminary work that has: - added code to the compiler in several spots to flag when something is used without being properly required/imported/whatever (disabled by default) - that was used to generate project wide file dependencies (some circulars were manually fixed) - then that graph underwent a transitive reduction and the result was written to all `jak1` source files. The next step will be making this actually produce and use a dependency graph. Some of the reasons why I'm working on this: - eliminates more `game.gp` boilerplate. This includes the `.gd` files to some extent (`*-ag` files and `tpage` files will still need to be handled) this is the point of the new `bundles` form. This should make it even easier to add a new file into the source tree. - a build order that is actually informed from something real and compiler warnings that tell you when you are using something that won't be available at build time. - narrows the search space for doing LSP actions -- like searching for references. Since it would be way too much work to store in the compiler every location where every symbol/function/etc is used, I have to do ad-hoc searches. By having a dependency graph i can significantly reduce that search space. - opens the doors for common shared code with a legitimate pattern. Right now jak 2 shares code from the jak 1 folder. This is basically a hack -- but by having an explicit require syntax, it would be possible to reference arbitrary file paths, such as a `common` folder. Some stats: - Jak 1 has about 2500 edges between files, including transitives - With transitives reduced at the source code level, each file seems to have a modest amount of explicit requirements. Known issues: - Tracking the location for where `defmacro`s and virtual state definitions were defined (and therefore the file) is still problematic. Because those forms are in a macro environment, the reader does not track them. I'm wondering if a workaround could be to search the reader's text_db by not just the `goos::Object` but by the text position. But for the purposes of finishing this work, I just statically analyzed and searched the code with throwaway python code.
164 lines
5.1 KiB
Common Lisp
164 lines
5.1 KiB
Common Lisp
;;-*-Lisp-*-
|
|
(in-package goal)
|
|
(bundles "ENGINE.CGO" "GAME.CGO")
|
|
|
|
(require "kernel-defs.gc")
|
|
|
|
;; name: timer-h.gc
|
|
;; name in dgo: timer-h
|
|
;; dgos: GAME, ENGINE
|
|
|
|
|
|
;; There are two sources for timing:
|
|
;; - EE TIMER1, used for the frame profiler. There are 9765 counts of this per frame. It gets reset in drawable.
|
|
;; - The "stopwatch" system, used for reading the CPU clock cycle counter, at 300 MHz (32-bit)
|
|
|
|
;; The Emotion Engine has 4 hardware timers, timer1 is used as the
|
|
(defconstant TIMER0_BANK #x10000000) ;; has HOLD register!
|
|
(defconstant TIMER1_BANK #x10000800) ;; has HOLD register!
|
|
(defconstant TIMER2_BANK #x10001000) ;; does NOT have HOLD register!
|
|
(defconstant TIMER3_BANK #x10001800) ;; does NOT have HOLD register!
|
|
|
|
|
|
;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
|
|
;; PC Port Timer
|
|
;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
|
|
(defmacro get-cpu-clock ()
|
|
"Read the 300 MHz clock."
|
|
;; __read-ee-timer is a 300 MHz timer from the C Kernel.
|
|
;; it's a real timer.
|
|
`(the uint (logand #xffffffff (__read-ee-timer)))
|
|
)
|
|
|
|
(defmacro get-bus-clock/256 ()
|
|
"Read the 150 MHz / 256 clock."
|
|
;; 300 MHz / (2^9)
|
|
`(the uint (logand #xffffffff (shr (__read-ee-timer) 9)))
|
|
)
|
|
|
|
(#when PC_PORT
|
|
;; the bus clock can be reset, which just stores the current count here.
|
|
(define *timer-reset-value* (the uint 0))
|
|
)
|
|
|
|
;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
|
|
;; Timer HW
|
|
;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
|
|
(defenum timer-clock-selection
|
|
:type uint8
|
|
(busclk 0)
|
|
(busclk/16 1)
|
|
(busclk/256 2)
|
|
(hblank 3)
|
|
)
|
|
|
|
;; DECOMP BEGINS
|
|
|
|
;; this matches the Tn_MODE register structure of the ps2 EE timers.
|
|
;; Only the lower 32 bits of these registers are usable, and the upper 16 hardwired to zero
|
|
(deftype timer-mode (uint32)
|
|
((clks timer-clock-selection :offset 0 :size 2)
|
|
(gate uint8 :offset 2 :size 1)
|
|
(gats uint8 :offset 3 :size 1)
|
|
(gatm uint8 :offset 4 :size 2)
|
|
(zret uint8 :offset 6 :size 1)
|
|
(cue uint8 :offset 7 :size 1)
|
|
(cmpe uint8 :offset 8 :size 1)
|
|
(ovfe uint8 :offset 9 :size 1)
|
|
(equf uint8 :offset 10 :size 1)
|
|
(ovff uint8 :offset 11 :size 1)
|
|
)
|
|
)
|
|
|
|
;; this matches an EE timer (without a HOLD register, timers 2 and 3)
|
|
;; Each register is 128-bits wide, but only the lower 32-bits are usable, and the upper
|
|
;; 16-bits of that are hardwired to zero.
|
|
(deftype timer-bank (structure)
|
|
((count uint32 :offset 0)
|
|
(mode timer-mode :offset 16)
|
|
(comp uint32 :offset 32)
|
|
)
|
|
)
|
|
|
|
;; this matches an EE timer (with a HOLD register, timers 0 and 1)
|
|
(deftype timer-hold-bank (timer-bank)
|
|
((hold uint32 :offset 48)
|
|
)
|
|
)
|
|
|
|
;; stopwatches are used to measure CPU clock cycles
|
|
;; they don't use the timer above, but instead the Count COP0 register
|
|
;; which counts CPU clock cycles directly
|
|
(deftype stopwatch (basic)
|
|
((prev-time-elapsed time-frame)
|
|
(start-time time-frame)
|
|
(begin-level int32)
|
|
)
|
|
)
|
|
|
|
;; Confusing! What IS this measuring exactly? Hmm...
|
|
;; this is set by default for NTSC, it will later be changed if PAL.
|
|
(define *ticks-per-frame* (/ 2500000 256)) ;; 2 500 000 / 256 = 9765
|
|
|
|
(defun timer-init ((timer timer-bank) (mode timer-mode))
|
|
"Initiate a timer, start counting at a rate of 1 every 256 bus clocks (BUSCLK: ~147.456MHz)."
|
|
(set! (-> timer mode) mode)
|
|
(set! (-> timer count) 0)
|
|
)
|
|
|
|
;; needs PS2 TIMER porting
|
|
(#unless PC_PORT
|
|
(timer-init (the-as timer-bank TIMER1_BANK) (new 'static 'timer-mode :clks (timer-clock-selection busclk/16) :cue 1))
|
|
)
|
|
|
|
;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
|
|
;; Profiler
|
|
;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
|
|
|
|
;; The profiler uses the EE Timer 1 to record how long is spent in each part of the frame.
|
|
;; There is a EE and VU1 profiler. The EE profiler relies on code manually reporting how long
|
|
;; it takes to run, and the VU1 profiler uses VIF interrupts to do this automatically on
|
|
;; microprogram completion.
|
|
|
|
;; A single thing in the profiler
|
|
(deftype profile-frame (structure)
|
|
((name symbol)
|
|
(time-stamp uint32)
|
|
(color rgba)
|
|
)
|
|
)
|
|
|
|
|
|
;; A "bar" to display all the timed events
|
|
(declare-type dma-buffer basic)
|
|
(deftype profile-bar (basic)
|
|
((profile-frame-count int32)
|
|
(cache-time time-frame)
|
|
(data profile-frame 1024 :inline)
|
|
)
|
|
(:methods
|
|
(new (symbol type) _type_)
|
|
(get-last-frame-time-stamp (_type_) uint)
|
|
(reset (_type_) _type_)
|
|
(add-frame (_type_ symbol rgba) profile-frame)
|
|
(add-end-frame (_type_ symbol rgba) profile-frame)
|
|
(draw (_type_ dma-buffer int) float)
|
|
)
|
|
)
|
|
|
|
(defmacro add-ee-profile-frame (name &key (r 0) &key (g 0) &key (b 0) &key (a #x80))
|
|
`(if *debug-segment*
|
|
(add-frame
|
|
(-> *display* frames (-> *display* on-screen) frame profile-bar 0)
|
|
,name
|
|
(new 'static 'rgba :r ,r :g ,g :b ,b :a ,a)
|
|
)
|
|
)
|
|
)
|
|
|
|
;; tentative name
|
|
(defmethod get-last-frame-time-stamp profile-bar ((this profile-bar))
|
|
"Returns the timestamp of the last (non-remaining) frame on the profiler bar."
|
|
(-> this data (+ (-> this profile-frame-count) -2) time-stamp)
|
|
)
|