staging/lustre: tracefile: document seconds overflow

The lustre tracefile has a timestamp defined as

       __u32 ph_sec;
       __u64 ph_usec;

which seems completely backwards, as the microsecond portion of
a time stamp will always fit into a __u32 value, while the second
portion will overflow in 2038 or 2106 (in case of unsigned seconds).

Changing this would unfortunately change the format in an incompatible
way, breaking all existing user space tools that access the data.

This uses ktime_get_real_ts64() to replace the insufficient
do_gettimeofday() and then truncates the seconds portion to
an u32 type, along with comments to explain the result.

A possible alternative would be the use of ktime_get_ts64() to
read a monotonic timestamp that never overflows, but this would
trigger a check in user space 'hdr->ph_sec < (1 << 30)' that
attempts to ensure that the values are within a reasonable range.

Signed-off-by: Arnd Bergmann <arnd@arndb.de>
Signed-off-by: Oleg Drokin <green@linuxhacker.ru>
Signed-off-by: Greg Kroah-Hartman <gregkh@linuxfoundation.org>

diff --git a/drivers/staging/lustre/include/linux/libcfs/libcfs_debug.h b/drivers/staging/lustre/include/linux/libcfs/libcfs_debug.h
index a3aa644154e24a578b84d125d26e811479656f2b..a1787bb43483b113632a7daa833cc5dd6a9b93df 100644 (file)
--- a/drivers/staging/lustre/include/linux/libcfs/libcfs_debug.h
+++ b/drivers/staging/lustre/include/linux/libcfs/libcfs_debug.h
@@ -73,6 +73,7 @@ struct ptldebug_header {
        __u32 ph_mask;
        __u16 ph_cpu_id;
        __u16 ph_type;
+       /* time_t overflow in 2106 */
        __u32 ph_sec;
        __u64 ph_usec;
        __u32 ph_stack;

diff --git a/drivers/staging/lustre/lustre/libcfs/linux/linux-tracefile.c b/drivers/staging/lustre/lustre/libcfs/linux/linux-tracefile.c
index 87d844953522a762939a6753a961e240d58e10b7..64a136cd503db28a0ca22cfc7bcf69fa2e5c4572 100644 (file)
--- a/drivers/staging/lustre/lustre/libcfs/linux/linux-tracefile.c
+++ b/drivers/staging/lustre/lustre/libcfs/linux/linux-tracefile.c
@@ -191,16 +191,18 @@ cfs_set_ptldebug_header(struct ptldebug_header *header,
                        struct libcfs_debug_msg_data *msgdata,
                        unsigned long stack)
 {
-       struct timeval tv;
+       struct timespec64 ts;
 
-       do_gettimeofday(&tv);
+       ktime_get_real_ts64(&ts);
 
        header->ph_subsys = msgdata->msg_subsys;
        header->ph_mask = msgdata->msg_mask;
        header->ph_cpu_id = smp_processor_id();
        header->ph_type = cfs_trace_buf_idx_get();
-       header->ph_sec = (__u32)tv.tv_sec;
-       header->ph_usec = tv.tv_usec;
+       /* y2038 safe since all user space treats this as unsigned, but
+        * will overflow in 2106 */
+       header->ph_sec = (u32)ts.tv_sec;
+       header->ph_usec = ts.tv_nsec / NSEC_PER_USEC;
        header->ph_stack = stack;
        header->ph_pid = current->pid;
        header->ph_line_num = msgdata->msg_line;