lsfd: cleanup --summary semantic

Signed-off-by: Karel Zak <kzak@redhat.com>

lsfd: add --dump-counters option

User may wonder how the built-in counters are defined.
Describing their definitions in lsfd(1) is one of choice.
However, the definitions may drastically change in the future
development.

--dump-counters option is for making lsfd self descriptive.
Users who understand the filter expressions can understand
directly the meaning of the counters.

Signed-off-by: Masatake YAMATO <yamato@redhat.com>

lsfd.1.doc: write anout --summary and --counter options

Signed-off-by: Masatake YAMATO <yamato@redhat.com>

lsfd: implement --summary and --counter options

Signed-off-by: Masatake YAMATO <yamato@redhat.com>

lsfd: add a helper function for building filter

Signed-off-by: Masatake YAMATO <yamato@redhat.com>

lsfd: (filter) make some data structures its source file local

Unintentionally they were extern'ed.

Signed-off-by: Masatake YAMATO <yamato@redhat.com>

lsfd: don't define a local variable in the middle of a block

Signed-off-by: Masatake YAMATO <yamato@redhat.com>

lsfd.1.doc: use delimited literal block notation in the EXAMPLE section

Signed-off-by: Masatake YAMATO <yamato@redhat.com>

lsfd.1.adoc: remove redundant parenthesis from the examples

Signed-off-by: Masatake YAMATO <yamato@redhat.com>

lsfd.1.adoc: add caution about the CLI stability

Signed-off-by: Masatake YAMATO <yamato@redhat.com>

lsfd.1.adoc: fix a typo

Signed-off-by: Masatake YAMATO <yamato@redhat.com>

lsfd.1.adoc: Add missing underscores

lsfd: remove unused --sysroot

It's unnecessary to redirect to any /proc dump if we can use 'test_mkfds'.

Signed-off-by: Karel Zak <kzak@redhat.com>

lsfd: delete an unnecessary semicolon

Signed-off-by: Masatake YAMATO <yamato@redhat.com>

lsfd: introduce -p/--pid option, pids filter working in the early stage

    $ time sudo ./lsfd -Q '(PID == 1) or (PID == 2)' > /dev/null

    real 0m0.508s
    user 0m0.230s
    sys 0m0.267s

    $ time sudo ./lsfd -p 1,2 > /dev/null

    real 0m0.088s
    user 0m0.036s
    sys 0m0.033s

    $ [ $(./lsfd -p 1,2) = $(./lsfd -Q '(PID == 1) or (PID == 2)') ]
    $ echo $?
    0

Signed-off-by: Masatake YAMATO <yamato@redhat.com>

lsfd: introduce -p/--pid option, pids filter working in the early stage

    $ time sudo ./lsfd -Q '(PID == 1) or (PID == 2)' > /dev/null

    real 0m0.508s
    user 0m0.230s
    sys 0m0.267s

    $ time sudo ./lsfd -p 1,2 > /dev/null

    real 0m0.088s
    user 0m0.036s
    sys 0m0.033s

    $ [ $(./lsfd -p 1,2) = $(./lsfd -Q '(PID == 1) or (PID == 2)') ]
    $ echo $?
    0

Signed-off-by: Masatake YAMATO <yamato@redhat.com>

lsfd: (adoc) add more exapmles

Signed-off-by: Masatake YAMATO <yamato@redhat.com>

lsfd: remove --source option

-Q '(SOURCE == ...)' works well for the same purpose.
See https://github.com/karelzak/util-linux/pull/1418#issuecomment-945643880

Signed-off-by: Masatake YAMATO <yamato@redhat.com>

lsfd: add KTHREAD column

Signed-off-by: Masatake YAMATO <yamato@redhat.com>

lsfd: (test) add a case for displaying symlinks

Signed-off-by: Masatake YAMATO <yamato@redhat.com>

lsfd: (test) add a case for displaying COMMAND column

Signed-off-by: Masatake YAMATO <yamato@redhat.com>

lsfd: (test) add a case for displaying socket pairs

Signed-off-by: Masatake YAMATO <yamato@redhat.com>

lsfd: (test) add a case for displaying DEV column

Signed-off-by: Masatake YAMATO <yamato@redhat.com>

lsfd: (helper) improve the code converting file descriptor numbers

Signed-off-by: Masatake YAMATO <yamato@redhat.com>

lsfd: (test) add a case for displaying a character device

Signed-off-by: Masatake YAMATO <yamato@redhat.com>

lsfd: add --debug-filter option

Signed-off-by: Masatake YAMATO <yamato@redhat.com>

lsfd: (test) add a case for testing SIZE column

Signed-off-by: Masatake YAMATO <yamato@redhat.com>

lsfd: (test) add a case for testing FLAGS (wronly,nonblock) column

Signed-off-by: Masatake YAMATO <yamato@redhat.com>

lsfd: (helper) add "nonblock" parameter to pipe-no-fork factory

Signed-off-by: Masatake YAMATO <yamato@redhat.com>

lsfd: (helper) update examples in the help message

Signed-off-by: Masatake YAMATO <yamato@redhat.com>

lsfd: (helper) add "dentries" parameter to directory factory

Signed-off-by: Masatake YAMATO <yamato@redhat.com>

lsfd: (helper) add "dir" parameter to directory factory

Signed-off-by: Masatake YAMATO <yamato@redhat.com>

lsfd: (test) test POS column

Signed-off-by: Masatake YAMATO <yamato@redhat.com>

lsfd: (helper) add "offset" parameter to ro-regular-file factory

Signed-off-by: Masatake YAMATO <yamato@redhat.com>

lsfd: (helper) accept an integer argument for a parameter

Signed-off-by: Masatake YAMATO <yamato@redhat.com>

lsfd: (helper) add "file" parameter to ro-regular-file factory

Signed-off-by: Masatake YAMATO <yamato@redhat.com>

lsfd: (helper) allow to pass extra parameters

Signed-off-by: Masatake YAMATO <yamato@redhat.com>

lsfd: (helper) use more "const" modifiers

Signed-off-by: Masatake YAMATO <yamato@redhat.com>

lsfd: (helper) set proper errno before calling err()

Signed-off-by: Masatake YAMATO <yamato@redhat.com>

lsfd: (filter) accept % char as a part of column name

Signed-off-by: Masatake YAMATO <yamato@redhat.com>

lsfd: (filter) fix a memory leak

Signed-off-by: Masatake YAMATO <yamato@redhat.com>

lsfd: remove prototype decls for removed functions

Signed-off-by: Masatake YAMATO <yamato@redhat.com>

lsfd: declare local variables at the beginning of block

Signed-off-by: Masatake YAMATO <yamato@redhat.com>

lsfd: remove duplicated an O_ flag entry

Signed-off-by: Masatake YAMATO <yamato@redhat.com>

build-sys: link lib_common to test_procfs

Suggested by Thomas Weißschuh at
https://github.com/karelzak/util-linux/pull/1418#pullrequestreview-775639562

lsfd: (adoc) write about filter expression

Charelle Collett helped me improve the setences.

Signed-off-by: Masatake YAMATO <yamato@redhat.com>

lsfd: (test) add a case for displaying a directory

Signed-off-by: Masatake YAMATO <yamato@redhat.com>

lsfd: (test) add cases for displaying a regular file and pipe

Signed-off-by: Masatake YAMATO <yamato@redhat.com>

lsfd: add FUID and OWNER columns

UID and USER is for processes.
FUID and OWNER is for owners of files.

Signed-off-by: Masatake YAMATO <yamato@redhat.com>

lsfd: fill UID column with the process's uid

The original code fills the column with the owner id of the executable
file. Because lsfd fills USER column field by decoding UID column, the
USER in lsfd meant the owner name of the executable.

On the other hand, lsof fills the USER column with the process's user
name.

To avoid users confusing, this change makes lsfd do the same lsof;
filling UID column with the process's uid.

Signed-off-by: Masatake YAMATO <yamato@redhat.com>

lsfd: (filter) implement !~, an operator for regex unmatching

Signed-off-by: Masatake YAMATO <yamato@redhat.com>

lsfd: (filter) implement =~, an operator for regex matching

Signed-off-by: Masatake YAMATO <yamato@redhat.com>

lsfd: (filter) make error messages in check_type methods

Signed-off-by: Masatake YAMATO <yamato@redhat.com>

lsfd: (filter) give a name to a constant

Signed-off-by: Masatake YAMATO <yamato@redhat.com>

lsfd: (filter) whitespace cleanup

Signed-off-by: Masatake YAMATO <yamato@redhat.com>

lsfd: (adoc) remove a redundant word

Signed-off-by: Masatake YAMATO <yamato@redhat.com>

build-sys: fix test_procfs SOURCES

Signed-off-by: Karel Zak <kzak@redhat.com>

lsns: optimize mountinfo use

Let's parse mountinfo only for unknown namespaces or when
namespace Id is not accessible (unprivileged users).

Signed-off-by: Karel Zak <kzak@redhat.com>

lsfd: remove unused code

Signed-off-by: Karel Zak <kzak@redhat.com>

lsfd: function rename

Signed-off-by: Karel Zak <kzak@redhat.com>

build-sys: cleanup lsfd related stuff

- add lsfd to meson.build
- add Masatake to AUTHORS
- add me to lsfd.c header and man page

Signed-off-by: Karel Zak <kzak@redhat.com>

lsfd: add new man page to Makemodule.am

Signed-off-by: Masatake YAMATO <yamato@redhat.com>

lsfd: (adoc) write more about the -o option

Signed-off-by: Masatake YAMATO <yamato@redhat.com>

lsfd: (adoc) add proc(5) to SEE ALSO section

Signed-off-by: Masatake YAMATO <yamato@redhat.com>

lsfd: (adoc) reorder the options

Signed-off-by: Masatake YAMATO <yamato@redhat.com>

lsfd: (adoc) update DESCRIPTION

Signed-off-by: Masatake YAMATO <yamato@redhat.com>

lsfd: (adoc) reorder the sections

Signed-off-by: Masatake YAMATO <yamato@redhat.com>

lsfd: (adoc) put missing :: at the end of options

lsfd: fix a typo in DEVTYPE description

Signed-off-by: Masatake YAMATO <yamato@redhat.com>

lsfd: wrap code for debugging with #ifdef DEBUG/#endif

Signed-off-by: Masatake YAMATO <yamato@redhat.com>

lsfd: convert lines introducing local variable to a block with {...}

The following code causing an error on test run on GitHub Action:

  case FOO:
      type localvar;

This change converts above code to:

  case FOO: {
      type localvar;
  }

Signed-off-by: Masatake YAMATO <yamato@redhat.com>

lsfd: change the license of the filtering engine to LGPL

This change is for moving the filtering engine to libsmartcols in the
future.

In addition to the change, I made myself a copyright holder of the
code.

Signed-off-by: Masatake YAMATO <yamato@redhat.com>

lsfd: Add new man page to po4a.cfg

lsfd: Add initial man page

lsfd: Fix typos in lsfd.c

lsfd: use new scols_line_get_column_data()

Signed-off-by: Karel Zak <kzak@redhat.com>

libsmartcols: add scols_line_get_column_data()

Signed-off-by: Karel Zak <kzak@redhat.com>

lsfd: collect threads level information if TID is specified in a filter

Signed-off-by: Masatake YAMATO <yamato@redhat.com>

lsfd: introduce --source filter option

Reflecting the review comment:

    add filter by SOURCE (lsfd --source sda1)

Example output:

    # ./lsfd --source proc | head
    COMMAND             PID   USER ASSOC MODE TYPE SOURCE MNTID      INODE NAME
    systemd               1   root    10  r--  REG   proc    23      18542 /proc/1/mountinfo
    systemd               1   root    14  r--  REG   proc    23 4026532082 /proc/swaps
    systemd-resolve     856   root     7  r--  REG   proc   254      24841 /proc/sys/kernel/hostname
    low-memory-moni     898   root     7  rw-  REG   proc   425 4026532073 /proc/pressure/memory
    low-memory-moni     898   root     8  rw-  REG   proc   425 4026532073 /proc/pressure/memory
    low-memory-moni     898   root     9  rw-  REG   proc   425 4026532073 /proc/pressure/memory
    packagekitd       25205   root    12  r--  REG   proc    23      69645 /proc/25205/mountinfo
    systemd           26466   root    10  r--  REG   proc    23      71813 /proc/26466/mountinfo
    systemd           26466   root    14  r--  REG   proc    23 4026532082 /proc/swaps

    # ./lsfd --source proc -Q '(PID == 898)'
    COMMAND           PID USER ASSOC MODE TYPE SOURCE MNTID      INODE NAME
    low-memory-moni   898 root     7  rw-  REG   proc   425 4026532073 /proc/pressure/memory
    low-memory-moni   898 root     8  rw-  REG   proc   425 4026532073 /proc/pressure/memory
    low-memory-moni   898 root     9  rw-  REG   proc   425 4026532073 /proc/pressure/memory

Signed-off-by: Masatake YAMATO <yamato@redhat.com>

lsfd: introduce -Q option for generic filtering

Examples:

    # ./lsfd -Q "(FD <= 9) and (TYPE == 'SOCK')" -Q "COMMAND == 'ssh'" | head
    COMMAND     PID USER ASSOC MODE TYPE SOURCE MNTID    INODE NAME
    ssh      153907 root     4  rw- SOCK sockfs     9  2450021 TCP:[2450021]
    ssh     1657696 root     4  rw- SOCK sockfs     9 64357645 TCP:[64357645]
    ssh     1657696 root     5  rw- SOCK sockfs     9 64363596 UNIX:[64363596]
    ssh     2345473 root     4  rw- SOCK sockfs     9 81978848 TCP:[81978848]
    ssh     2345473 root     5  rw- SOCK sockfs     9 81980736 UNIX:[81980736]
    ssh     2345473 root     9  rw- SOCK sockfs     9 81980737 UNIX:[81980737]
    ssh     2345475 root     4  rw- SOCK sockfs     9 81975091 UNIX:[81975091]
    ssh     3958804 root     0  rw- SOCK sockfs     9 87840900 UNIX:[87840900]
    ssh     3958804 root     4  rw- SOCK sockfs     9 87836642 TCP:[87836642]

    # ./lsfd -Q "((ASSOC == 'exe') || (ASSOC == 'pid')) and (USER == 'yamato')"
    COMMAND        PID   USER ASSOC MODE TYPE SOURCE MNTID      INODE NAME
    lsfd        690292 yamato   exe  ---  REG   dm-2     0   34474245 /home/yamato/var/util-linux/util-linux/.libs/lsfd
    lsfd        690292 yamato   pid  ---  REG   nsfs     0 4026531836 pid:[4026531836]
    pidns      1458677 yamato   exe  ---  REG   dm-2     0   34212178 /home/yamato/var/kernel-essential-training/container/pidns
    pidns      1458677 yamato   pid  ---  REG   nsfs     0 4026533715 pid:[4026533715]
    fd-catalog 1677961 yamato   exe  ---  REG   dm-2     0  128715536 /home/yamato/var/fd-catalog/fd-catalog (deleted)
    fd-catalog 1677961 yamato   pid  ---  REG   nsfs     0 4026531836 pid:[4026531836]

Signed-off-by: Masatake YAMATO <yamato@redhat.com>

lsfd: add filter engine

Signed-off-by: Masatake YAMATO <yamato@redhat.com>

lsfd: fix a typo in comment

Signed-off-by: Masatake YAMATO <yamato@redhat.com>

lsfd: optimize symlinks use

Like the previous commit, this patch tries to reuse
/proc/#/{fd,ns,cwd,root} symlinks if possible. On my machine it
saves ~2000 stat() calls.

Signed-off-by: Karel Zak <kzak@redhat.com>

lsfd: optimize maps use

The /proc/#/maps file usually contains the same file more than once.
This patch tries to reuse previous file to reduce number of stat()
calls, see "strace --summary-only" output below, the syscall is reduce
in 50%.

old version:

% time     seconds  usecs/call     calls    errors syscall
------ ----------- ----------- --------- --------- ----------------
 55.57    0.118708           2     50756      5414 newfstatat

new version:

% time     seconds  usecs/call     calls    errors syscall
------ ----------- ----------- --------- --------- ----------------
 39.17    0.058501           2     24436      5382 newfstatat

Signed-off-by: Karel Zak <kzak@redhat.com>

lsfd: use only "/proc/#/maps" file

* do not read /proc/#/map_files symlinks
* use paths from /proc/#/maps
* do not maintain map entries

Signed-off-by: Karel Zak <kzak@redhat.com>

lsfd: don't use 'long int' for file data

Let's always assume positions, offsets, etc.. as 64-bit numbers.

Signed-off-by: Karel Zak <kzak@redhat.com>

lsfd: cleanup fdinfo handling

Signed-off-by: Karel Zak <kzak@redhat.com>

lsfd:remove struct fdinfo_data

Signed-off-by: Karel Zak <kzak@redhat.com>

lsfd: split new_file(), remove map_file_data

Don't initialize entire 'struct file' in one step. It seems better to
use different ways according to file source (map, symlink, etc.).

Signed-off-by: Karel Zak <kzak@redhat.com>

lsfd: rename DEVNAME column to SOURCE

Reflecting the review comment:

    maybe rename DEVNAME to SOURCE as we have here things like 'devtmpfs' etc.

Signed-off-by: Masatake YAMATO <yamato@redhat.com>

lsfd: remove redundant "nodev:" prefix from DEVNAME column

Reflecting the review comment:

    remove "nodev:" from DEVNAME

Signed-off-by: Masatake YAMATO <yamato@redhat.com>

lsfd: add DEVTYPE column

Reflecting the review comment:

    add DEVTYPE for blk, char, and nodev

Signed-off-by: Masatake YAMATO <yamato@redhat.com>

lsfd: sort the enumerators about columns

Signed-off-by: Masatake YAMATO <yamato@redhat.com>

lsfd: rename the column DEVICE to MAJ:MIN

Reflecting the review comment:

    add MAJ:MIN for major and minor numbers, remove DEVICE (we use
    MAJ:MIN in other tools)

Signed-off-by: Masatake YAMATO <yamato@redhat.com>

lsfd: don't duplicate ASSOC_EXE processing

Signed-off-by: Karel Zak <kzak@redhat.com>

lsfd: use one function to all symlinks

This commit introduces collect_file_symlink() to gather info from
arbitrary symlink (e.g. /proc/#/exe, /proc/#/fd/1).

Signed-off-by: Karel Zak <kzak@redhat.com>

lib/path: add ul_path_next_dirent()

Signed-off-by: Karel Zak <kzak@redhat.com>

lib/path: use flags for fstatat()

Signed-off-by: Karel Zak <kzak@redhat.com>

lsfd: fix ASSOC_EXE use, make file->association use more robust

Let's use is_association() macro in the code rather than directly
check file->association as this struct member has special semantic.

Signed-off-by: Karel Zak <kzak@redhat.com>

lsfd: cleanup collect_outofbox_files stuff

* use path_cxt
* call fstat() only once (no extra call to get uid)
* reduce names to variables to get function calls to one line ;-)
* fix use of procfs_process_get_cmdname()

Signed-off-by: Karel Zak <kzak@redhat.com>