fix-handling-of-extended-tv_sec

   1 From: David Turner <novalis@novalis.org>
   2
   3 ext4: Fix handling of extended tv_sec
   4 In ext4, the bottom two bits of {a,c,m}time_extra are used to extend
   5 the {a,c,m}time fields, deferring the year 2038 problem to the year
   6 2446.
   7
   8 When decoding these extended fields, for times whose bottom 32 bits
   9 would represent a negative number, sign extension causes the 64-bit
  10 extended timestamp to be negative as well, which is not what's
  11 intended.  This patch corrects that issue, so that the only negative
  12 {a,c,m}times are those between 1901 and 1970 (as per 32-bit signed
  13 timestamps).
  14
  15 Some older kernels might have written pre-1970 dates with 1,1 in the
  16 extra bits.  This patch treats those incorrectly-encoded dates as
  17 pre-1970, instead of post-2311, until kernel 4.20 is released.
  18 Hopefully by then e2fsck will have fixed up the bad data.
  19
  20 Also add a comment explaining the encoding of ext4's extra {a,c,m}time
  21 bits.
  22
  23 Signed-off-by: David Turner <novalis@novalis.org>
  24 Signed-off-by: Theodore Ts'o <tytso@mit.edu>
  25 Reported-by: Mark Harris <mh8928@yahoo.com>
  26 Bugzilla: https://bugzilla.kernel.org/show_bug.cgi?id=23732
  27 Cc: stable@vger.kernel.org
  28 ---
  29  fs/ext4/ext4.h | 49 ++++++++++++++++++++++++++++++++++++++++++-------
  30  1 file changed, 42 insertions(+), 7 deletions(-)
  31
  32 diff --git a/fs/ext4/ext4.h b/fs/ext4/ext4.h
  33 index 750063f..fddce29 100644
  34 --- a/fs/ext4/ext4.h
  35 +++ b/fs/ext4/ext4.h
  36 @@ -26,6 +26,7 @@
  37  #include <linux/seqlock.h>
  38  #include <linux/mutex.h>
  39  #include <linux/timer.h>
  40 +#include <linux/version.h>
  41  #include <linux/wait.h>
  42  #include <linux/blockgroup_lock.h>
  43  #include <linux/percpu_counter.h>
  44 @@ -727,19 +728,53 @@ struct move_extent {
  45         <= (EXT4_GOOD_OLD_INODE_SIZE +                  \
  46             (einode)->i_extra_isize))                   \
  47
  48 +/*
  49 + * We use an encoding that preserves the times for extra epoch "00":
  50 + *
  51 + * extra  msb of                         adjust for signed
  52 + * epoch  32-bit                         32-bit tv_sec to
  53 + * bits   time    decoded 64-bit tv_sec  64-bit tv_sec      valid time range
  54 + * 0 0    1    -0x80000000..-0x00000001  0x000000000 1901-12-13..1969-12-31
  55 + * 0 0    0    0x000000000..0x07fffffff  0x000000000 1970-01-01..2038-01-19
  56 + * 0 1    1    0x080000000..0x0ffffffff  0x100000000 2038-01-19..2106-02-07
  57 + * 0 1    0    0x100000000..0x17fffffff  0x100000000 2106-02-07..2174-02-25
  58 + * 1 0    1    0x180000000..0x1ffffffff  0x200000000 2174-02-25..2242-03-16
  59 + * 1 0    0    0x200000000..0x27fffffff  0x200000000 2242-03-16..2310-04-04
  60 + * 1 1    1    0x280000000..0x2ffffffff  0x300000000 2310-04-04..2378-04-22
  61 + * 1 1    0    0x300000000..0x37fffffff  0x300000000 2378-04-22..2446-05-10
  62 + *
  63 + * Note that previous versions of the kernel on 64-bit systems would
  64 + * incorrectly use extra epoch bits 1,1 for dates between 1901 and
  65 + * 1970.  e2fsck will correct this, assuming that it is run on the
  66 + * affected filesystem before 2242.
  67 + */
  68 +
  69  static inline __le32 ext4_encode_extra_time(struct timespec *time)
  70  {
  71 -       return cpu_to_le32((sizeof(time->tv_sec) > 4 ?
  72 -                          (time->tv_sec >> 32) & EXT4_EPOCH_MASK : 0) |
  73 -                          ((time->tv_nsec << EXT4_EPOCH_BITS) & EXT4_NSEC_MASK));
  74 +       u32 extra = sizeof(time->tv_sec) > 4 ?
  75 +               ((time->tv_sec - (s32)time->tv_sec) >> 32) & EXT4_EPOCH_MASK : 0;
  76 +       return cpu_to_le32(extra | (time->tv_nsec << EXT4_EPOCH_BITS));
  77  }
  78
  79  static inline void ext4_decode_extra_time(struct timespec *time, __le32 extra)
  80  {
  81 -       if (sizeof(time->tv_sec) > 4)
  82 -              time->tv_sec |= (__u64)(le32_to_cpu(extra) & EXT4_EPOCH_MASK)
  83 -                              << 32;
  84 -       time->tv_nsec = (le32_to_cpu(extra) & EXT4_NSEC_MASK) >> EXT4_EPOCH_BITS;
  85 +       if (unlikely(sizeof(time->tv_sec) > 4 &&
  86 +                       (extra & cpu_to_le32(EXT4_EPOCH_MASK)))) {
  87 +#if LINUX_VERSION_CODE < KERNEL_VERSION(4,20,0)
  88 +               /* Handle legacy encoding of pre-1970 dates with epoch
  89 +                * bits 1,1.  We assume that by kernel version 4.20,
  90 +                * everyone will have run fsck over the affected
  91 +                * filesystems to correct the problem.
  92 +                */
  93 +               u64 extra_bits = le32_to_cpu(extra) & EXT4_EPOCH_MASK;
  94 +               if (extra_bits == 3)
  95 +                       extra_bits = 0;
  96 +               time->tv_sec += extra_bits << 32;
  97 +#else
  98 +               time->tv_sec += (u64)(le32_to_cpu(extra) & EXT4_EPOCH_MASK) << 32;
  99 +#endif
 100 +       }
 101 +       time->tv_nsec = (le32_to_cpu(extra) & EXT4_NSEC_MASK) >> EXT4_EPOCH_BITS;
 102  }
 103
 104  #define EXT4_INODE_SET_XTIME(xtime, inode, raw_inode)                         \