NAME¶

lsfd - list file descriptors

SYNOPSIS¶

lsfd [option]

DESCRIPTION¶

lsfd is intended to be a modern replacement for lsof(8) on Linux systems. Unlike lsof, lsfd is specialized to Linux kernel; it supports Linux specific features like namespaces with simpler code. lsfd is not a drop-in replacement for lsof; they are different in the command line interface and output formats.

The default output is subject to change. So whenever possible, you should avoid using default outputs in your scripts. Always explicitly define expected columns by using --output columns-list in environments where a stable output is required.

lsfd uses Libsmartcols for output formatting and filtering. See the description of --output option for customizing the output format, and --filter option for filtering. Use lsfd --help to get a list of all available columns.

OPTIONS¶

-l, --threads

-J, --json

-n, --noheadings

-o, --output list

-r, --raw

--notruncate

-p, --pid pids

-i[4|6], --inet[=4|=6]

-Q, --filter expr

-C, --counter label:filter_expr

--summary[=when]

--debug-filter

--dump-counters

-h, --help

-V, --version

OUTPUT COLUMNS¶

Each column has a type. Types are surround by < and >.

CAUTION: The names and types of columns are not stable yet. They may be changed in the future releases.

AINODECLASS <string>

ASSOC <string>

BLKDRV <string>

CHRDRV <string>

COMMAND <string>

DELETED <boolean>

DEV <string>

DEVTYPE <string>

ENDPOINT <string>

FD <number>

FLAGS <string>

FUID <number>

INET.LADDR <string>

INET.RADDR <string>

INET6.LADDR <string>

INET6.RADDR <string>

INODE <number>

KNAME <string>

KTHREAD <boolean>

MAJ:MIN <string>

MAPLEN <number>

MISCDEV <string>

MNTID <number>

MODE <string>

NAME <string>

NETLINK.GROUPS <number>>

NETLINK.LPORT <number>>

NETLINK.PROTOCOL <string>>

NLINK <number>

NS.NAME <string>

NS.TYPE <string>

OWNER <string>

PACKET.IFACE <string>

PACKET.PROTOCOL <string>

PARTITION <string>

PID <number>

PIDFD.COMM <string>

PIDFD.NSPID <string>

PIDFD.PID <number>

PING.ID <`number`>

POS <number>

RAW.PROTOCOL <number>

RDEV <string>

SIZE <number>

SOCK.LISTENING <boolean>

SOCK.NETS <number>

SOCK.PROTONAME <string>

SOCK.STATE <string>

SOCK.TYPE <string>

SOURCE <string>

STTYPE <string>

TCP.LADDR <string>

TCP.LPORT <integer>

TCP.RADDR <string>

TCP.RPORT <integer>

TID <number>

TYPE <string>

UDP.LADDR <string>

UDP.LPORT <integer>

UDP.RADDR <string>

UDP.RPORT <integer>

UDPLITE.LADDR <string>

UDPLITE.LPORT <integer>

UDPLITE.RADDR <string>

UDPLITE.RPORT <integer>

UID <number>

UNIX.PATH <string>

USER <string>

FILTER EXPRESSION¶

lsfd evaluates the expression passed to --filter option every time before printing a file line. lsfd prints the line only if the result of evaluation is true.

An expression consists of column names, literals and, operators like: DELETED, (PID == 1), (NAME == "/etc/passwd"), (PID == 1) && DELETED. DELETED, PID, and NAME are column names in the example. 1 and "/etc/passwd" are literals. == and && are operators.

Before evaluation, lsfd substitutes column names in the given expression with actual column values in the line. There are three different data types: boolean, string, and number. For columns with a boolean type, the value can be stand-alone. For string and number values, the value must be an operand of an operator, for example, (PID == 1). See OUTPUT COLUMNS about the types of columns.

Literal is for representing a value directly. See BOOLLIT, STRLIT, and NUMLIT. Different data types have different literal syntax.

An operator works with one or two operand(s). An operator has an expectation about the data type(s) of its operands. Giving an unexpected data type to an operator causes a syntax error.

Operators taking two operands are and, or, eq, ne, le, lt, ge, gt, =~, !~. Alphabetically named operators have C-language flavored aliases: &&, ||, ==, !=, <, ⇐, >=, and >.

! is the only operator that takes one operand.

eq, ne, and their aliases expect operands have the same data type. Applying these operators return a boolean.

and, or, not and their aliases expect operands have boolean data type. Applying these operators return a boolean.

lt, le, gt, ge, and their aliases expect operands have number data types. Applying these operators return a boolean.

=~ is for regular expression matching; if a string at the right side matches a regular expression at the left side, the result is true. The right side operand must be a string literal. See STRLIT about the syntax.

!~ is a short-hand version of not (STR =~ PAT); it inverts the result of =~.

FILTER EXAMPLES¶

lsfd has few options for filtering. In most of cases, what you should know is -Q (or --filter) option. Combined with -o (or --output) option, you can customize the output as you want.

List files associated with PID 1 and PID 2 processes:

# lsfd -Q '(PID == 1) or (PID == 2)'

Do the same in an alternative way:

# lsfd -Q '(PID == 1) || (PID == 2)'

Do the same in a more efficient way:

# lsfd --pid 1,2

Whitescapes can be used instead of a comma:

# lsfd --pid '1 2'

Utilize pidof(1) for list the files associated with "firefox":

# lsfd --pid "$(pidof firefox)"

List the 1st file descriptor opened by PID 1 process:

# lsfd -Q '(PID == 1) and (FD == 1)'

Do the same in an alternative way:

# lsfd -Q '(PID == 1) && (FD == 1)'

List all running executables:

# lsfd -Q 'ASSOC == "exe"'

Do the same in an alternative way:

# lsfd -Q 'ASSOC eq "exe"'

Do the same but print only file names:

# lsfd -o NAME -Q 'ASSOC eq "exe"' | sort -u

List deleted files associated to processes:

# lsfd -Q 'DELETED'

List non-regular files:

# lsfd -Q 'TYPE != "REG"'

List block devices:

# lsfd -Q 'DEVTYPE == "blk"'

Do the same with TYPE column:

# lsfd -Q 'TYPE == "BLK"'

List files including "dconf" directory in their names:

# lsfd -Q 'NAME =~ ".\*/dconf/.*"'

List files opened in a QEMU virtual machine:

# lsfd -Q '(COMMAND =~ ".\*qemu.*") and (FD >= 0)'

Hide files associated to kernel threads:

# lsfd -Q '!KTHREAD'

COUNTER EXAMPLES¶

Report the numbers of netlink socket descriptors and unix socket descriptors:

# lsfd --summary=only \


        -C 'netlink sockets':'(NAME =~ "NETLINK:.*")' \


        -C 'unix sockets':'(NAME =~ "UNIX:.*")'
VALUE COUNTER


   57 netlink sockets


 1552 unix sockets

Do the same but print in JSON format:

# lsfd --summary=only --json \


        -C 'netlink sockets':'(NAME =~ "NETLINK:.*")' \


        -C 'unix sockets':'(NAME =~ "UNIX:.*")'
{


   "lsfd-summary": [


      {


         "value": 15,


         "counter": "netlink sockets"


      },{


         "value": 798,


         "counter": "unix sockets"


      }


   ]
}

HISTORY¶

The lsfd command is part of the util-linux package since v2.38.

AUTHORS¶

Masatake YAMATO <yamato@redhat.com>, Karel Zak <kzak@redhat.com>

SEE ALSO¶

lsof(8) pidof(1) proc(5) socket(2) stat(2)

REPORTING BUGS¶

For bug reports, use the issue tracker at <https://github.com/util-linux/util-linux/issues>.

AVAILABILITY¶

The lsfd command is part of the util-linux package which can be downloaded from Linux Kernel Archive <https://www.kernel.org/pub/linux/utils/util-linux/>.