WebSocket based debugger interface #10909

unknownbrackets · 2018-04-13T05:39:02Z

If you want to try it:

Run this build on your device (Android / iOS / desktop / whatever.)
Enable Settings -> Tools -> Developer tools -> Allow remote debugger.
Go here: http://ppsspp-debugger.unknownbrackets.org/

Alternatively (only logs, no debugger):
Copy this into an HTML file (desktop, whatever): https://gist.github.com/unknownbrackets/385c01ca12a5ac22071f688e84c39ba3 (possibly PPSSPP could embed its own default HTML...)
Open the HTML file in a web browser and play a game: watch the logs roll in.

This is just a thrown-together example and of course command line, lua, whatever could be used to speak to this WebSocket (a list of WebSocket libraries.) I'm planning a simple JSON API.

The debugger would also work fine in a Chrome tab on the device (assuming a mobile friendly debugger UI...) as long as PPSSPP is not quit (which might become the case on iOS...)

Update json Switch json to gason, include json writer in build #10960
Fix debugger threading Improve debugger threadsafety and consistency #10987
IPv6 support Enable IPv6 for reporting / sharing / etc. #11004
Include armips everywhere Include armips assembler in build #11093
Breakpoints on ARM Enable debugger / breakpoints / stepping on ARM / ARM64 #11148
Remove Qt debugger Remove Qt debugger #11130
WebSocket / separated webserver Move internal webserver to Core, add WebSocket stuff #11152
Rebase this (possibly merge some small commits together after rebase)

-[Unknown]

hrydgard · 2018-04-13T07:32:29Z

UI/RemoteISOScreen.cpp

@@ -161,6 +162,10 @@ static void ExecuteServer() {
 		http->RegisterHandler(pair.first.c_str(), handler);
 	}

+	// TODO: This isn't an ideal place to put this... should separate.
+	// But kinda nice to only have it listen on one port?


Yeah, I think this is fine really.

Cool. Thinking of moving it to Core/WebServer.cpp or something, and sending flags to it to restart with remote iso / debugger enabled.

-[Unknown]

hrydgard · 2018-04-13T07:36:10Z

Really cool stuff!

Regarding JSON serializer, we have a simple writer in ext/native/json_writer and a (different) reader in ext/native/ext/vjson. Might be worth using a proper one if we're gonna write a lot of different structs to json though, but I don't know much about which the best one today might be.

Same thing with React etc, not a frontend guy :)

unknownbrackets · 2018-04-14T16:09:34Z

Okay, just using that json_writer then (totally forgot it existed.) I think it will work fine.

Not sure if anyone else has opinions on frontend or where to source them - ideally this would make hacking, translation, cheat, whatever tools more accessible.

-[Unknown]

unknownbrackets · 2018-04-15T18:54:57Z

Went ahead and switched from vjson to gason (newer from same author.) Otherwise, vjson would parse 32-bit unsigned integer parameters as either truncated ints or floats.

-[Unknown]

hrydgard · 2018-04-15T19:34:27Z

Yeah, gason seems fine. Good stuff. And thanks for fixing stupid bugs in that old json writer, heh.

weituotian · 2018-04-16T14:09:12Z

Really cool stuff!

if it is allow, i want Memory::base;╰(￣▽￣)╮

unknownbrackets · 2018-04-16T14:34:45Z

I'm planning to have memory APIs: read, write, disasm, assemble, and memory breakpoint management.

Are you asking for an API to return the C++ address in Memory::base? Guess I can add that (although it'll only be useful on some platforms, I think.)

-[Unknown]

unknownbrackets · 2018-04-30T06:04:54Z

Just a note: at this point the branch supports other platforms (Linux, Android, etc.) but there's no breakpoint support on ARM. That means you can only step into and step HLE on ARM devices at the moment. Actually, I suppose it probably works if you use IR.

It also exposes Memory.base for all your cheat searching needs.

-[Unknown]

unknownbrackets · 2018-05-01T00:50:00Z

Okay, I've published a somewhat functional debugger UI here:

http://ppsspp-debugger.unknownbrackets.org/

As noted above, x86 only for any breakpointing / step over / step out / etc. You'll need to compile the latest branch here.

-[Unknown]

unknownbrackets · 2018-05-02T06:01:51Z

Now arm64 has breakpoints. Didn't test memory breakpoints yet, but hopefully they work....

-[Unknown]

This way we can switch context.

Lumping function symbols in here too, they're pretty related...

Ideally get rid of the memory lock...

And now step over/out/into can tie to the correct thread.

These happen on bytes that are not actually code.

unknownbrackets · 2018-06-08T14:03:10Z

Yep, rebased. I haven't tested these changes with GCC 8 either, though.

-[Unknown]

hrydgard · 2018-06-08T14:36:09Z

Well, I guess there will be enough platforms that we can bisect on either way :)

I'll give this a quick read through a little later and then probably merge. Actually, your pull request says "Not ready for merge" still?

hrydgard · 2018-06-09T19:16:50Z

@unknownbrackets I'm fine with this. Again, it says "Not ready for merge" in the pull request, so should I or not? :) If you're ready you can go ahead.

unknownbrackets · 2018-06-09T19:37:03Z

Oops, thanks for checking - forgot to remove it from there.

-[Unknown]

Leopard20 · 2018-06-09T20:03:12Z

@unknownbrackets Finally! Let's check this out! :)

Edit: Shoot! Build isn't done yet! 😅

Leopard20 · 2018-06-09T20:26:51Z

@unknownbrackets So...how do I make this work on Android again? I enabled Allow Remote Debugging but when I go to the mentioned site it says it can't connect to PPSSPP. 🤔
Also, is there a way to access the address directly from within the app? Like clicking on it to open the browser to that address or something?

unknownbrackets · 2018-06-09T20:36:57Z

Hm. That's all that should be needed. Specifically:

Make sure both devices are connected to the same wifi and use NAT (e.g. you have local IPs like 10.x.x.x or 192.168.x.x or 172.16.x.x.)
Make sure Allow Remote Debugging is checked on the device you want to debug (e.g. Android.)
While PPSSPP is running (doesn't need to be in a game yet), open http://ppsspp-debugger.unknownbrackets.org/.

IMPORTANT: https://ppsspp-debugger.unknownbrackets.org/ will not work. It unfortunately CANNOT be SSL because the emulator itself doesn't (and can't really) have a valid SSL certificate.

If this doesn't work, you can try looking at the IP and port your device is using (it can be seen under Tools -> Remote Disc Streaming -> Settings) and type it manually. If you go to http://192.x.x.x:zzzz/ in your browser it should also show a text file with at least one line "/debugger".

If you can't access the ip:port from your PC browser, then it could mean something is blocking the connection (either not the same wifi, or your device has a firewall on it - most Androids don't.) If you can, but the debugger doesn't work, it probably means a bug...

-[Unknown]

unknownbrackets · 2018-06-09T21:57:57Z

Just wondering - did that help?

Also, I've outlined the missing features for the web debugger UI here:
https://github.com/unknownbrackets/ppsspp-debugger/projects

-[Unknown]

hrydgard · 2018-06-09T23:29:31Z

Confirming that it works fine on Android for me if I have the device and the debugger on the same network. If it matters, whatismyip shows only a IPv4 address for me where I am now.

unknownbrackets · 2018-06-10T00:33:37Z

Ah, yes, it might be a little restrictive for ipv6 currently. It currently assumes the devices will be on the same /64 or "ipv6 subnet", which is commonly the case.

Your internet provider may give you an entire /56, but usually your router will assign IPs within a single /64 ipv6 subnet even so. If the router ends up assigning IPs more liberally and your mobile device and desktop are in entirely different subnets, then the automatic IP detection won't work.

-[Unknown]

Leopard20 · 2018-06-10T08:04:16Z

Derp, forgot about my phone firewall! Now it works! Thanks!

anr2me · 2021-10-23T08:06:13Z

Remote debugging seems to have a low chance to get connected :(
I've been trying to get it connected to "ws://192.168.8.100" by clicking the "Connect Automatically" on many attempts, but can only succeed twice.
And sometimes it gets disconnected by it self while i'm watching the logs from a game.

Or may be it takes a long time for Remote debugging to be ready to accept the connection? like within a minute or two may be?

Btw, i wished i can resize the Log window so i can get better view with many rows visible :)

unknownbrackets · 2021-10-23T14:36:23Z

If you're using multiple instances, which I'd guess you probably are, that may be impacting it.

"Connect automatically" looks up what IPs and ports have registered with your public IP, and tries to connect to them. But if you use multiple instances, it's probably rotating the port setting for each new instance, and might be causing a bunch of noise.

There's no need to type anything when using connect automatically. If you know your address and the port it's listening on, you can type "ws://192.168.8.100:12345" and connect manually. That field is only used when connecting manually, and must include the port.

I've only had it disconnect on me midway when something crashes or gets disconnected from the network.

-[Unknown]

anr2me · 2021-10-23T17:45:05Z

If you're using multiple instances, which I'd guess you probably are, that may be impacting it.

Nope, i was using one instance on PC and another on Android, and using it to get Android logs (only the one on Android have Remote debugging enabled), in the end i went back to using logcat since the connection is more stable (but the timestamp on Android logcat seems to be delayed by 1 second compared to the timestamp on Windows Logs, which can be confusing to compare)

"Connect automatically" looks up what IPs and ports have registered with your public IP, and tries to connect to them. But if you use multiple instances, it's probably rotating the port setting for each new instance, and might be causing a bunch of noise.

Ah, i didn't know "automatic" uses the public IP

There's no need to type anything when using connect automatically. If you know your address and the port it's listening on, you can type "ws://192.168.8.100:12345" and connect manually. That field is only used when connecting manually, and must include the port.

Since it wasn't clearly stated which port it was using (i assume "ws://" itself identify the port) thus i didn't include the port, so that is probably why the "Connect Manually" never worked, is it supposed to be port 12345?

unknownbrackets · 2021-10-23T20:32:19Z

The port is shown under the remote disc streaming settings, but it's generated dynamically, it's not a fixed port.

-[Unknown]

unknownbrackets added this to the v1.7.0 milestone Apr 13, 2018

unknownbrackets force-pushed the debugger branch from bb5bc71 to 66d53f7 Compare April 13, 2018 06:04

hrydgard reviewed Apr 13, 2018

View reviewed changes

unknownbrackets force-pushed the debugger branch from 653ae78 to 409d5b9 Compare April 14, 2018 15:57

This was referenced Apr 14, 2018

is there a ppsspp sdk to read ppsspp user memory? #9952

Closed

[Request] Trace Log Implementation #7389

Closed

unknownbrackets force-pushed the debugger branch 2 times, most recently from 0810d0f to 6ba4668 Compare April 15, 2018 18:52

unknownbrackets force-pushed the debugger branch from 6ba4668 to 5741066 Compare April 15, 2018 19:07

unknownbrackets mentioned this pull request Apr 24, 2018

Switch json to gason, include json writer in build #10960

Merged

unknownbrackets force-pushed the debugger branch 2 times, most recently from c3891d7 to 07811ec Compare April 24, 2018 21:12

unknownbrackets mentioned this pull request Apr 29, 2018

Improve debugger threadsafety and consistency #10987

Merged

unknownbrackets force-pushed the debugger branch 3 times, most recently from 02b238f to 3f45dcc Compare April 30, 2018 06:02

unknownbrackets force-pushed the debugger branch from d07ce7c to 70a32f2 Compare May 2, 2018 06:01

unknownbrackets force-pushed the debugger branch from 7273081 to 7e788f2 Compare May 5, 2018 06:06

This was referenced May 5, 2018

preliminary port to WiiU. #11001

Draft

Enable IPv6 for reporting / sharing / etc. #11004

Merged

unknownbrackets force-pushed the debugger branch from 7e788f2 to aaa4e93 Compare May 7, 2018 04:36

unknownbrackets added 7 commits June 8, 2018 06:59

Debugger: Add debug interfaces for threads.

5670fc0

This way we can switch context.

Debugger: Add HLE API funcs.

5bfba9b

Lumping function symbols in here too, they're pretty related...

Debugger: Avoid some lock ordering issues.

b828497

Ideally get rid of the memory lock...

Debugger: Allow stepping based on thread.

a863ce7

Debugger: Allow conditions on threadID/moduleID.

b114656

And now step over/out/into can tie to the correct thread.

Debugger: Add func name and data symbol to disasm.

25085fa

Debugger: Ignore invalid branches.

085bcde

These happen on bytes that are not actually code.

unknownbrackets force-pushed the debugger branch from 0eab4c2 to 085bcde Compare June 8, 2018 13:59

hrydgard approved these changes Jun 9, 2018

View reviewed changes

unknownbrackets merged commit 9d96e65 into hrydgard:master Jun 9, 2018

unknownbrackets deleted the debugger branch June 9, 2018 19:37

unknownbrackets mentioned this pull request Jun 9, 2018

Discussing Breakpoint improvements #4158

Closed

unknownbrackets mentioned this pull request Jun 21, 2018

MacOS build lacks debugger #11199

Closed

unknownbrackets mentioned this pull request Oct 23, 2018

Update README.md for 1.7.0 #11487

Merged

Davidcard22 mentioned this pull request Jan 14, 2021

phantasy star portable 2 infinity - strange framerate drops #13914

Open

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

WebSocket based debugger interface #10909

WebSocket based debugger interface #10909

unknownbrackets commented Apr 13, 2018 •

edited

Loading

hrydgard Apr 13, 2018

unknownbrackets Apr 14, 2018

hrydgard commented Apr 13, 2018

unknownbrackets commented Apr 14, 2018

unknownbrackets commented Apr 15, 2018

hrydgard commented Apr 15, 2018 •

edited

Loading

weituotian commented Apr 16, 2018

unknownbrackets commented Apr 16, 2018

unknownbrackets commented Apr 30, 2018 •

edited

Loading

unknownbrackets commented May 1, 2018

unknownbrackets commented May 2, 2018

unknownbrackets commented Jun 8, 2018

hrydgard commented Jun 8, 2018 •

edited

Loading

hrydgard commented Jun 9, 2018

unknownbrackets commented Jun 9, 2018

Leopard20 commented Jun 9, 2018 •

edited

Loading

Leopard20 commented Jun 9, 2018 •

edited

Loading

unknownbrackets commented Jun 9, 2018

unknownbrackets commented Jun 9, 2018

hrydgard commented Jun 9, 2018

unknownbrackets commented Jun 10, 2018

Leopard20 commented Jun 10, 2018 •

edited

Loading

anr2me commented Oct 23, 2021 •

edited

Loading

unknownbrackets commented Oct 23, 2021

anr2me commented Oct 23, 2021 •

edited

Loading

unknownbrackets commented Oct 23, 2021

WebSocket based debugger interface #10909

WebSocket based debugger interface #10909

Conversation

unknownbrackets commented Apr 13, 2018 • edited Loading

hrydgard Apr 13, 2018

Choose a reason for hiding this comment

unknownbrackets Apr 14, 2018

Choose a reason for hiding this comment

hrydgard commented Apr 13, 2018

unknownbrackets commented Apr 14, 2018

unknownbrackets commented Apr 15, 2018

hrydgard commented Apr 15, 2018 • edited Loading

weituotian commented Apr 16, 2018

unknownbrackets commented Apr 16, 2018

unknownbrackets commented Apr 30, 2018 • edited Loading

unknownbrackets commented May 1, 2018

unknownbrackets commented May 2, 2018

unknownbrackets commented Jun 8, 2018

hrydgard commented Jun 8, 2018 • edited Loading

hrydgard commented Jun 9, 2018

unknownbrackets commented Jun 9, 2018

Leopard20 commented Jun 9, 2018 • edited Loading

Leopard20 commented Jun 9, 2018 • edited Loading

unknownbrackets commented Jun 9, 2018

unknownbrackets commented Jun 9, 2018

hrydgard commented Jun 9, 2018

unknownbrackets commented Jun 10, 2018

Leopard20 commented Jun 10, 2018 • edited Loading

anr2me commented Oct 23, 2021 • edited Loading

unknownbrackets commented Oct 23, 2021

anr2me commented Oct 23, 2021 • edited Loading

unknownbrackets commented Oct 23, 2021

unknownbrackets commented Apr 13, 2018 •

edited

Loading

hrydgard commented Apr 15, 2018 •

edited

Loading

unknownbrackets commented Apr 30, 2018 •

edited

Loading

hrydgard commented Jun 8, 2018 •

edited

Loading

Leopard20 commented Jun 9, 2018 •

edited

Loading

Leopard20 commented Jun 9, 2018 •

edited

Loading

Leopard20 commented Jun 10, 2018 •

edited

Loading

anr2me commented Oct 23, 2021 •

edited

Loading

anr2me commented Oct 23, 2021 •

edited

Loading