Received-SPF: pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 2620:137:e000::1:20 as permitted sender) client-ip=2620:137:e000::1:20;
Date:   Wed, 4 Jan 2023 13:05:56 -0500
From:   Rodrigo Vivi <rodrigo.vivi@intel.com>
To:     Julia Lawall <julia.lawall@inria.fr>
CC:     Deepak R Varma <drv@mailo.com>,
        Nicolai Stange <nicstange@gmail.com>,
        Julia Lawall <Julia.Lawall@lip6.fr>,
        Jani Nikula <jani.nikula@linux.intel.com>,
        Joonas Lahtinen <joonas.lahtinen@linux.intel.com>,
        Tvrtko Ursulin <tvrtko.ursulin@linux.intel.com>,
        David Airlie <airlied@gmail.com>,
        "Daniel Vetter" <daniel@ffwll.ch>,
        <intel-gfx@lists.freedesktop.org>,
        <dri-devel@lists.freedesktop.org>, <linux-kernel@vger.kernel.org>,
        "Saurabh Singh Sengar" <ssengar@microsoft.com>,
        Praveen Kumar <kumarpraveen@linux.microsoft.com>
Subject: Re: [PATCH] drm/i915/fbc: Avoid full proxy f_ops for FBC debug
 attributes
Message-ID: <Y7XABJ9MWCWO5IUA@intel.com>
References: <Y6qmNW6cOHjGwn03@qemulion>
 <Y6sn1BmhFJFssW0h@intel.com>
 <Y6s0FSK9+F+/oKSf@qemulion>
 <Y6wl9NhYZG5RjJL7@intel.com>
 <Y7PG5Hx5dDE7aHSx@qemulion>
 <alpine.DEB.2.22.394.2301041850570.7216@hadrien>
Content-Type: text/plain; charset="us-ascii"
Content-Disposition: inline
In-Reply-To: <alpine.DEB.2.22.394.2301041850570.7216@hadrien>
MIME-Version: 1.0
X-MS-Exchange-AntiSpam-MessageData-ChunkCount: 1
X-MS-Exchange-AntiSpam-MessageData-0: =?us-ascii?Q?va7mAdOwHVBqEVh5xo5R4FsFahFVjeKwoC1TQvWiZzznSCXNYusu66TUNyBM?=
 =?us-ascii?Q?c9ydljFtf/H+wFVVJ63/bOAn5m+qa28yFGehwGaq8mL8547mI+aBkOeAGCIK?=
 =?us-ascii?Q?fFa99VllZixD6kziIDCbhDzKGs9j5IiiYw+byFLV32nOltIY/lMfxqe3IDaD?=
 =?us-ascii?Q?HwmghNLJC2VPxDeJ4yG1uY+pm8HhQZWwpGnPMAmUlupLLL1/xCoXHCNaVfk+?=
 =?us-ascii?Q?mEStvOQ43p6R6jemGIFROENr+SyJUD+j915WjrHjtv8ghp7vunOQsFdC4fBC?=
 =?us-ascii?Q?FMwTGbDmvK2RJgeCwthmyQv2YzAZHdn/pw5ZgzXHQKlkl3cWgG4DNEEqEVue?=
 =?us-ascii?Q?QdXvlpdiptUFxA6HofhbENupXq2tcw5efGdskgR918bnRs93yxcXtlzSuU22?=
 =?us-ascii?Q?ZrSdtKcP3R6D8WFmTPgBmV3/QxS9LeFFYihHfsS07nZGC2YubUZhid7eIiI5?=
 =?us-ascii?Q?kYH7YWpGZI68T1QIWobQpMr64+LxOLXVaIKlF5B2/GELzFG0s2PIrXnRTQHu?=
 =?us-ascii?Q?gLgOaRpzeRmeyOdIPtVpVhtsYDffztEcXfX36LVjSmx0tyuzJ0bqmJh6ANsc?=
 =?us-ascii?Q?eJwIVnTrNZd5PkO4HT2us0gVuHodwsxEllnaWY8J03KjWIgl6s1qt0sRhQ6O?=
 =?us-ascii?Q?55SgaMhA03sP97UXBnPl2DHkq4Bus4Qy1R9WoqXf0Y59tydvVDcZAkSkPsRu?=
 =?us-ascii?Q?vtCTlSHROd57qKjaKsAAFpdDxDNaiMhxBJl1rFaamc9+s+cgT6xtF5vDu/3T?=
 =?us-ascii?Q?EItTRzFjesz8XdhqL+Sfhr/SWseXrdO3mtWF6Fd+bxCdPcr21VBDEOTF2tRj?=
 =?us-ascii?Q?dHOsYrkGRTkiEiuFd+t8ZmIXlRBCTzMsOOT4Vb8vhxAL7qukwMrF+HhwmNT4?=
 =?us-ascii?Q?K7E+I/jULal85Tn2MsZWKdbsxIvCl9FNNDRxP4LmDjc2o7MAarxHCoyfdKB8?=
 =?us-ascii?Q?VmZ9NV2ifoybtn2wH4wOFVO6zqNSC/BT5TFzUvr2/Pk5O0mEVltu6UBsnqW2?=
 =?us-ascii?Q?MxNpNu6NrAtxqk85B6OjjAGt9sTAODMRrDT01HZVaqsf9T/XKRIGnhGNRDww?=
 =?us-ascii?Q?TAMZfRWAMK7Zhs1utBYevsSpZCG3NebE7BcBOZY8ed7ZCrNkVO6Q1qYWZMz3?=
 =?us-ascii?Q?wue+E4jljABh/pd2XQ9cQmwyXf1SeVnAEwNE/8ktgac/V8o26BYnPC3wZC6Z?=
 =?us-ascii?Q?fxiet4deBc4LzLao33pTsIyhn15PD1YP4hJnCwjrPlfgbC57nbKIF3w8jYKl?=
 =?us-ascii?Q?fUGKNWJWBXiIOKukwId9GteWExujv1VV7HZUNDfJ9P4gchLcu7uyHZDFxMxR?=
 =?us-ascii?Q?6pbErV7QZlMw1WvFf05QErvd7DxCofxKvUH2ROWZaNPEAFKwzm9KVIunCB2q?=
 =?us-ascii?Q?Yjrsotc5XyQtu2h0IWUQH7Tnd8O1esXDzTlW5M2P2WhUSljXQt6qL5/tR3gg?=
 =?us-ascii?Q?YweBA6lqV9YU8z+gzudhMYJ4JNPVReRGKRIPEAgiFscKnv+vPkPT+wBeGCTa?=
 =?us-ascii?Q?4KjjzT7q8J/vOCF3YduD4Ubj6iiqzeERNFkitgZbYHXefK3AnYStMSkg+a8w?=
 =?us-ascii?Q?cNwVi9BA9WDEN5xAb1cE0nIs6z1mOh5Jvhp9wJyKGGpku4UnL2ArVA98E8RE?=
 =?us-ascii?Q?9w=3D=3D?=
X-MS-Exchange-CrossTenant-Network-Message-Id: 4365b236-f377-4028-5c2a-08daee7e5706
X-MS-Exchange-CrossTenant-AuthSource: MN0PR11MB6059.namprd11.prod.outlook.com
X-MS-Exchange-CrossTenant-AuthAs: Internal
X-MS-Exchange-CrossTenant-OriginalArrivalTime: 04 Jan 2023 18:06:02.2014
 (UTC)
X-MS-Exchange-CrossTenant-FromEntityHeader: Hosted
X-MS-Exchange-CrossTenant-Id: 46c98d88-e344-4ed4-8496-4ed7712e255d
X-MS-Exchange-CrossTenant-MailboxType: HOSTED
X-MS-Exchange-CrossTenant-UserPrincipalName: d218OiHKgFhtAiVgWjP79lvSa2bSiY/e7SoSS5Rq0Rxdh2ur/wf2dy+pAVGmvsTfq+DAmC2zl2ur7UYlpMCVHA==
X-MS-Exchange-Transport-CrossTenantHeadersStamped: DM4PR11MB7184
X-OriginatorOrg: intel.com
X-Spam-Status: No, score=-2.1 required=5.0 tests=BAYES_00,DKIMWL_WL_HIGH,
        DKIM_SIGNED,DKIM_VALID,DKIM_VALID_AU,DKIM_VALID_EF,SPF_HELO_NONE,
        SPF_NONE autolearn=ham autolearn_force=no version=3.4.6
X-Spam-Checker-Version: SpamAssassin 3.4.6 (2021-04-09) on
        lindbergh.monkeyblade.net
Precedence: bulk
List-ID: <linux-kernel.vger.kernel.org>
X-Mailing-List: linux-kernel@vger.kernel.org

On Wed, Jan 04, 2023 at 06:51:37PM +0100, Julia Lawall wrote:
> 
> 
> On Tue, 3 Jan 2023, Deepak R Varma wrote:
> 
> > On Wed, Dec 28, 2022 at 06:18:12AM -0500, Rodrigo Vivi wrote:
> > > On Tue, Dec 27, 2022 at 11:36:13PM +0530, Deepak R Varma wrote:
> > > > On Tue, Dec 27, 2022 at 12:13:56PM -0500, Rodrigo Vivi wrote:
> > > > > On Tue, Dec 27, 2022 at 01:30:53PM +0530, Deepak R Varma wrote:
> > > > > > Using DEFINE_SIMPLE_ATTRIBUTE macro with the debugfs_create_file()
> > > > > > function adds the overhead of introducing a proxy file operation
> > > > > > functions to wrap the original read/write inside file removal protection
> > > > > > functions. This adds significant overhead in terms of introducing and
> > > > > > managing the proxy factory file operations structure and function
> > > > > > wrapping at runtime.
> > > > > > As a replacement, a combination of DEFINE_DEBUGFS_ATTRIBUTE macro paired
> > > > > > with debugfs_create_file_unsafe() is suggested to be used instead.  The
> > > > > > DEFINE_DEBUGFS_ATTRIBUTE utilises debugfs_file_get() and
> > > > > > debugfs_file_put() wrappers to protect the original read and write
> > > > > > function calls for the debug attributes. There is no need for any
> > > > > > runtime proxy file operations to be managed by the debugfs core.
> > > > > >
> > > > > > This Change is reported by the debugfs_simple_attr.cocci Coccinelle
> > > > > > semantic patch.
> > > > >
> > > > > I just checked here with
> > > > > $ make coccicheck M=drivers/gpu/drm/i915/ MODE=context COCCI=./scripts/coccinelle/api/debugfs/debugfs_simple_attr.cocci
> > > >
> > > > Hello Rodrigo,
> > > > Thank you so much for your review and feedback on the patch proposal.
> > > >
> > > > >
> > > > > The part reported by the this script is the s/SIMPLE/DEBUGFS
> > > > > but the change to the unsafe option is not.
> > > >
> > > > If you look at the original commit of this coccinelle file, it calls out the
> > > > need for pairing debugfs_create_file_unsafe() as well. Please review this
> > > >
> > > > commitID: 5103068eaca2: ("debugfs, coccinelle: check for obsolete DEFINE_SIMPLE_ATTRIBUTE() usage")
> > >
> > > +Nicolai and Julia.
> > >
> > > It looks like coccinelle got right the
> > > - DEFINE_SIMPLE_ATTRIBUTE(dsa_fops, dsa_get, dsa_set, dsa_fmt);
> > > + DEFINE_DEBUGFS_ATTRIBUTE(dsa_fops, dsa_get, dsa_set, dsa_fmt);
> > >
> > > but it failed badly on
> > > - debugfs_create_file(name, mode, parent, data, &dsa_fops)
> > > + debugfs_create_file_unsafe(name, mode, parent, data, &dsa_fops)
> > >
> > > >
> > > > Based on my review of the code, the functions debugfs_create_file() and
> > > > debugfs_create_file_unsafe(), both internally call __debugfs_create_file().
> > > > However, they pass debugfs_full_proxy_file_operations and
> > > > debugfs_open_proxy_file_operations respectively to it. The former represents the
> > > > full proxy factory, where as the later one is lightweight open proxy
> > > > implementation of the file operations structure.
> > > >
> > > > >
> > > > > This commit message is not explaining why the unsafe is the suggested
> > > > > or who suggested it.
> > > >
> > > > If you find the response above accurate, I will include these details about
> > > > the _unsafe() function in my commit message in v2.
> > > >
> > > > >
> > > > > If you remove the unsafe part feel free to resend adding:
> > > >
> > > > Please confirm you still believe switching to _unsafe() is not necessary.
> > >
> > > Based on the coccinelle commit it looks like you are right, but cocinelle
> > > just failed to detect the case. Let's see what Nicolai and Julia respond
> > > before we move with any patch here.
> >
> > Hello Nicolai and Julia,
> > Can you please review this proposed patch and the feedback comments from Rodrigo
> > please?
> 
> I'm not an expert on this issue.  If the semantic patch needs to change in
> some way, I would be happy to take any improvements.

Hi Julia, thanks for helping here.

So, my question is why this 

make coccicheck M=drivers/gpu/drm/i915/ MODE=context COCCI=./scripts/coccinelle/api/debugfs/debugfs_simple_attr.cocci 

didn't catch this chunck:

-		debugfs_create_file("i915_fbc_false_color", 0644, parent,
-				    fbc, &intel_fbc_debugfs_false_color_fops);
+		debugfs_create_file_unsafe("i915_fbc_false_color", 0644, parent,
+					   fbc, &intel_fbc_debugfs_false_color_fops);

When I run it it only catches and replaces this:

- DEFINE_SIMPLE_ATTRIBUTE(dsa_fops, dsa_get, dsa_set, dsa_fmt);
+ DEFINE_DEBUGFS_ATTRIBUTE(dsa_fops, dsa_get, dsa_set, dsa_fmt);

But looking to the .cocci script or at least to its description,
I believe it should catch both cases.

But if it is not a bug in the cocci script, then I'd like to hear
from Nicolai why. And have this documented in the script.

Thanks,
Rodrigo.

> 
> julia
> 
> 
> >
> > Thank you,
> > ./drv
> >
> > >
> > > >
> > > > >
> > > > > Reviewed-by: Rodrigo Vivi <rodrigo.vivi@intel.com>
> > > > > (to both patches, this and the drrs one.
> > > > >
> > > > > Also, it looks like you could contribute with other 2 patches:
> > > > > drivers/gpu/drm/i915/pxp/intel_pxp_debugfs.c:64:0-23: WARNING: pxp_terminate_fops should be defined with DEFINE_DEBUGFS_ATTRIBUTE
> > > > > drivers/gpu/drm/i915/gvt/debugfs.c:150:0-23: WARNING: vgpu_scan_nonprivbb_fops should be defined with DEFINE_DEBUGFS_ATTRIBUTE
> > > >
> > > > Yes, these are on my list. Was waiting for a feedback on the first submission
> > > > before I send more similar patches.
> > > >
> > > > Appreciate your time and the feedback.
> > > >
> > > >
> > > > Regards,
> > > > ./drv
> > > >
> > > > >
> > > > > >
> > > > > > Signed-off-by: Deepak R Varma <drv@mailo.com>
> > > > > > ---
> > > > > >  drivers/gpu/drm/i915/display/intel_fbc.c | 12 ++++++------
> > > > > >  1 file changed, 6 insertions(+), 6 deletions(-)
> > > > > >
> > > > > > diff --git a/drivers/gpu/drm/i915/display/intel_fbc.c b/drivers/gpu/drm/i915/display/intel_fbc.c
> > > > > > index b5ee5ea0d010..4b481e2f908b 100644
> > > > > > --- a/drivers/gpu/drm/i915/display/intel_fbc.c
> > > > > > +++ b/drivers/gpu/drm/i915/display/intel_fbc.c
> > > > > > @@ -1809,10 +1809,10 @@ static int intel_fbc_debugfs_false_color_set(void *data, u64 val)
> > > > > >  	return 0;
> > > > > >  }
> > > > > >
> > > > > > -DEFINE_SIMPLE_ATTRIBUTE(intel_fbc_debugfs_false_color_fops,
> > > > > > -			intel_fbc_debugfs_false_color_get,
> > > > > > -			intel_fbc_debugfs_false_color_set,
> > > > > > -			"%llu\n");
> > > > > > +DEFINE_DEBUGFS_ATTRIBUTE(intel_fbc_debugfs_false_color_fops,
> > > > > > +			 intel_fbc_debugfs_false_color_get,
> > > > > > +			 intel_fbc_debugfs_false_color_set,
> > > > > > +			 "%llu\n");
> > > > > >
> > > > > >  static void intel_fbc_debugfs_add(struct intel_fbc *fbc,
> > > > > >  				  struct dentry *parent)
> > > > > > @@ -1821,8 +1821,8 @@ static void intel_fbc_debugfs_add(struct intel_fbc *fbc,
> > > > > >  			    fbc, &intel_fbc_debugfs_status_fops);
> > > > > >
> > > > > >  	if (fbc->funcs->set_false_color)
> > > > > > -		debugfs_create_file("i915_fbc_false_color", 0644, parent,
> > > > > > -				    fbc, &intel_fbc_debugfs_false_color_fops);
> > > > > > +		debugfs_create_file_unsafe("i915_fbc_false_color", 0644, parent,
> > > > > > +					   fbc, &intel_fbc_debugfs_false_color_fops);
> > > > > >  }
> > > > > >
> > > > > >  void intel_fbc_crtc_debugfs_add(struct intel_crtc *crtc)
> > > > > > --
> > > > > > 2.34.1
> > > > > >
> > > > > >
> > > > > >
> > > >
> > > >
> > >
> >
> >
> >