再びWindows+WSLでC++のデバッグ環境を構築する

環境は次の通り。

• OS : windows10 Pro version: 2004 build:19041.804
• ubuntu : 18.04.5 LTS
• VSCode version: 1.53.2

全てのファイルをOneDriveで共有しているため、.vscode内のjsonファイルも共有されています。そのため、windows環境とmac環境の両方で扱えるようにjsonファイルを記述する必要があります。

ディレクトリは次のようになっています。

┣.vscode
┃	┣c_cpp_proprtties.json
┃	┣tasks.json
┃	┗launch.json
┃
┗practice
	┗chap13
		┗test.cpp

2.C++の構成

C++をWindows+WSL2+VSCodeでコンパイルを参考にしました。c_cpp_properties.jsonの中身は以下の通り。

{
    "configurations": [
        {
            "name": "WSL",
            "includePath": [
                "${workspaceFolder}/**",
                "/usr/include/**"
            ],
            "defines": [
                "_DEBUG",
                "UNICODE",
                "_UNICODE"
            ],
            "compilerPath": "/usr/bin/gcc",
            "cStandard": "c11",
            "cppStandard": "c++17",
            "intelliSenseMode": "gcc-x64"
        },
        {
            "name": "Mac",
            "includePath": [
                "${workspaceFolder}/**",
                "usr/local/include/**"
            ],
            "defines": [],
            "macFrameworkPath": [
                "/Library/Developer/CommandLineTools/SDKs/MacOSX.sdk 1/System/Library/Frameworks"
            ],
            "compilerPath": "/usr/local/bin/g++",
            "cStandard": "c17",
            "cppStandard": "c++17",
            "intelliSenseMode": "gcc-x64"
        }
    ],
    "version": 4
}

compilerPathはwhichコマンドから調べることができます。

which gcc

また、WSL上ではELF32バイナリが実行できません。

3.tasks.json

【VScode＋WSLで始める】競プロ用C++デバッグ環境構築とWSL2とVSCodeでC++環境構築した（AtCoder Libraryを使えるようになるまで）を参考に作成しました。全文は以下の通り。

{
    "version": "2.0.0",
    "tasks": [
        {
            "label": "build on mac",
            "type": "shell",
            "command": "g++",
            "args": [
                "-std=c++17",
                "-g",
                "-O0",
                "-o",
                "'${workspaceFolder}/problem.out'",
                "'${file}'",
            ],
            "group": {
                "kind": "build",
                "isDefault": true
            }
        },
        {
            "type": "shell",
            "label": "build on WSL",
            "command": "/usr/bin/g++",
            "args": [
                "-std=gnu++17",
                "-Wall",
                "-Wextra",
                "-Wshadow",
                "-Wconversion",
                "-fsanitize=undefined",
                "-ggdb",
                "${file}",
                "-o",
                "${fileDirname}/${fileBasenameNoExtension}"
            ],
            "problemMatcher": [
                "$gcc"
            ],
            "group": {
                "kind": "build",
                "isDefault": true
            }
        }
    ]
}

調べていると、commandが"/usr/bin/g++-9"としている人が多く見られましたが、私の環境では「そんなディレクトリやファイルはない」と怒られたので消しています。こちらもwhichコマンドで調べられます。

参考にしたコードと異なるところは、

• オプションを"-std=gun++17"に変更。
• 出力ファイル名を変更。(このためlaunch.jsonも書き換える必要がある)
• Labelを自分がわかりやすいように変更。
• wslのファイルパスに変更するコマンドを削除。

です。

4.コンパイルできるかテスト

テストコードを書きます。Hello,World!でもなんでもいいです。今回はデバッグ環境まで構築するため、デバッグのテストでも使えるようなコードにしました。(デバッグしてvectorの中身が見れるのか知りたかっただけ)

#include <bits/stdc++.h>
#define rep(i, n) for (int i = 0; i < (n); i++)
#define rep2(i, s, n) for (int i = (s); i < (n); i++)
using namespace std;
using ll = long long;
using P = pair<int, int>;
int main() {
  int n;
  cin >> n;
  vector<int> v;
  rep(i, n) v.emplace_back(i);
  v.resize(10);
  for (auto num : v) cout << num << endl;
  return 0;
}

コードを保存して、VSCodeを再起動します。コマンドパレット(Ctrl+Shift+P)を開いて、"reload"まで打つと、"Developer: Reload Window"と出てくるので、それを選択してEnterを押すだけです。

Ctrl+Shift+Bを押してコンパイルをします。cppファイルのあるディレクトリ内にtestというファイルがあればコンパイルできています。一応叩いて動かしておきましょう。

./test

5.デバッグ環境

launch.jsonを作成し記述します。Visual Studio Code を使った C++ のビルド＆デバッグ方法と【VScode＋WSLで始める】競プロ用C++デバッグ環境構築を参考にしました。

{
    "version": "0.2.0",
    "configurations": [
        {
            "name": "(lldb) on Mac Launch",
            "type": "lldb",
            "request": "launch",
            "program": "${workspaceFolder}/problem.out",
            "args": [],
            "cwd": "${workspaceFolder}",
        },
        {
            "name": "(gdb) Launch",
            "type": "cppdbg",
            "request": "launch",
            "program": "${fileDirname}/${fileBasenameNoExtension}",
            "args": [
                "<",
                "${workspaceFolder}/problem.in"
            ],
            "stopAtEntry": false,
            "cwd": "${workspaceFolder}",
            "environment": [],
            "externalConsole": false,
            "MIMode": "gdb",
            "miDebuggerPath": "/usr/bin/gdb",
            "setupCommands": [
                {
                    "description": "Enable pretty-printing for gdb",
                    "text": "-enable-pretty-printing",
                    "ignoreFailures": true
                }
            ]
        }
    ]
}

変更点は

• programの場所を変えたので、同じ場所を指すように指定
• externalConsoleをfalseに変更

です。

コンパイル時に実行ファイルの出力先を変えたので、それを指すようにしています。また、Macではコンソールが出てきてそこに入力をすればいいのですが、windowsの方だとそれが出てきません。また、多数のクエリを処理するコードを動かすとき、コンソール入力をするととても見づらい出力が出てくるのが嫌だという理由もあります。

そういうことで、入力する数値などはproblem.inにまとめています。

externalConsoleはtrueの場合デバッグ用コンソールが起動し、falseの場合統合コンソールに表示されるものです。trueの状態でデバッグするとタスクは起動しているがデバッグはされていない状態になり、falseにすると統合ターミナルのデバッグコンソールタブに表示され正常に動作しました。

falseにして不便はないのでそのままにしました。

6.デバッグのテスト

ブレークポイントを設定してデバッグをしてみます。

vectorの中身を覗くこともできました。

7.おわりに

macのデバッガーのlldbでは配列内のアドレスは見れても値までは見れなかったので、更に便利になりました。何個か問題を解いてちゃんと使えるかテストして今週のコンテストに挑みたいと思います。

8.参考文献

C++をWindows+WSL2+VSCodeでコンパイル

Visual Studio Code を使った C++ のビルド＆デバッグ方法

【VScode＋WSLで始める】競プロ用C++デバッグ環境構築

WSL2とVSCodeでC++環境構築した（AtCoder Libraryを使えるようになるまで）

Windows Subsystem for Linux で Visual Studio Code の使用を開始する

ディレクトリ構成図を書くときに便利な記号