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.
Showing the changes to include/uapi/linux (1 of 2 files). Show all
Unified · Split
| @@ -31,15 +31,37 @@ · 30 unmodified lines | ||
| 31 | 31 | #define PTP_ENABLE_FEATURE (1<<0) |
| 32 | 32 | #define PTP_RISING_EDGE (1<<1) |
| 33 | 33 | #define PTP_FALLING_EDGE (1<<2) |
| 34 | + | |
| 35 | +/* | |
| 36 | + * flag fields valid for the new PTP_EXTTS_REQUEST2 ioctl. | |
| 37 | + */ | |
| 34 | 38 | #define PTP_EXTTS_VALID_FLAGS (PTP_ENABLE_FEATURE | \ |
| 35 | 39 | PTP_RISING_EDGE | \ |
| 36 | 40 | PTP_FALLING_EDGE) |
| 37 | 41 | |
| 42 | +/* | |
| 43 | + * flag fields valid for the original PTP_EXTTS_REQUEST ioctl. | |
| 44 | + * DO NOT ADD NEW FLAGS HERE. | |
| 45 | + */ | |
| 46 | +#define PTP_EXTTS_V1_VALID_FLAGS (PTP_ENABLE_FEATURE | \ | |
| 47 | + PTP_RISING_EDGE | \ | |
| 48 | + PTP_FALLING_EDGE) | |
| 49 | + | |
| 38 | 50 | /* |
| 39 | 51 | * Bits of the ptp_perout_request.flags field: |
| 40 | 52 | */ |
| 41 | 53 | #define PTP_PEROUT_ONE_SHOT (1<<0) |
| 54 | + | |
| 55 | +/* | |
| 56 | + * flag fields valid for the new PTP_PEROUT_REQUEST2 ioctl. | |
| 57 | + */ | |
| 42 | 58 | #define PTP_PEROUT_VALID_FLAGS (PTP_PEROUT_ONE_SHOT) |
| 59 | + | |
| 60 | +/* | |
| 61 | + * No flags are valid for the original PTP_PEROUT_REQUEST ioctl | |
| 62 | + */ | |
| 63 | +#define PTP_PEROUT_V1_VALID_FLAGS (0) | |
| 64 | + | |
| 43 | 65 | /* |
| 44 | 66 | * struct ptp_clock_time - represents a time value |
| 45 | 67 | * |