| Message ID | 20190313144401.17735-7-chris@chris-wilson.co.uk (mailing list archive) |
|---|---|
| State | New, archived |
| Headers | show |
| Series | [01/39] drm/i915: Hold a ref to the ring while retiring | expand |
On 13/03/2019 14:43, Chris Wilson wrote: > An idea for extending uABI inspired by Vulkan's extension chains. > Instead of expanding the data struct for each ioctl every time we need > to add a new feature, define an extension chain instead. As we add > optional interfaces to control the ioctl, we define a new extension > struct that can be linked into the ioctl data only when required by the > user. The key advantage being able to ignore large control structs for > optional interfaces/extensions, while being able to process them in a > consistent manner. > > In comparison to other extensible ioctls, the key difference is the > use of a linked chain of extension structs vs an array of tagged > pointers. For example, > > struct drm_amdgpu_cs_chunk { > __u32 chunk_id; > __u32 length_dw; > __u64 chunk_data; > }; > > struct drm_amdgpu_cs_in { > __u32 ctx_id; > __u32 bo_list_handle; > __u32 num_chunks; > __u32 _pad; > __u64 chunks; > }; > > allows userspace to pass in array of pointers to extension structs, but > must therefore keep constructing that array along side the command stream. > In dynamic situations like that, a linked list is preferred and does not > similar from extra cache line misses as the extension structs themselves > must still be loaded separate to the chunks array. > > v2: Apply the tail call optimisation directly to nip the worry of stack > overflow in the bud. > v3: Defend against recursion. > > Opens: > - do we include the result as an out-field in each chain? > struct i915_user_extension { > __u64 next_extension; > __u64 name; > __s32 result; > __u32 mbz; /* reserved for future use */ > }; > * Undecided, so provision some room for future expansion. > > Signed-off-by: Chris Wilson <chris@chris-wilson.co.uk> > Cc: Tvrtko Ursulin <tvrtko.ursulin@intel.com> > Cc: Joonas Lahtinen <joonas.lahtinen@linux.intel.com> > --- > drivers/gpu/drm/i915/Makefile | 1 + > drivers/gpu/drm/i915/i915_user_extensions.c | 59 +++++++++++++++++++++ > drivers/gpu/drm/i915/i915_user_extensions.h | 20 +++++++ > drivers/gpu/drm/i915/i915_utils.h | 12 +++++ > include/uapi/drm/i915_drm.h | 22 ++++++++ > 5 files changed, 114 insertions(+) > create mode 100644 drivers/gpu/drm/i915/i915_user_extensions.c > create mode 100644 drivers/gpu/drm/i915/i915_user_extensions.h > > diff --git a/drivers/gpu/drm/i915/Makefile b/drivers/gpu/drm/i915/Makefile > index 68fecf355471..60de05f3fa60 100644 > --- a/drivers/gpu/drm/i915/Makefile > +++ b/drivers/gpu/drm/i915/Makefile > @@ -46,6 +46,7 @@ i915-y := i915_drv.o \ > i915_sw_fence.o \ > i915_syncmap.o \ > i915_sysfs.o \ > + i915_user_extensions.o \ > intel_csr.o \ > intel_device_info.o \ > intel_pm.o \ > diff --git a/drivers/gpu/drm/i915/i915_user_extensions.c b/drivers/gpu/drm/i915/i915_user_extensions.c > new file mode 100644 > index 000000000000..d28c95221db4 > --- /dev/null > +++ b/drivers/gpu/drm/i915/i915_user_extensions.c > @@ -0,0 +1,59 @@ > +/* > + * SPDX-License-Identifier: MIT > + * > + * Copyright © 2018 Intel Corporation > + */ > + > +#include <linux/nospec.h> > +#include <linux/sched/signal.h> > +#include <linux/uaccess.h> > + > +#include <uapi/drm/i915_drm.h> > + > +#include "i915_user_extensions.h" > +#include "i915_utils.h" > + > +int i915_user_extensions(struct i915_user_extension __user *ext, > + const i915_user_extension_fn *tbl, > + unsigned long count, Could shrink to unsigned int if going to 32-bit "name". And... > + void *data) > +{ > + unsigned int stackdepth = 512; > + > + while (ext) { > + int i, err; > + u64 x; ... so it is u32 in this version. > + > + if (!stackdepth--) /* recursion vs useful flexibility */ > + return -E2BIG; > + > + err = check_user_mbz(&ext->flags); > + if (err) > + return err; > + > + for (i = 0; i < ARRAY_SIZE(ext->rsvd); i++) { > + err = check_user_mbz(&ext->rsvd[i]); > + if (err) > + return err; > + } > + > + if (get_user(x, &ext->name)) > + return -EFAULT; > + > + err = -EINVAL; > + if (x < count) { > + x = array_index_nospec(x, count); > + if (tbl[x]) > + err = tbl[x](ext, data); > + } > + if (err) > + return err; > + > + if (get_user(x, &ext->next_extension)) > + return -EFAULT; > + > + ext = u64_to_user_ptr(x); > + } > + > + return 0; > +} > diff --git a/drivers/gpu/drm/i915/i915_user_extensions.h b/drivers/gpu/drm/i915/i915_user_extensions.h > new file mode 100644 > index 000000000000..313a510b068a > --- /dev/null > +++ b/drivers/gpu/drm/i915/i915_user_extensions.h > @@ -0,0 +1,20 @@ > +/* > + * SPDX-License-Identifier: MIT > + * > + * Copyright © 2018 Intel Corporation > + */ > + > +#ifndef I915_USER_EXTENSIONS_H > +#define I915_USER_EXTENSIONS_H > + > +struct i915_user_extension; > + > +typedef int (*i915_user_extension_fn)(struct i915_user_extension __user *ext, > + void *data); > + > +int i915_user_extensions(struct i915_user_extension __user *ext, > + const i915_user_extension_fn *tbl, > + unsigned long count, > + void *data); > + > +#endif /* I915_USER_EXTENSIONS_H */ > diff --git a/drivers/gpu/drm/i915/i915_utils.h b/drivers/gpu/drm/i915/i915_utils.h > index 9726df37c4c4..51b658fa966d 100644 > --- a/drivers/gpu/drm/i915/i915_utils.h > +++ b/drivers/gpu/drm/i915/i915_utils.h > @@ -105,6 +105,18 @@ > __T; \ > }) > > +#define container_of_user(ptr, type, member) ({ \ > + void __user *__mptr = (void __user *)(ptr); \ > + BUILD_BUG_ON_MSG(!__same_type(*(ptr), ((type *)0)->member) && \ > + !__same_type(*(ptr), void), \ > + "pointer type mismatch in container_of()"); \ > + ((type __user *)(__mptr - offsetof(type, member))); }) > + > +#define check_user_mbz(U) ({ \ > + typeof(*(U)) mbz__; \ > + get_user(mbz__, (U)) ? -EFAULT : mbz__ ? -EINVAL : 0; \ > +}) > + > static inline u64 ptr_to_u64(const void *ptr) > { > return (uintptr_t)ptr; > diff --git a/include/uapi/drm/i915_drm.h b/include/uapi/drm/i915_drm.h > index aa2d4c73a97d..1c69ed16a923 100644 > --- a/include/uapi/drm/i915_drm.h > +++ b/include/uapi/drm/i915_drm.h > @@ -62,6 +62,28 @@ extern "C" { > #define I915_ERROR_UEVENT "ERROR" > #define I915_RESET_UEVENT "RESET" > > +/* > + * i915_user_extension: Base class for defining a chain of extensions > + * > + * Many interfaces need to grow over time. In most cases we can simply > + * extend the struct and have userspace pass in more data. Another option, > + * as demonstrated by Vulkan's approach to providing extensions for forward > + * and backward compatibility, is to use a list of optional structs to > + * provide those extra details. > + * > + * The key advantage to using an extension chain is that it allows us to > + * redefine the interface more easily than an ever growing struct of > + * increasing complexity, and for large parts of that interface to be > + * entirely optional. The downside is more pointer chasing; chasing across > + * the __user boundary with pointers encapsulated inside u64. > + */ > +struct i915_user_extension { > + __u64 next_extension; > + __u32 name; > + __u32 flags; /* All undefined bits must be zero. */ > + __u32 rsvd[4]; /* Reserved for future use; must be zero. */ > +}; > + > /* > * MOCS indexes used for GPU surfaces, defining the cacheability of the > * surface data and the coherency for this data wrt. CPU vs. GPU accesses. > With the u32 thing fixed: Reviewed-by: Tvrtko Ursulin <tvrtko.ursulin@intel.com> Regards, Tvrtko
Quoting Tvrtko Ursulin (2019-03-14 14:52:00) > > On 13/03/2019 14:43, Chris Wilson wrote: > > +int i915_user_extensions(struct i915_user_extension __user *ext, > > + const i915_user_extension_fn *tbl, > > + unsigned long count, > > Could shrink to unsigned int if going to 32-bit "name". And... > > > + void *data) > > +{ > > + unsigned int stackdepth = 512; > > + > > + while (ext) { > > + int i, err; > > + u64 x; > > ... so it is u32 in this version. This was a convenience to use one variable for both; it doesn't affect the get_user() as that is determined by the sizeof(*ptr) and not the local. However, it did upset array_index_nospec() on 32bit, so it did become a u32. So unsigned int count also makes some sense, I was using the natural type for ARRAY_SIZE() so that we didn't accidentally truncate, but shrinking the array bound is not as harmful. -Chris
On 14/03/2019 14:59, Chris Wilson wrote: > Quoting Tvrtko Ursulin (2019-03-14 14:52:00) >> >> On 13/03/2019 14:43, Chris Wilson wrote: >>> +int i915_user_extensions(struct i915_user_extension __user *ext, >>> + const i915_user_extension_fn *tbl, >>> + unsigned long count, >> >> Could shrink to unsigned int if going to 32-bit "name". And... >> >>> + void *data) >>> +{ >>> + unsigned int stackdepth = 512; >>> + >>> + while (ext) { >>> + int i, err; >>> + u64 x; >> >> ... so it is u32 in this version. > > This was a convenience to use one variable for both; it doesn't affect > the get_user() as that is determined by the sizeof(*ptr) and not the My bad, I thought the destination controls the size. > local. However, it did upset array_index_nospec() on 32bit, so it did > become a u32. So unsigned int count also makes some sense, I was using > the natural type for ARRAY_SIZE() so that we didn't accidentally > truncate, but shrinking the array bound is not as harmful. Ok. Regards, Tvrtko
diff --git a/drivers/gpu/drm/i915/Makefile b/drivers/gpu/drm/i915/Makefile index 68fecf355471..60de05f3fa60 100644 --- a/drivers/gpu/drm/i915/Makefile +++ b/drivers/gpu/drm/i915/Makefile @@ -46,6 +46,7 @@ i915-y := i915_drv.o \ i915_sw_fence.o \ i915_syncmap.o \ i915_sysfs.o \ + i915_user_extensions.o \ intel_csr.o \ intel_device_info.o \ intel_pm.o \ diff --git a/drivers/gpu/drm/i915/i915_user_extensions.c b/drivers/gpu/drm/i915/i915_user_extensions.c new file mode 100644 index 000000000000..d28c95221db4 --- /dev/null +++ b/drivers/gpu/drm/i915/i915_user_extensions.c @@ -0,0 +1,59 @@ +/* + * SPDX-License-Identifier: MIT + * + * Copyright © 2018 Intel Corporation + */ + +#include <linux/nospec.h> +#include <linux/sched/signal.h> +#include <linux/uaccess.h> + +#include <uapi/drm/i915_drm.h> + +#include "i915_user_extensions.h" +#include "i915_utils.h" + +int i915_user_extensions(struct i915_user_extension __user *ext, + const i915_user_extension_fn *tbl, + unsigned long count, + void *data) +{ + unsigned int stackdepth = 512; + + while (ext) { + int i, err; + u64 x; + + if (!stackdepth--) /* recursion vs useful flexibility */ + return -E2BIG; + + err = check_user_mbz(&ext->flags); + if (err) + return err; + + for (i = 0; i < ARRAY_SIZE(ext->rsvd); i++) { + err = check_user_mbz(&ext->rsvd[i]); + if (err) + return err; + } + + if (get_user(x, &ext->name)) + return -EFAULT; + + err = -EINVAL; + if (x < count) { + x = array_index_nospec(x, count); + if (tbl[x]) + err = tbl[x](ext, data); + } + if (err) + return err; + + if (get_user(x, &ext->next_extension)) + return -EFAULT; + + ext = u64_to_user_ptr(x); + } + + return 0; +} diff --git a/drivers/gpu/drm/i915/i915_user_extensions.h b/drivers/gpu/drm/i915/i915_user_extensions.h new file mode 100644 index 000000000000..313a510b068a --- /dev/null +++ b/drivers/gpu/drm/i915/i915_user_extensions.h @@ -0,0 +1,20 @@ +/* + * SPDX-License-Identifier: MIT + * + * Copyright © 2018 Intel Corporation + */ + +#ifndef I915_USER_EXTENSIONS_H +#define I915_USER_EXTENSIONS_H + +struct i915_user_extension; + +typedef int (*i915_user_extension_fn)(struct i915_user_extension __user *ext, + void *data); + +int i915_user_extensions(struct i915_user_extension __user *ext, + const i915_user_extension_fn *tbl, + unsigned long count, + void *data); + +#endif /* I915_USER_EXTENSIONS_H */ diff --git a/drivers/gpu/drm/i915/i915_utils.h b/drivers/gpu/drm/i915/i915_utils.h index 9726df37c4c4..51b658fa966d 100644 --- a/drivers/gpu/drm/i915/i915_utils.h +++ b/drivers/gpu/drm/i915/i915_utils.h @@ -105,6 +105,18 @@ __T; \ }) +#define container_of_user(ptr, type, member) ({ \ + void __user *__mptr = (void __user *)(ptr); \ + BUILD_BUG_ON_MSG(!__same_type(*(ptr), ((type *)0)->member) && \ + !__same_type(*(ptr), void), \ + "pointer type mismatch in container_of()"); \ + ((type __user *)(__mptr - offsetof(type, member))); }) + +#define check_user_mbz(U) ({ \ + typeof(*(U)) mbz__; \ + get_user(mbz__, (U)) ? -EFAULT : mbz__ ? -EINVAL : 0; \ +}) + static inline u64 ptr_to_u64(const void *ptr) { return (uintptr_t)ptr; diff --git a/include/uapi/drm/i915_drm.h b/include/uapi/drm/i915_drm.h index aa2d4c73a97d..1c69ed16a923 100644 --- a/include/uapi/drm/i915_drm.h +++ b/include/uapi/drm/i915_drm.h @@ -62,6 +62,28 @@ extern "C" { #define I915_ERROR_UEVENT "ERROR" #define I915_RESET_UEVENT "RESET" +/* + * i915_user_extension: Base class for defining a chain of extensions + * + * Many interfaces need to grow over time. In most cases we can simply + * extend the struct and have userspace pass in more data. Another option, + * as demonstrated by Vulkan's approach to providing extensions for forward + * and backward compatibility, is to use a list of optional structs to + * provide those extra details. + * + * The key advantage to using an extension chain is that it allows us to + * redefine the interface more easily than an ever growing struct of + * increasing complexity, and for large parts of that interface to be + * entirely optional. The downside is more pointer chasing; chasing across + * the __user boundary with pointers encapsulated inside u64. + */ +struct i915_user_extension { + __u64 next_extension; + __u32 name; + __u32 flags; /* All undefined bits must be zero. */ + __u32 rsvd[4]; /* Reserved for future use; must be zero. */ +}; + /* * MOCS indexes used for GPU surfaces, defining the cacheability of the * surface data and the coherency for this data wrt. CPU vs. GPU accesses.
An idea for extending uABI inspired by Vulkan's extension chains. Instead of expanding the data struct for each ioctl every time we need to add a new feature, define an extension chain instead. As we add optional interfaces to control the ioctl, we define a new extension struct that can be linked into the ioctl data only when required by the user. The key advantage being able to ignore large control structs for optional interfaces/extensions, while being able to process them in a consistent manner. In comparison to other extensible ioctls, the key difference is the use of a linked chain of extension structs vs an array of tagged pointers. For example, struct drm_amdgpu_cs_chunk { __u32 chunk_id; __u32 length_dw; __u64 chunk_data; }; struct drm_amdgpu_cs_in { __u32 ctx_id; __u32 bo_list_handle; __u32 num_chunks; __u32 _pad; __u64 chunks; }; allows userspace to pass in array of pointers to extension structs, but must therefore keep constructing that array along side the command stream. In dynamic situations like that, a linked list is preferred and does not similar from extra cache line misses as the extension structs themselves must still be loaded separate to the chunks array. v2: Apply the tail call optimisation directly to nip the worry of stack overflow in the bud. v3: Defend against recursion. Opens: - do we include the result as an out-field in each chain? struct i915_user_extension { __u64 next_extension; __u64 name; __s32 result; __u32 mbz; /* reserved for future use */ }; * Undecided, so provision some room for future expansion. Signed-off-by: Chris Wilson <chris@chris-wilson.co.uk> Cc: Tvrtko Ursulin <tvrtko.ursulin@intel.com> Cc: Joonas Lahtinen <joonas.lahtinen@linux.intel.com> --- drivers/gpu/drm/i915/Makefile | 1 + drivers/gpu/drm/i915/i915_user_extensions.c | 59 +++++++++++++++++++++ drivers/gpu/drm/i915/i915_user_extensions.h | 20 +++++++ drivers/gpu/drm/i915/i915_utils.h | 12 +++++ include/uapi/drm/i915_drm.h | 22 ++++++++ 5 files changed, 114 insertions(+) create mode 100644 drivers/gpu/drm/i915/i915_user_extensions.c create mode 100644 drivers/gpu/drm/i915/i915_user_extensions.h