new PTP ioctl fixes
Subsystems (13)
v2 cover new PTP ioctl fixes
I noticed recently that Filip added new versions of the PTP ioctls which correctly honor the reserved fields (making it so that we can safely extend them in the future).
Unfortunately, this breaks the old ioctls for a couple of reasons. First, the flags for the old ioctls get cleared. This means that the external timestamp request can never be enabled. Further, it means future new flags will *not* be cleared, and thus old ioctl will potentially send non-zero data and be mis-interpreted.
Additionally, new flags are not protected against in-driver, because no current driver verifies that the flags are only one of the supported ones. This means new flags will be mis-interpreted by the drivers.
This series provides patches to fix drivers to verify and reject unsupported flags, as well as to fix the ioctls to clear flags on the old version of the ioctl properly.
Range-diff from v1:
1: c317dc1cc7eb = 1: c317dc1cc7eb ptp: correctly disable flags on old ioctls
2: 08ce725c7f2a ! 2: 5537762fb9cc net: reject ptp requests with unsupported flags
@@ drivers/net/phy/dp83640.c: static int ptp_dp83640_enable(struct ptp_clock_info *
switch (rq->type) {
case PTP_CLK_REQ_EXTTS:
+ /* Reject requests with unsupported flags */
-+ if (rq->extts.flags & ~(PTP_FEATURE_ENABLE |
++ if (rq->extts.flags & ~(PTP_ENABLE_FEATURE |
+ PTP_RISING_EDGE |
+ PTP_FALLING_EDGE))
+ return -EOPNOTSUPP;Jacob Keller (2):
ptp: correctly disable flags on old ioctls
net: reject ptp requests with unsupported flags
drivers/net/dsa/mv88e6xxx/ptp.c | 5 +++++ drivers/net/ethernet/broadcom/tg3.c | 4 ++++ drivers/net/ethernet/intel/igb/igb_ptp.c | 8 +++++++ .../ethernet/mellanox/mlx5/core/lib/clock.c | 10 +++++++++ drivers/net/ethernet/microchip/lan743x_ptp.c | 4 ++++ drivers/net/ethernet/renesas/ravb_ptp.c | 9 ++++++++ .../net/ethernet/stmicro/stmmac/stmmac_ptp.c | 4 ++++ drivers/net/phy/dp83640.c | 8 +++++++ drivers/ptp/ptp_chardev.c | 4 ++-- include/uapi/linux/ptp_clock.h | 22 +++++++++++++++++++ 10 files changed, 76 insertions(+), 2 deletions(-)
Signature · 1 line
2.23.0.245.gf157bbb9169d
PATCH v2 1/2 ptp: correctly disable flags on old ioctls
Commit 415606588c61 ("PTP: introduce new versions of IOCTLs", 2019-09-13) introduced new versions of the PTP ioctls which actually validate that the flags are acceptable values.
As part of this, it cleared the flags value using a bitwise and+negation, in an attempt to prevent the old ioctl from accidentally enabling new features.
This is incorrect for a couple of reasons. First, it results in accidentally preventing previously working flags on the request ioctl. By clearing the "valid" flags, we now no longer allow setting the enable, rising edge, or falling edge flags.
Second, if we add new additional flags in the future, they must not be set by the old ioctl. (Since the flag wasn't checked before, we could potentially break userspace programs which sent garbage flag data.
The correct way to resolve this is to check for and clear all but the originally valid flags.
Create defines indicating which flags are correctly checked and interpreted by the original ioctls. Use these to clear any bits which will not be correctly interpreted by the original ioctls.
In the future, new flags must be added to the VALID_FLAGS macros, but *not* to the V1_VALID_FLAGS macros. In this way, new features may be exposed over the v2 ioctls, but without breaking previous userspace which happened to not clear the flags value properly. The old ioctl will continue to behave the same way, while the new ioctl gains the benefit of using the flags fields.
--- drivers/ptp/ptp_chardev.c | 4 ++-- include/uapi/linux/ptp_clock.h | 22 ++++++++++++++++++++++ 2 files changed, 24 insertions(+), 2 deletions(-)
drivers/ptp/ptp_chardev.c +2 -2
@@ -155,7 +155,7 @@ long ptp_ioctl(struct posix_clock *pc, unsigned int cmd, unsigned long arg) err = -EINVAL ;break ; }else if (cmd ==PTP_EXTTS_REQUEST ) { - req.extts.flags &= ~PTP_EXTTS_VALID_FLAGS ; + req.extts.flags &=PTP_EXTTS_V1_VALID_FLAGS ; req.extts.rsv[0 ] =0 ; req.extts.rsv[1 ] =0 ; }
@@ -184,7 +184,7 @@ long ptp_ioctl(struct posix_clock *pc, unsigned int cmd, unsigned long arg) err = -EINVAL ;break ; }else if (cmd ==PTP_PEROUT_REQUEST ) { - req.perout.flags &= ~PTP_PEROUT_VALID_FLAGS ; + req.perout.flags &=PTP_PEROUT_V1_VALID_FLAGS ; req.perout.rsv[0 ] =0 ; req.perout.rsv[1 ] =0 ; req.perout.rsv[2 ] =0 ;
include/uapi/linux/ptp_clock.h +22 -0
@@ -31,15 +31,37 @@#define PTP_ENABLE_FEATURE (1<<0)#define PTP_RISING_EDGE (1<<1)#define PTP_FALLING_EDGE (1<<2) + +/* +* flag fields valid for the new PTP_EXTTS_REQUEST2 ioctl. +*/ #define PTP_EXTTS_VALID_FLAGS (PTP_ENABLE_FEATURE | \ PTP_RISING_EDGE | \ PTP_FALLING_EDGE) +/* +* flag fields valid for the original PTP_EXTTS_REQUEST ioctl. +* DO NOT ADD NEW FLAGS HERE. +*/ +#define PTP_EXTTS_V1_VALID_FLAGS (PTP_ENABLE_FEATURE | \ + PTP_RISING_EDGE | \ + PTP_FALLING_EDGE) +/* * Bits of the ptp_perout_request.flags field: */ #define PTP_PEROUT_ONE_SHOT (1<<0) + +/* +* flag fields valid for the new PTP_PEROUT_REQUEST2 ioctl. +*/ #define PTP_PEROUT_VALID_FLAGS (PTP_PEROUT_ONE_SHOT) + +/* +* No flags are valid for the original PTP_PEROUT_REQUEST ioctl +*/ +#define PTP_PEROUT_V1_VALID_FLAGS (0) +/* * struct ptp_clock_time - represents a time value *
Signature · 1 line
2.23.0.245.gf157bbb9169d
Re: [net-next v2 1/2] ptp: correctly disable flags on old ioctls
drivers/ptp/ptp_chardev.c long ptp_ioctl(struct posix_clock *pc, unsigned int cmd, unsigned long arg) · line 158
Quoted 10 lines · Jacob Keller
drivers/ptp/ptp_chardev.c +1
-1@@ -155,7 +155,7 @@ long ptp_ioctl(struct posix_clock *pc, unsigned int cmd, unsigned long arg) err = -EINVAL ;break ; }else if (cmd ==PTP_EXTTS_REQUEST ) { - req.extts.flags &= ~PTP_EXTTS_VALID_FLAGS ; + req.extts.flags &=PTP_EXTTS_V1_VALID_FLAGS ;
Duh, the bit wise negation was not the intention. Thanks for catching this, and introducing the "V1" set of flags makes sense.
@davem Please merge this patch as a bug fix.
Re: [net-next v2 1/2] ptp: correctly disable flags on old ioctls
In reply to Jacob KellerFrom: Jacob Keller <[email protected]>
Date: Wed, 25 Sep 2019 19:28:19 -0700
Quoted 24 lines
Commit
415606588c61("PTP: introduce new versions of IOCTLs", 2019-09-13) introduced new versions of the PTP ioctls which actually validate that the flags are acceptable values.As part of this, it cleared the flags value using a bitwise and+negation, in an attempt to prevent the old ioctl from accidentally enabling new features.
This is incorrect for a couple of reasons. First, it results in accidentally preventing previously working flags on the request ioctl. By clearing the "valid" flags, we now no longer allow setting the enable, rising edge, or falling edge flags.
Second, if we add new additional flags in the future, they must not be set by the old ioctl. (Since the flag wasn't checked before, we could potentially break userspace programs which sent garbage flag data.
The correct way to resolve this is to check for and clear all but the originally valid flags.
Create defines indicating which flags are correctly checked and interpreted by the original ioctls. Use these to clear any bits which will not be correctly interpreted by the original ioctls.
Quoted 8 lines
In the future, new flags must be added to the
VALID_FLAGSmacros, but *not* to theV1_VALID_FLAGSmacros. In this way, new features may be exposed over the v2 ioctls, but without breaking previous userspace which happened to not clear the flags value properly. The old ioctl will continue to behave the same way, while the new ioctl gains the benefit of using the flags fields.Signed-off-by Jacob Keller <[email protected]>
Applied to 'net'.
PATCH v2 2/2 net: reject ptp requests with unsupported flags
In reply to Jacob KellerFix all of the drivers which implement support for the periodic output or external timestamp requests to reject unsupported flags.
This is important for forward compatibility: if a new flag is introduced, the driver should reject requests to enable the flag until it has been modified to actually support the flag in question.
This patch may not be correct for individual drivers, especially regarding the rising vs falling edge flags. I interpreted the default behavior to be to timestamp the rising edge of a pin transition.
--- drivers/net/dsa/mv88e6xxx/ptp.c | 5 +++++ drivers/net/ethernet/broadcom/tg3.c | 4 ++++ drivers/net/ethernet/intel/igb/igb_ptp.c | 8 ++++++++ drivers/net/ethernet/mellanox/mlx5/core/lib/clock.c | 10 ++++++++++ drivers/net/ethernet/microchip/lan743x_ptp.c | 4 ++++ drivers/net/ethernet/renesas/ravb_ptp.c | 9 +++++++++ drivers/net/ethernet/stmicro/stmmac/stmmac_ptp.c | 4 ++++ drivers/net/phy/dp83640.c | 8 ++++++++ 8 files changed, 52 insertions(+)
drivers/net/dsa/mv88e6xxx/ptp.c +5 -0
@@ -273,6 +273,11 @@ static int mv88e6352_ptp_enable_extts(struct mv88e6xxx_chip *chip,int pin;int err; +/* Reject requests with unsupported flags */ +if (rq->extts.flags & ~(PTP_ENABLE_FEATURE | +PTP_RISING_EDGE )) +return -EOPNOTSUPP ; + pin =ptp_find_pin (chip->ptp_clock,PTP_PF_EXTTS , rq->extts.index);if (pin <0 )
drivers/net/ethernet/broadcom/tg3.c +4 -0
@@ -6280,6 +6280,10 @@ static int tg3_ptp_enable(struct ptp_clock_info *ptp,switch (rq->type) {case PTP_CLK_REQ_PEROUT : +/* Reject requests with unsupported flags */ +if (rq->perout.flags) +return -EOPNOTSUPP ; +if (rq->perout.index !=0 )return -EINVAL ;
drivers/net/ethernet/intel/igb/igb_ptp.c +8 -0
@@ -521,6 +521,10 @@ static int igb_ptp_feature_enable_i210(struct ptp_clock_info *ptp,switch (rq->type) {case PTP_CLK_REQ_EXTTS : +/* Reject requests with unsupported flags */ +if (rq->extts.flags & ~(PTP_ENABLE_FEATURE |PTP_RISING_EDGE )) +return -EOPNOTSUPP ; +if (on) { pin =ptp_find_pin (igb->ptp_clock,PTP_PF_EXTTS , rq->extts.index);
@@ -551,6 +555,10 @@ static int igb_ptp_feature_enable_i210(struct ptp_clock_info *ptp,return 0 ;case PTP_CLK_REQ_PEROUT : +/* Reject requests with unsupported flags */ +if (rq->perout.flags) +return -EOPNOTSUPP ; +if (on) { pin =ptp_find_pin (igb->ptp_clock,PTP_PF_PEROUT , rq->perout.index);
drivers/net/ethernet/mellanox/mlx5/core/lib/clock.c +10 -0
@@ -236,6 +236,12 @@ static int mlx5_extts_configure(struct ptp_clock_info *ptp,if (!MLX5_PPS_CAP (mdev))return -EOPNOTSUPP ; +/* Reject requests with unsupported flags */ +if (rq->extts.flags & ~(PTP_ENABLE_FEATURE | +PTP_RISING_EDGE | +PTP_FALLING_EDGE )) +return -EOPNOTSUPP ; +if (rq->extts.index >= clock->ptp_info.n_pins)return -EINVAL ;
@@ -290,6 +296,10 @@ static int mlx5_perout_configure(struct ptp_clock_info *ptp,if (!MLX5_PPS_CAP (mdev))return -EOPNOTSUPP ; +/* Reject requests with unsupported flags */ +if (rq->perout.flags) +return -EOPNOTSUPP ; +if (rq->perout.index >= clock->ptp_info.n_pins)return -EINVAL ;
drivers/net/ethernet/microchip/lan743x_ptp.c +4 -0
@@ -429,6 +429,10 @@ static int lan743x_ptp_perout(struct lan743x_adapter *adapter, int on,int pulse_width =0 ;int perout_bit =0 ; +/* Reject requests with unsupported flags */ +if (perout->flags) +return -EOPNOTSUPP ; +if (!on) {lan743x_ptp_perout_off (adapter);return 0 ;
drivers/net/ethernet/renesas/ravb_ptp.c +9 -0
@@ -182,6 +182,11 @@ static int ravb_ptp_extts(struct ptp_clock_info *ptp,struct net_device *ndev = priv->ndev;unsigned long flags; +/* Reject requests with unsupported flags */ +if (req->flags & ~(PTP_ENABLE_FEATURE | +PTP_RISING_EDGE )) +return -EOPNOTSUPP ; +if (req->index)return -EINVAL ;
@@ -211,6 +216,10 @@ static int ravb_ptp_perout(struct ptp_clock_info *ptp,unsigned long flags;int error =0 ; +/* Reject requests with unsupported flags */ +if (req->flags) +return -EOPNOTSUPP ; +if (req->index)return -EINVAL ;
drivers/net/ethernet/stmicro/stmmac/stmmac_ptp.c +4 -0
@@ -140,6 +140,10 @@ static int stmmac_enable(struct ptp_clock_info *ptp,switch (rq->type) {case PTP_CLK_REQ_PEROUT : +/* Reject requests with unsupported flags */ +if (rq->perout.flags) +return -EOPNOTSUPP ; + cfg = &priv->pps[rq->perout.index]; cfg->start.tv_sec = rq->perout.start.sec;
drivers/net/phy/dp83640.c +8 -0
@@ -469,6 +469,11 @@ static int ptp_dp83640_enable(struct ptp_clock_info *ptp,switch (rq->type) {case PTP_CLK_REQ_EXTTS : +/* Reject requests with unsupported flags */ +if (rq->extts.flags & ~(PTP_ENABLE_FEATURE | +PTP_RISING_EDGE | +PTP_FALLING_EDGE )) +return -EOPNOTSUPP ; index = rq->extts.index;if (index >=N_EXT_TS )return -EINVAL ;
@@ -491,6 +496,9 @@ static int ptp_dp83640_enable(struct ptp_clock_info *ptp,return 0 ;case PTP_CLK_REQ_PEROUT : +/* Reject requests with unsupported flags */ +if (rq->perout.flags) +return -EOPNOTSUPP ;if (rq->perout.index >=N_PER_OUT )return -EINVAL ;return periodic_output (clock, rq, on, rq->perout.index);
Signature · 1 line
2.23.0.245.gf157bbb9169d
Richard Cochran
maintainerRe: [net-next v2 2/2] net: reject ptp requests with unsupported flags
Quoted 3 lines · Jacob Keller
This patch may not be correct for individual drivers, especially regarding the rising vs falling edge flags. I interpreted the default behavior to be to timestamp the rising edge of a pin transition.
So I think this patch goes too far. It breaks the implied ABI.
drivers/net/ethernet/intel/igb/igb_ptp.c static int igb_ptp_feature_enable_i210(struct ptp_clock_info *ptp, · line 526
Quoted 11 lines
drivers/net/ethernet/intel/igb/igb_ptp.c +3
-0@@ -521,6 +521,10 @@ static int igb_ptp_feature_enable_i210(struct ptp_clock_info *ptp,switch (rq->type) {case PTP_CLK_REQ_EXTTS : +/* Reject requests with unsupported flags */ +if (rq->extts.flags & ~(PTP_ENABLE_FEATURE |PTP_RISING_EDGE )) +return -EOPNOTSUPP ;
This HW always time stamps both edges, and that is not configurable. Here you reject PTP_FALLING_EDGE, and that is clearly wrong. If the driver had been really picky (my fault I guess), it should have always insisted on (PTP_RISING_EDGE | PTP_FALLING_EDGE) being set together. But it is too late to enforce that now, because it could break user space programs.
I do agree with the sentiment of checking the flags at the driver level, but this needs to be done case by case, with the drivers' author's input.
(The req.perout.flags can be done unconditionally in all drivers, since there were never any valid flags, but req.extts.flags needs careful attention.)
Thanks,
Richard
RE: [net-next v2 2/2] net: reject ptp requests with unsupported flags
Quoted 13 lines
-----Original Message-----
From: netdev-owner at vger.kernel.org [mailto:netdev-owner at vger.kernel.org] On Behalf Of Richard Cochran
Sent: Wednesday, September 25, 2019 9:02 PM
To: Keller, Jacob E <[email protected]>
Cc: netdev at vger.kernel.org; Intel Wired LAN <[email protected]>; Kirsher, Jeffrey T <[email protected]>; Felipe Balbi <[email protected]>; David S . Miller <[email protected]>; Hall, Christopher S <[email protected]>
Subject: Re: [net-next v2 2/2] net: reject ptp requests with unsupported flags
Quoted 6 lines
Quoted 3 lines · Jacob Keller
This patch may not be correct for individual drivers, especially regarding the rising vs falling edge flags. I interpreted the default behavior to be to timestamp the rising edge of a pin transition.
So I think this patch goes too far. It breaks the implied ABI.
Sure, I didn't really know whether the rising vs falling edge and how it was supposed to work for each driver. I just want to ensure that any future flags get rejected until they are actually supported.
Quoted 9 lines
Review
Quoted 2 lines
(quoted diff) +0
-0
b/drivers/net/ethernet/intel/igb/igb_ptp.cdrivers/net/ethernet/intel/igb/igb_ptp.c static int igb_ptp_feature_enable_i210(struct
Quoted 4 lines
index
fd3071f55bd3..2867a2581a36100644drivers/net/ethernet/intel/igb/igb_ptp.c +0
-0@@ -521,6 +521,10 @@ static int igb_ptp_feature_enable_i210(struct
ptp_clock_info*ptp,Quoted 1 line
Quoted 12 lines
drivers/net/ethernet/intel/igb/igb_ptp.c static int igb_ptp_feature_enable_i210(struct ptp_clock_info *ptp, · line 526
Quoted 5 lines
drivers/net/ethernet/intel/igb/igb_ptp.c +3
-0switch (rq->type) {case PTP_CLK_REQ_EXTTS : +/* Reject requests with unsupported flags */ +if (rq->extts.flags & ~(PTP_ENABLE_FEATURE |PTP_RISING_EDGE )) +return -EOPNOTSUPP ;This HW always time stamps both edges, and that is not configurable. Here you reject
PTP_FALLING_EDGE, and that is clearly wrong. If the driver had been really picky (my fault I guess), it should have always insisted on (PTP_RISING_EDGE|PTP_FALLING_EDGE) being set together. But it is too late to enforce that now, because it could break user space programs.
Yes.
Quoted 4 lines
I do agree with the sentiment of checking the flags at the driver level, but this needs to be done case by case, with the drivers' author's input.
Sure. I think the best immediate approach is to make sure all drivers reject any *new* flags, and each driver can decide whether they should reject rising, falling, etc.
Quoted 5 lines
(The req.perout.flags can be done unconditionally in all drivers, since there were never any valid flags, but req.extts.flags needs careful attention.)
Right.
Quoted 2 lines
Thanks,
Richard
RE: [net-next v2 2/2] net: reject ptp requests with unsupported flags
In reply to Richard CochranQuoted 45 lines
-----Original Message-----
From: netdev-owner at vger.kernel.org [mailto:netdev-owner at vger.kernel.org] On Behalf Of Richard Cochran
Sent: Wednesday, September 25, 2019 9:02 PM
To: Keller, Jacob E <[email protected]>
Cc: netdev at vger.kernel.org; Intel Wired LAN <[email protected]>; Kirsher, Jeffrey T <[email protected]>; Felipe Balbi <[email protected]>; David S . Miller <[email protected]>; Hall, Christopher S <[email protected]>
Subject: Re: [net-next v2 2/2] net: reject ptp requests with unsupported flagsQuoted 3 lines · Jacob Keller
This patch may not be correct for individual drivers, especially regarding the rising vs falling edge flags. I interpreted the default behavior to be to timestamp the rising edge of a pin transition.
So I think this patch goes too far. It breaks the implied ABI.
Review
Quoted 1 line
(quoted diff) +0
-0
b/drivers/net/ethernet/intel/igb/igb_ptp.cdrivers/net/ethernet/intel/igb/igb_ptp.c static int igb_ptp_feature_enable_i210(struct
Quoted 4 lines
index
fd3071f55bd3..2867a2581a36100644drivers/net/ethernet/intel/igb/igb_ptp.c +0
-0@@ -521,6 +521,10 @@ static int igb_ptp_feature_enable_i210(struct
ptp_clock_info*ptp,drivers/net/ethernet/intel/igb/igb_ptp.c static int igb_ptp_feature_enable_i210(struct ptp_clock_info *ptp, · line 526
Quoted 6 lines
drivers/net/ethernet/intel/igb/igb_ptp.c +3
-0switch (rq->type) {case PTP_CLK_REQ_EXTTS : +/* Reject requests with unsupported flags */ +if (rq->extts.flags & ~(PTP_ENABLE_FEATURE |PTP_RISING_EDGE )) +return -EOPNOTSUPP ;This HW always time stamps both edges, and that is not configurable. Here you reject
PTP_FALLING_EDGE, and that is clearly wrong. If the driver had been really picky (my fault I guess), it should have always insisted on (PTP_RISING_EDGE|PTP_FALLING_EDGE) being set together. But it is too late to enforce that now, because it could break user space programs.I do agree with the sentiment of checking the flags at the driver level, but this needs to be done case by case, with the drivers' author's input.
Quoted 6 lines
(The req.perout.flags can be done unconditionally in all drivers, since there were never any valid flags, but req.extts.flags needs careful attention.)
Thanks,
Richard
I will split this patch apart and make the extts part per-driver.
Thanks,
Jake