[Toybox] [PATCH] hwclock: just assume /dev/rtc0.

[enh]

(Apologies for the length of this commit message, but it's not entirely
clear how we arrived at our present state, and right now all three of
toybox, busybox, and util-linux differ from each other. And it took a
week of arguments behind the scenes to agree on what we thought was the
right behavior, which seemed worth capturing for posterity.)

This reverts my change ef0546d4f536f42a57af4c32bd37f7fd752d10c2 from
2015. The commit message back then claimed:

    For systems using /dev/rtcN, /dev/rtc0 isn't necessarily the RTC
    that's used to provide the system time at boot time. We need to
    search for the RTC whose /sys/class/rtc/rtcN/hctosys contains "1".

A few things to note here:

1. I can't find any historical motivation for this change. There's no
   bug, there's no internal email thread, and I can't even find anything
   referring to devices using anything other than /dev/rtc0.

2. It turns out (though this wasn't true at the time) that the kernel
   since 4.19 interprets hctosys as the RTC that *did* set the clock,
   not the RTC that *should* set the clock.

3. That's not an academic difference. If you have a cheap RTC that isn't
   battery-backed, or you have an RTC whose battery died, and you're
   using Linux 4.19 or later, you will boot with no RTC having hctosys=1.

4. An actual SoC vendor has hit this in practice.

My original toybox patch appears to be equivalent to code in the Android
frameworks, which -- under the auspices of the SoC vendor's bug --
I'm about to replace with code that checks "/dev/rtc" first, then
"/dev/rtc0", then fails hard. (Strictly, it's this copy of the search
that's causing the SoC vendor issues. AFAIK no-one's using
hwclock/rtcwake except interactively. And even if they are, Android
devices ship with [at least] two copies of toybox, so code/scripts on
the vendor partition will continue to run the vendor copy of toybox they
were developed against, and a newer toybox elsewhere on the system won't
affect them.)

All Android devices (and emulators) available to me at the moment use
/dev/rtc0, but supporting /dev/rtc gives a workaround for anyone who
really insists on using an RTC other than /dev/rtc0. That said, the
Generic Kernel Image (GKI) always assumes /dev/rtc0, so going forward
/dev/rtc0 is always the right choice.

I did consider making toybox hwclock try /dev/rtc, /dev/rtc0, and
/dev/misc/rtc -- and even wrote the code for that first -- but strace
shows that busybox and util-linux's hwclock implementations differ in
the order in which they try these (busybox tries /dev/rtc first,
util-linux tries /dev/rtc0 first). Given that util-linux seems like the
more canonical precedent, trying /dev/rtc0 and then falling back to
/dev/rtc would offer no advantage to Android users (and would seem to be
just another stumbling block in getting everyone to a world where
/dev/rtc0 is "the" system RTC).

Note that rtcwake is unaffected by all this, because the toybox and
util-linux implementations both default to only trying /dev/rtc0 already.

Bug: https://issuetracker.google.com/158051176
---
 toys/other/hwclock.c | 35 +++--------------------------------
 1 file changed, 3 insertions(+), 32 deletions(-)
-------------- next part --------------
A non-text attachment was scrubbed...
Name: 0001-hwclock-just-assume-dev-rtc0.patch
Type: text/x-patch
Size: 5035 bytes
Desc: not available
URL: <http://lists.landley.net/pipermail/toybox-landley.net/attachments/20200611/a7c334ef/attachment-0002.bin>