Donate to e Foundation | Murena handsets with /e/OS | Own a part of Murena! Learn more

Commit a98dc6ae authored by David S. Miller's avatar David S. Miller
Browse files

Merge branch 'net-y2038-safe-socket-timestamps' 



Deepa Dinamani says:

====================
net: y2038-safe socket timestamps

The series introduces new socket timestamps that are
y2038 safe.

The time data types used for the existing socket timestamp
options: SO_TIMESTAMP, SO_TIMESTAMPNS and SO_TIMESTAMPING
are not y2038 safe. The series introduces SO_TIMESTAMP_NEW,
SO_TIMESTAMPNS_NEW and SO_TIMESTAMPING_NEW to replace these.
These new timestamps can be used on all architectures.

The alternative considered was to extend the sys_setsockopt()
by using the flags. We did not receive any strong opinions about
either of the approaches. Hence, this was chosen, as glibc folks
preferred this.

The series does not deal with updating the internal kernel socket
calls like rxrpc to make them y2038 safe. This will be dealt
with separately.

Note that the timestamps behavior already does not match the
man page specific behavior:
SIOCGSTAMP
    This ioctl should only be used if the socket option SO_TIMESTAMP
	is not set on the socket. Otherwise, it returns the timestamp of
	the last packet that was received while SO_TIMESTAMP was not set,
	or it fails if no such packet has been received,
	(i.e., ioctl(2) returns -1 with errno set to ENOENT).

The recommendation is to update the man page to remove the above statement.

The overview of the socket timestamp series is as below:
1. Delete asm specific socket.h when possible.
2. Support SO/SCM_TIMESTAMP* options only in userspace.
3. Rename current SO/SCM_TIMESTAMP* to SO/SCM_TIMESTAMP*_OLD.
3. Alter socket options so that SOCK_RCVTSTAMPNS does
   not rely on SOCK_RCVTSTAMP.
4. Introduce y2038 safe types for socket timestamp.
5. Introduce new y2038 safe socket options SO/SCM_TIMESTAMP*_NEW.
6. Intorduce new y2038 safe socket timeout options.

Changes since v4:
* Fixed the typo in calling sock_get_timeout()

Changes since v3:
* Rebased onto net-next and fixups as per review comments
* Merged the socket timeout series
* Integrated Arnd's patch to simplify compat handling of timeout syscalls

Changes since v2:
* Removed extra functions to reduce diff churn as per code review

Changes since v1:
* Dropped the change to disentangle sock flags
* Renamed sock_timeval to __kernel_sock_timeval
* Updated a few comments
* Added documentation changes
====================

Signed-off-by: default avatarDavid S. Miller <davem@davemloft.net>
parents 3f8cfd0d a9beb86a

Documentation/networking/timestamping.txt

+38 −5
Original line number Diff line number Diff line
@@ -6,11 +6,21 @@ The interfaces for receiving network packages timestamps are: 
* SO_TIMESTAMP

  Generates a timestamp for each incoming packet in (not necessarily

  monotonic) system time. Reports the timestamp via recvmsg() in a

  control message as struct timeval (usec resolution).

  control message in usec resolution.

  SO_TIMESTAMP is defined as SO_TIMESTAMP_NEW or SO_TIMESTAMP_OLD

  based on the architecture type and time_t representation of libc.

  Control message format is in struct __kernel_old_timeval for

  SO_TIMESTAMP_OLD and in struct __kernel_sock_timeval for

  SO_TIMESTAMP_NEW options respectively.



* SO_TIMESTAMPNS

  Same timestamping mechanism as SO_TIMESTAMP, but reports the

  timestamp as struct timespec (nsec resolution).

  timestamp as struct timespec in nsec resolution.

  SO_TIMESTAMPNS is defined as SO_TIMESTAMPNS_NEW or SO_TIMESTAMPNS_OLD

  based on the architecture type and time_t representation of libc.

  Control message format is in struct timespec for SO_TIMESTAMPNS_OLD

  and in struct __kernel_timespec for SO_TIMESTAMPNS_NEW options

  respectively.



* IP_MULTICAST_LOOP + SO_TIMESTAMP[NS]

  Only for multicast:approximate transmit timestamp obtained by
@@ -22,7 +32,7 @@ The interfaces for receiving network packages timestamps are: 
  timestamps for stream sockets.





1.1 SO_TIMESTAMP:

1.1 SO_TIMESTAMP (also SO_TIMESTAMP_OLD and SO_TIMESTAMP_NEW):



This socket option enables timestamping of datagrams on the reception

path. Because the destination socket, if any, is not known early in
@@ -31,15 +41,25 @@ same is true for all early receive timestamp options. 


For interface details, see `man 7 socket`.



Always use SO_TIMESTAMP_NEW timestamp to always get timestamp in

struct __kernel_sock_timeval format.



1.2 SO_TIMESTAMPNS:

SO_TIMESTAMP_OLD returns incorrect timestamps after the year 2038

on 32 bit machines.



1.2 SO_TIMESTAMPNS (also SO_TIMESTAMPNS_OLD and SO_TIMESTAMPNS_NEW):



This option is identical to SO_TIMESTAMP except for the returned data type.

Its struct timespec allows for higher resolution (ns) timestamps than the

timeval of SO_TIMESTAMP (ms).



Always use SO_TIMESTAMPNS_NEW timestamp to always get timestamp in

struct __kernel_timespec format.



SO_TIMESTAMPNS_OLD returns incorrect timestamps after the year 2038

on 32 bit machines.



1.3 SO_TIMESTAMPING:

1.3 SO_TIMESTAMPING (also SO_TIMESTAMPING_OLD and SO_TIMESTAMPING_NEW):



Supports multiple types of timestamp requests. As a result, this

socket option takes a bitmap of flags, not a boolean. In
@@ -323,10 +343,23 @@ SO_TIMESTAMP and SO_TIMESTAMPNS records can be retrieved. 
These timestamps are returned in a control message with cmsg_level

SOL_SOCKET, cmsg_type SCM_TIMESTAMPING, and payload of type



For SO_TIMESTAMPING_OLD:



struct scm_timestamping {

	struct timespec ts[3];

};



For SO_TIMESTAMPING_NEW:



struct scm_timestamping64 {

	struct __kernel_timespec ts[3];



Always use SO_TIMESTAMPING_NEW timestamp to always get timestamp in

struct scm_timestamping64 format.



SO_TIMESTAMPING_OLD returns incorrect timestamps after the year 2038

on 32 bit machines.



The structure can return up to three timestamps. This is a legacy

feature. At least one field is non-zero at any time. Most timestamps

are passed in ts[0]. Hardware timestamps are passed in ts[2].

arch/alpha/include/uapi/asm/socket.h

+38 −9
Original line number Diff line number Diff line
@@ -3,6 +3,7 @@ 
#define _UAPI_ASM_SOCKET_H



#include <asm/sockios.h>

#include <asm/bitsperlong.h>



/* For setsockopt(2) */

/*
@@ -30,8 +31,8 @@ 
#define SO_RCVBUFFORCE	0x100b

#define	SO_RCVLOWAT	0x1010

#define	SO_SNDLOWAT	0x1011

#define	SO_RCVTIMEO	0x1012

#define	SO_SNDTIMEO	0x1013

#define	SO_RCVTIMEO_OLD	0x1012

#define	SO_SNDTIMEO_OLD	0x1013

#define SO_ACCEPTCONN	0x1014

#define SO_PROTOCOL	0x1028

#define SO_DOMAIN	0x1029
@@ -51,13 +52,9 @@ 
#define SO_GET_FILTER		SO_ATTACH_FILTER



#define SO_PEERNAME		28

#define SO_TIMESTAMP		29

#define SCM_TIMESTAMP		SO_TIMESTAMP



#define SO_PEERSEC		30

#define SO_PASSSEC		34

#define SO_TIMESTAMPNS		35

#define SCM_TIMESTAMPNS		SO_TIMESTAMPNS



/* Security levels - as per NRL IPv6 - don't actually do anything */

#define SO_SECURITY_AUTHENTICATION		19
@@ -66,9 +63,6 @@ 


#define SO_MARK			36



#define SO_TIMESTAMPING		37

#define SCM_TIMESTAMPING	SO_TIMESTAMPING



#define SO_RXQ_OVFL             40



#define SO_WIFI_STATUS		41
@@ -117,4 +111,39 @@ 


#define SO_BINDTOIFINDEX	62



#define SO_TIMESTAMP_OLD        29

#define SO_TIMESTAMPNS_OLD      35

#define SO_TIMESTAMPING_OLD     37



#define SO_TIMESTAMP_NEW        63

#define SO_TIMESTAMPNS_NEW      64

#define SO_TIMESTAMPING_NEW     65



#define SO_RCVTIMEO_NEW         66

#define SO_SNDTIMEO_NEW         67



#if !defined(__KERNEL__)



#if __BITS_PER_LONG == 64

#define SO_TIMESTAMP		SO_TIMESTAMP_OLD

#define SO_TIMESTAMPNS		SO_TIMESTAMPNS_OLD

#define SO_TIMESTAMPING         SO_TIMESTAMPING_OLD



#define SO_RCVTIMEO		SO_RCVTIMEO_OLD

#define SO_SNDTIMEO		SO_SNDTIMEO_OLD

#else

#define SO_TIMESTAMP (sizeof(time_t) == sizeof(__kernel_long_t) ? SO_TIMESTAMP_OLD : SO_TIMESTAMP_NEW)

#define SO_TIMESTAMPNS (sizeof(time_t) == sizeof(__kernel_long_t) ? SO_TIMESTAMPNS_OLD : SO_TIMESTAMPNS_NEW)

#define SO_TIMESTAMPING (sizeof(time_t) == sizeof(__kernel_long_t) ? SO_TIMESTAMPING_OLD : SO_TIMESTAMPING_NEW)



#define SO_RCVTIMEO (sizeof(time_t) == sizeof(__kernel_long_t) ? SO_RCVTIMEO_OLD : SO_RCVTIMEO_NEW)

#define SO_SNDTIMEO (sizeof(time_t) == sizeof(__kernel_long_t) ? SO_SNDTIMEO_OLD : SO_SNDTIMEO_NEW)

#endif



#define SCM_TIMESTAMP           SO_TIMESTAMP

#define SCM_TIMESTAMPNS         SO_TIMESTAMPNS

#define SCM_TIMESTAMPING        SO_TIMESTAMPING



#endif



#endif /* _UAPI_ASM_SOCKET_H */

arch/ia64/include/uapi/asm/Kbuild

+1 −0
Original line number Diff line number Diff line
@@ -2,3 +2,4 @@ include include/uapi/asm-generic/Kbuild.asm 


generated-y += unistd_64.h

generic-y += kvm_para.h

generic-y += socket.h

arch/ia64/include/uapi/asm/socket.h

deleted100644 → 0
+0 −122
Original line number Diff line number Diff line 
/* SPDX-License-Identifier: GPL-2.0 WITH Linux-syscall-note */

#ifndef _ASM_IA64_SOCKET_H

#define _ASM_IA64_SOCKET_H



/*

 * Socket related defines.

 *

 * Based on <asm-i386/socket.h>.

 *

 * Modified 1998-2000

 *	David Mosberger-Tang <davidm@hpl.hp.com>, Hewlett-Packard Co

 */



#include <asm/sockios.h>



/* For setsockopt(2) */

#define SOL_SOCKET	1



#define SO_DEBUG	1

#define SO_REUSEADDR	2

#define SO_TYPE		3

#define SO_ERROR	4

#define SO_DONTROUTE	5

#define SO_BROADCAST	6

#define SO_SNDBUF	7

#define SO_RCVBUF	8

#define SO_SNDBUFFORCE	32

#define SO_RCVBUFFORCE	33

#define SO_KEEPALIVE	9

#define SO_OOBINLINE	10

#define SO_NO_CHECK	11

#define SO_PRIORITY	12

#define SO_LINGER	13

#define SO_BSDCOMPAT	14

#define SO_REUSEPORT	15

#define SO_PASSCRED	16

#define SO_PEERCRED	17

#define SO_RCVLOWAT	18

#define SO_SNDLOWAT	19

#define SO_RCVTIMEO	20

#define SO_SNDTIMEO	21



/* Security levels - as per NRL IPv6 - don't actually do anything */

#define SO_SECURITY_AUTHENTICATION		22

#define SO_SECURITY_ENCRYPTION_TRANSPORT	23

#define SO_SECURITY_ENCRYPTION_NETWORK		24



#define SO_BINDTODEVICE		25



/* Socket filtering */

#define SO_ATTACH_FILTER	26

#define SO_DETACH_FILTER	27

#define SO_GET_FILTER		SO_ATTACH_FILTER



#define SO_PEERNAME		28

#define SO_TIMESTAMP		29

#define SCM_TIMESTAMP		SO_TIMESTAMP



#define SO_ACCEPTCONN		30



#define SO_PEERSEC             31

#define SO_PASSSEC		34

#define SO_TIMESTAMPNS		35

#define SCM_TIMESTAMPNS		SO_TIMESTAMPNS



#define SO_MARK			36



#define SO_TIMESTAMPING		37

#define SCM_TIMESTAMPING	SO_TIMESTAMPING



#define SO_PROTOCOL		38

#define SO_DOMAIN		39



#define SO_RXQ_OVFL             40



#define SO_WIFI_STATUS		41

#define SCM_WIFI_STATUS		SO_WIFI_STATUS

#define SO_PEEK_OFF		42



/* Instruct lower device to use last 4-bytes of skb data as FCS */

#define SO_NOFCS		43



#define SO_LOCK_FILTER		44



#define SO_SELECT_ERR_QUEUE	45



#define SO_BUSY_POLL		46



#define SO_MAX_PACING_RATE	47



#define SO_BPF_EXTENSIONS	48



#define SO_INCOMING_CPU		49



#define SO_ATTACH_BPF		50

#define SO_DETACH_BPF		SO_DETACH_FILTER



#define SO_ATTACH_REUSEPORT_CBPF	51

#define SO_ATTACH_REUSEPORT_EBPF	52



#define SO_CNX_ADVICE		53



#define SCM_TIMESTAMPING_OPT_STATS	54



#define SO_MEMINFO		55



#define SO_INCOMING_NAPI_ID	56



#define SO_COOKIE		57



#define SCM_TIMESTAMPING_PKTINFO	58



#define SO_PEERGROUPS		59



#define SO_ZEROCOPY		60



#define SO_TXTIME		61

#define SCM_TXTIME		SO_TXTIME



#define SO_BINDTOIFINDEX	62



#endif /* _ASM_IA64_SOCKET_H */

arch/mips/include/uapi/asm/socket.h

+38 −9
Original line number Diff line number Diff line
@@ -11,6 +11,7 @@ 
#define _UAPI_ASM_SOCKET_H



#include <asm/sockios.h>

#include <asm/bitsperlong.h>



/*

 * For setsockopt(2)
@@ -38,8 +39,8 @@ 
#define SO_RCVBUF	0x1002	/* Receive buffer. */

#define SO_SNDLOWAT	0x1003	/* send low-water mark */

#define SO_RCVLOWAT	0x1004	/* receive low-water mark */

#define SO_SNDTIMEO	0x1005	/* send timeout */

#define SO_RCVTIMEO	0x1006	/* receive timeout */

#define SO_SNDTIMEO_OLD	0x1005	/* send timeout */

#define SO_RCVTIMEO_OLD	0x1006	/* receive timeout */

#define SO_ACCEPTCONN	0x1009

#define SO_PROTOCOL	0x1028	/* protocol type */

#define SO_DOMAIN	0x1029	/* domain/socket family */
@@ -65,21 +66,14 @@ 
#define SO_GET_FILTER		SO_ATTACH_FILTER



#define SO_PEERNAME		28

#define SO_TIMESTAMP		29

#define SCM_TIMESTAMP		SO_TIMESTAMP



#define SO_PEERSEC		30

#define SO_SNDBUFFORCE		31

#define SO_RCVBUFFORCE		33

#define SO_PASSSEC		34

#define SO_TIMESTAMPNS		35

#define SCM_TIMESTAMPNS		SO_TIMESTAMPNS



#define SO_MARK			36



#define SO_TIMESTAMPING		37

#define SCM_TIMESTAMPING	SO_TIMESTAMPING



#define SO_RXQ_OVFL		40



#define SO_WIFI_STATUS		41
@@ -128,4 +122,39 @@ 


#define SO_BINDTOIFINDEX	62



#define SO_TIMESTAMP_OLD        29

#define SO_TIMESTAMPNS_OLD      35

#define SO_TIMESTAMPING_OLD     37



#define SO_TIMESTAMP_NEW        63

#define SO_TIMESTAMPNS_NEW      64

#define SO_TIMESTAMPING_NEW     65



#define SO_RCVTIMEO_NEW         66

#define SO_SNDTIMEO_NEW         67



#if !defined(__KERNEL__)



#if __BITS_PER_LONG == 64

#define SO_TIMESTAMP		SO_TIMESTAMP_OLD

#define SO_TIMESTAMPNS		SO_TIMESTAMPNS_OLD

#define SO_TIMESTAMPING		SO_TIMESTAMPING_OLD



#define SO_RCVTIMEO             SO_RCVTIMEO_OLD

#define SO_SNDTIMEO             SO_SNDTIMEO_OLD

#else

#define SO_TIMESTAMP (sizeof(time_t) == sizeof(__kernel_long_t) ? SO_TIMESTAMP_OLD : SO_TIMESTAMP_NEW)

#define SO_TIMESTAMPNS (sizeof(time_t) == sizeof(__kernel_long_t) ? SO_TIMESTAMPNS_OLD : SO_TIMESTAMPNS_NEW)

#define SO_TIMESTAMPING (sizeof(time_t) == sizeof(__kernel_long_t) ? SO_TIMESTAMPING_OLD : SO_TIMESTAMPING_NEW)



#define SO_RCVTIMEO (sizeof(time_t) == sizeof(__kernel_long_t) ? SO_RCVTIMEO_OLD : SO_RCVTIMEO_NEW)

#define SO_SNDTIMEO (sizeof(time_t) == sizeof(__kernel_long_t) ? SO_SNDTIMEO_OLD : SO_SNDTIMEO_NEW)

#endif



#define SCM_TIMESTAMP           SO_TIMESTAMP

#define SCM_TIMESTAMPNS         SO_TIMESTAMPNS

#define SCM_TIMESTAMPING        SO_TIMESTAMPING



#endif



#endif /* _UAPI_ASM_SOCKET_H */