package memtrace_viewer
sectionYPositions = computeSectionYPositions($el), 10)"
x-init="setTimeout(() => sectionYPositions = computeSectionYPositions($el), 10)"
>
Interactive memory profiler based on Memtrace
Install
dune-project
Dependency
Authors
Maintainers
Sources
v0.17.0.tar.gz
sha256=0d9b7ddf94f9cf090930a36468abd4f4ca40c5618ec02dbbc6fd47fb0572433d
doc/src/memtrace_viewer.client/flame_graph_view.ml.html
Source file flame_graph_view.ml
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 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842open! Core open Bonsai_web module Node_svg = Virtual_dom_svg.Node module Attr_svg = Virtual_dom_svg.Attr include Flame_graph_view_intf let node_height = 20. let control_area_width = 63. let focus_border_thickness = 4. (* needs to match CSS .flame-graph-sequence-border *) let focus_border_protrusion = 14. let = 8. let = button_width /. Float.sqrt 2. let = 3. let bracket_margin = 3. let bracket_arm_length = 3. let bracket_tick_length = 3. module Controls = struct module Glyph = struct type t = | Up_to_here | Down_to_here let render t x y = let points = match t with | Up_to_here -> [ x +. (0.5 *. button_width), y ; x, y +. button_height ; x +. button_width, y +. button_height ] | Down_to_here -> [ x, y; x +. button_width, y; x +. (0.5 *. button_width), y +. button_height ] in Node_svg.polygon ~attrs:[ Attr_svg.points points; Vdom.Attr.class_ "flame-graph-button-glyph" ] [] ;; end let render_motion_line ~x ~y ~arrow_base_y = let line_x = x +. (button_width /. 2.) in let end_y = if Float.(arrow_base_y > y) then (* Don't smudge the point of the arrow *) y +. button_height else y in Node_svg.line ~attrs: [ Vdom.Attr.class_ "flame-graph-button-motion-line" ; Attr_svg.x1 line_x ; Attr_svg.y1 arrow_base_y ; Attr_svg.x2 line_x ; Attr_svg.y2 end_y ] [] ;; let ~glyph ~x ~y ~arrow_base_y ~on_click = let on_click _ = on_click in Node_svg.g ~attrs:[ Vdom.Attr.class_ "flame-graph-button"; Vdom.Attr.on_click on_click ] [ Glyph.render glyph x y; render_motion_line ~x ~y ~arrow_base_y ] ;; end module Style = struct type t = | Flames | Focus | Icicles let random_flame_color () = let v1 = Random.float 1. in let v2 = Random.float 1. in let v3 = Random.float 1. in let r = 205 + (50. *. v3 |> Int.of_float) in let g = 0 + (230. *. v1 |> Int.of_float) in let b = 0 + (55. *. v2 |> Int.of_float) in `RGBA (Css_gen.Color.RGBA.create ~r ~g ~b ()) ;; let random_icicle_color () = let v1 = Random.float 1. in let v2 = Random.float 1. in let v3 = Random.float 1. in let r = 50 + (55. *. v2 |> Int.of_float) in let g = 100 + (130. *. v1 |> Int.of_float) in let b = 230 + (25. *. v3 |> Int.of_float) in `RGBA (Css_gen.Color.RGBA.create ~r ~g ~b ()) ;; let focus_color_odd : Css_gen.Color.t = `Var "--focus-color-odd" let focus_color_even = `Var "--focus-color-even" let focus_color even = if even then focus_color_even else focus_color_odd let get_color even = function | Flames -> random_flame_color () | Icicles -> random_icicle_color () | Focus -> focus_color even ;; let get_node_css even style = let color = get_color even style in Css_gen.create_with_color ~field:"fill" ~color ;; end module Bearing = struct type t = | Upwards | Downwards let succ_y ~bearing y = match bearing with | Upwards -> y -. node_height | Downwards -> y +. node_height ;; end module Make (Graph : Graph) = struct module Selector = struct type t = | Flame of Graph.Tree.t | Icicle of Graph.Tree.t | Focus of Graph.Sequence.t let flame tree = Flame tree let icicle tree = Icicle tree let focus seq = Focus seq let same t1 t2 = match t1, t2 with | Flame tree1, Flame tree2 -> Graph.Tree.same tree1 tree2 | Flame _, (Icicle _ | Focus _) -> false | Icicle tree1, Icicle tree2 -> Graph.Tree.same tree1 tree2 | Icicle _, (Flame _ | Focus _) -> false | Focus seq1, Focus seq2 -> Graph.Sequence.same seq1 seq2 | Focus _, (Flame _ | Icicle _) -> false ;; end module Context = struct (* Parameters that are unchanged throughout the rendering of one section (the sections being flame, icicle, and focus). *) type t = { graph : Graph.t ; selection : Selector.t option ; select : Selector.t -> unit Effect.t ; activate : Selector.t -> unit Effect.t ; commands : Commands.t ; style : Style.t ; bearing : Bearing.t ; data_left : float ; focus_border_above : float option (* y-coordinate of the focus border above the section *) ; focus_border_below : float option } end let ~cxt ~y ~selected = let Commands. { extend_focus_to; retract_callers_from_focus; retract_callees_from_focus } = cxt.Context.commands in if not selected then [] else let open struct type position = (* Bottom aligned with top edge of node *) | Over_border | (* Top aligned with top edge of node *) Up_to_border | (* Bottom aligned with bottom edge of node *) Down_to_border | (* Top aligned with bottom edge of node *) Under_border end in let glyph vpos command = match (command : Command.t) with | Enabled on_click -> let x = cxt.data_left -. (button_margin +. button_width) in let y = match vpos with | Over_border -> y -. button_width | Up_to_border -> y | Down_to_border -> y +. (node_height -. button_width) | Under_border -> y +. node_height in let arrow_base_y = match (glyph : Controls.Glyph.t) with | Down_to_here -> cxt.Context.focus_border_above |> Option.value_exn ~here:[%here] | Up_to_here -> cxt.focus_border_below |> Option.value_exn ~here:[%here] in Some (Controls.render_button ~glyph ~x ~y ~arrow_base_y ~on_click) | Disabled -> None in let = let (glyph : Controls.Glyph.t), vpos = match cxt.style with | Flames | Focus -> Up_to_here, Up_to_border | Icicles -> Down_to_here, Down_to_border in button glyph vpos extend_focus_to in let = button Up_to_here Under_border retract_callers_from_focus in let = button Down_to_here Over_border retract_callees_from_focus in List.filter_opt [ extend_focus_to_button ; retract_callers_from_focus_button ; retract_callees_from_focus_button ] ;; let color_box_class_attr = Vdom.Attr.class_ "flame-graph-node-color-box" let height_attr = Attr_svg.height node_height let text_x_attr = Attr_svg.x 2. let text_y_attr = Attr_svg.y (0.8 *. node_height) let render_node ~cxt ~x ~y ~width ~even ~selector node : Vdom.Node.t list = let graph = cxt.Context.graph in let css = Style.get_node_css even cxt.style in let selected = Option.exists ~f:(Selector.same selector) cxt.selection in let node_type_class = match Graph.Node.type_ ~graph node with | Function -> Vdom.Attr.class_ "flame-graph-node-function" | Allocation_site -> Vdom.Attr.class_ "flame-graph-node-alloc-site" in let selected_class = if selected then Vdom.Attr.class_ "flame-graph-node-selected" else Vdom.Attr.empty in let alloc_site_indicator = match Graph.Node.type_ ~graph node with | Function -> Vdom.Node.none | Allocation_site -> Node_svg.tspan ~attrs:[ Vdom.Attr.class_ "loc-alloc-site-indicator" ] [ Vdom.Node.text "A " ] in let = render_buttons ~cxt ~y ~selected in let rect = (* Put the node in an embedded <svg> element so that the text gets clipped to the rectangle *) Node_svg.svg ~attrs: [ Attr_svg.x x ; Attr_svg.y y ; Attr_svg.width width ; height_attr ; Vdom.Attr.classes [ "flame-graph-node" ] ; node_type_class ; selected_class ; Vdom.Attr.on_click (fun _ -> cxt.select selector) ; Vdom.Attr.on_double_click (fun _ -> cxt.activate selector) ] [ Node_svg.rect ~attrs: [ color_box_class_attr ; Vdom.Attr.style css ; (* Since we set the width on the svg element above, we should be able to let CSS take care of setting this rect's width to 100% of its container and be done with it, but Chrome was sporadically making the rect very small for no apparent reason. Height doesn't seem to have the same problem. *) Attr_svg.width width ] [] ; Node_svg.text ~attrs:[ text_x_attr; text_y_attr ] [ alloc_site_indicator; Vdom.Node.text (Graph.Node.label ~graph node) ] ; Node_svg.title [ Vdom.Node.text (Graph.Node.details ~graph node) ] ] in List.concat [ buttons; [ rect ] ] ;; let render_sequence ~cxt ~x ~y ~width ~make_selector seq : Vdom.Node.t list = let graph = cxt.Context.graph in let bearing = cxt.bearing in let starting_y = y in let y = ref starting_y in let rec render_nodes ~even seq = let first = Graph.Sequence.node seq in let first_view = let selector = make_selector seq in render_node ~cxt ~x ~y:!y ~width ~even ~selector first in let rest_view = match Graph.Sequence.next ~graph seq with | None -> [] | Some rest -> y := Bearing.succ_y ~bearing !y; let even = not even in render_nodes ~even rest in first_view :: rest_view in let nodes = match seq with | None -> [] | Some seq -> List.concat (render_nodes ~even:false seq) in let border y = let segment ?(attr = Vdom.Attr.empty) x1 x2 = Node_svg.line ~attrs: [ attr ; Attr_svg.x1 x1 ; Attr_svg.y1 y ; Attr_svg.x2 x2 ; Attr_svg.y2 y ; Vdom.Attr.class_ "flame-graph-sequence-border" ] [] in [ segment (x -. focus_border_protrusion) (x +. (width /. 2.)) ~attr:(Attr_svg.stroke_linecap `Round) ; segment (x +. (width /. 2.)) (x +. width) ] in let starting_border_y, ending_border_y = match bearing with | Upwards -> starting_y +. node_height, !y | Downwards -> starting_y, !y +. node_height in let starting_border = border starting_border_y in let ending_border = match seq with | None -> [] | Some _ -> border ending_border_y in let bracket_right_x = x -. focus_border_protrusion -. bracket_margin in let bracket = match seq with | None -> [] | Some seq -> let right_x = bracket_right_x in let middle_x = bracket_right_x -. bracket_arm_length in let left_x = middle_x -. bracket_tick_length in let line = Node_svg.polyline ~attrs: [ Attr_svg.points [ right_x, starting_border_y ; middle_x, starting_border_y ; middle_x, ending_border_y ; right_x, ending_border_y ] ] [] in let middle_y = (starting_border_y +. ending_border_y) /. 2. in let tick = Node_svg.polyline ~attrs:[ Attr_svg.points [ middle_x, middle_y; left_x, middle_y ] ] [] in let text_right_x = left_x -. bracket_margin in let text_lines = let first = ref true in List.map (Graph.Sequence.label ~graph seq) ~f:(fun line -> let dy = if !first then Vdom.Attr.empty else Vdom.Attr.create "dy" "1.2em" in first := false; Node_svg.tspan ~attrs:[ Attr_svg.x text_right_x; Attr_svg.y (middle_y -. 3.); dy ] [ Vdom.Node.text line ]) in let text = Node_svg.text ~attrs:[ Vdom.Attr.create "text-anchor" "end" ] text_lines in [ Node_svg.g ~attrs:[ Vdom.Attr.class_ "flame-graph-sequence-bracket" ] [ line; tick; text ] ] in (* An invisible box that's there so we can scroll the whole sequence into view (see [scroll_focus_into_view] below) *) let box = match seq with | None -> [] | Some _ -> let height = Float.abs (starting_border_y -. ending_border_y) in let y = Float.min starting_border_y ending_border_y in [ Node_svg.rect ~attrs: [ Attr_svg.x x ; Attr_svg.y y ; Attr_svg.width width ; Attr_svg.height height ; Vdom.Attr.class_ "flame-graph-sequence-box" ] [] ] in List.concat [ box; nodes; starting_border; ending_border; bracket ] ;; let rec render_tree ~cxt ~x ~y ~scale ~even ~make_selector tree : Vdom.Node.t list = let graph = cxt.Context.graph in let bearing = cxt.bearing in let node = Graph.Tree.node tree in let width = Graph.Node.size ~graph node *. scale in let view = let selector = make_selector tree in render_node ~cxt ~x ~y ~width ~even ~selector node in let children_view = let even = not even in let y = Bearing.succ_y ~bearing y in let children = Graph.Tree.children ~graph tree in let children_size = List.fold_left children ~init:0. ~f:(fun total child -> total +. Graph.Node.size ~graph (Graph.Tree.node child)) in let children_width = children_size *. scale in let x = x +. ((width -. children_width) /. 2.) in render_level ~cxt ~x ~y ~scale ~even ~make_selector children in List.concat [ view; children_view ] and render_level ~cxt ~x ~y ~scale ~even ~make_selector trees = let graph = cxt.Context.graph in let x = ref x in let tree_views = List.concat_map trees ~f:(fun tree -> let this_x = !x in let node = Graph.Tree.node tree in let width = Graph.Node.size ~graph node *. scale in x := !x +. width; render_tree ~cxt ~x:this_x ~y ~scale ~even ~make_selector tree) in (* If there's a single child, flatten the DOM out a little; if nothing else, it makes it easier to poke around using the Chrome inspector *) match trees with | [] | [ _ ] -> tree_views | _ -> [ Node_svg.g tree_views ] ;; let rec tree_height ~graph trees = List.fold_left trees ~init:0 ~f:(fun acc tree -> let height = 1 + tree_height ~graph (Graph.Tree.children ~graph tree) in Int.max acc height) ;; let rec sequence_beginning ~graph seq = match Graph.Sequence.prev ~graph seq with | None -> seq | Some prev -> sequence_beginning ~graph prev ;; let rec sequence_end ~graph seq = match Graph.Sequence.next ~graph seq with | None -> seq | Some next -> sequence_end ~graph next ;; let rec sequence_height ~graph seq = match Graph.Sequence.next ~graph seq with | None -> 1 | Some next -> 1 + sequence_height ~graph next ;; let render ~width ~set_width ~selection ~select ~activate ~commands graph = Random.init 0; let focus = Option.map ~f:(sequence_beginning ~graph) (Graph.focus graph) in let actual_control_area_width = match focus with | None -> (* If there's no focus, the control area is just a bit of space for the buttons *) focus_border_protrusion | Some _ -> (* If there's a focus, reserve room for the bracket and the focused allocations *) control_area_width in let data_left = 0. +. actual_control_area_width in let data_width = width -. actual_control_area_width in let flame_tree = Graph.flame_tree graph in let icicle_tree = Graph.icicle_tree graph in let size = Graph.size graph in let scale = data_width /. size in (* If the focus border is at the very top (because there's no flame tree), it needs a bit of extra space so it doesn't get clipped *) let extra_space_at_top_for_border = if List.is_empty flame_tree then focus_border_thickness /. 2. else 0. in let flame_height = node_height *. (tree_height ~graph flame_tree |> Float.of_int) in let focus_height = match focus with | None -> 0. | Some seq -> node_height *. (sequence_height ~graph seq |> Float.of_int) in let icicle_height = node_height *. (tree_height ~graph icicle_tree |> Float.of_int) in let extra_space_at_bottom_for_border = if List.is_empty icicle_tree then focus_border_thickness /. 2. else 0. in let height = extra_space_at_top_for_border +. flame_height +. focus_height +. icicle_height +. extra_space_at_bottom_for_border in let flame_graph_bottom_node_y = flame_height -. node_height +. extra_space_at_top_for_border in let focus_top_node_y = flame_graph_bottom_node_y +. node_height in let focus_bottom_node_y = flame_graph_bottom_node_y +. focus_height in let icicle_graph_top_node_y = focus_bottom_node_y +. node_height in let flame_graph_views = render_level ~cxt: { graph ; style = Flames ; bearing = Upwards ; selection ; select ; activate ; commands ; data_left ; focus_border_above = None ; focus_border_below = Some focus_top_node_y } ~x:data_left ~y:flame_graph_bottom_node_y ~scale ~even:false ~make_selector:Selector.flame flame_tree in let focus_views = render_sequence ~cxt: { graph ; style = Focus ; bearing = Upwards ; selection ; select ; activate ; commands ; data_left ; focus_border_above = Some focus_top_node_y ; focus_border_below = Some (focus_bottom_node_y +. node_height) } ~x:data_left ~y:focus_bottom_node_y ~width:data_width ~make_selector:Selector.focus focus in let icicle_graph_views = render_level ~cxt: { graph ; style = Icicles ; bearing = Downwards ; selection ; select ; activate ; commands ; data_left ; focus_border_below = None ; focus_border_above = Some (focus_bottom_node_y +. node_height) } ~x:data_left ~y:icicle_graph_top_node_y ~scale ~even:false ~make_selector:Selector.icicle icicle_tree in let open Vdom in let flame_view = Node_svg.g ~attrs:[ Attr.class_ "flame-graph-flames" ] flame_graph_views in let focus_view = Node_svg.g ~attrs:[ Attr.class_ "flame-graph-focus" ] focus_views in let icicle_view = Node_svg.g ~attrs:[ Attr.class_ "flame-graph-icicles" ] icicle_graph_views in let on_size_change = Bonsai_web_ui_element_size_hooks.Size_tracker.on_change (fun ~width ~height:_ -> set_width width) in Node.div ~attrs:[ Attr.class_ "flame-graph-container" ] [ Node.div ~attrs:[ Attr.class_ "flame-graph-sizer"; on_size_change ] [ Node_svg.svg ~attrs: [ Attr_svg.height height ; Attr_svg.viewbox ~min_x:0. ~min_y:0. ~width ~height ] [ flame_view; icicle_view; focus_view ] ] ] ;; let scroll_into_view : string -> unit Effect.t = let open Js_of_ocaml in Effect.of_sync_fun (fun selector -> let selected_node = Dom_html.document##querySelector (selector |> Js.string) in Js.Opt.iter selected_node (fun selected -> let options = object%js (self) val block = "nearest" |> Js.string val inline = "nearest" |> Js.string end in Js.Unsafe.meth_call selected "scrollIntoView" [| Js.Unsafe.inject options |])) ;; let scroll_selection_into_view = scroll_into_view ".flame-graph-node-selected .flame-graph-node-color-box" ;; let scroll_focus_into_view = scroll_into_view ".flame-graph-focus .flame-graph-sequence-box" ;; type t = { view : Vdom.Node.t ; key_handler : Vdom_keyboard.Keyboard_event_handler.t } let component graph ~selection ~select ~ ~activate ~commands = let open Bonsai.Let_syntax in let%sub width, set_width = Bonsai.state 500. ~equal:[%equal: Float.t] in return (let%map graph = graph and width = width and set_width = set_width and selection = selection and select = select and = navigate_to and activate = activate and commands = commands in let view = render ~width ~set_width ~selection ~select ~activate ~commands graph in let key_handler = Keyboard_navigation.key_handler ~graph ~selection ~navigate_to ~activate in { view; key_handler }) ;; end
sectionYPositions = computeSectionYPositions($el), 10)"
x-init="setTimeout(() => sectionYPositions = computeSectionYPositions($el), 10)"
>