From: John Garry <john.garry@huawei.com> To: Arnaldo Carvalho de Melo <acme@kernel.org>, Ian Rogers <irogers@google.com> Cc: Andi Kleen <ak@linux.intel.com>, Jiri Olsa <jolsa@redhat.com>, "Namhyung Kim" <namhyung@kernel.org>, Kajol Jain <kjain@linux.ibm.com>, "Paul A . Clarke" <pc@us.ibm.com>, Riccardo Mancini <rickyman7@gmail.com>, Kan Liang <kan.liang@linux.intel.com>, Peter Zijlstra <peterz@infradead.org>, "Ingo Molnar" <mingo@redhat.com>, Mark Rutland <mark.rutland@arm.com>, "Alexander Shishkin" <alexander.shishkin@linux.intel.com>, <linux-perf-users@vger.kernel.org>, <linux-kernel@vger.kernel.org>, "Vineet Singh" <vineet.singh@intel.com>, James Clark <james.clark@arm.com>, "Mathieu Poirier" <mathieu.poirier@linaro.org>, Suzuki K Poulose <suzuki.poulose@arm.com>, Mike Leach <mike.leach@linaro.org>, Leo Yan <leo.yan@linaro.org>, <coresight@lists.linaro.org>, <linux-arm-kernel@lists.infradead.org>, <eranian@google.com> Subject: Re: [PATCH 01/22] libperf: Add comments to perf_cpu_map. Date: Mon, 13 Dec 2021 08:56:17 +0000 [thread overview] Message-ID: <02b330aa-ebce-11b2-9d3f-9b2497ae7133@huawei.com> (raw) In-Reply-To: <YbOlnH0NLQdAECcK@kernel.org> On 10/12/2021 19:08, Arnaldo Carvalho de Melo wrote: >>>> +/** >>>> + * A sized, reference counted, sorted array of integers representing CPU >>>> + * numbers. This is commonly used to capture which CPUs a PMU is associated >>>> + * with. >>>> + */ >>>> struct perf_cpu_map { >>>> refcount_t refcnt; >>>> + /** Length of the map array. */ >>>> int nr; I'd have /s/nr/len/, as it means the map length, as opposed to confusing nr meaning with number of cpus in the host or something else. And the new comment uses "Length" also. >>>> + /** The CPU values. */ >>>> int map[]; >>> would simply more distinct names for the variables help instead of or in >>> addition to comments? > Well, in this case the typical usage doesn't help, as 'struct > perf_cpu_map' are being used simply as "map" There are a lot of instances to change ... but I am all up for using consistent and well-meaning variable / argument names per type. > where it should be cpu_map, > so we would have: > > cpu_map->nr > > And all should be obvious, no? Otherwise we would have redundant 'cpu', > like: > > cpu_map->nr_cpus > > And 'map' should really be entries, so: > > cpu_map->entries[index]; > > Would be clear enough, o? > >> Thanks John! I agree. The phrase that is often used is intention >> revealing names. The kernel style for naming is to be brief:
WARNING: multiple messages have this Message-ID (diff)
From: John Garry <john.garry@huawei.com> To: Arnaldo Carvalho de Melo <acme@kernel.org>, Ian Rogers <irogers@google.com> Cc: Andi Kleen <ak@linux.intel.com>, Jiri Olsa <jolsa@redhat.com>, "Namhyung Kim" <namhyung@kernel.org>, Kajol Jain <kjain@linux.ibm.com>, "Paul A . Clarke" <pc@us.ibm.com>, Riccardo Mancini <rickyman7@gmail.com>, Kan Liang <kan.liang@linux.intel.com>, Peter Zijlstra <peterz@infradead.org>, "Ingo Molnar" <mingo@redhat.com>, Mark Rutland <mark.rutland@arm.com>, "Alexander Shishkin" <alexander.shishkin@linux.intel.com>, <linux-perf-users@vger.kernel.org>, <linux-kernel@vger.kernel.org>, "Vineet Singh" <vineet.singh@intel.com>, James Clark <james.clark@arm.com>, "Mathieu Poirier" <mathieu.poirier@linaro.org>, Suzuki K Poulose <suzuki.poulose@arm.com>, Mike Leach <mike.leach@linaro.org>, Leo Yan <leo.yan@linaro.org>, <coresight@lists.linaro.org>, <linux-arm-kernel@lists.infradead.org>, <eranian@google.com> Subject: Re: [PATCH 01/22] libperf: Add comments to perf_cpu_map. Date: Mon, 13 Dec 2021 08:56:17 +0000 [thread overview] Message-ID: <02b330aa-ebce-11b2-9d3f-9b2497ae7133@huawei.com> (raw) In-Reply-To: <YbOlnH0NLQdAECcK@kernel.org> On 10/12/2021 19:08, Arnaldo Carvalho de Melo wrote: >>>> +/** >>>> + * A sized, reference counted, sorted array of integers representing CPU >>>> + * numbers. This is commonly used to capture which CPUs a PMU is associated >>>> + * with. >>>> + */ >>>> struct perf_cpu_map { >>>> refcount_t refcnt; >>>> + /** Length of the map array. */ >>>> int nr; I'd have /s/nr/len/, as it means the map length, as opposed to confusing nr meaning with number of cpus in the host or something else. And the new comment uses "Length" also. >>>> + /** The CPU values. */ >>>> int map[]; >>> would simply more distinct names for the variables help instead of or in >>> addition to comments? > Well, in this case the typical usage doesn't help, as 'struct > perf_cpu_map' are being used simply as "map" There are a lot of instances to change ... but I am all up for using consistent and well-meaning variable / argument names per type. > where it should be cpu_map, > so we would have: > > cpu_map->nr > > And all should be obvious, no? Otherwise we would have redundant 'cpu', > like: > > cpu_map->nr_cpus > > And 'map' should really be entries, so: > > cpu_map->entries[index]; > > Would be clear enough, o? > >> Thanks John! I agree. The phrase that is often used is intention >> revealing names. The kernel style for naming is to be brief: _______________________________________________ linux-arm-kernel mailing list linux-arm-kernel@lists.infradead.org http://lists.infradead.org/mailman/listinfo/linux-arm-kernel
next prev parent reply other threads:[~2021-12-13 8:56 UTC|newest] Thread overview: 80+ messages / expand[flat|nested] mbox.gz Atom feed top 2021-12-08 2:45 [PATCH 00/22] Refactor perf cpumap Ian Rogers 2021-12-08 2:45 ` Ian Rogers 2021-12-08 2:45 ` [PATCH 01/22] libperf: Add comments to perf_cpu_map Ian Rogers 2021-12-08 2:45 ` Ian Rogers 2021-12-08 12:05 ` John Garry 2021-12-08 12:05 ` John Garry 2021-12-08 14:34 ` Ian Rogers 2021-12-08 14:34 ` Ian Rogers 2021-12-08 15:09 ` Ian Rogers 2021-12-08 15:09 ` Ian Rogers 2021-12-10 19:08 ` Arnaldo Carvalho de Melo 2021-12-10 19:08 ` Arnaldo Carvalho de Melo 2021-12-13 8:56 ` John Garry [this message] 2021-12-13 8:56 ` John Garry 2021-12-08 2:45 ` [PATCH 02/22] perf stat: Add aggr creators that are passed a cpu Ian Rogers 2021-12-08 2:45 ` Ian Rogers 2021-12-08 12:50 ` John Garry 2021-12-08 12:50 ` John Garry 2021-12-10 19:10 ` Arnaldo Carvalho de Melo 2021-12-10 19:10 ` Arnaldo Carvalho de Melo 2021-12-08 2:45 ` [PATCH 03/22] perf stat: Switch aggregation to use for_each loop Ian Rogers 2021-12-08 2:45 ` Ian Rogers 2021-12-11 19:24 ` Jiri Olsa 2021-12-11 19:24 ` Jiri Olsa 2021-12-13 16:17 ` Ian Rogers 2021-12-13 16:17 ` Ian Rogers 2021-12-08 2:45 ` [PATCH 04/22] perf stat: Switch to cpu version of cpu_map__get Ian Rogers 2021-12-08 2:45 ` Ian Rogers 2021-12-08 2:45 ` [PATCH 05/22] perf cpumap: Switch cpu_map__build_map to cpu function Ian Rogers 2021-12-08 2:45 ` Ian Rogers 2021-12-08 2:45 ` [PATCH 06/22] perf cpumap: Remove map+index get_socket Ian Rogers 2021-12-08 2:45 ` Ian Rogers 2021-12-11 19:25 ` Jiri Olsa 2021-12-11 19:25 ` Jiri Olsa 2021-12-08 2:45 ` [PATCH 07/22] perf cpumap: Remove map+index get_die Ian Rogers 2021-12-08 2:45 ` Ian Rogers 2021-12-08 2:45 ` [PATCH 08/22] perf cpumap: Remove map+index get_core Ian Rogers 2021-12-08 2:45 ` Ian Rogers 2021-12-08 2:45 ` [PATCH 09/22] perf cpumap: Remove map+index get_node Ian Rogers 2021-12-08 2:45 ` Ian Rogers 2021-12-08 2:45 ` [PATCH 10/22] perf cpumap: Add comments to aggr_cpu_id Ian Rogers 2021-12-08 2:45 ` Ian Rogers 2021-12-08 2:45 ` [PATCH 11/22] perf cpumap: Remove unused cpu_map__socket Ian Rogers 2021-12-08 2:45 ` Ian Rogers 2021-12-08 2:45 ` [PATCH 12/22] perf cpumap: Simplify equal function name Ian Rogers 2021-12-08 2:45 ` Ian Rogers 2021-12-08 2:45 ` [PATCH 13/22] perf cpumap: Rename empty functions Ian Rogers 2021-12-08 2:45 ` Ian Rogers 2021-12-08 2:45 ` [PATCH 14/22] perf cpumap: Document cpu__get_node and remove redundant function Ian Rogers 2021-12-08 2:45 ` Ian Rogers 2021-12-08 2:46 ` [PATCH 15/22] perf cpumap: Remove map from function names that don't use a map Ian Rogers 2021-12-08 2:46 ` Ian Rogers 2021-12-08 2:46 ` [PATCH 16/22] perf cpumap: Remove cpu_map__cpu, use libperf function Ian Rogers 2021-12-08 2:46 ` Ian Rogers 2021-12-08 2:46 ` [PATCH 17/22] perf cpumap: Refactor cpu_map__build_map Ian Rogers 2021-12-08 2:46 ` Ian Rogers 2021-12-11 19:25 ` Jiri Olsa 2021-12-11 19:25 ` Jiri Olsa 2021-12-08 2:46 ` [PATCH 18/22] perf cpumap: Rename cpu_map__get_X_aggr_by_cpu functions Ian Rogers 2021-12-08 2:46 ` Ian Rogers 2021-12-08 2:46 ` [PATCH 19/22] perf cpumap: Move 'has' function to libperf Ian Rogers 2021-12-08 2:46 ` Ian Rogers 2021-12-08 17:59 ` Mathieu Poirier 2021-12-08 17:59 ` Mathieu Poirier 2021-12-08 2:46 ` [PATCH 20/22] perf cpumap: Add some comments to cpu_aggr_map Ian Rogers 2021-12-08 2:46 ` Ian Rogers 2021-12-08 2:46 ` [PATCH 21/22] perf cpumap: Trim the cpu_aggr_map Ian Rogers 2021-12-08 2:46 ` Ian Rogers 2021-12-11 19:24 ` Jiri Olsa 2021-12-11 19:24 ` Jiri Olsa 2021-12-13 16:11 ` Ian Rogers 2021-12-13 16:11 ` Ian Rogers 2021-12-08 2:46 ` [PATCH 22/22] perf stat: Fix memory leak in check_per_pkg Ian Rogers 2021-12-08 2:46 ` Ian Rogers 2021-12-13 11:39 ` [PATCH 00/22] Refactor perf cpumap James Clark 2021-12-13 11:39 ` James Clark 2021-12-13 16:10 ` Ian Rogers 2021-12-13 16:10 ` Ian Rogers 2021-12-13 22:06 ` Ian Rogers 2021-12-13 22:06 ` Ian Rogers
Reply instructions: You may reply publicly to this message via plain-text email using any one of the following methods: * Save the following mbox file, import it into your mail client, and reply-to-all from there: mbox Avoid top-posting and favor interleaved quoting: https://en.wikipedia.org/wiki/Posting_style#Interleaved_style * Reply using the --to, --cc, and --in-reply-to switches of git-send-email(1): git send-email \ --in-reply-to=02b330aa-ebce-11b2-9d3f-9b2497ae7133@huawei.com \ --to=john.garry@huawei.com \ --cc=acme@kernel.org \ --cc=ak@linux.intel.com \ --cc=alexander.shishkin@linux.intel.com \ --cc=coresight@lists.linaro.org \ --cc=eranian@google.com \ --cc=irogers@google.com \ --cc=james.clark@arm.com \ --cc=jolsa@redhat.com \ --cc=kan.liang@linux.intel.com \ --cc=kjain@linux.ibm.com \ --cc=leo.yan@linaro.org \ --cc=linux-arm-kernel@lists.infradead.org \ --cc=linux-kernel@vger.kernel.org \ --cc=linux-perf-users@vger.kernel.org \ --cc=mark.rutland@arm.com \ --cc=mathieu.poirier@linaro.org \ --cc=mike.leach@linaro.org \ --cc=mingo@redhat.com \ --cc=namhyung@kernel.org \ --cc=pc@us.ibm.com \ --cc=peterz@infradead.org \ --cc=rickyman7@gmail.com \ --cc=suzuki.poulose@arm.com \ --cc=vineet.singh@intel.com \ /path/to/YOUR_REPLY https://kernel.org/pub/software/scm/git/docs/git-send-email.html * If your mail client supports setting the In-Reply-To header via mailto: links, try the mailto: linkBe sure your reply has a Subject: header at the top and a blank line before the message body.
This is an external index of several public inboxes, see mirroring instructions on how to clone and mirror all data and code used by this external index.