【Nim】FlameGraphを使ったプロファイル結果の可視化

やりたいこと

　Nim言語を実行した際に、どの処理にどれだけ掛かっているかを把握して処理高速化の目途付けが出来るようにしたい
　具体的には以下のような出力が欲しい
　（縮小して小さいですが、クリック等で操作できるはず)

大まかな流れ

1. std/nimprof を利用してプロファイルテキストを生成する
2. PythonでFrameGraph生成用ファイルに変換する
3. Perlでsvgファイルに変換する

　以下のサイトを参考にさせて頂きました
※リンク先手順通りやれば、Pythonでのテキスト変換挟まなくても良さそうでした

chy72.hatenablog.com

環境構築

　調べてやれそうなやり方を繋ぎ合わせたため、Nim・Python・Perlの3言語を使う必要があります
　Nimの実行環境は整っているものとします

　Pythonは3.10を使っていますので、これ以降のバージョンを使っている場合は問題ないはずです
　追加で必要なライブラリも特にはありません

　Perlは、以下のサイトを参考にインストールしました

　Perlのインストール、プログラムの実施 #Perl - Qiita

　Perl導入後、Nimでプロファイル計測を行うことができない現象が発生しました
　PATHを編集したりしていた所、何故か直ってしまいました
　恐らく、Nimのコンパイル実行で使うgccと、Perlで使うgccが影響し合ったと思われますが、再現したら教えてください

使い方

std/nimprof を利用してプロファイルテキストを生成する

　プロファイル計測したいNimのコードの最初の方に以下のコードを書きます

import nimprof
setSamplingFrequency(1000)  # 1ms

　そして、Nimを実行する際の引数に「--profiler:on --stackTrace:on」を加えて実行します
　自分はテキストで標準入出力をしているので、以下のようなコマンドになりました

nim c -r --profiler:on --stackTrace:on -d:release ファイル名.nim < nim_input.txt > nim_output.txt

　完了すると、「profile_results.txt」というファイルが出来ていると思います

PythonでFrameGraph生成用ファイルに変換する

　次に、以下のコードのPythonファイルを同階層に準備して実行します

コード折り畳み

def findCallCount(line):
    args = line.split(" ")
    for i, arg in enumerate(args):
        if arg[:4] != "Call": continue
        return args[i+1].split("/")[0]
    return ""

def parseTree(lines):
    result = []
    ignored = False
    for line in lines[1:]:
        if line == "": continue
        if line[0] == " ":
            flames = line.split(" ")
            file = flames[2].replace(".nim", "").replace(":", "")
            fun = flames[3].replace(";", "").replace(":", "")
            if file[0]=="." or fun[0]==".": continue
            if file == "nimprof" : ignored = True
            if ignored: continue
            result[-1].append(f"{fun}({file})")
        else:
            ignored = False
            result.append([])
            result[-1].append(findCallCount(line))

    return result

def parse(file_path):
    result = []
    with open(file_path) as f:
        lines = f.readlines()
    tree = parseTree(lines)
    for t in tree:
        result.append(";".join(reversed(t[1:]))+ f" {t[0]}\n")
    return result

file_path = "./profile_results.txt"
res = parse(file_path)
output = "./profile_export.txt"
with open(output, "w") as f:
    f.writelines(res)

　実行完了すると「profile_export.txt」というファイルが出来ていると思います

Perlでsvgファイルに変換する

　FlameGraphへ変換するPerlのコードを以下のサイトから入手します

　FlameGraph/flamegraph.pl at master · brendangregg/FlameGraph · GitHub

　そして、以下のコマンドを実行します

perl flamegraph.pl < profile_export.txt > flamegraph.svg

　実行完了すると「flamegraph.svg」というファイルが出来ていると思います
　このファイルをブラウザで開くとプロファイル結果を見ることが出来ます

実際に処理改善してみる

　A - ゲーム実況者Xの挑戦で提出したコードを元に改善してみます
　以下が元のプロファイル結果で、例として右の方のセグ木の時間に着目します
　update()の内、op()が結構な割合を占めています

　op()は、以下のコードが書かれていました

proc op(a, b: (int, int)):(int, int) = min(a, b)

　min()を使っていたので、if文を使った処理へ書き換えてみます

proc op(a, b: (int, int)):(int, int) = 
    if a[0] <= b[0]: return a
    else: return b

　再度、プロファイルを取り直したものが以下になります

　全体に対する処理時間の割合が減ったように見えます
　コードテストも回してみます
　計測誤差もあるとは思いますが、実行時間を改善することが出来ました！

おわりに

　自分への備忘録として書きましたが、誰かの役に立てば幸いです