/* * lsfd(1) - list file descriptors * * Copyright (C) 2021 Red Hat, Inc. All rights reserved. * Written by Masatake YAMATO * * Very generally based on lsof(8) by Victor A. Abell * It supports multiple OSes. lsfd specializes to Linux. * * This program is free software; you can redistribute it and/or modify * it under the terms of the GNU General Public License as published by * the Free Software Foundation; either version 2 of the License, or * (at your option) any later version. * * This program is distributed in the hope that it would be useful, * but WITHOUT ANY WARRANTY; without even the implied warranty of * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the * GNU General Public License for more details. * * You should have received a copy of the GNU General Public License * along with this program; if not, write to the Free Software Foundation, * Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA */ #ifndef UTIL_LINUX_LSFD_H #define UTIL_LINUX_LSFD_H #include #include #include #include #include #include #include #include "debug.h" #include "libsmartcols.h" #include "list.h" #include "nls.h" #include "path.h" #include "strutils.h" #include "xalloc.h" /* * debug */ UL_DEBUG_DECLARE_MASK(lsfd); #define LSFD_DEBUG_INIT (1 << 1) #define LSFD_DEBUG_ENDPOINTS (1 << 2) #define LSFD_DEBUG_ALL 0xFFFF #define DBG(m, x) __UL_DBG(lsfd, LSFD_DEBUG_, m, x) /* * column IDs */ enum { COL_AINODECLASS, COL_ASSOC, COL_BLKDRV, COL_BPF_MAP_ID, COL_BPF_MAP_TYPE, COL_BPF_MAP_TYPE_RAW, COL_BPF_NAME, COL_BPF_PROG_ID, COL_BPF_PROG_TYPE, COL_BPF_PROG_TYPE_RAW, COL_CHRDRV, COL_COMMAND, COL_DELETED, COL_DEV, COL_DEVTYPE, COL_ENDPOINTS, COL_EVENTFD_ID, COL_EVENTPOLL_TFDS, COL_FD, COL_FLAGS, COL_FUID, /* file */ COL_INET_LADDR, COL_INET_RADDR, COL_INET6_LADDR, COL_INET6_RADDR, COL_INODE, COL_INOTIFY_INODES, COL_INOTIFY_INODES_RAW, COL_KNAME, COL_KTHREAD, COL_MAJMIN, COL_MAPLEN, COL_MISCDEV, COL_MNT_ID, COL_MODE, COL_NAME, COL_NETLINK_GROUPS, COL_NETLINK_LPORT, COL_NETLINK_PROTOCOL, COL_NLINK, COL_NS_NAME, COL_NS_TYPE, COL_OWNER, /* file */ COL_PACKET_IFACE, COL_PACKET_PROTOCOL, COL_PARTITION, COL_PID, COL_PIDFD_COMM, COL_PIDFD_NSPID, COL_PIDFD_PID, COL_PING_ID, COL_POS, COL_PTMX_TTY_INDEX, COL_RAW_PROTOCOL, COL_RDEV, COL_SIGNALFD_MASK, COL_SIZE, COL_SOCK_LISTENING, COL_SOCK_NETNS, COL_SOCK_PROTONAME, COL_SOCK_SHUTDOWN, COL_SOCK_STATE, COL_SOCK_TYPE, COL_SOURCE, COL_STTYPE, COL_TCP_LADDR, COL_TCP_RADDR, COL_TCP_LPORT, COL_TCP_RPORT, COL_TID, COL_TIMERFD_CLOCKID, COL_TIMERFD_INTERVAL, COL_TIMERFD_REMAINING, COL_TUN_IFACE, COL_TYPE, COL_UDP_LADDR, COL_UDP_RADDR, COL_UDP_LPORT, COL_UDP_RPORT, COL_UDPLITE_LADDR, COL_UDPLITE_RADDR, COL_UDPLITE_LPORT, COL_UDPLITE_RPORT, COL_UID, /* process */ COL_UNIX_PATH, COL_USER, /* process */ COL_XMODE, LSFD_N_COLS /* This must be at last. */ }; /* * Process structure */ enum association { ASSOC_EXE = 1, ASSOC_CWD, ASSOC_ROOT, ASSOC_NS_CGROUP, ASSOC_NS_IPC, ASSOC_NS_MNT, ASSOC_NS_NET, ASSOC_NS_PID, ASSOC_NS_PID4C, ASSOC_NS_TIME, ASSOC_NS_TIME4C, ASSOC_NS_USER, ASSOC_NS_UTS, ASSOC_MEM, /* private file mapping */ ASSOC_SHM, /* shared file mapping */ N_ASSOCS, }; struct proc { pid_t pid; struct proc * leader; char *command; uid_t uid; ino_t ns_mnt; struct list_head procs; struct list_head files; unsigned int kthread: 1; struct list_head eventpolls; }; struct proc *get_proc(pid_t pid); /* * File class */ struct file { struct list_head files; const struct file_class *class; int association; char *name; struct stat stat; mode_t mode; struct proc *proc; uint64_t pos; uint64_t map_start; uint64_t map_end; unsigned int sys_flags; unsigned int mnt_id; struct { uint8_t read:1, write:1; } locked; uint8_t multiplexed; }; #define is_opened_file(_f) ((_f)->association >= 0) #define is_mapped_file(_f) (is_association((_f), SHM) || is_association((_f), MEM)) #define is_association(_f, a) ((_f)->association < 0 && (_f)->association == -ASSOC_ ## a) struct file_class { const struct file_class *super; size_t size; void (*initialize_class)(void); void (*finalize_class)(void); bool (*fill_column)(struct proc *proc, struct file *file, struct libscols_line *ln, int column_id, size_t column_index); int (*handle_fdinfo)(struct file *file, const char *key, const char* value); void (*attach_xinfo)(struct file *file); void (*initialize_content)(struct file *file); void (*free_content)(struct file *file); const struct ipc_class *(*get_ipc_class)(struct file *file); }; extern const struct file_class file_class, cdev_class, bdev_class, sock_class, unkn_class, fifo_class, nsfs_file_class, mqueue_file_class; /* * IPC */ struct ipc { const struct ipc_class *class; struct list_head endpoints; struct list_head ipcs; }; struct ipc_endpoint { struct ipc *ipc; struct list_head endpoints; }; struct ipc_class { size_t size; unsigned int (*get_hash)(struct file *file); bool (*is_suitable_ipc)(struct ipc *ipc, struct file *file); void (*free)(struct ipc *ipc); }; struct ipc *new_ipc(const struct ipc_class *class); struct ipc *get_ipc(struct file *file); void add_ipc(struct ipc *ipc, unsigned int hash); void init_endpoint(struct ipc_endpoint *endpoint); void add_endpoint(struct ipc_endpoint *endpoint, struct ipc *ipc); #define foreach_endpoint(E,ENDPOINT) list_for_each_backwardly(E, &((ENDPOINT).ipc->endpoints)) enum decode_source_bit { DECODE_SOURCE_MAJMIN_BIT = 1 << 0, DECODE_SOURCE_PARTITION_BIT = 1 << 1, DECODE_SOURCE_FILESYS_BIT = 1 << 2, }; enum decode_source_level { DECODE_SOURCE_MAJMIN = DECODE_SOURCE_MAJMIN_BIT, DECODE_SOURCE_PARTITION = DECODE_SOURCE_PARTITION_BIT | DECODE_SOURCE_MAJMIN, DECODE_SOURCE_FILESYS = DECODE_SOURCE_FILESYS_BIT | DECODE_SOURCE_PARTITION, DECODE_SOURCE_FULL = DECODE_SOURCE_FILESYS, }; void decode_source(char *buf, size_t bufsize, unsigned int dev_major, unsigned int dev_minor, enum decode_source_level level); /* * Name managing */ struct name_manager; struct name_manager *new_name_manager(void); void free_name_manager(struct name_manager *nm); const char *get_name(struct name_manager *nm, unsigned long id); unsigned long add_name(struct name_manager *nm, const char *name); const char *get_partition(dev_t dev); const char *get_blkdrv(unsigned long major); const char *get_chrdrv(unsigned long major); const char *get_miscdev(unsigned long minor); const char *get_nodev_filesystem(unsigned long minor); void add_nodev(unsigned long minor, const char *filesystem); /* * Net namespace */ void load_sock_xinfo(struct path_cxt *pc, const char *name, ino_t netns); bool is_nsfs_dev(dev_t dev); /* * POSIX Mqueue */ /* 0 is assumed as the major dev for DEV. */ bool is_mqueue_dev(dev_t dev); /* * Eventpoll */ bool is_multiplexed_by_eventpoll(int fd, struct list_head *eventpolls); #endif /* UTIL_LINUX_LSFD_H */