Cara menggunakan gdbserver untuk debugging jarak jauh di Linux

Jika Anda memprogram dalam bahasa C atau C++ Linux dan Anda belum pernah menggunakan gdbserverAnda melewatkan salah satu alat paling berguna untuk men-debug proses dari jarak jauh, baik di server, sistem tertanam, atau bahkan di dalam mesin virtual atau WSL. Jauh dari sesuatu yang "ajaib" atau hanya diperuntukkan bagi para ahli, gdbserver hanyalah sebuah program kecil yang berkomunikasi dengan gdb dan mengontrol eksekusi proses target.

Ide utamanya sangat sederhana.: pada mesin tempat biner yang ingin Anda debug berjalan ( target) Anda memulai gdbserver; di komputer kerja Anda (the tuan rumahAnda dapat menjalankan gdb atau bahkan WinDbg yang mendukung protokol gdb. Keduanya terhubung melalui TCP atau port serial, dan dari sana Anda dapat mengatur breakpoint, memeriksa variabel, melihat stack, atau mengikuti eksekusi langkah demi langkah seolah-olah program tersebut berjalan di mesin Anda sendiri.

Apa itu gdbserver dan kapan sebaiknya digunakan?

gdbserver adalah "agen" debugging jarak jauh untuk GNU gdb.Fungsinya sangat spesifik: ia berjalan di mesin tempat program yang akan dianalisis berjalan, mengontrol proses tersebut (atau proses-proses tersebut), dan berkomunikasi dengan klien gdb yang terletak di mesin lain (atau di mesin yang sama) melalui koneksi jarak jauh.

Dalam penggunaan sehari-hari, gdbserver digunakan dalam dua skenario umum.Melakukan debugging perangkat lunak yang berjalan di lingkungan tertanam (router, papan dengan Linux versi ringkas, perangkat) IOTdll.) dan proses debug pada mesin Linux jarak jauh, di mana tidak nyaman atau tidak mungkin untuk memiliki gdb "lengkap" dengan semua pustaka dan simbol.

Secara praktis, gdbserver menangani tugas-tugas seperti: Membaca dan menulis register dan memori proses, mengontrol eksekusi (lanjutkan, jeda, langkah demi langkah), mengelola breakpoint, dan mengirim semua data ini ke gdb menggunakan protokol jarak jauh GDB. Filosofi ini sangat mirip dengan alat seperti OpenOCD, yang bertindak sebagai jembatan antara gdb dan perangkat keras eksternal, dengan perbedaan bahwa gdbserver berjalan pada sistem yang sama tempat binary tersebut berjalan.

Jika Anda berasal dari lingkungan Windows Menarik juga untuk diketahui Debugger seperti WinDbg dapat berkomunikasi dengan gdbserver di Linux, sehingga Anda dapat melakukan debug proses pengguna di Linux dari WinDbg menggunakan dukungan debugging jarak jauh melalui protokol gdb yang telah diintegrasikan Microsoft dalam versi terbaru.

Persyaratan dasar untuk melakukan debugging dengan gdb dan gdbserver

Sebelum memulai proses debugging jarak jauh, Anda perlu memahami hubungan antara host dan target.. Itu target Ini adalah mesin tempat program yang akan di-debug berjalan dan tempat gdbserver akan dieksekusi; tuan rumah Ini adalah mesin tempat Anda akan menjalankan gdb (atau WinDbg) dan tempat Anda akan menyimpan kode sumber dan, sebaiknya, simbol debugging.

Titik awal yang penting adalah mengkompilasi biner dengan simbol.Di GCC atau g++ hal ini dicapai dengan menggunakan flag. -gdan biasanya disarankan untuk juga menonaktifkan optimasi (misalnya dengan -O0Ini memungkinkan debugger untuk menampilkan variabel, makro, dan struktur kode dengan lebih akurat. Untuk makro tertentu, Anda dapat menggunakan level debugging yang lebih tinggi, seperti -g3.

Di sisi host, Anda memerlukan versi gdb yang kompatibel. dengan arsitektur target. Untuk melakukan debugging pada sistem tertanam MIPS, ARM, atau arsitektur lainnya, Anda harus menggunakan gdb dari cross-toolchain yang sesuai (misalnya). arm-none-eabi-gdb o gdb-multiarch) dan, jika perlu, konfigurasikan arsitektur dan endianness dengan perintah sebagai set arch y set endian.

Mengenai koneksi, gdbserver mendukung dua tipe utama.Tautan serial (sangat umum pada perangkat keras tertanam, melalui UART) dan TCP/IP, yang paling nyaman digunakan ketika target berada di jaringan yang sama atau merupakan mesin Linux yang dapat diakses melalui jaringan. Dalam kedua kasus tersebut, perintah digunakan dari gdb. target remote untuk terhubung ke endpoint yang diekspos oleh gdbserver.

Cara memulai gdbserver: mode proses tunggal dan mode multi-proses

gdbserver dapat bekerja dengan dua cara utama. Ketika kita berbicara tentang debugging mode pengguna: secara langsung terkait dengan satu proses atau sebagai "server proses" yang memungkinkan untuk mendengarkan dan terhubung ke berbagai proses sistem.

Dalam mode proses tunggal Anda menjalankan gdbserver, dengan menentukan host:port dan program yang akan dijalankan. Dalam contoh sederhana pada mesin desktop Linux, Anda dapat melakukan sesuatu seperti ini:

Perintah: gdbserver localhost:3333 foo

Dengan perintah tersebut, gdbserver memulai program biner. foo dan dia terus mendengarkan di port 3333Sampai gdb jarak jauh terhubung, program tetap berhenti; ketika gdb terhubung dengan target remote localhost:3333, proses tersebut mulai dikendalikan oleh descrusher.

Dalam mode multi-proses (server proses), opsi ini digunakan. --multiDalam hal ini, gdbserver tidak secara langsung meluncurkan program apa pun, tetapi hanya mendengarkan koneksi masuk dan memungkinkan klien (gdb atau WinDbg) untuk mengelola proses mana yang akan dibuat atau dihubungkan:

Perintah: gdbserver --multi localhost:1234

Saat menggunakan WinDbg di Linux, mode multi-fungsi ini sangat menarik.Karena dari WinDbg sendiri Anda dapat mencantumkan proses pada sistem jarak jauh, melihat PID, pengguna, dan baris perintah, serta melampirkan ke proses yang Anda minati, dengan cara yang mirip dengan yang dilakukan pada process server. dbgsrv.exe di Windows.

Debugging jarak jauh dengan gdbserver dan gdb langkah demi langkah

Mari kita sederhanakan dengan contoh yang sangat umum.Lakukan debugging aplikasi sederhana pada mesin yang sama (host dan target cocok) menggunakan gdbserver untuk mensimulasikan skenario jarak jauh.

Pertama, Anda menulis dan mengkompilasi program kecil.Sebagai contoh, sebuah perulangan sederhana yang mencetak sebuah penghitung:

Perintah: gcc -g foo.c -o foo

Kuncinya di sini adalah benderanya. -gIni menambahkan informasi debugging yang diperlukan ke dalam biner sehingga gdb dapat menampilkan baris kode, nama variabel, tipe, dll. Dalam lingkungan kompilasi silang "sesungguhnya", Anda akan melakukan kompilasi ini dengan cross-toolchain dan kemudian menyalin biner dan dependensinya ke target.

Langkah selanjutnya adalah memulai gdbserver pada target.Jika host dan target adalah mesin yang sama, maka:

Perintah: gdbserver localhost:3333 foo

Anda akan melihat pesan yang mirip dengan “Proses foo dibuat; pid = XXXX; Mendengarkan di port 3333”. Ini menunjukkan bahwa gdbserver telah membuat proses dan sedang menunggu gdb untuk terhubung. Jika Anda berada di sistem yang memerlukan hak akses lebih (misalnya, untuk terhubung ke proses sistem), Anda mungkin perlu menjalankan perintah dengan sudoNamun, selalu bijaksana untuk berhati-hati saat memberikan izin. akar ke alat penghilang sulfur.

Di host, Anda memulai gdb dengan menentukan executable lokal. (yang sama dengan yang berjalan di target, atau salinan identik dengan simbol):

Perintah: gdb foo

Setelah masuk ke dalam gdb, Anda membuat koneksi jarak jauh dengan:

Perintah: target remote localhost:3333

Pada titik itu, gdb memuat simbol dari biner lokal.Ia melakukan sinkronisasi dengan gdbserver dan mengambil alih proses yang sebenarnya berjalan di bawah gdbserver. Dari situ, alurnya seperti biasa: perintah seperti break untuk menetapkan titik kritis, continue, step, next, print untuk memeriksa variabel, backtrace untuk melihat baterai, dll.

Menghubungkan ke proses yang sedang berjalan dengan gdbserver

Anda tidak selalu ingin menjalankan program dari awal.Seringkali Anda tertarik untuk bergabung dengan proses yang sudah berjalan (misalnya, sebuah httpd sebuah router(daemon sistem atau layanan produksi).

Pola umumnya adalah menggunakan opsi tersebut. --attach dari gdbserverdengan memberikan port tempat ia akan mendengarkan dan PID dari proses target. Misalnya, pada router tempat Anda telah menyalin gdbserver yang dikompilasi untuk arsitekturnya, Anda dapat melakukan:

Perintah: gdbserver localhost:3333 --attach <pid_de_httpd>

Di sisi host, Anda akan menggunakan versi gdb yang mendukung arsitektur router., sebagai contoh gdb-multiarchMengonfigurasikan arsitektur dan endianness terlebih dahulu:

Perintah: set arch mips
set endian big

Kemudian Anda menentukan file lokal yang berisi simbol-simbol tersebut. dari biner jarak jauh (misalnya) file httpd) dan, jika perlu, Anda memberi tahu gdb di mana sebenarnya biner tersebut berjalan pada target dengan set remote exec-file /usr/bin/httpdTerakhir, seperti sebelumnya, Anda terhubung dengan:

Perintah: target remote 192.168.0.1:3333

Setelah terpasangAnda dapat mengatur breakpoint pada fungsi tertentu (misalnya, break checkFirmware), melanjutkan eksekusi dan membiarkan alur normal program (misalnya, mengunggah firmware dari antarmuka web) memicu breakpoint.

Menggunakan gdbserver dengan WinDbg di Linux

Dalam beberapa tahun terakhir, Microsoft telah menambahkan dukungan untuk men-debug proses Linux di WinDbg. Menggunakan gdbserver sebagai backend. Fungsionalitas ini ditujukan untuk skenario di mana Anda bekerja di Windows tetapi kode berjalan di Linux (termasuk WSL).

Untuk melakukan debugging proses Linux tertentu dengan WinDbg menggunakan gdbserverAlurnya akan seperti ini: pertama, Anda menemukan proses target pada mesin Linux dengan perintah seperti ps -A (misalnya sebuah python3 (yang sedang berjalan), kemudian Anda jalankan gdbserver pada target:

Perintah: gdbserver localhost:1234 python3

Jika lingkungan mengharuskan demikian, Anda mungkin perlu menggunakan sudo gdbserver ...dengan tindakan pencegahan keamanan yang sama seperti biasanya. Setelah gdbserver menunjukkan bahwa ia "Mendengarkan di port 1234", di WinDbg buka "File / Hubungkan ke debugger jarak jauh" dan tentukan string koneksi dengan tipe berikut:

Perintah: gdb:server=localhost,port=1234

WinDbg menggunakan "driver" protokol gdb kecil untuk berkomunikasi dengan gdbserver. dan, begitu koneksi terjalin, koneksi tersebut tetap berhenti pada titik tersebut. boot dari proses tersebut. Dari sana Anda dapat menggunakan jendela tumpukan (stack windows), modul, memori, titik henti (breakpoints), serta perintah-perintah seperti k untuk melihat baterai atau lm untuk menampilkan daftar modul (dengan mengingat bahwa beberapa perintah mengharapkan format PE dan bukan ELF, sehingga mungkin menampilkan data yang aneh dalam kasus tertentu).

gdbserver dan server proses WinDbg

Selain kasus proses tunggal, WinDbg dapat terhubung ke gdbserver yang bertindak sebagai server proses. agar bekerja lebih mirip dengan cara kerjanya dengan proses Windows jarak jauh. Dalam mode ini, gdbserver diluncurkan dengan --multi dan tanpa proses terkait:

Perintah: sudo gdbserver --multi localhost:1234

Dari WinDbg, pilih “File / Connect to process server” dan Anda menggunakan kembali string koneksi tersebut gdb:server=localhost,port=1234Saat koneksi aktif, Anda dapat melihat daftar proses Linux yang tersedia dan terhubung ke proses yang Anda inginkan atau bahkan meluncurkan proses baru.

Satu detail kecil yang harus diingat.WinDbg membedakan antara "server proses" dan "target tunggal" tergantung pada apakah gdbserver sudah terhubung ke suatu proses saat terhubung. Jika Anda membiarkan gdbserver terhubung ke suatu proses, menutup WinDbg, dan kemudian mencoba untuk terhubung kembali, mungkin tidak akan terdeteksi sebagai server proses, dan Anda mungkin perlu memulai ulang gdbserver.

Untuk mengakhiri sesi server prosesBiasanya, cukup dengan menekan CTRL+D di konsol tempat gdbserver berjalan dan menghentikan debugging dari WinDbg sudah cukup. Dalam beberapa kasus ekstrem, jika ada masalah sinkronisasi, mungkin perlu untuk menutup debugger sepenuhnya dan memulai ulang gdbserver dari awal.

Manajemen simbol dan kode sumber dalam debugging jarak jauh

Salah satu kunci untuk membuat debugging jarak jauh menjadi nyaman adalah memastikan bagian simbol dan font teratasi dengan baik.Tanpa simbol, menavigasi tumpukan atau mengatur breakpoint pada fungsi tertentu menjadi sangat sulit.

Dalam skenario gdb + gdbserver klasik, idealnya salinan file yang dapat dieksekusi beserta simbolnya disimpan di host. (belum dihilangkan) dan pohon sumber. gdb tidak mengharuskan biner jarak jauh berisi simbol; cukup bahwa file lokal yang Anda muat dengan file cocokkan file eksekusi jarak jauh pada tingkat offset.

Di dunia WinDbg dan debugging Linux, layanan seperti DebugInfoD juga telah muncul.yang mengekspos simbol dan font melalui HTTP. WinDbg dapat menggunakan jalur khusus dengan tipe tersebut. DebugInfoD*https://debuginfod.elfutils.org keduanya masuk .sympath seperti dalam .srcpath untuk mengunduh simbol DWARF sesuai permintaan dan kode sumber biner Linux ELF.

Dalam contoh spesifik dengan WSL, di mana kode pengguna berada di bawah C:\Users\Bob\Anda bisa memberi tahu WinDbg:

Perintah: .sympath C:\Users\Bob\
.srcpath C:\Users\Bob\

Dan jika Anda juga ingin menggunakan DebugInfoD untuk biner sistem:

Perintah: .sympath+ DebugInfoD*https://debuginfod.elfutils.org
.srcpath+ DebugInfoD*https://debuginfod.elfutils.org

Dengan konfigurasi ini, saat Anda memeriksa stack atau memasuki fungsi libcWinDbg mungkin akan mencoba mengunduh simbol DWARF yang sesuai dan, jika server juga mengekspos kode tersebut, akan menampilkan kode sumber secara detail, meskipun secara internal toolchain Windows tidak menangani ELF dan DWARF secara "alami" seperti PE dan PDB.

Contoh praktis: men-debug program C++ dengan gdbserver dan WinDbg

Contoh ilustratifnya adalah aplikasi C++ kecil yang menulis ucapan salam ke layar., dikompilasi di WSL dengan simbol debugging. Bayangkan sebuah program yang memesan sebuah std::array<wchar_t, 50> dan menyalin pesan yang lebih panjang ke dalamnya, menyebabkan teks terpotong dan karakter muncul. ???? pada akhirnya

Setelah mengkompilasi dengan sesuatu seperti:

Perintah: g++ DisplayGreeting.cpp -g -o DisplayGreeting

Anda menjalankan gdbserver terhadap biner tersebut.:

Perintah: gdbserver localhost:1234 DisplayGreeting

Di WinDbg Anda terhubung dengan string gdb:server=localhost,port=1234 Dan, setelah sesi dibuat dan jalur simbol serta font dikonfigurasi, Anda mengatur breakpoint di DisplayGreeting!mainkamu bisa menggunakan dx greeting untuk memeriksa array lokal dan melihat ukurannya (50 posisi), dan secara visual memeriksa di tab memori atau di tampilan variabel bagaimana ucapan tersebut terpotong.

Keindahan contoh ini terletak pada demonstrasinya bahwa, bahkan tanpa dukungan penuh untuk semua format ELF/DWARF di WinDbgAnda dapat menelusuri tumpukan, memeriksa tipe, mengatur titik henti berdasarkan nama fungsi, dan menavigasi kode C++ dengan cukup nyaman menggunakan gdbserver sebagai backend jarak jauh.

Mendebug kernel Linux dengan qemu dan gdb

gdbserver tidak hanya digunakan dalam mode pengguna; ada juga skenario yang sangat ampuh dalam mode kernel.terutama ketika Anda menggabungkan QEMU dengan dukungan debugging. Meskipun di sini peran "gdbserver" dipenuhi oleh opsi QEMU sendiri, pendekatannya identik: satu ujung menjalankan sistem yang akan di-debug dan membuka port gdb; ujung lainnya adalah gdb atau debugger yang berkomunikasi dengan protokol jarak jauh.

Untuk melakukan debugging kernel, Anda perlu mengkompilasinya dengan opsi debugging tertentu.: mengaktifkan pembuatan informasi debugging (CONFIG_DEBUG_INFO), skrip kernel GDB (CONFIG_GDB_SCRIPTS) dan mode debug kernel itu sendiri (CONFIG_DEBUG_KERNELPenting juga untuk menonaktifkan opsi yang menghapus simbol selama proses penautan, seperti "Hapus simbol yang dihasilkan assembler selama penautan".

Setelah kompilasi, Anda akan mendapatkan file biner. vmlinux “tidak dilucuti”yang akan Anda gunakan dari gdb. Anda juga memerlukan initramfs dasar, yang dapat Anda hasilkan dengan perintah seperti:

Perintah: mkinitramfs -o ramdisk.img

Kemudian Anda menjalankan QEMU dengan parameter debugging.Contoh tipikalnya mencakup opsi -gdb tcp::1234 untuk membuka titik akhir jarak jauh yang kompatibel dengan gdb, dan -S sehingga mesin virtual dimulai dalam keadaan terjeda sejak awal. Anda juga menentukan kernel dengan -kernel vmlinux, The -initrd ramdisk.img, ingatan dengan -m 512 dan Anda biasanya mengarahkan konsol ke ttyS0 untuk mengelola segala sesuatu mulai dari terminal.

Dengan QEMU ditahan menunggu gdbDari mesin host, Anda memulai gdb yang mengarah ke vmlinux dan Anda terhubung dengan target remote localhost:1234Dari situ Anda dapat mengatur breakpoint awal, misalnya sebuah hb start_kerneldan mengontrol eksekusi dengan perintah seperti c (lanjutkan) dan CTRL+C untuk menjeda lagi.

Perubahan dan nuansa terkini pada gdb dan gdbserver

Pada distribusi modern seperti Red Hat Enterprise Linux 8, terdapat sejumlah perubahan pada gdb dan gdbserver yang perlu diperhatikan.terutama jika Anda berasal dari versi sebelumnya atau memiliki skrip yang menganalisis output debugger.

Di satu sisi, gdbserver sekarang memulai proses "tingkat bawah" menggunakan shell.Sama seperti gdb, ini memungkinkan perluasan dan substitusi variabel pada baris perintah. Jika karena alasan tertentu Anda perlu menonaktifkan perilaku ini, ada pengaturan khusus yang didokumentasikan di RHEL 8 untuk kembali ke mode sebelumnya.

Beberapa hal juga telah dihapus atau diubah.: dukungan debugging untuk program Java yang dikompilasi dengan gcj, mode kompatibilitas HP-UX XDB, perintah seperti set remotebaud (digantikan oleh set serial baud) atau kompatibilitas dengan format lama tertentu dari stabsSelain itu, penomoran thread tidak lagi bersifat global, tetapi berdasarkan thread "lebih rendah", dan muncul sebagai inferior_num.thread_num, dengan variabel kenyamanan baru seperti $_gthread untuk merujuk pada pengidentifikasi global.

Fitur baru penting lainnya adalah penyesuaian. max-value-sizeIni membatasi jumlah memori yang dapat dialokasikan gdb untuk menampilkan isi suatu nilai. Nilai defaultnya adalah 64 KiB, sehingga upaya untuk mencetak array besar atau struktur masif dapat mengakibatkan peringatan "nilai terlalu besar" alih-alih menampilkan semua memori yang tersedia.

Cara gdb menangani juga telah disesuaikan. sysrootNilai default sekarang adalah target:Ini berarti bahwa untuk proses jarak jauh, sistem akan terlebih dahulu mencoba menemukan pustaka dan simbol pada sistem target. Jika Anda ingin sistem memprioritaskan simbol lokal, Anda harus menjalankan perintah berikut: set sysroot dengan rute yang Anda minati sebelum melakukan target remote.

Mengenai riwayat perintah, variabel lingkungan yang digunakan sekarang adalah GDBHISTSIZE di tempat HISTSIZEIni memungkinkan Anda untuk mengatur dengan tepat berapa lama Anda ingin menyimpan perintah yang telah Anda ketik dalam sesi debugging tanpa mengganggu perilaku aplikasi lain yang menggunakan pustaka pembacaan baris.

Tips alur kerja dan pemecahan masalah dengan gdbserver

Untuk menciptakan alur kerja yang nyaman, ada beberapa pola yang cenderung sangat efektif. Saat mengembangkan perangkat lunak untuk sistem tertanam atau server jarak jauh, langkah pertama adalah mengotomatiskan kompilasi simbol dan penyebaran biner ke target sebanyak mungkin. Dengan cara ini, Anda selalu tahu versi executable mana yang sedang berjalan dan memiliki salinan simbol yang siap tersedia di host.

Di lingkungan dengan banyak core crash, ada baiknya mempelajari cara menggunakan gdb dalam mode batch., dengan bendera seperti --batch, --ex y -x untuk secara otomatis menjalankan perintah pada daftar inti dan memproses jejak baliknya dari skrip (misalnya di Ular sancaIni memungkinkan Anda untuk dengan cepat menyaring masalah yang berulang, mengelompokkan kegagalan berdasarkan jejak tumpukan (stack trace), dan lain sebagainya.

Jika terjadi masalah dengan koneksi jarak jauh, opsi --debug gdbserver adalah sahabat terbaikmuJika Anda memulai, misalnya, server proses dengan:

Perintah: gdbserver --debug --multi localhost:1234

Konsol gdbserver akan menampilkan jejak detail tentang apa yang sedang terjadi. Pada level protokol jarak jauh, ini termasuk paket masuk, kesalahan format, masalah pemutusan koneksi, dll. Ini sangat berguna ketika server gdb Anda tiba-tiba terputus, suatu proses mengalami crash segera setelah breakpoint diatur, atau GUI debug Anda mengirimkan sesuatu yang tidak dipahami oleh gdbserver.

Dalam konteks seperti router TP-Link di mana Anda melampirkan gdbserver ke proses penting seperti httpdCukup umum terjadi bahwa breakpoint tertentu dapat menciptakan kondisi race atau watchdog yang menghentikan proses ketika proses tersebut "terjebak" terlalu lama di debugger. Dalam situasi ini, mungkin perlu untuk menyesuaikan sinyal mana yang diblokir, thread mana yang dikendalikan, dan, jika berlaku, memodifikasi konfigurasi sistem itu sendiri (waktu timeout, watchdog perangkat keras) untuk memungkinkan sesi debugging yang lebih lama.

Penggunaan gdbserver yang baik melibatkan penggabungan beberapa bagian.Kompilasi dengan simbol yang sesuai, pilih gdb yang tepat untuk arsitektur, konfigurasikan jalur simbol dan sumber, pahami dua mode utama gdbserver (proses tunggal dan multi-proses), dan jangan ragu untuk mengambil dari mode tersebut. --debug ketika koneksi tidak berfungsi seperti yang diharapkan. Dengan dasar tersebut, men-debug aplikasi yang berjalan pada sistem Linux jarak jauh, router, atau mesin virtual dengan kernel kustom dari PC Anda menjadi cukup rutin dan, yang terpenting, sangat berguna.