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

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

Merge branch 'net-extend-socket-timestamping-API' 



Miroslav Lichvar says:

====================
Extend socket timestamping API

Changes v5->v6:
- fixed skb_is_swtx_tstamp() when OPT_TX_SWHW is disabled and improved
  its description
- improved OPT_PKTINFO documentation
- improved scm_timestamping documentation

Changes v4->v5:
- fixed initialization of reserved fields in struct scm_ts_pktinfo

Changes v3->v4:
- added reserved fields to struct scm_ts_pktinfo
- replaced patch fixing false SW timestamps with a documentation fix
- updated OPT_TX_SWHW patch to handle false SW timestamps

Changes v2->v3:
- modified struct scm_ts_pktinfo to use fixed-width integer types
- added WARN_ON_ONCE for missing RCU lock in dev_get_by_napi_id()
- modified dev_get_by_napi_id() to not return dev in unexpected branch
- modified recv to return SCM_TIMESTAMPING_PKTINFO even if the interface
  index is unknown

Changes v1->v2:
- added separate patch for new NAPI functions
- split code from __sock_recv_timestamp() for better readability
- fixed RCU locking
- fixed compiler warning (missing case in switch in first patch)
- inline sw_tx_timestamp() in its only user

Changes RFC->v1:
- reworked SOF_TIMESTAMPING_OPT_PKTINFO patch to not add new fields to
  skb shared info (net device is now looked up by napi_id), not require
  any changes in drivers, and restrict the cmsg to incoming packets
- renamed SOF_TIMESTAMPING_OPT_MULTIMSG to SOF_TIMESTAMPING_OPT_TX_SWHW
  and fixed its description
- moved struct scm_ts_pktinfo from errqueue.h to net_tstamp.h as it
  can't be received from the error queue anymore
- improved commit descriptions and removed incorrect comment

This patchset adds new options to the timestamping API that will be
useful for NTP implementations and possibly other applications.

The first patch specifies a timestamp filter for NTP packets. The second
patch updates drivers that can timestamp all packets, or need to list
the filter as unsupported. There is no attempt to add the support to the
phyter driver.

The third patch adds two helper functions working with NAPI ID, which is
needed by the next patch. The fourth patch adds a new option to get a
new control message with the L2 length and interface index for incoming
packets with hardware timestamps.

The fifth patch fixes documentation on number of non-zero fields in
scm_timestamping and warns about false software timestamps when
SO_TIMESTAMP(NS) is combined with SCM_TIMESTAMPING.

The sixth patch adds a new option to request both software and hardware
timestamps for outgoing packets. The seventh patch updates drivers that
assumed software timestamping cannot be used together with hardware
timestamping.

The patches have been tested on x86_64 machines with igb and e1000e
drivers.
====================

Signed-off-by: default avatarDavid S. Miller <davem@davemloft.net>
parents 2061ec3f 74abc9b1

Documentation/networking/timestamping.txt

+25 −1
Original line number Diff line number Diff line
@@ -193,6 +193,24 @@ SOF_TIMESTAMPING_OPT_STATS: 
  the transmit timestamps, such as how long a certain block of

  data was limited by peer's receiver window.



SOF_TIMESTAMPING_OPT_PKTINFO:



  Enable the SCM_TIMESTAMPING_PKTINFO control message for incoming

  packets with hardware timestamps. The message contains struct

  scm_ts_pktinfo, which supplies the index of the real interface which

  received the packet and its length at layer 2. A valid (non-zero)

  interface index will be returned only if CONFIG_NET_RX_BUSY_POLL is

  enabled and the driver is using NAPI. The struct contains also two

  other fields, but they are reserved and undefined.



SOF_TIMESTAMPING_OPT_TX_SWHW:



  Request both hardware and software timestamps for outgoing packets

  when SOF_TIMESTAMPING_TX_HARDWARE and SOF_TIMESTAMPING_TX_SOFTWARE

  are enabled at the same time. If both timestamps are generated,

  two separate messages will be looped to the socket's error queue,

  each containing just one timestamp.



New applications are encouraged to pass SOF_TIMESTAMPING_OPT_ID to

disambiguate timestamps and SOF_TIMESTAMPING_OPT_TSONLY to operate

regardless of the setting of sysctl net.core.tstamp_allow_data.
@@ -312,7 +330,7 @@ struct scm_timestamping { 
};



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

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

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].



ts[1] used to hold hardware timestamps converted to system time.
@@ -321,6 +339,12 @@ a HW PTP clock source, to allow time conversion in userspace and 
optionally synchronize system time with a userspace PTP stack such

as linuxptp. For the PTP clock API, see Documentation/ptp/ptp.txt.



Note that if the SO_TIMESTAMP or SO_TIMESTAMPNS option is enabled

together with SO_TIMESTAMPING using SOF_TIMESTAMPING_SOFTWARE, a false

software timestamp will be generated in the recvmsg() call and passed

in ts[0] when a real software timestamp is missing. This happens also

on hardware transmit timestamps.



2.1.1 Transmit timestamps with MSG_ERRQUEUE



For transmit timestamps the outgoing packet is looped back to the

drivers/net/ethernet/amd/xgbe/xgbe-drv.c

+2 −2
Original line number Diff line number Diff line
@@ -1268,6 +1268,7 @@ static int xgbe_set_hwtstamp_settings(struct xgbe_prv_data *pdata, 
	case HWTSTAMP_FILTER_NONE:

		break;



	case HWTSTAMP_FILTER_NTP_ALL:

	case HWTSTAMP_FILTER_ALL:

		XGMAC_SET_BITS(mac_tscr, MAC_TSCR, TSENALL, 1);

		XGMAC_SET_BITS(mac_tscr, MAC_TSCR, TSENA, 1);
@@ -1390,7 +1391,6 @@ static void xgbe_prep_tx_tstamp(struct xgbe_prv_data *pdata, 
		spin_unlock_irqrestore(&pdata->tstamp_lock, flags);

	}



	if (!XGMAC_GET_BITS(packet->attributes, TX_PACKET_ATTRIBUTES, PTP))

	skb_tx_timestamp(skb);

}

drivers/net/ethernet/broadcom/bnx2x/bnx2x_main.c

+1 −0
Original line number Diff line number Diff line
@@ -15351,6 +15351,7 @@ int bnx2x_configure_ptp_filters(struct bnx2x *bp) 
		break;

	case HWTSTAMP_FILTER_ALL:

	case HWTSTAMP_FILTER_SOME:

	case HWTSTAMP_FILTER_NTP_ALL:

		bp->rx_filter = HWTSTAMP_FILTER_NONE;

		break;

	case HWTSTAMP_FILTER_PTP_V1_L4_EVENT:

drivers/net/ethernet/cavium/liquidio/lio_main.c

+1 −0
Original line number Diff line number Diff line
@@ -3024,6 +3024,7 @@ static int hwtstamp_ioctl(struct net_device *netdev, struct ifreq *ifr) 
	case HWTSTAMP_FILTER_PTP_V2_EVENT:

	case HWTSTAMP_FILTER_PTP_V2_SYNC:

	case HWTSTAMP_FILTER_PTP_V2_DELAY_REQ:

	case HWTSTAMP_FILTER_NTP_ALL:

		conf.rx_filter = HWTSTAMP_FILTER_ALL;

		break;

	default:

drivers/net/ethernet/cavium/liquidio/lio_vf_main.c

+1 −0
Original line number Diff line number Diff line
@@ -2085,6 +2085,7 @@ static int hwtstamp_ioctl(struct net_device *netdev, struct ifreq *ifr) 
	case HWTSTAMP_FILTER_PTP_V2_EVENT:

	case HWTSTAMP_FILTER_PTP_V2_SYNC:

	case HWTSTAMP_FILTER_PTP_V2_DELAY_REQ:

	case HWTSTAMP_FILTER_NTP_ALL:

		conf.rx_filter = HWTSTAMP_FILTER_ALL;

		break;

	default: