Merge branch 'bloomberg:main' into xrj_add_grep_tree

Author: denghz

.github/workflows/build.yml

@@ -17,7 +17,7 @@ jobs:
     name: "Check if generated files are up to date"
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
       - name: Set up dependencies
         run: |
           sudo apt-get update
@@ -41,7 +41,7 @@ jobs:
     name: "Test with coverage"
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
       - name: Set up Python
         uses: actions/setup-python@v4
         with:
@@ -73,7 +73,7 @@ jobs:
       image: alpine
       options: --cap-add=SYS_PTRACE
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
       - name: Set up dependencies
         run: |
           apk add --update build-base libunwind-dev lz4-dev musl-dev python3-dev python3-dbg gdb lldb git bash perl perl-datetime build-base perl-app-cpanminus
@@ -105,7 +105,7 @@ jobs:
     name: "Lint and Docs"
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
       - name: Set up Node
         uses: actions/setup-node@v3
         with:
@@ -136,7 +136,7 @@ jobs:
     name: "Valgrind & Helgrind"
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
       - name: Set up Python 3.10
         uses: actions/setup-python@v4
         with:

.github/workflows/build_wheels.yml

@@ -22,7 +22,7 @@ jobs:
     name: Build source distribution
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
 
       - name: Build sdist
         run: pipx run build --sdist
@@ -72,7 +72,7 @@ jobs:
         with:
           name: tests
           path: tests
-      - uses: docker/setup-qemu-action@v2
+      - uses: docker/setup-qemu-action@v3
         if: runner.os == 'Linux'
         name: Set up QEMU
       - name: Extract sdist
@@ -82,7 +82,7 @@ jobs:
         run: |
           echo 0 | sudo tee /proc/sys/kernel/yama/ptrace_scope
       - name: Build wheels
-        uses: pypa/cibuildwheel@v2.14.1
+        uses: pypa/cibuildwheel@v2.15.0
         env:
           CIBW_BUILD: ${{ matrix.cibw_python }}
           CIBW_ARCHS_LINUX: ${{ matrix.cibw_arch }}
@@ -124,7 +124,7 @@ jobs:
           echo "CFLAGS=-target arm64-apple-macos11" >> $GITHUB_ENV
           echo "MEMRAY_LIBBACKTRACE_TARGET=arm64-apple-macos11" >> $GITHUB_ENV
       - name: Build wheels
-        uses: pypa/cibuildwheel@v2.14.1
+        uses: pypa/cibuildwheel@v2.15.0
         env:
           CIBW_BUILD: ${{ matrix.cibw_python }}
           CIBW_ARCHS_MACOS: ${{ matrix.cibw_arch }}
@@ -148,10 +148,6 @@ jobs:
         with:
           name: dist
           path: dist
-      - name: Avoid publishing Python 3.12 wheels
-        run: |
-          rm -f dist/*cp312*
-          ls -l dist/
       - uses: pypa/gh-action-pypi-publish@release/v1
         with:
           skip_existing: true
@@ -164,7 +160,7 @@ jobs:
     permissions:
       contents: write
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
       - name: Set up Python
         uses: actions/setup-python@v4
         with:

.github/workflows/coverage.yml

@@ -30,7 +30,7 @@ jobs:
     strategy:
       fail-fast: false
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
       - name: Set up Python
         uses: actions/setup-python@v4
         with:

docs/_static/images/icicle_flame_toggle.png

@@ -25,6 +25,7 @@
             background-image: url("{{pathto('_static/images/circle_outer_opt.png', 1)}}");
         }
     </style>
+    <link rel="icon" href="_static/favicon.ico">
 
 </head>
 

docs/_static/images/invert_button.png

@@ -40,6 +40,7 @@
 html_additional_pages = {
     "index": "index.html",
 }
+html_favicon = "favicon.ico"
 
 # -- Options for smartquotes ----------------------------------------------------------
 

docs/_templates/index.html

@@ -196,19 +196,24 @@ checkbox:
 Note that allocations in these frames will still be accounted for
 in parent frames, even if they're hidden.
 
-Inverted View
------------------
-
-Although the flame graphs explained above show the calling functions below
-and memory allocating functions above, flame graphs can be inverted
-so that the calling functions are at the top, while memory allocating
-functions are at the bottom. In this view, look for wide ceilings
-instead of wide plateaus to find functions with the largest allocation
-of memory.
-
-To invert the flame graph, press the *Invert* button:
+Flames versus Icicles
+---------------------
 
-.. image:: _static/images/invert_button.png
+The flame graphs explained above show each function above its caller,
+with the root at the bottom. This is what's traditionally called
+a "flame graph", because the wide base with narrowing columns above it
+looks sort of like a burning log with flames leaping into the air above
+it. Memray also supports what's sometimes called an "icicle graph",
+which has the root at the top. In an icicle graph, each function is
+below its caller, and there is a wide ceiling that thinner columns
+descend from, like icicles hanging from a roof. Whichever of these modes
+you choose, the data shown in the table is the same, just mirrored
+vertically.
+
+You can switch between showing a flame graph and an icicle graph with
+this toggle button:
+
+.. image:: _static/images/icicle_flame_toggle.png
     :align: center
 
 .. _memory-leaks-view:

docs/conf.py

@@ -0,0 +1,4 @@
+Add a new ``--inverted`` flag to ``memray flamegraph``. In an inverted flame graph, the roots are the functions that allocated memory,
+and the children of any given node represent the percentage of that node's
+allocations that can be attributed to a particular caller. The inverted flame graph is very helpful in analyzing where memory is being
+spent in aggregate.