misc-utils/lsfd.h

   1 /*
   2  * lsfd(1) - list file descriptors
   3  *
   4  * Copyright (C) 2021 Red Hat, Inc. All rights reserved.
   5  * Written by Masatake YAMATO <yamato@redhat.com>
   6  *
   7  * Very generally based on lsof(8) by Victor A. Abell <abe@purdue.edu>
   8  * It supports multiple OSes. lsfd specializes to Linux.
   9  *
  10  * This program is free software; you can redistribute it and/or modify
  11  * it under the terms of the GNU General Public License as published by
  12  * the Free Software Foundation; either version 2 of the License, or
  13  * (at your option) any later version.
  14  *
  15  * This program is distributed in the hope that it would be useful,
  16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  18  * GNU General Public License for more details.
  19  *
  20  * You should have received a copy of the GNU General Public License
  21  * along with this program; if not, write to the Free Software Foundation,
  22  * Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
  23  */
  24 #ifndef UTIL_LINUX_LSFD_H
  25 #define UTIL_LINUX_LSFD_H
  26
  27 #include <stdbool.h>
  28 #include <sys/stat.h>
  29 #include <dirent.h>
  30 #include <inttypes.h>
  31
  32 #include "list.h"
  33 #include "path.h"
  34 #include "strutils.h"
  35
  36 /*
  37  * column IDs
  38  */
  39 enum {
  40         COL_AINODECLASS,
  41         COL_ASSOC,
  42         COL_BLKDRV,
  43         COL_CHRDRV,
  44         COL_COMMAND,
  45         COL_DELETED,
  46         COL_DEV,
  47         COL_DEVTYPE,
  48         COL_ENDPOINTS,
  49         COL_EVENTFD_ID,
  50         COL_EVENTPOLL_TFDS,
  51         COL_FD,
  52         COL_FLAGS,
  53         COL_FUID,               /* file */
  54         COL_INET_LADDR,
  55         COL_INET_RADDR,
  56         COL_INET6_LADDR,
  57         COL_INET6_RADDR,
  58         COL_INODE,
  59         COL_INOTIFY_INODES,
  60         COL_INOTIFY_INODES_RAW,
  61         COL_KNAME,
  62         COL_KTHREAD,
  63         COL_MAJMIN,
  64         COL_MAPLEN,
  65         COL_MISCDEV,
  66         COL_MNT_ID,
  67         COL_MODE,
  68         COL_NAME,
  69         COL_NETLINK_GROUPS,
  70         COL_NETLINK_LPORT,
  71         COL_NETLINK_PROTOCOL,
  72         COL_NLINK,
  73         COL_NS_NAME,
  74         COL_NS_TYPE,
  75         COL_OWNER,              /* file */
  76         COL_PACKET_IFACE,
  77         COL_PACKET_PROTOCOL,
  78         COL_PARTITION,
  79         COL_PID,
  80         COL_PIDFD_COMM,
  81         COL_PIDFD_NSPID,
  82         COL_PIDFD_PID,
  83         COL_PING_ID,
  84         COL_POS,
  85         COL_RAW_PROTOCOL,
  86         COL_RDEV,
  87         COL_SIGNALFD_MASK,
  88         COL_SIZE,
  89         COL_SOCK_LISTENING,
  90         COL_SOCK_NETNS,
  91         COL_SOCK_PROTONAME,
  92         COL_SOCK_STATE,
  93         COL_SOCK_TYPE,
  94         COL_SOURCE,
  95         COL_STTYPE,
  96         COL_TCP_LADDR,
  97         COL_TCP_RADDR,
  98         COL_TCP_LPORT,
  99         COL_TCP_RPORT,
 100         COL_TID,
 101         COL_TIMERFD_CLOCKID,
 102         COL_TIMERFD_INTERVAL,
 103         COL_TIMERFD_REMAINING,
 104         COL_TYPE,
 105         COL_UDP_LADDR,
 106         COL_UDP_RADDR,
 107         COL_UDP_LPORT,
 108         COL_UDP_RPORT,
 109         COL_UDPLITE_LADDR,
 110         COL_UDPLITE_RADDR,
 111         COL_UDPLITE_LPORT,
 112         COL_UDPLITE_RPORT,
 113         COL_UID,                /* process */
 114         COL_UNIX_PATH,
 115         COL_USER,               /* process */
 116         LSFD_N_COLS             /* This must be at last. */
 117 };
 118
 119 /*
 120  * Process structure
 121  */
 122 enum association {
 123         ASSOC_EXE = 1,
 124         ASSOC_CWD,
 125         ASSOC_ROOT,
 126         ASSOC_NS_CGROUP,
 127         ASSOC_NS_IPC,
 128         ASSOC_NS_MNT,
 129         ASSOC_NS_NET,
 130         ASSOC_NS_PID,
 131         ASSOC_NS_PID4C,
 132         ASSOC_NS_TIME,
 133         ASSOC_NS_TIME4C,
 134         ASSOC_NS_USER,
 135         ASSOC_NS_UTS,
 136         ASSOC_MEM,              /* private file mapping */
 137         ASSOC_SHM,              /* shared file mapping */
 138         N_ASSOCS,
 139 };
 140
 141 struct proc {
 142         pid_t pid;
 143         struct proc * leader;
 144         char *command;
 145         uid_t uid;
 146         ino_t ns_mnt;
 147         struct list_head procs;
 148         struct list_head files;
 149         unsigned int kthread: 1;
 150 };
 151
 152 struct proc *get_proc(pid_t pid);
 153
 154 /*
 155  * File class
 156  */
 157 struct file {
 158         struct list_head files;
 159         const struct file_class *class;
 160         int association;
 161         char *name;
 162         struct stat stat;
 163         mode_t mode;
 164         struct proc *proc;
 165
 166         uint64_t pos;
 167         uint64_t map_start;
 168         uint64_t map_end;
 169
 170         unsigned int sys_flags;
 171         unsigned int mnt_id;
 172 };
 173
 174 #define is_opened_file(_f) ((_f)->association >= 0)
 175 #define is_mapped_file(_f) (is_association((_f), SHM) || is_association((_f), MEM))
 176 #define is_association(_f, a)   ((_f)->association < 0 && (_f)->association == -ASSOC_ ## a)
 177
 178 struct file_class {
 179         const struct file_class *super;
 180         size_t size;
 181         void (*initialize_class)(void);
 182         void (*finalize_class)(void);
 183         bool (*fill_column)(struct proc *proc,
 184                             struct file *file,
 185                             struct libscols_line *ln,
 186                             int column_id,
 187                             size_t column_index);
 188         int  (*handle_fdinfo)(struct file *file, const char *key, const char* value);
 189         void (*attach_xinfo)(struct file *file);
 190         void (*initialize_content)(struct file *file);
 191         void (*free_content)(struct file *file);
 192         const struct ipc_class *(*get_ipc_class)(struct file *file);
 193 };
 194
 195 extern const struct file_class file_class, cdev_class, bdev_class, sock_class, unkn_class, fifo_class,
 196         nsfs_file_class, mqueue_file_class;
 197
 198 /*
 199  * IPC
 200  */
 201 struct ipc {
 202         const struct ipc_class *class;
 203         struct list_head endpoints;
 204         struct list_head ipcs;
 205 };
 206
 207 struct ipc_endpoint {
 208         struct ipc *ipc;
 209         struct list_head endpoints;
 210 };
 211
 212 struct ipc_class {
 213         size_t size;
 214         unsigned int (*get_hash)(struct file *file);
 215         bool (*is_suitable_ipc)(struct ipc *ipc, struct file *file);
 216         void (*free)(struct ipc *ipc);
 217 };
 218
 219 struct ipc *new_ipc(const struct ipc_class *class);
 220 struct ipc *get_ipc(struct file *file);
 221 void add_ipc(struct ipc *ipc, unsigned int hash);
 222 void init_endpoint(struct ipc_endpoint *endpoint);
 223 void add_endpoint(struct ipc_endpoint *endpoint, struct ipc *ipc);
 224 #define foreach_endpoint(E,ENDPOINT) list_for_each_backwardly(E, &((ENDPOINT).ipc->endpoints))
 225
 226 enum decode_source_bit {
 227         DECODE_SOURCE_MAJMIN_BIT    = 1 << 0,
 228         DECODE_SOURCE_PARTITION_BIT = 1 << 1,
 229         DECODE_SOURCE_FILESYS_BIT   = 1 << 2,
 230 };
 231
 232 enum decode_source_level {
 233         DECODE_SOURCE_MAJMIN    = DECODE_SOURCE_MAJMIN_BIT,
 234         DECODE_SOURCE_PARTITION = DECODE_SOURCE_PARTITION_BIT | DECODE_SOURCE_MAJMIN,
 235         DECODE_SOURCE_FILESYS   = DECODE_SOURCE_FILESYS_BIT   | DECODE_SOURCE_PARTITION,
 236         DECODE_SOURCE_FULL      = DECODE_SOURCE_FILESYS,
 237 };
 238
 239 void decode_source(char *buf, size_t bufsize, unsigned int dev_major, unsigned int dev_minor,
 240                    enum decode_source_level level);
 241 /*
 242  * Name managing
 243  */
 244 struct name_manager;
 245
 246 struct name_manager *new_name_manager(void);
 247 void free_name_manager(struct name_manager *nm);
 248 const char *get_name(struct name_manager *nm, unsigned long id);
 249 unsigned long add_name(struct name_manager *nm, const char *name);
 250
 251 const char *get_partition(dev_t dev);
 252 const char *get_blkdrv(unsigned long major);
 253 const char *get_chrdrv(unsigned long major);
 254 const char *get_miscdev(unsigned long minor);
 255 const char *get_nodev_filesystem(unsigned long minor);
 256 void add_nodev(unsigned long minor, const char *filesystem);
 257
 258 static inline void xstrappend(char **a, const char *b)
 259 {
 260         if (strappend(a, b) < 0)
 261                 err(XALLOC_EXIT_CODE, _("failed to allocate memory for string"));
 262 }
 263
 264 static inline void xstrputc(char **a, char c)
 265 {
 266         char b[] = {c, '\0'};
 267         xstrappend(a, b);
 268 }
 269
 270 /*
 271  * Net namespace
 272  */
 273 void load_sock_xinfo(struct path_cxt *pc, const char *name, ino_t netns);
 274 bool is_nsfs_dev(dev_t dev);
 275
 276 /*
 277  * POSIX Mqueue
 278  */
 279 /* 0 is assumed as the major dev for DEV. */
 280 bool is_mqueue_dev(dev_t dev);
 281
 282 #endif /* UTIL_LINUX_LSFD_H */