Hi Chengming,
On Mon, 30 May 2022 10:20:16 +0800 Chengming Zhou <zhouchengming@xxxxxxxxxxxxx> wrote:
> Since commit 0f91d13366a4 ("mm/damon: simplify stop mechanism")
> delete kdamond_stop and change to use kthread stop mechanism,
> these obsolete comments should be removed accordingly.
Good point, thank you!
>
> Signed-off-by: Chengming Zhou <zhouchengming@xxxxxxxxxxxxx>
> ---
> include/linux/damon.h | 17 ++++++++---------
> 1 file changed, 8 insertions(+), 9 deletions(-)
>
> diff --git a/include/linux/damon.h b/include/linux/damon.h
> index 7c62da31ce4b..fa1c2968b1dd 100644
> --- a/include/linux/damon.h
> +++ b/include/linux/damon.h
> @@ -397,7 +397,6 @@ struct damon_callback {
> * detail.
> *
> * @kdamond: Kernel thread who does the monitoring.
> - * @kdamond_stop: Notifies whether kdamond should stop.
> * @kdamond_lock: Mutex for the synchronizations with @kdamond.
> *
> * For each monitoring context, one kernel thread for the monitoring is
> @@ -406,14 +405,14 @@ struct damon_callback {
> * Once started, the monitoring thread runs until explicitly required to be
> * terminated or every monitoring target is invalid. The validity of the
> * targets is checked via the &damon_operations.target_valid of @ops. The
> - * termination can also be explicitly requested by writing non-zero to
> - * @kdamond_stop. The thread sets @kdamond to NULL when it terminates.
> - * Therefore, users can know whether the monitoring is ongoing or terminated by
> - * reading @kdamond. Reads and writes to @kdamond and @kdamond_stop from
> - * outside of the monitoring thread must be protected by @kdamond_lock.
> - *
> - * Note that the monitoring thread protects only @kdamond and @kdamond_stop via
> - * @kdamond_lock. Accesses to other fields must be protected by themselves.
> + * termination can also be explicitly requested by calling __damon_stop().
'__damon_stop()' is a static function, so mentioning that here makes no sense.
Let's mention its wrapper, 'damon_stop()' instead.
After the change, you could add
Reviewed-by: SeongJae Park <sj@xxxxxxxxxx>
Thanks,
SJ
> + * The thread sets @kdamond to NULL when it terminates. Therefore, users can
> + * know whether the monitoring is ongoing or terminated by reading @kdamond.
> + * Reads and writes to @kdamond from outside of the monitoring thread must
> + * be protected by @kdamond_lock.
> + *
> + * Note that the monitoring thread protects only @kdamond via @kdamond_lock.
> + * Accesses to other fields must be protected by themselves.
> *
> * @ops: Set of monitoring operations for given use cases.
> * @callback: Set of callbacks for monitoring events notifications.
> --
> 2.36.1
