From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on aws-us-west-2-korg-lkml-1.web.codeaurora.org Received: from vger.kernel.org (vger.kernel.org [23.128.96.18]) by smtp.lore.kernel.org (Postfix) with ESMTP id 4F672C54EBC for ; Sun, 8 Jan 2023 10:38:09 +0000 (UTC) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S232965AbjAHKhh (ORCPT ); Sun, 8 Jan 2023 05:37:37 -0500 Received: from lindbergh.monkeyblade.net ([23.128.96.19]:36344 "EHLO lindbergh.monkeyblade.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S231184AbjAHKhe (ORCPT ); Sun, 8 Jan 2023 05:37:34 -0500 Received: from sender-of-o50.zoho.in (sender-of-o50.zoho.in [103.117.158.50]) by lindbergh.monkeyblade.net (Postfix) with ESMTPS id 59971E0AC; Sun, 8 Jan 2023 02:37:30 -0800 (PST) ARC-Seal: i=1; a=rsa-sha256; t=1673174206; cv=none; d=zohomail.in; s=zohoarc; b=akXCCA4JuxnOgto/J8q1kb+rip57LQ+dko8pa4VesnXQCZtDQZyjwTbUWJ79SoCtrDPAWvD5P3jEAExAq7m2VE4PJ6E9/nEp3oTC0vcpTUZtSRXygu3kXdlLzAI2qEcECMnnf/lSar/eIFpy0YAb4tf9BsYl6lemqLV8NcD5cHg= ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=zohomail.in; s=zohoarc; t=1673174206; h=Content-Type:Content-Transfer-Encoding:Cc:Date:From:In-Reply-To:MIME-Version:Message-ID:References:Subject:To; bh=i1VfZ1loxuzJE4HpGT3JsDM7dhG8ZhXmhmOet+rOcV0=; b=IqwfeT5R13uy0cuxTkQYXYexmJXDxsn1TKJMQGIBV7cOnon9Y0pskrXlasexqxASoVRIsAUbKKvPa5Mithc714nFOQ3E1kJ2CC67Hzz30lbmHohwEzMWUazRmuYvO+9NtOp0CtTYf1sfiLxloHpBLzSEalRMWGOIibj9eMFUZc4= ARC-Authentication-Results: i=1; mx.zohomail.in; dkim=pass header.i=siddh.me; spf=pass smtp.mailfrom=code@siddh.me; dmarc=pass header.from= DKIM-Signature: v=1; a=rsa-sha256; q=dns/txt; c=relaxed/relaxed; t=1673174206; s=zmail; d=siddh.me; i=code@siddh.me; h=From:From:To:To:Cc:Cc:Message-ID:Subject:Subject:Date:Date:In-Reply-To:References:MIME-Version:Content-Transfer-Encoding:Content-Type:Message-Id:Reply-To; bh=i1VfZ1loxuzJE4HpGT3JsDM7dhG8ZhXmhmOet+rOcV0=; b=amaa5UjyejDEI5LrocbxMM3bBAMy4TBXNeX0QgM10CrpeE5z9uHNfPCgUqm2XkUK 1N9pcnZux/Jej5sYtOO/vYGuaArPchnjuo6VVwPFsXSQemFEhLAHtgX+LqHOMdU3qp7 aillHXO9pvIeAP25d3Ul26C9lyjS9L8G6JPPXrKg= Received: from kampyooter.. (110.226.31.37 [110.226.31.37]) by mx.zoho.in with SMTPS id 1673174205857144.87777906120232; Sun, 8 Jan 2023 16:06:45 +0530 (IST) From: Siddh Raman Pant To: Mauro Carvalho Chehab , Randy Dunlap , David Howells , Jonathan Corbet , "Fabio M. De Francesco" , Eric Dumazet , Christophe JAILLET , Eric Biggers Cc: keyrings , linux-security-module , linux-fsdevel , linux-kernel Message-ID: <97ce37e2fdcfbed29d9467057f0f870359d88b89.1673173920.git.code@siddh.me> Subject: [PATCH v3 1/2] include/linux/watch_queue: Improve documentation Date: Sun, 8 Jan 2023 16:06:31 +0530 X-Mailer: git-send-email 2.39.0 In-Reply-To: References: MIME-Version: 1.0 Content-Transfer-Encoding: quoted-printable X-ZohoMailClient: External Content-Type: text/plain; charset=utf8 Precedence: bulk List-ID: X-Mailing-List: linux-fsdevel@vger.kernel.org Introduce kerneldoc-style comments, and document a couple of things explicitly. Signed-off-by: Siddh Raman Pant --- include/linux/watch_queue.h | 102 ++++++++++++++++++++++++++---------- 1 file changed, 75 insertions(+), 27 deletions(-) diff --git a/include/linux/watch_queue.h b/include/linux/watch_queue.h index fc6bba20273b..7f6eea4a33a6 100644 --- a/include/linux/watch_queue.h +++ b/include/linux/watch_queue.h @@ -18,57 +18,103 @@ =20 struct cred; =20 +/** + * struct watch_type_filter - Filter on watch type + * + * @type: Type of watch_notification + * @subtype_filter: Bitmask of subtypes to filter on + * @info_filter: Filter on watch_notification::info + * @info_mask: Mask of relevant bits in info_filter + */ struct watch_type_filter { =09enum watch_notification_type type; -=09__u32=09=09subtype_filter[1];=09/* Bitmask of subtypes to filter on */ -=09__u32=09=09info_filter;=09=09/* Filter on watch_notification::info */ -=09__u32=09=09info_mask;=09=09/* Mask of relevant bits in info_filter */ +=09__u32=09=09subtype_filter[1]; +=09__u32=09=09info_filter; +=09__u32=09=09info_mask; }; =20 +/** + * struct watch_filter - Filter on watch + * + * @rcu: RCU head (in union with type_filter) + * @type_filter: Bitmask of accepted types (in union with rcu) + * @nr_filters: Number of filters + * @filters: Array of watch_type_filter + */ struct watch_filter { =09union { =09=09struct rcu_head=09rcu; -=09=09/* Bitmask of accepted types */ =09=09DECLARE_BITMAP(type_filter, WATCH_TYPE__NR); =09}; -=09u32=09=09=09nr_filters;=09/* Number of filters */ +=09u32=09=09=09 nr_filters; =09struct watch_type_filter filters[]; }; =20 +/** + * struct watch_queue - General notification queue + * + * @rcu: RCU head + * @filter: Filter to use on watches + * @pipe: The pipe we're using as a buffer + * @watches: Contributory watches + * @notes: Preallocated notifications + * @notes_bitmap: Allocation bitmap for notes + * @usage: Object usage count + * @lock: To serialize accesses and removes + * @nr_notes: Number of notes + * @nr_pages: Number of pages in notes[] + * @defunct: True when queues closed + */ struct watch_queue { =09struct rcu_head=09=09rcu; =09struct watch_filter __rcu *filter; -=09struct pipe_inode_info=09*pipe;=09=09/* The pipe we're using as a buffe= r */ -=09struct hlist_head=09watches;=09/* Contributory watches */ -=09struct page=09=09**notes;=09/* Preallocated notifications */ -=09unsigned long=09=09*notes_bitmap;=09/* Allocation bitmap for notes */ -=09struct kref=09=09usage;=09=09/* Object usage count */ +=09struct pipe_inode_info=09*pipe; +=09struct hlist_head=09watches; +=09struct page=09=09**notes; +=09unsigned long=09=09*notes_bitmap; +=09struct kref=09=09usage; =09spinlock_t=09=09lock; -=09unsigned int=09=09nr_notes;=09/* Number of notes */ -=09unsigned int=09=09nr_pages;=09/* Number of pages in notes[] */ -=09bool=09=09=09defunct;=09/* T when queues closed */ +=09unsigned int=09=09nr_notes; +=09unsigned int=09=09nr_pages; +=09bool=09=09=09defunct; }; =20 -/* - * Representation of a watch on an object. +/** + * struct watch - Representation of a watch on an object + * + * @rcu: RCU head (in union with info_id) + * @info_id: ID to be OR'd in to info field (in union with rcu) + * @queue: Queue to post events to + * @queue_node: Link in queue->watches + * @watch_list: The watch list containing this watch + * @list_node: Link in watch_list->watchers + * @cred: Creds of the owner of the watch + * @private: Private data for the watched object + * @id: Internal identifier + * @usage: Object usage count */ struct watch { =09union { =09=09struct rcu_head=09rcu; -=09=09u32=09=09info_id;=09/* ID to be OR'd in to info field */ +=09=09u32=09=09info_id; =09}; -=09struct watch_queue __rcu *queue;=09/* Queue to post events to */ -=09struct hlist_node=09queue_node;=09/* Link in queue->watches */ +=09struct watch_queue __rcu *queue; +=09struct hlist_node=09queue_node; =09struct watch_list __rcu=09*watch_list; -=09struct hlist_node=09list_node;=09/* Link in watch_list->watchers */ -=09const struct cred=09*cred;=09=09/* Creds of the owner of the watch */ -=09void=09=09=09*private;=09/* Private data for the watched object */ -=09u64=09=09=09id;=09=09/* Internal identifier */ -=09struct kref=09=09usage;=09=09/* Object usage count */ +=09struct hlist_node=09list_node; +=09const struct cred=09*cred; +=09void=09=09=09*private; +=09u64=09=09=09id; +=09struct kref=09=09usage; }; =20 -/* - * List of watches on an object. +/** + * struct watch_list - List of watches on an object + * + * @rcu: RCU head + * @watchers: List head + * @release_watch: Function to release watch + * @lock: To protect addition and removal of watches */ struct watch_list { =09struct rcu_head=09=09rcu; @@ -118,8 +164,10 @@ static inline void remove_watch_list(struct watch_list= *wlist, u64 id) } =20 /** - * watch_sizeof - Calculate the information part of the size of a watch re= cord, - * given the structure size. + * watch_sizeof() - Calculate the information part of the size of a watch + *=09=09 record, given the structure size. + * + * @STRUCT: The structure whose size is to be given */ #define watch_sizeof(STRUCT) (sizeof(STRUCT) << WATCH_INFO_LENGTH__SHIFT) =20 --=20 2.39.0