Opened 13 months ago

Last modified 4 months ago

#32036 new enhancement

output debug logs to logcat as early as possible on Android

Reported by: eighthave Owned by:
Priority: Medium Milestone: Tor: unspecified
Component: Core Tor/Tor Version:
Severity: Normal Keywords: tbb-mobile, Android, 043-deferred, BugSmashFund, 044-deferred
Cc: sisbell Actual Points:
Parent ID: Points: 1
Reviewer: Sponsor:


Now that I have a native TorService working on Android, I'm working on creating an Android-native test suite for it. For some reason, it fails to start there, but it fails quite early, so there is no way to get logs out. --Log debug android is enabled after this issue.

I've gotten earlier log output to logcat by executing add_android_log() at the beginning of options_act_reversible(). Ideally, there would be a way to have this built in. On Android, there is no way to see stderr or stdout from C code executed via JNI. Only from Java code. Yes, this is terrible design, but that's how it seems to be.

Here's one potential solution for redirecting stdout/stderr: Just ignore the part about Android being "basically a UNIX system" because Android is really not UNIX, its a lot more different from UNIX than Windows. Like Windows, it has some familiar UNIXish things.

Child Tickets

Attachments (1)

0001-Override-log_err-log_warn-in-connection-since-stdout.patch (1.2 KB) - added by eighthave 12 months ago.

Download all attachments as: .zip

Change History (13)

comment:1 Changed 13 months ago by eighthave

For a concrete example, my specific case was failing on "Could not bind to Address already in use. Is Tor already running?". Tor was outputting no messages because add_android_log() is executed after Tor binds to the ports. So even moving it a little earlier would be helpful.

comment:2 Changed 13 months ago by eighthave

Here's another example, if the app that includes TorService forgets to set the INTERNET permission, tor will silently fail to start. Here's the error:

              Tor-EARLY  I  Opening Socks listener on
                         W  Socket creation failed: Permission denied
                         I  Opening HTTP tunnel listener on
                         W  Socket creation failed: Permission denied
                         I  Opening Control listener on
                         W  Socket creation failed: Permission denied

comment:3 Changed 12 months ago by eighthave

I dug into syslog on Android. Though syslog works well as a logging mechanism for Android, it suffers from the same issue here, where output to syslog starts after some critical error points.

comment:4 Changed 12 months ago by eighthave

Here's a nice diagram and description of the Android logging system which could be helpful:

comment:5 Changed 12 months ago by eighthave

The attached patch is the workaround we're using to provide error messages to logcat for this early startup stuff.

comment:6 Changed 12 months ago by nickm

Milestone: Tor: 0.4.3.x-final

comment:7 Changed 12 months ago by teor

Keywords: 043-should added

I wonder if we should have a separate layer for control logs (which require the network) and other function-based logs, like syslog, which do not.

But that's a big refactor, so maybe we should provide a way to change the default err log. At the moment, the default err log is a write() to stderr. When the err module is initialised, it can be replaced with stdout. When the log module is initialised, it can be replaced with a file or function.

Is syslog() interrupt-safe on Android?

comment:8 Changed 12 months ago by eighthave

The workings of both logcat and syslog are not really officially documented anywhere, or at least I've never found it. So it seems source code is the way. Android's libc is called Bionic, so that's where the syslog calls come from:

And typical Android, liblog and lgocat source code is somewhere else entirely:

As far as I know, there is never a syslogd running on Android, so I don't understand out the strings get from syslog() to logcat. I imagine it is via /dev/log/* device or something similar.

comment:9 Changed 12 months ago by teor

Keywords: BugSmashFund added
Points: 1

comment:10 Changed 11 months ago by sisbell

Cc: sisbell added

comment:11 Changed 9 months ago by ahf

Keywords: 043-deferred added; 043-should removed
Milestone: Tor: 0.4.3.x-finalTor: 0.4.4.x-final

comment:12 Changed 4 months ago by nickm

Keywords: 044-deferred added
Milestone: Tor: 0.4.4.x-finalTor: unspecified

Bulk-remove tickets from 0.4.4. Add the 044-deferred label to them.

Note: See TracTickets for help on using tickets.