diff mbox series

drm/doc: Document that modifiers are always required for fb

Message ID 20200902102440.3621733-1-daniel.vetter@ffwll.ch (mailing list archive)
State New, archived
Headers show
Series drm/doc: Document that modifiers are always required for fb | expand

Commit Message

Daniel Vetter Sept. 2, 2020, 10:24 a.m. UTC
Even for legacy userspace, since otherwise GETFB2 is broken and if you
switch between modifier-less and modifier-aware compositors, smooth
transitions break.

Also it's just best practice to make sure modifiers are invariant for
a given drm_fb, and that a modifier-aware kms drivers only has one
place to store them, ignoring any old implicit bo flags or whatever
else might float around.

Motivated by some irc discussion with Bas about amdgpu modifier
support.

Fixes: 455e00f1412f ("drm: Add getfb2 ioctl")
Cc: Daniel Stone <daniels@collabora.com>
Cc: Juston Li <juston.li@intel.com>
Cc: Daniel Vetter <daniel.vetter@ffwll.ch>
Cc: Ville Syrjälä <ville.syrjala@linux.intel.com>
Cc: Bas Nieuwenhuizen <bas@basnieuwenhuizen.nl>
Cc: Marek Olšák <maraeo@gmail.com>
Cc: "Wentland, Harry" <harry.wentland@amd.com>
Signed-off-by: Daniel Vetter <daniel.vetter@intel.com>
---
 include/drm/drm_mode_config.h | 13 +++++++++++++
 1 file changed, 13 insertions(+)

Comments

Pekka Paalanen Sept. 2, 2020, 11:02 a.m. UTC | #1
On Wed,  2 Sep 2020 12:24:40 +0200
Daniel Vetter <daniel.vetter@ffwll.ch> wrote:

> Even for legacy userspace, since otherwise GETFB2 is broken and if you
> switch between modifier-less and modifier-aware compositors, smooth
> transitions break.
> 
> Also it's just best practice to make sure modifiers are invariant for
> a given drm_fb, and that a modifier-aware kms drivers only has one
> place to store them, ignoring any old implicit bo flags or whatever
> else might float around.
> 
> Motivated by some irc discussion with Bas about amdgpu modifier
> support.
> 
> Fixes: 455e00f1412f ("drm: Add getfb2 ioctl")
> Cc: Daniel Stone <daniels@collabora.com>
> Cc: Juston Li <juston.li@intel.com>
> Cc: Daniel Vetter <daniel.vetter@ffwll.ch>
> Cc: Ville Syrjälä <ville.syrjala@linux.intel.com>
> Cc: Bas Nieuwenhuizen <bas@basnieuwenhuizen.nl>
> Cc: Marek Olšák <maraeo@gmail.com>
> Cc: "Wentland, Harry" <harry.wentland@amd.com>
> Signed-off-by: Daniel Vetter <daniel.vetter@intel.com>
> ---
>  include/drm/drm_mode_config.h | 13 +++++++++++++
>  1 file changed, 13 insertions(+)
> 
> diff --git a/include/drm/drm_mode_config.h b/include/drm/drm_mode_config.h
> index a18f73eb3cf6..5ffbb4ed5b35 100644
> --- a/include/drm/drm_mode_config.h
> +++ b/include/drm/drm_mode_config.h
> @@ -58,6 +58,12 @@ struct drm_mode_config_funcs {
>  	 * actual modifier used if the request doesn't have it specified,
>  	 * ie. when (@mode_cmd->flags & DRM_MODE_FB_MODIFIERS) == 0.
>  	 *
> +	 * IMPORTANT: These implied modifiers for legacy userspace must be
> +	 * stored in struct &drm_framebuffer, including all relevant metadata
> +	 * like &drm_framebuffer.pitches and &drm_framebuffer.offsets if the
> +	 * modifier enables additional planes beyond the fourcc pixel format
> +	 * code. This is required by the GETFB2 ioctl.
> +	 *
>  	 * If the parameters are deemed valid and the backing storage objects in
>  	 * the underlying memory manager all exist, then the driver allocates
>  	 * a new &drm_framebuffer structure, subclassed to contain
> @@ -915,6 +921,13 @@ struct drm_mode_config {
>  	 * @allow_fb_modifiers:
>  	 *
>  	 * Whether the driver supports fb modifiers in the ADDFB2.1 ioctl call.
> +	 *
> +	 * IMPORTANT:
> +	 *
> +	 * If this is set the driver must fill out the full implicit modifier
> +	 * information in their &drm_mode_config_funcs.fb_create hook for legacy
> +	 * userspace which does not set modifiers. Otherwise the GETFB2 ioctl is
> +	 * broken for modifier aware userspace.
>  	 */
>  	bool allow_fb_modifiers;
>  

Hi,

are there any drivers that would infer this information at
modeset/pageflip/atomic ioctl time instead of AddFB/AddFB2 time?

Userspace may be creating the FB once per buffer and keep re-using
that over several render/display cycles. If a driver was changing the
"effective modifiers" dynamically, userspace could break.


Thanks,
pq
Daniel Vetter Sept. 2, 2020, 11:15 a.m. UTC | #2
On Wed, Sep 2, 2020 at 1:02 PM Pekka Paalanen <ppaalanen@gmail.com> wrote:
>
> On Wed,  2 Sep 2020 12:24:40 +0200
> Daniel Vetter <daniel.vetter@ffwll.ch> wrote:
>
> > Even for legacy userspace, since otherwise GETFB2 is broken and if you
> > switch between modifier-less and modifier-aware compositors, smooth
> > transitions break.
> >
> > Also it's just best practice to make sure modifiers are invariant for
> > a given drm_fb, and that a modifier-aware kms drivers only has one
> > place to store them, ignoring any old implicit bo flags or whatever
> > else might float around.
> >
> > Motivated by some irc discussion with Bas about amdgpu modifier
> > support.
> >
> > Fixes: 455e00f1412f ("drm: Add getfb2 ioctl")
> > Cc: Daniel Stone <daniels@collabora.com>
> > Cc: Juston Li <juston.li@intel.com>
> > Cc: Daniel Vetter <daniel.vetter@ffwll.ch>
> > Cc: Ville Syrjälä <ville.syrjala@linux.intel.com>
> > Cc: Bas Nieuwenhuizen <bas@basnieuwenhuizen.nl>
> > Cc: Marek Olšák <maraeo@gmail.com>
> > Cc: "Wentland, Harry" <harry.wentland@amd.com>
> > Signed-off-by: Daniel Vetter <daniel.vetter@intel.com>
> > ---
> >  include/drm/drm_mode_config.h | 13 +++++++++++++
> >  1 file changed, 13 insertions(+)
> >
> > diff --git a/include/drm/drm_mode_config.h b/include/drm/drm_mode_config.h
> > index a18f73eb3cf6..5ffbb4ed5b35 100644
> > --- a/include/drm/drm_mode_config.h
> > +++ b/include/drm/drm_mode_config.h
> > @@ -58,6 +58,12 @@ struct drm_mode_config_funcs {
> >        * actual modifier used if the request doesn't have it specified,
> >        * ie. when (@mode_cmd->flags & DRM_MODE_FB_MODIFIERS) == 0.
> >        *
> > +      * IMPORTANT: These implied modifiers for legacy userspace must be
> > +      * stored in struct &drm_framebuffer, including all relevant metadata
> > +      * like &drm_framebuffer.pitches and &drm_framebuffer.offsets if the
> > +      * modifier enables additional planes beyond the fourcc pixel format
> > +      * code. This is required by the GETFB2 ioctl.
> > +      *
> >        * If the parameters are deemed valid and the backing storage objects in
> >        * the underlying memory manager all exist, then the driver allocates
> >        * a new &drm_framebuffer structure, subclassed to contain
> > @@ -915,6 +921,13 @@ struct drm_mode_config {
> >        * @allow_fb_modifiers:
> >        *
> >        * Whether the driver supports fb modifiers in the ADDFB2.1 ioctl call.
> > +      *
> > +      * IMPORTANT:
> > +      *
> > +      * If this is set the driver must fill out the full implicit modifier
> > +      * information in their &drm_mode_config_funcs.fb_create hook for legacy
> > +      * userspace which does not set modifiers. Otherwise the GETFB2 ioctl is
> > +      * broken for modifier aware userspace.
> >        */
> >       bool allow_fb_modifiers;
> >
>
> Hi,
>
> are there any drivers that would infer this information at
> modeset/pageflip/atomic ioctl time instead of AddFB/AddFB2 time?

Currently no, the only driver that infers anything for legacy is i915.
Proposed amdgpu modifier patches don't work like that, but I think Bas
is working on adding the modifier inference at addfb time for legacy
userspace.

> Userspace may be creating the FB once per buffer and keep re-using
> that over several render/display cycles. If a driver was changing the
> "effective modifiers" dynamically, userspace could break.

Yeah this is why I want to lock this all down, since effective
modifiers that change for a drm_fb object which is supposed to have
all invariant metadata just isn't great uapi.
-Daniel

>
>
> Thanks,
> pq
Pekka Paalanen Sept. 2, 2020, 11:34 a.m. UTC | #3
On Wed, 2 Sep 2020 13:15:49 +0200
Daniel Vetter <daniel.vetter@ffwll.ch> wrote:

> On Wed, Sep 2, 2020 at 1:02 PM Pekka Paalanen <ppaalanen@gmail.com> wrote:
> >
> > On Wed,  2 Sep 2020 12:24:40 +0200
> > Daniel Vetter <daniel.vetter@ffwll.ch> wrote:
> >  
> > > Even for legacy userspace, since otherwise GETFB2 is broken and if you
> > > switch between modifier-less and modifier-aware compositors, smooth
> > > transitions break.
> > >
> > > Also it's just best practice to make sure modifiers are invariant for
> > > a given drm_fb, and that a modifier-aware kms drivers only has one
> > > place to store them, ignoring any old implicit bo flags or whatever
> > > else might float around.
> > >
> > > Motivated by some irc discussion with Bas about amdgpu modifier
> > > support.
> > >
> > > Fixes: 455e00f1412f ("drm: Add getfb2 ioctl")
> > > Cc: Daniel Stone <daniels@collabora.com>
> > > Cc: Juston Li <juston.li@intel.com>
> > > Cc: Daniel Vetter <daniel.vetter@ffwll.ch>
> > > Cc: Ville Syrjälä <ville.syrjala@linux.intel.com>
> > > Cc: Bas Nieuwenhuizen <bas@basnieuwenhuizen.nl>
> > > Cc: Marek Olšák <maraeo@gmail.com>
> > > Cc: "Wentland, Harry" <harry.wentland@amd.com>
> > > Signed-off-by: Daniel Vetter <daniel.vetter@intel.com>
> > > ---
> > >  include/drm/drm_mode_config.h | 13 +++++++++++++
> > >  1 file changed, 13 insertions(+)
> > >
> > > diff --git a/include/drm/drm_mode_config.h b/include/drm/drm_mode_config.h
> > > index a18f73eb3cf6..5ffbb4ed5b35 100644
> > > --- a/include/drm/drm_mode_config.h
> > > +++ b/include/drm/drm_mode_config.h
> > > @@ -58,6 +58,12 @@ struct drm_mode_config_funcs {
> > >        * actual modifier used if the request doesn't have it specified,
> > >        * ie. when (@mode_cmd->flags & DRM_MODE_FB_MODIFIERS) == 0.
> > >        *
> > > +      * IMPORTANT: These implied modifiers for legacy userspace must be
> > > +      * stored in struct &drm_framebuffer, including all relevant metadata
> > > +      * like &drm_framebuffer.pitches and &drm_framebuffer.offsets if the
> > > +      * modifier enables additional planes beyond the fourcc pixel format
> > > +      * code. This is required by the GETFB2 ioctl.
> > > +      *
> > >        * If the parameters are deemed valid and the backing storage objects in
> > >        * the underlying memory manager all exist, then the driver allocates
> > >        * a new &drm_framebuffer structure, subclassed to contain
> > > @@ -915,6 +921,13 @@ struct drm_mode_config {
> > >        * @allow_fb_modifiers:
> > >        *
> > >        * Whether the driver supports fb modifiers in the ADDFB2.1 ioctl call.
> > > +      *
> > > +      * IMPORTANT:
> > > +      *
> > > +      * If this is set the driver must fill out the full implicit modifier
> > > +      * information in their &drm_mode_config_funcs.fb_create hook for legacy
> > > +      * userspace which does not set modifiers. Otherwise the GETFB2 ioctl is
> > > +      * broken for modifier aware userspace.
> > >        */
> > >       bool allow_fb_modifiers;
> > >  
> >
> > Hi,
> >
> > are there any drivers that would infer this information at
> > modeset/pageflip/atomic ioctl time instead of AddFB/AddFB2 time?  
> 
> Currently no, the only driver that infers anything for legacy is i915.
> Proposed amdgpu modifier patches don't work like that, but I think Bas
> is working on adding the modifier inference at addfb time for legacy
> userspace.
> 
> > Userspace may be creating the FB once per buffer and keep re-using
> > that over several render/display cycles. If a driver was changing the
> > "effective modifiers" dynamically, userspace could break.  
> 
> Yeah this is why I want to lock this all down, since effective
> modifiers that change for a drm_fb object which is supposed to have
> all invariant metadata just isn't great uapi.

Sounds good to me!

Acked-by: Pekka Paalanen <pekka.paalanen@collabora.com>


Thanks,
pq
Simon Ser Sept. 2, 2020, 12:40 p.m. UTC | #4
Looks fine to me!

Acked-by: Simon Ser <contact@emersion.fr>

I suppose something similar happens in user-space: gbm_bo_create
without modifiers needs to properly set the implicit modifier, ie.
gbm_bo_get_modifier needs to return the effective modifier. Is this
something already documented?
Daniel Vetter Sept. 2, 2020, 12:44 p.m. UTC | #5
On Wed, Sep 2, 2020 at 2:40 PM Simon Ser <contact@emersion.fr> wrote:
>
> Looks fine to me!
>
> Acked-by: Simon Ser <contact@emersion.fr>
>
> I suppose something similar happens in user-space: gbm_bo_create
> without modifiers needs to properly set the implicit modifier, ie.
> gbm_bo_get_modifier needs to return the effective modifier. Is this
> something already documented?

I don't think that happens, but it has come up in discussions. It's
kinda different scenario though: getfb2 is for cross-compositor stuff,
enabling smooth transitions at boot-up and when switching. So you have
a legit reason for mixing modifier-aware userspace with
non-modifier-aware userspace. And the modifier-aware userspace would
like that everything works with modifiers consistently, including
getfb2. But gbm is just within a single process, and that should
either run all with modifiers, or not at all, since these worlds just
dont mix well. Hence I'm not seeing much use for that, -modesetting
being a confused mess nonwithstanding :-)

Cheers, Daniel
Simon Ser Sept. 2, 2020, 12:49 p.m. UTC | #6
On Wednesday, September 2, 2020 2:44 PM, Daniel Vetter <daniel.vetter@ffwll.ch> wrote:

> > I suppose something similar happens in user-space: gbm_bo_create
> > without modifiers needs to properly set the implicit modifier, ie.
> > gbm_bo_get_modifier needs to return the effective modifier. Is this
> > something already documented?
>
> I don't think that happens, but it has come up in discussions. It's
> kinda different scenario though: getfb2 is for cross-compositor stuff,
> enabling smooth transitions at boot-up and when switching. So you have
> a legit reason for mixing modifier-aware userspace with
> non-modifier-aware userspace. And the modifier-aware userspace would
> like that everything works with modifiers consistently, including
> getfb2. But gbm is just within a single process, and that should
> either run all with modifiers, or not at all, since these worlds just
> dont mix well. Hence I'm not seeing much use for that, -modesetting
> being a confused mess nonwithstanding :-)

Well… There's also the case where some legacy Wayland client talks to a
modifier-aware compositor. gbm_bo_import would be called without a
modifier, but the compositor expects gbm_bo_get_modifier to work.

Also, wlroots will call gbm_bo_create without a modifier to only let
the driver pick "safe" modifiers in case passing the full list of
modifiers results in a black screen. Later on wlroots will call
gbm_bo_get_modifier to figure out what modifier the driver picked.
Daniel Stone Sept. 2, 2020, 12:56 p.m. UTC | #7
On Wed, 2 Sep 2020 at 13:49, Simon Ser <contact@emersion.fr> wrote:
> On Wednesday, September 2, 2020 2:44 PM, Daniel Vetter <daniel.vetter@ffwll.ch> wrote:
> > I don't think that happens, but it has come up in discussions. It's
> > kinda different scenario though: getfb2 is for cross-compositor stuff,
> > enabling smooth transitions at boot-up and when switching. So you have
> > a legit reason for mixing modifier-aware userspace with
> > non-modifier-aware userspace. And the modifier-aware userspace would
> > like that everything works with modifiers consistently, including
> > getfb2. But gbm is just within a single process, and that should
> > either run all with modifiers, or not at all, since these worlds just
> > dont mix well. Hence I'm not seeing much use for that, -modesetting
> > being a confused mess nonwithstanding :-)
>
> Well… There's also the case where some legacy Wayland client talks to a
> modifier-aware compositor. gbm_bo_import would be called without a
> modifier, but the compositor expects gbm_bo_get_modifier to work.
>
> Also, wlroots will call gbm_bo_create without a modifier to only let
> the driver pick "safe" modifiers in case passing the full list of
> modifiers results in a black screen. Later on wlroots will call
> gbm_bo_get_modifier to figure out what modifier the driver picked.

I think those are reasonable expectations to have, even though
arguably for consistency we should always have a fixed INVALID for
when a modifier isn't used.

Anyway, patch is:
Acked-by: Daniel Stone <daniels@collabora.com>

Thanks for typing this up!

Cheers,
Daniel
Bas Nieuwenhuizen Sept. 2, 2020, 2:29 p.m. UTC | #8
On Wed, Sep 2, 2020 at 2:49 PM Simon Ser <contact@emersion.fr> wrote:
>
> On Wednesday, September 2, 2020 2:44 PM, Daniel Vetter <daniel.vetter@ffwll.ch> wrote:
>
> > > I suppose something similar happens in user-space: gbm_bo_create
> > > without modifiers needs to properly set the implicit modifier, ie.
> > > gbm_bo_get_modifier needs to return the effective modifier. Is this
> > > something already documented?
> >
> > I don't think that happens, but it has come up in discussions. It's
> > kinda different scenario though: getfb2 is for cross-compositor stuff,
> > enabling smooth transitions at boot-up and when switching. So you have
> > a legit reason for mixing modifier-aware userspace with
> > non-modifier-aware userspace. And the modifier-aware userspace would
> > like that everything works with modifiers consistently, including
> > getfb2. But gbm is just within a single process, and that should
> > either run all with modifiers, or not at all, since these worlds just
> > dont mix well. Hence I'm not seeing much use for that, -modesetting
> > being a confused mess nonwithstanding :-)
>
> Well… There's also the case where some legacy Wayland client talks to a
> modifier-aware compositor. gbm_bo_import would be called without a
> modifier, but the compositor expects gbm_bo_get_modifier to work.
>
> Also, wlroots will call gbm_bo_create without a modifier to only let
> the driver pick "safe" modifiers in case passing the full list of
> modifiers results in a black screen. Later on wlroots will call
> gbm_bo_get_modifier to figure out what modifier the driver picked.

I don't think we can do that generally, as pre-modifier clients are
typically also not capable of handling memory planes > format planes,
which will happen with compression (but used out of band communication
for the second plane on AMD in the non-modifier case).
> _______________________________________________
> dri-devel mailing list
> dri-devel@lists.freedesktop.org
> https://lists.freedesktop.org/mailman/listinfo/dri-devel
Daniel Vetter Sept. 2, 2020, 2:29 p.m. UTC | #9
On Wed, Sep 2, 2020 at 2:49 PM Simon Ser <contact@emersion.fr> wrote:
>
> On Wednesday, September 2, 2020 2:44 PM, Daniel Vetter <daniel.vetter@ffwll.ch> wrote:
>
> > > I suppose something similar happens in user-space: gbm_bo_create
> > > without modifiers needs to properly set the implicit modifier, ie.
> > > gbm_bo_get_modifier needs to return the effective modifier. Is this
> > > something already documented?
> >
> > I don't think that happens, but it has come up in discussions. It's
> > kinda different scenario though: getfb2 is for cross-compositor stuff,
> > enabling smooth transitions at boot-up and when switching. So you have
> > a legit reason for mixing modifier-aware userspace with
> > non-modifier-aware userspace. And the modifier-aware userspace would
> > like that everything works with modifiers consistently, including
> > getfb2. But gbm is just within a single process, and that should
> > either run all with modifiers, or not at all, since these worlds just
> > dont mix well. Hence I'm not seeing much use for that, -modesetting
> > being a confused mess nonwithstanding :-)
>
> Well… There's also the case where some legacy Wayland client talks to a
> modifier-aware compositor. gbm_bo_import would be called without a
> modifier, but the compositor expects gbm_bo_get_modifier to work.
>
> Also, wlroots will call gbm_bo_create without a modifier to only let
> the driver pick "safe" modifiers in case passing the full list of
> modifiers results in a black screen. Later on wlroots will call
> gbm_bo_get_modifier to figure out what modifier the driver picked.

gbm_bo_import is a different thing from gbm_bo_create. Former I agree
should figure out the right modifiers (and I think it does that, at
least on intel mesa). For gbm_bo_create I'm not sure we should/need to
require that.
-Daniel
Simon Ser Sept. 2, 2020, 2:59 p.m. UTC | #10
On Wednesday, September 2, 2020 4:29 PM, Daniel Vetter <daniel.vetter@ffwll.ch> wrote:

> On Wed, Sep 2, 2020 at 2:49 PM Simon Ser contact@emersion.fr wrote:
>
> > On Wednesday, September 2, 2020 2:44 PM, Daniel Vetter daniel.vetter@ffwll.ch wrote:
> >
> > > > I suppose something similar happens in user-space: gbm_bo_create
> > > > without modifiers needs to properly set the implicit modifier, ie.
> > > > gbm_bo_get_modifier needs to return the effective modifier. Is this
> > > > something already documented?
> > >
> > > I don't think that happens, but it has come up in discussions. It's
> > > kinda different scenario though: getfb2 is for cross-compositor stuff,
> > > enabling smooth transitions at boot-up and when switching. So you have
> > > a legit reason for mixing modifier-aware userspace with
> > > non-modifier-aware userspace. And the modifier-aware userspace would
> > > like that everything works with modifiers consistently, including
> > > getfb2. But gbm is just within a single process, and that should
> > > either run all with modifiers, or not at all, since these worlds just
> > > dont mix well. Hence I'm not seeing much use for that, -modesetting
> > > being a confused mess nonwithstanding :-)
> >
> > Well… There's also the case where some legacy Wayland client talks to a
> > modifier-aware compositor. gbm_bo_import would be called without a
> > modifier, but the compositor expects gbm_bo_get_modifier to work.
> > Also, wlroots will call gbm_bo_create without a modifier to only let
> > the driver pick "safe" modifiers in case passing the full list of
> > modifiers results in a black screen. Later on wlroots will call
> > gbm_bo_get_modifier to figure out what modifier the driver picked.
>
> gbm_bo_import is a different thing from gbm_bo_create. Former I agree
> should figure out the right modifiers (and I think it does that, at
> least on intel mesa). For gbm_bo_create I'm not sure we should/need to
> require that.

I guess the compositor will just forward the value returned by
gbm_bo_get_modifier in any case, so returning INVALID would be fine
too (to mean "implicit modifier").

In both the create and import cases, other metadata like pitches and
offsets should be correctly set I think?
Daniel Vetter Sept. 7, 2020, 8:31 a.m. UTC | #11
On Wed, Sep 02, 2020 at 02:59:49PM +0000, Simon Ser wrote:
> On Wednesday, September 2, 2020 4:29 PM, Daniel Vetter <daniel.vetter@ffwll.ch> wrote:
> 
> > On Wed, Sep 2, 2020 at 2:49 PM Simon Ser contact@emersion.fr wrote:
> >
> > > On Wednesday, September 2, 2020 2:44 PM, Daniel Vetter daniel.vetter@ffwll.ch wrote:
> > >
> > > > > I suppose something similar happens in user-space: gbm_bo_create
> > > > > without modifiers needs to properly set the implicit modifier, ie.
> > > > > gbm_bo_get_modifier needs to return the effective modifier. Is this
> > > > > something already documented?
> > > >
> > > > I don't think that happens, but it has come up in discussions. It's
> > > > kinda different scenario though: getfb2 is for cross-compositor stuff,
> > > > enabling smooth transitions at boot-up and when switching. So you have
> > > > a legit reason for mixing modifier-aware userspace with
> > > > non-modifier-aware userspace. And the modifier-aware userspace would
> > > > like that everything works with modifiers consistently, including
> > > > getfb2. But gbm is just within a single process, and that should
> > > > either run all with modifiers, or not at all, since these worlds just
> > > > dont mix well. Hence I'm not seeing much use for that, -modesetting
> > > > being a confused mess nonwithstanding :-)
> > >
> > > Well… There's also the case where some legacy Wayland client talks to a
> > > modifier-aware compositor. gbm_bo_import would be called without a
> > > modifier, but the compositor expects gbm_bo_get_modifier to work.
> > > Also, wlroots will call gbm_bo_create without a modifier to only let
> > > the driver pick "safe" modifiers in case passing the full list of
> > > modifiers results in a black screen. Later on wlroots will call
> > > gbm_bo_get_modifier to figure out what modifier the driver picked.
> >
> > gbm_bo_import is a different thing from gbm_bo_create. Former I agree
> > should figure out the right modifiers (and I think it does that, at
> > least on intel mesa). For gbm_bo_create I'm not sure we should/need to
> > require that.
> 
> I guess the compositor will just forward the value returned by
> gbm_bo_get_modifier in any case, so returning INVALID would be fine
> too (to mean "implicit modifier").
> 
> In both the create and import cases, other metadata like pitches and
> offsets should be correctly set I think?

Well if you have a modifier format underneath, the non-modifiered offsets
and pitches might be pure fiction. Also, they might not be sufficient, if
the modifier adds more planes.

So I'm not sure how we can let the "implicit modifier" go through once a
stack is converted to support modifiers. In a way modifiers are one-way
compatible only: implicit modifiers -> explicit modifiers should be
well-defined, the other way just looses information and doesn't work.
-Daniel
Simon Ser Sept. 7, 2020, 8:37 a.m. UTC | #12
On Monday, September 7, 2020 10:31 AM, Daniel Vetter <daniel@ffwll.ch> wrote:

> On Wed, Sep 02, 2020 at 02:59:49PM +0000, Simon Ser wrote:
>
> > On Wednesday, September 2, 2020 4:29 PM, Daniel Vetter daniel.vetter@ffwll.ch wrote:
> >
> > > On Wed, Sep 2, 2020 at 2:49 PM Simon Ser contact@emersion.fr wrote:
> > >
> > > > On Wednesday, September 2, 2020 2:44 PM, Daniel Vetter daniel.vetter@ffwll.ch wrote:
> > > >
> > > > > > I suppose something similar happens in user-space: gbm_bo_create
> > > > > > without modifiers needs to properly set the implicit modifier, ie.
> > > > > > gbm_bo_get_modifier needs to return the effective modifier. Is this
> > > > > > something already documented?
> > > > >
> > > > > I don't think that happens, but it has come up in discussions. It's
> > > > > kinda different scenario though: getfb2 is for cross-compositor stuff,
> > > > > enabling smooth transitions at boot-up and when switching. So you have
> > > > > a legit reason for mixing modifier-aware userspace with
> > > > > non-modifier-aware userspace. And the modifier-aware userspace would
> > > > > like that everything works with modifiers consistently, including
> > > > > getfb2. But gbm is just within a single process, and that should
> > > > > either run all with modifiers, or not at all, since these worlds just
> > > > > dont mix well. Hence I'm not seeing much use for that, -modesetting
> > > > > being a confused mess nonwithstanding :-)
> > > >
> > > > Well… There's also the case where some legacy Wayland client talks to a
> > > > modifier-aware compositor. gbm_bo_import would be called without a
> > > > modifier, but the compositor expects gbm_bo_get_modifier to work.
> > > > Also, wlroots will call gbm_bo_create without a modifier to only let
> > > > the driver pick "safe" modifiers in case passing the full list of
> > > > modifiers results in a black screen. Later on wlroots will call
> > > > gbm_bo_get_modifier to figure out what modifier the driver picked.
> > >
> > > gbm_bo_import is a different thing from gbm_bo_create. Former I agree
> > > should figure out the right modifiers (and I think it does that, at
> > > least on intel mesa). For gbm_bo_create I'm not sure we should/need to
> > > require that.
> >
> > I guess the compositor will just forward the value returned by
> > gbm_bo_get_modifier in any case, so returning INVALID would be fine
> > too (to mean "implicit modifier").
> > In both the create and import cases, other metadata like pitches and
> > offsets should be correctly set I think?
>
> Well if you have a modifier format underneath, the non-modifiered offsets
> and pitches might be pure fiction. Also, they might not be sufficient, if
> the modifier adds more planes.

In this case (gbm_bo_create without modifiers), we're discussing
whether we require gbm_bo_get_modifier to return a valid modifier, or
if INVALID is fine.

> So I'm not sure how we can let the "implicit modifier" go through once a
> stack is converted to support modifiers. In a way modifiers are one-way
> compatible only: implicit modifiers -> explicit modifiers should be
> well-defined, the other way just looses information and doesn't work.

That makes sense to me, and still works fine with the two use-cases
outlined above.
Daniel Vetter Sept. 7, 2020, 8:41 a.m. UTC | #13
On Mon, Sep 07, 2020 at 08:37:31AM +0000, Simon Ser wrote:
> On Monday, September 7, 2020 10:31 AM, Daniel Vetter <daniel@ffwll.ch> wrote:
> 
> > On Wed, Sep 02, 2020 at 02:59:49PM +0000, Simon Ser wrote:
> >
> > > On Wednesday, September 2, 2020 4:29 PM, Daniel Vetter daniel.vetter@ffwll.ch wrote:
> > >
> > > > On Wed, Sep 2, 2020 at 2:49 PM Simon Ser contact@emersion.fr wrote:
> > > >
> > > > > On Wednesday, September 2, 2020 2:44 PM, Daniel Vetter daniel.vetter@ffwll.ch wrote:
> > > > >
> > > > > > > I suppose something similar happens in user-space: gbm_bo_create
> > > > > > > without modifiers needs to properly set the implicit modifier, ie.
> > > > > > > gbm_bo_get_modifier needs to return the effective modifier. Is this
> > > > > > > something already documented?
> > > > > >
> > > > > > I don't think that happens, but it has come up in discussions. It's
> > > > > > kinda different scenario though: getfb2 is for cross-compositor stuff,
> > > > > > enabling smooth transitions at boot-up and when switching. So you have
> > > > > > a legit reason for mixing modifier-aware userspace with
> > > > > > non-modifier-aware userspace. And the modifier-aware userspace would
> > > > > > like that everything works with modifiers consistently, including
> > > > > > getfb2. But gbm is just within a single process, and that should
> > > > > > either run all with modifiers, or not at all, since these worlds just
> > > > > > dont mix well. Hence I'm not seeing much use for that, -modesetting
> > > > > > being a confused mess nonwithstanding :-)
> > > > >
> > > > > Well… There's also the case where some legacy Wayland client talks to a
> > > > > modifier-aware compositor. gbm_bo_import would be called without a
> > > > > modifier, but the compositor expects gbm_bo_get_modifier to work.
> > > > > Also, wlroots will call gbm_bo_create without a modifier to only let
> > > > > the driver pick "safe" modifiers in case passing the full list of
> > > > > modifiers results in a black screen. Later on wlroots will call
> > > > > gbm_bo_get_modifier to figure out what modifier the driver picked.
> > > >
> > > > gbm_bo_import is a different thing from gbm_bo_create. Former I agree
> > > > should figure out the right modifiers (and I think it does that, at
> > > > least on intel mesa). For gbm_bo_create I'm not sure we should/need to
> > > > require that.
> > >
> > > I guess the compositor will just forward the value returned by
> > > gbm_bo_get_modifier in any case, so returning INVALID would be fine
> > > too (to mean "implicit modifier").
> > > In both the create and import cases, other metadata like pitches and
> > > offsets should be correctly set I think?
> >
> > Well if you have a modifier format underneath, the non-modifiered offsets
> > and pitches might be pure fiction. Also, they might not be sufficient, if
> > the modifier adds more planes.
> 
> In this case (gbm_bo_create without modifiers), we're discussing
> whether we require gbm_bo_get_modifier to return a valid modifier, or
> if INVALID is fine.

Hm then I missed the use-case for a gbm_bo_create without modifiers, where
afterwards userspace wants the modifiers. That sounds like a bug (and yes
-modesetting is buggy that way).
-Daniel

> > So I'm not sure how we can let the "implicit modifier" go through once a
> > stack is converted to support modifiers. In a way modifiers are one-way
> > compatible only: implicit modifiers -> explicit modifiers should be
> > well-defined, the other way just looses information and doesn't work.
> 
> That makes sense to me, and still works fine with the two use-cases
> outlined above.
Pekka Paalanen Sept. 7, 2020, 9:07 a.m. UTC | #14
On Mon, 7 Sep 2020 10:41:37 +0200
Daniel Vetter <daniel@ffwll.ch> wrote:

> On Mon, Sep 07, 2020 at 08:37:31AM +0000, Simon Ser wrote:
> > On Monday, September 7, 2020 10:31 AM, Daniel Vetter <daniel@ffwll.ch> wrote:
> >   
> > > On Wed, Sep 02, 2020 at 02:59:49PM +0000, Simon Ser wrote:
> > >  
> > > > On Wednesday, September 2, 2020 4:29 PM, Daniel Vetter daniel.vetter@ffwll.ch wrote:
> > > >  
> > > > > On Wed, Sep 2, 2020 at 2:49 PM Simon Ser contact@emersion.fr wrote:
> > > > >  
> > > > > > On Wednesday, September 2, 2020 2:44 PM, Daniel Vetter daniel.vetter@ffwll.ch wrote:
> > > > > >  
> > > > > > > > I suppose something similar happens in user-space: gbm_bo_create
> > > > > > > > without modifiers needs to properly set the implicit modifier, ie.
> > > > > > > > gbm_bo_get_modifier needs to return the effective modifier. Is this
> > > > > > > > something already documented?  
> > > > > > >
> > > > > > > I don't think that happens, but it has come up in discussions. It's
> > > > > > > kinda different scenario though: getfb2 is for cross-compositor stuff,
> > > > > > > enabling smooth transitions at boot-up and when switching. So you have
> > > > > > > a legit reason for mixing modifier-aware userspace with
> > > > > > > non-modifier-aware userspace. And the modifier-aware userspace would
> > > > > > > like that everything works with modifiers consistently, including
> > > > > > > getfb2. But gbm is just within a single process, and that should
> > > > > > > either run all with modifiers, or not at all, since these worlds just
> > > > > > > dont mix well. Hence I'm not seeing much use for that, -modesetting
> > > > > > > being a confused mess nonwithstanding :-)  
> > > > > >
> > > > > > Well… There's also the case where some legacy Wayland client talks to a
> > > > > > modifier-aware compositor. gbm_bo_import would be called without a
> > > > > > modifier, but the compositor expects gbm_bo_get_modifier to work.
> > > > > > Also, wlroots will call gbm_bo_create without a modifier to only let
> > > > > > the driver pick "safe" modifiers in case passing the full list of
> > > > > > modifiers results in a black screen. Later on wlroots will call
> > > > > > gbm_bo_get_modifier to figure out what modifier the driver picked.  
> > > > >
> > > > > gbm_bo_import is a different thing from gbm_bo_create. Former I agree
> > > > > should figure out the right modifiers (and I think it does that, at
> > > > > least on intel mesa). For gbm_bo_create I'm not sure we should/need to
> > > > > require that.  
> > > >
> > > > I guess the compositor will just forward the value returned by
> > > > gbm_bo_get_modifier in any case, so returning INVALID would be fine
> > > > too (to mean "implicit modifier").
> > > > In both the create and import cases, other metadata like pitches and
> > > > offsets should be correctly set I think?  
> > >
> > > Well if you have a modifier format underneath, the non-modifiered offsets
> > > and pitches might be pure fiction. Also, they might not be sufficient, if
> > > the modifier adds more planes.  
> > 
> > In this case (gbm_bo_create without modifiers), we're discussing
> > whether we require gbm_bo_get_modifier to return a valid modifier, or
> > if INVALID is fine.  
> 
> Hm then I missed the use-case for a gbm_bo_create without modifiers, where
> afterwards userspace wants the modifiers. That sounds like a bug (and yes
> -modesetting is buggy that way).

I'm guessing that use case might be related to
https://gitlab.freedesktop.org/wayland/weston/-/issues/429

The weston issue is about
gbm_surface_create/gbm_surface_create_with_modifiers, but that's not
too different from gbm_bo_create/gbm_bo_create_with_modifiers?

Weston happens to have this code:
https://gitlab.freedesktop.org/wayland/weston/-/blob/9.0.0/libweston/backend-drm/drm-gbm.c#L209-230
and then it unconditionally calls gbm_bo_get_modifier(). However,
DRM_FORMAT_MOD_INVALID is handled specially:
https://gitlab.freedesktop.org/wayland/weston/-/blob/9.0.0/libweston/backend-drm/fb.c#L80-97


Thanks,
pq
Daniel Vetter Sept. 7, 2020, 1:51 p.m. UTC | #15
On Mon, Sep 7, 2020 at 11:07 AM Pekka Paalanen <ppaalanen@gmail.com> wrote:
>
> On Mon, 7 Sep 2020 10:41:37 +0200
> Daniel Vetter <daniel@ffwll.ch> wrote:
>
> > On Mon, Sep 07, 2020 at 08:37:31AM +0000, Simon Ser wrote:
> > > On Monday, September 7, 2020 10:31 AM, Daniel Vetter <daniel@ffwll.ch> wrote:
> > >
> > > > On Wed, Sep 02, 2020 at 02:59:49PM +0000, Simon Ser wrote:
> > > >
> > > > > On Wednesday, September 2, 2020 4:29 PM, Daniel Vetter daniel.vetter@ffwll.ch wrote:
> > > > >
> > > > > > On Wed, Sep 2, 2020 at 2:49 PM Simon Ser contact@emersion.fr wrote:
> > > > > >
> > > > > > > On Wednesday, September 2, 2020 2:44 PM, Daniel Vetter daniel.vetter@ffwll.ch wrote:
> > > > > > >
> > > > > > > > > I suppose something similar happens in user-space: gbm_bo_create
> > > > > > > > > without modifiers needs to properly set the implicit modifier, ie.
> > > > > > > > > gbm_bo_get_modifier needs to return the effective modifier. Is this
> > > > > > > > > something already documented?
> > > > > > > >
> > > > > > > > I don't think that happens, but it has come up in discussions. It's
> > > > > > > > kinda different scenario though: getfb2 is for cross-compositor stuff,
> > > > > > > > enabling smooth transitions at boot-up and when switching. So you have
> > > > > > > > a legit reason for mixing modifier-aware userspace with
> > > > > > > > non-modifier-aware userspace. And the modifier-aware userspace would
> > > > > > > > like that everything works with modifiers consistently, including
> > > > > > > > getfb2. But gbm is just within a single process, and that should
> > > > > > > > either run all with modifiers, or not at all, since these worlds just
> > > > > > > > dont mix well. Hence I'm not seeing much use for that, -modesetting
> > > > > > > > being a confused mess nonwithstanding :-)
> > > > > > >
> > > > > > > Well… There's also the case where some legacy Wayland client talks to a
> > > > > > > modifier-aware compositor. gbm_bo_import would be called without a
> > > > > > > modifier, but the compositor expects gbm_bo_get_modifier to work.
> > > > > > > Also, wlroots will call gbm_bo_create without a modifier to only let
> > > > > > > the driver pick "safe" modifiers in case passing the full list of
> > > > > > > modifiers results in a black screen. Later on wlroots will call
> > > > > > > gbm_bo_get_modifier to figure out what modifier the driver picked.
> > > > > >
> > > > > > gbm_bo_import is a different thing from gbm_bo_create. Former I agree
> > > > > > should figure out the right modifiers (and I think it does that, at
> > > > > > least on intel mesa). For gbm_bo_create I'm not sure we should/need to
> > > > > > require that.
> > > > >
> > > > > I guess the compositor will just forward the value returned by
> > > > > gbm_bo_get_modifier in any case, so returning INVALID would be fine
> > > > > too (to mean "implicit modifier").
> > > > > In both the create and import cases, other metadata like pitches and
> > > > > offsets should be correctly set I think?
> > > >
> > > > Well if you have a modifier format underneath, the non-modifiered offsets
> > > > and pitches might be pure fiction. Also, they might not be sufficient, if
> > > > the modifier adds more planes.
> > >
> > > In this case (gbm_bo_create without modifiers), we're discussing
> > > whether we require gbm_bo_get_modifier to return a valid modifier, or
> > > if INVALID is fine.
> >
> > Hm then I missed the use-case for a gbm_bo_create without modifiers, where
> > afterwards userspace wants the modifiers. That sounds like a bug (and yes
> > -modesetting is buggy that way).
>
> I'm guessing that use case might be related to
> https://gitlab.freedesktop.org/wayland/weston/-/issues/429
>
> The weston issue is about
> gbm_surface_create/gbm_surface_create_with_modifiers, but that's not
> too different from gbm_bo_create/gbm_bo_create_with_modifiers?
>
> Weston happens to have this code:
> https://gitlab.freedesktop.org/wayland/weston/-/blob/9.0.0/libweston/backend-drm/drm-gbm.c#L209-230
> and then it unconditionally calls gbm_bo_get_modifier(). However,
> DRM_FORMAT_MOD_INVALID is handled specially:
> https://gitlab.freedesktop.org/wayland/weston/-/blob/9.0.0/libweston/backend-drm/fb.c#L80-97

Hm yeah that feels a bit like an interim hack instead of more
modifiers fallback logic. I guess shouldn't be too tricky for mesa to
support that, since internally modifier aware drivers work only with
modifiers anyway (or at least should, that's what we're requiring on
the kms side with this patch at least).

Up to mesa people I'd say.
-Daniel
diff mbox series

Patch

diff --git a/include/drm/drm_mode_config.h b/include/drm/drm_mode_config.h
index a18f73eb3cf6..5ffbb4ed5b35 100644
--- a/include/drm/drm_mode_config.h
+++ b/include/drm/drm_mode_config.h
@@ -58,6 +58,12 @@  struct drm_mode_config_funcs {
 	 * actual modifier used if the request doesn't have it specified,
 	 * ie. when (@mode_cmd->flags & DRM_MODE_FB_MODIFIERS) == 0.
 	 *
+	 * IMPORTANT: These implied modifiers for legacy userspace must be
+	 * stored in struct &drm_framebuffer, including all relevant metadata
+	 * like &drm_framebuffer.pitches and &drm_framebuffer.offsets if the
+	 * modifier enables additional planes beyond the fourcc pixel format
+	 * code. This is required by the GETFB2 ioctl.
+	 *
 	 * If the parameters are deemed valid and the backing storage objects in
 	 * the underlying memory manager all exist, then the driver allocates
 	 * a new &drm_framebuffer structure, subclassed to contain
@@ -915,6 +921,13 @@  struct drm_mode_config {
 	 * @allow_fb_modifiers:
 	 *
 	 * Whether the driver supports fb modifiers in the ADDFB2.1 ioctl call.
+	 *
+	 * IMPORTANT:
+	 *
+	 * If this is set the driver must fill out the full implicit modifier
+	 * information in their &drm_mode_config_funcs.fb_create hook for legacy
+	 * userspace which does not set modifiers. Otherwise the GETFB2 ioctl is
+	 * broken for modifier aware userspace.
 	 */
 	bool allow_fb_modifiers;