Add support for Windows on ARM #1502

GustavoLCR · 2021-08-23T08:36:53Z

Your checklist for this pull request

I've read the guidelines for contributing to this repository
I made sure to follow the project's coding style
I've added tests that prove my fix is effective or that my feature works (if possible)
I've updated the documentation and the rizin book with the relevant information (if needed)

Detailed description

Building this requires Meson >= 0.60.1 (mesonbuild/meson@6a1157b)
Fixes building for Windows on ARM
Some fixes for ARM PE binaries
Many fixes for debugging on ARM

Test plan

Manually tested

Closing issues

None

XVilka

There is a new file sys/cross-arm64-windows.txt. I wonder if it make sense to document how to use it/build for the Windows ARM64 in BUILDING.md

librz/debug/p/native/windows/windows_debug.c

librz/bin/p/bin_pe.inc

librz/debug/p/debug_native.c

ret2libc

Just so I can take a bit of time for manual testing as well on my systems :)

XVilka

"cl" "-Ilibrz/debug\rz_debug.dll.p" "-I." "-I.." "-I..\librz\include" "-I..\librz\bin\format\elf" "-I..\shlr\qnx\include" "-I..\shlr\gdb\include" "-I..\shlr\gdb\include\gdbclient" "-I..\shlr\gdb\include\gdbserver" "-I..\shlr\bochs\include" "-I..\shlr\winkd" "-Isubprojects\sdb" "-I..\subprojects\sdb" "-Isubprojects\sdb\src" "-I..\subprojects\sdb\src" "-I..\librz\analysis\arch\gb" "-I..\librz\analysis\arch\hexagon" "-I..\shlr\w32dbg_wrap\include" "/MD" "/nologo" "/showIncludes" "/W2" "/O2" "/Gw" "-DRZ_PLUGIN_INCORE=1" "/Fdlibrz/debug\rz_debug.dll.p\p_debug_gdb.c.pdb" /Folibrz/debug/rz_debug.dll.p/p_debug_gdb.c.obj "/c" ../librz/debug/p/debug_gdb.c
D:\a\rizin\rizin\librz\debug\p\native\bt/windows-all.c(82): error C2065: 'IMAGE_FILE_MACHINE_i386': undeclared identifier

One more thing. This pull request combines both fixes for analysis (and PE binary parsing) and debugger. I suggest to extract the analysis fix to the separate PR and add a new test for it. Then we can include this analysis fix into 0.3.0, while ARM debugger has to wait for 0.4.0, ok? cc @ret2libc

XVilka · 2021-08-24T06:02:25Z

In theory it shouldn't be affected by your code, but it only happens in your branch only (I saw it even before the PR, it appears quite consistently), see:

[XX] C:\projects\rizin\test\db\tools\rz_ax rz-ax -t "1234567890 GMT-1"
ANSICON=1 RZ_NOPLUGINS=1 rizin -escr.utf8=0 -escr.color=0 -escr.interactive=0 -N -Qc '!rz-ax -t "1234567890 GMT-1" | cut -d " " -f 1,2' =
-- stdout
--- expected
+++ actual
@@ -1,1 +1,1 @@
-Fri Feb
+Mon Aug

I guess it's either timezone problem or something unitialized. Might be related to #982 (comment)

* Fix usage of reserved function name on ARM * Fix architecture dependent `CONTEXT` fields access

* Fix breakpoint behavior on windows on ARM * Fix register profile when debugging * Remove `drx` error message if not supported * Add support for hardware breakpoints * Disable support for hardware single-stepping

* Consider link register as destination for return instructions

XVilka · 2021-11-18T09:44:38Z

librz/include/rz_types.h

@@ -497,16 +497,26 @@ static inline void *rz_new_copy(int size, void *data) {
 #endif
 #else
 #ifdef _MSC_VER
-#ifdef _WIN64
+#if defined(_M_X64) || defined(_M_AMD64)
 #define RZ_SYS_ARCH   "x86"
 #define RZ_SYS_BITS   (RZ_SYS_BITS_32 | RZ_SYS_BITS_64)
 #define RZ_SYS_ENDIAN 0


I think Meson could get endian value from .endian() function, see:

https://mesonbuild.com/Reference-tables.html#cpu-families
cc @ret2libc
Maybe we should drop those and use it instead.

It could be done in a separate PR though, obviously.

XVilka

Code looks OK.
Tested on Windows 10 x86_64 - debugging and heap parsing works fine.

@yossizap could you please confirm if these changes are fine?

* Support building for Windows on ARM * Fix usage of reserved function name on ARM * Fix architecture dependent `CONTEXT` fields access * Fixes for debugging on Windows on ARM * Fix breakpoint behavior on windows on ARM * Fix register profile when debugging * Remove `drx` error message if not supported * Add support for hardware breakpoints * Disable support for hardware single-stepping * Fix Windows Message breakpoints on ARM * Fix software single-stepping on return instruction on ARM * Consider link register as destination for return instructions * Fix setting debug bits to 16 * Rename `r12` to `ip` for windows arm register profile * Remove debug bits hardcoding on windows * Add 32bit registers to Windows ARM64 register profile * Fix software step breakpoint alignment when entering thumb mode * Define `RZ_TEST_ARCH` for `arm` and `arm64` * Use `StackWalk64` API for backtracing on Windows * Fix software single-stepping ARM in thumb mode * Sync `asm.bits` with debugger * Cleanup windows_debug.c * Add SPDX for cross-arm64-windows.txt * Add floating point control register flags * Fix Windows Arm register profile alignment * Keep `drx` warning

GustavoLCR requested review from kazarmy, ret2libc, thestr4ng3r, wargio, XVilka and yossizap as code owners August 23, 2021 08:36

github-actions bot added command rz-test RzAnalysis RzBin RzDebug visual labels Aug 23, 2021

GustavoLCR force-pushed the windows-on-arm branch from 4e0297e to 48407c8 Compare August 23, 2021 08:39

XVilka added this to the 0.3.0 milestone Aug 23, 2021

XVilka requested changes Aug 23, 2021

View reviewed changes

librz/debug/p/native/windows/windows_debug.c Outdated Show resolved Hide resolved

This comment has been minimized.

Sign in to view

wargio reviewed Aug 23, 2021

View reviewed changes

librz/bin/p/bin_pe.inc Outdated Show resolved Hide resolved

wargio reviewed Aug 23, 2021

View reviewed changes

librz/debug/p/debug_native.c Outdated Show resolved Hide resolved

ret2libc requested changes Aug 23, 2021

View reviewed changes

XVilka changed the title ~~Add support for Windows on Arm~~ Add support for Windows on ARM Aug 23, 2021

XVilka added port Support for various OS and environments Windows ARM labels Aug 23, 2021

ret2libc modified the milestones: 0.3.0, 0.4.0 Aug 23, 2021

GustavoLCR force-pushed the windows-on-arm branch from 48407c8 to 6807150 Compare August 24, 2021 02:40

XVilka requested changes Aug 24, 2021

View reviewed changes

GustavoLCR force-pushed the windows-on-arm branch from 6807150 to 3ec5678 Compare August 24, 2021 05:18

GustavoLCR force-pushed the windows-on-arm branch from 3ec5678 to 98e007a Compare August 25, 2021 01:45

GustavoLCR added 18 commits November 17, 2021 23:13

Support building for Windows on ARM

a1f8c84

* Fix usage of reserved function name on ARM * Fix architecture dependent `CONTEXT` fields access

Fixes for debugging on Windows on ARM

9009fd0

* Fix breakpoint behavior on windows on ARM * Fix register profile when debugging * Remove `drx` error message if not supported * Add support for hardware breakpoints * Disable support for hardware single-stepping

Fix Windows Message breakpoints on ARM

78ba1c1

Fix software single-stepping on return instruction on ARM

ab50ea0

* Consider link register as destination for return instructions

Fix setting debug bits to 16

228c49e

Rename r12 to ip for windows arm register profile

27761a0

Remove debug bits hardcoding on windows

805cdaa

Add 32bit registers to Windows ARM64 register profile

0cc5052

Fix software step breakpoint alignment when entering thumb mode

3277345

Define RZ_TEST_ARCH for arm and arm64

b01d05c

Use StackWalk64 API for backtracing on Windows

abf4e53

Fix software single-stepping ARM in thumb mode

a65f94e

Sync asm.bits with debugger

229f2f6

Cleanup windows_debug.c

ed9009c

Add SPDX for cross-arm64-windows.txt

c9eac9b

Add floating point control register flags

d14557a

Fix Windows Arm register profile alignment

083e543

Keep drx warning

472d9b8

GustavoLCR force-pushed the windows-on-arm branch from eea1ad2 to 472d9b8 Compare November 18, 2021 02:22

github-actions bot added the RzCore label Nov 18, 2021

XVilka reviewed Nov 18, 2021

View reviewed changes

XVilka approved these changes Nov 18, 2021

View reviewed changes

XVilka requested review from ret2libc, wargio and yossizap November 19, 2021 01:59

wargio approved these changes Nov 24, 2021

View reviewed changes

Merge branch 'dev' into windows-on-arm

f4937d5

XVilka merged commit 53a7694 into dev Nov 24, 2021

XVilka deleted the windows-on-arm branch November 24, 2021 12:13

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add support for Windows on ARM #1502

Add support for Windows on ARM #1502

GustavoLCR commented Aug 23, 2021 •

edited by XVilka

Loading

XVilka left a comment

This comment has been minimized.

ret2libc left a comment

XVilka left a comment •

edited

Loading

XVilka commented Aug 24, 2021

XVilka Nov 18, 2021 •

edited

Loading

XVilka Nov 24, 2021

XVilka left a comment •

edited

Loading

Add support for Windows on ARM #1502

Add support for Windows on ARM #1502

Conversation

GustavoLCR commented Aug 23, 2021 • edited by XVilka Loading

XVilka left a comment

Choose a reason for hiding this comment

This comment has been minimized.

ret2libc left a comment

Choose a reason for hiding this comment

XVilka left a comment • edited Loading

Choose a reason for hiding this comment

XVilka commented Aug 24, 2021

XVilka Nov 18, 2021 • edited Loading

Choose a reason for hiding this comment

XVilka Nov 24, 2021

Choose a reason for hiding this comment

XVilka left a comment • edited Loading

Choose a reason for hiding this comment

GustavoLCR commented Aug 23, 2021 •

edited by XVilka

Loading

XVilka left a comment •

edited

Loading

XVilka Nov 18, 2021 •

edited

Loading

XVilka left a comment •

edited

Loading