mirror of git://git.yoctoproject.org/linux-yocto.git synced 2025-07-07 22:35:42 +02:00

Luis Chamberlain 0199849acd sysctl: remove register_sysctl_paths()

The deprecation for register_sysctl_paths() is over. We can rejoice as
we nuke register_sysctl_paths(). The routine register_sysctl_table()
was the only user left of register_sysctl_paths(), so we can now just
open code and move the implementation over to what used to be
to __register_sysctl_paths().

The old dynamic struct ctl_table_set *set is now the point to
sysctl_table_root.default_set.

The old dynamic const struct ctl_path *path was being used in the
routine register_sysctl_paths() with a static:

static const struct ctl_path null_path[] = { {} };

Since this is a null path we can now just simplfy the old routine
and remove its use as its always empty.

This saves us a total of 230 bytes.

$ ./scripts/bloat-o-meter vmlinux.old vmlinux
add/remove: 2/7 grow/shrink: 1/1 up/down: 1015/-1245 (-230)
Function                                     old     new   delta
register_leaf_sysctl_tables.constprop          -     524    +524
register_sysctl_table                         22     497    +475
__pfx_register_leaf_sysctl_tables.constprop       -      16     +16
null_path                                      8       -      -8
__pfx_register_sysctl_paths                   16       -     -16
__pfx_register_leaf_sysctl_tables             16       -     -16
__pfx___register_sysctl_paths                 16       -     -16
__register_sysctl_base                        29      12     -17
register_sysctl_paths                         18       -     -18
register_leaf_sysctl_tables                  534       -    -534
__register_sysctl_paths                      620       -    -620
Total: Before=21259666, After=21259436, chg -0.00%

Signed-off-by: Luis Chamberlain <mcgrof@kernel.org>

2023-05-02 19:24:16 -07:00

3.9 KiB

Executable File

Raw Blame History

#!/usr/bin/gawk -f

SPDX-License-Identifier: GPL-2.0

Script to check sysctl documentation against source files

Copyright (c) 2020 Stephen Kitt

Example invocation:

scripts/check-sysctl-docs -vtable="kernel" \

Documentation/admin-guide/sysctl/kernel.rst \

$(git grep -l register_sysctl_)

Specify -vdebug=1 to see debugging information

BEGIN { if (!table) { print "Please specify the table to look for using the table variable" > "/dev/stderr" exit 1 } }

The following globals are used:

children: maps ctl_table names and procnames to child ctl_table names

documented: maps documented entries (each key is an entry)

entries: maps ctl_table names and procnames to counts (so

enumerating the subkeys for a given ctl_table lists its

procnames)

files: maps procnames to source file names

paths: maps ctl_path names to paths

curpath: the name of the current ctl_path struct

curtable: the name of the current ctl_table struct

curentry: the name of the current proc entry (procname when parsing

a ctl_table, constructed path when parsing a ctl_path)

Remove punctuation from the given value

function trimpunct(value) { while (value ~ /^["&]/) { value = substr(value, 2) } while (value ~ /[]["&,}]$/) { value = substr(value, 1, length(value) - 1) } return value }

Print the information for the given entry

function printentry(entry) { seen[entry]++ printf "* %s from %s", entry, file[entry] if (documented[entry]) { printf " (documented)" } print "" }

Stage 1: build the list of documented entries

FNR == NR && /^=+$/ { if (prevline ~ /Documentation for/) { # This is the main title next }

# The previous line is a section title, parse it
$0 = prevline
if (debug) print "Parsing " $0
inbrackets = 0
for (i = 1; i <= NF; i++) {
if (length($i) == 0) {
    continue
}
if (!inbrackets && substr($i, 1, 1) == "(") {
    inbrackets = 1
}
if (!inbrackets) {
    token = trimpunct($i)
    if (length(token) > 0 && token != "and") {
	if (debug) print trimpunct($i)
	documented[trimpunct($i)]++
    }
}
if (inbrackets && substr($i, length($i), 1) == ")") {
    inbrackets = 0
}
}

}

FNR == NR { prevline = $0 next }

Stage 2: process each file and find all sysctl tables

BEGINFILE { delete children delete entries delete paths curpath = "" curtable = "" curentry = "" if (debug) print "Processing file " FILENAME }

/^static struct ctl_path/ { match($0, /static struct ctl_path ([^][]+)/, tables) curpath = tables[1] if (debug) print "Processing path " curpath }

/^static struct ctl_table/ { match($0, /static struct ctl_table ([^][]+)/, tables) curtable = tables[1] if (debug) print "Processing table " curtable }

/^};$/ { curpath = "" curtable = "" curentry = "" }

curpath && /.procname[\t ]=[\t ]".+"/ { match($0, /.procname[\t ]=[\t ]"([^"]+)"/, names) if (curentry) { curentry = curentry "/" names[1] } else { curentry = names[1] } if (debug) print "Setting path " curpath " to " curentry paths[curpath] = curentry }

curtable && /.procname[\t ]=[\t ]".+"/ { match($0, /.procname[\t ]=[\t ]"([^"]+)"/, names) curentry = names[1] if (debug) print "Adding entry " curentry " to table " curtable entries[curtable][curentry]++ file[curentry] = FILENAME }

/.child[\t ]*=/ { child = trimpunct($NF) if (debug) print "Linking child " child " to table " curtable " entry " curentry children[curtable][curentry] = child }

/register_sysctl_table(.*)/ { match($0, /register_sysctl_table(([^)]+))/, tables) if (debug) print "Registering table " tables[1] if (children[tables[1]][table]) { for (entry in entries[children[tables[1]][table]]) { printentry(entry) } } }

END { for (entry in documented) { if (!seen[entry]) { print "No implementation for " entry } } }

3.9 KiB Executable File Raw Blame History