summaryrefslogtreecommitdiffstats
path: root/misc-utils/lsfd-file.c
diff options
context:
space:
mode:
Diffstat (limited to 'misc-utils/lsfd-file.c')
-rw-r--r--misc-utils/lsfd-file.c465
1 files changed, 465 insertions, 0 deletions
diff --git a/misc-utils/lsfd-file.c b/misc-utils/lsfd-file.c
new file mode 100644
index 0000000..bdaac3f
--- /dev/null
+++ b/misc-utils/lsfd-file.c
@@ -0,0 +1,465 @@
+/*
+ * lsfd(1) - list file descriptors
+ *
+ * Copyright (C) 2021 Red Hat, Inc. All rights reserved.
+ * Written by Masatake YAMATO <yamato@redhat.com>
+ *
+ * Very generally based on lsof(8) by Victor A. Abell <abe@purdue.edu>
+ * 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
+ */
+
+#include <unistd.h>
+
+#ifdef HAVE_LINUX_NSFS_H
+# include <linux/nsfs.h>
+# if defined(NS_GET_NSTYPE)
+# define USE_NS_GET_API 1
+# include <sys/ioctl.h>
+# endif
+#endif
+#include <linux/sched.h>
+
+#include "xalloc.h"
+#include "nls.h"
+#include "buffer.h"
+#include "idcache.h"
+#include "strutils.h"
+
+#include "libsmartcols.h"
+
+#include "lsfd.h"
+
+static struct idcache *username_cache;
+
+static const char *assocstr[N_ASSOCS] = {
+ [ASSOC_CWD] = "cwd",
+ [ASSOC_EXE] = "exe",
+ /* "root" appears as user names, too.
+ * So we use "rtd" here instead of "root". */
+ [ASSOC_ROOT] = "rtd",
+ [ASSOC_NS_CGROUP] = "cgroup",
+ [ASSOC_NS_IPC] = "ipc",
+ [ASSOC_NS_MNT] = "mnt",
+ [ASSOC_NS_NET] = "net",
+ [ASSOC_NS_PID] = "pid",
+ [ASSOC_NS_PID4C] = "pid4c",
+ [ASSOC_NS_TIME] = "time",
+ [ASSOC_NS_TIME4C] = "time4c",
+ [ASSOC_NS_USER] = "user",
+ [ASSOC_NS_UTS] = "uts",
+ [ASSOC_MEM] = "mem",
+ [ASSOC_SHM] = "shm",
+};
+
+static const char *strftype(mode_t ftype)
+{
+ switch (ftype) {
+ case S_IFBLK:
+ return "BLK";
+ case S_IFCHR:
+ return "CHR";
+ case S_IFDIR:
+ return "DIR";
+ case S_IFIFO:
+ return "FIFO";
+ case S_IFLNK:
+ return "LINK";
+ case S_IFREG:
+ return "REG";
+ case S_IFSOCK:
+ return "SOCK";
+ default:
+ return "UNKN";
+ }
+}
+
+extern void lsfd_decode_file_flags(struct ul_buffer *buf, int flags);
+static void file_fill_flags_buf(struct ul_buffer *buf, int flags)
+{
+ lsfd_decode_file_flags(buf, flags);
+}
+
+#define does_file_has_fdinfo_alike(file) \
+ ((file)->association >= 0 \
+ || (file)->association == -ASSOC_SHM \
+ || (file)->association == -ASSOC_MEM)
+
+static uint64_t get_map_length(struct file *file)
+{
+ uint64_t res = 0;
+
+ if (is_association(file, SHM) || is_association(file, MEM)) {
+ static size_t pagesize = 0;
+
+ if (!pagesize)
+ pagesize = getpagesize();
+
+ res = (file->map_end - file->map_start) / pagesize;
+ }
+
+ return res;
+}
+
+static bool file_fill_column(struct proc *proc,
+ struct file *file,
+ struct libscols_line *ln,
+ int column_id,
+ size_t column_index)
+{
+ char *str = NULL;
+ mode_t ftype;
+ const char *partition;
+
+ switch(column_id) {
+ case COL_COMMAND:
+ if (proc->command
+ && scols_line_set_data(ln, column_index, proc->command))
+ err(EXIT_FAILURE, _("failed to add output data"));
+ return true;
+ case COL_KNAME:
+ case COL_NAME:
+ if (file->name
+ && scols_line_set_data(ln, column_index, file->name))
+ err(EXIT_FAILURE, _("failed to add output data"));
+ return true;
+ case COL_STTYPE:
+ case COL_TYPE:
+ ftype = file->stat.st_mode & S_IFMT;
+ if (scols_line_set_data(ln, column_index, strftype(ftype)))
+ err(EXIT_FAILURE, _("failed to add output data"));
+ return true;
+ case COL_USER:
+ add_uid(username_cache, (int)proc->uid);
+ if (scols_line_set_data(ln, column_index,
+ get_id(username_cache,
+ (int)proc->uid)->name))
+ err(EXIT_FAILURE, _("failed to add output data"));
+ return true;
+ case COL_OWNER:
+ add_uid(username_cache, (int)file->stat.st_uid);
+ if (scols_line_set_data(ln, column_index,
+ get_id(username_cache,
+ (int)file->stat.st_uid)->name))
+ err(EXIT_FAILURE, _("failed to add output data"));
+ return true;
+ case COL_DEVTYPE:
+ if (scols_line_set_data(ln, column_index,
+ "nodev"))
+ err(EXIT_FAILURE, _("failed to add output data"));
+ return true;
+ case COL_FD:
+ if (!is_opened_file(file))
+ return false;
+ /* FALL THROUGH */
+ case COL_ASSOC:
+ if (is_opened_file(file))
+ xasprintf(&str, "%d", file->association);
+ else {
+ int assoc = file->association * -1;
+ if (assoc >= N_ASSOCS)
+ return false; /* INTERNAL ERROR */
+ xasprintf(&str, "%s", assocstr[assoc]);
+ }
+ break;
+ case COL_INODE:
+ xasprintf(&str, "%llu", (unsigned long long)file->stat.st_ino);
+ break;
+ case COL_SOURCE:
+ if (major(file->stat.st_dev) == 0) {
+ const char *filesystem = get_nodev_filesystem(minor(file->stat.st_dev));
+ if (filesystem) {
+ xasprintf(&str, "%s", filesystem);
+ break;
+ }
+ }
+ /* FALL THROUGH */
+ case COL_PARTITION:
+ partition = get_partition(file->stat.st_dev);
+ if (partition) {
+ str = xstrdup(partition);
+ break;
+ }
+ /* FALL THROUGH */
+ case COL_DEV:
+ case COL_MAJMIN:
+ xasprintf(&str, "%u:%u",
+ major(file->stat.st_dev),
+ minor(file->stat.st_dev));
+ break;
+ case COL_RDEV:
+ xasprintf(&str, "%u:%u",
+ major(file->stat.st_rdev),
+ minor(file->stat.st_rdev));
+ break;
+ case COL_PID:
+ xasprintf(&str, "%d", (int)proc->leader->pid);
+ break;
+ case COL_TID:
+ xasprintf(&str, "%d", (int)proc->pid);
+ break;
+ case COL_UID:
+ xasprintf(&str, "%d", (int)proc->uid);
+ break;
+ case COL_FUID:
+ xasprintf(&str, "%d", (int)file->stat.st_uid);
+ break;
+ case COL_SIZE:
+ xasprintf(&str, "%jd", (intmax_t)file->stat.st_size);
+ break;
+ case COL_NLINK:
+ xasprintf(&str, "%ju", (uintmax_t)file->stat.st_nlink);
+ break;
+ case COL_DELETED:
+ xasprintf(&str, "%d", file->stat.st_nlink == 0);
+ break;
+ case COL_KTHREAD:
+ xasprintf(&str, "%u", proc->kthread);
+ break;
+ case COL_MNT_ID:
+ xasprintf(&str, "%d", is_opened_file(file)? file->mnt_id: 0);
+ break;
+ case COL_MODE:
+ if (does_file_has_fdinfo_alike(file))
+ xasprintf(&str, "%c%c%c",
+ file->mode & S_IRUSR? 'r': '-',
+ file->mode & S_IWUSR? 'w': '-',
+ (is_mapped_file(file)
+ && file->mode & S_IXUSR)? 'x': '-');
+ else
+ xasprintf(&str, "---");
+ break;
+ case COL_POS:
+ xasprintf(&str, "%" PRIu64,
+ (does_file_has_fdinfo_alike(file))? file->pos: 0);
+ break;
+ case COL_FLAGS: {
+ struct ul_buffer buf = UL_INIT_BUFFER;
+
+ if (!is_opened_file(file))
+ return true;
+
+ if (file->sys_flags == 0)
+ return true;
+
+ file_fill_flags_buf(&buf, file->sys_flags);
+ if (ul_buffer_is_empty(&buf))
+ return true;
+ str = ul_buffer_get_data(&buf, NULL, NULL);
+ break;
+ }
+ case COL_MAPLEN:
+ if (!is_mapped_file(file))
+ return true;
+ xasprintf(&str, "%ju", (uintmax_t)get_map_length(file));
+ break;
+ default:
+ return false;
+ };
+
+ if (!str)
+ err(EXIT_FAILURE, _("failed to add output data"));
+ if (scols_line_refer_data(ln, column_index, str))
+ err(EXIT_FAILURE, _("failed to add output data"));
+ return true;
+}
+
+static int file_handle_fdinfo(struct file *file, const char *key, const char* value)
+{
+ int rc;
+
+ if (strcmp(key, "pos") == 0) {
+ rc = ul_strtou64(value, &file->pos, 10);
+
+ } else if (strcmp(key, "flags") == 0) {
+ rc = ul_strtou32(value, &file->sys_flags, 8);
+
+ } else if (strcmp(key, "mnt_id") == 0) {
+ rc = ul_strtou32(value, &file->mnt_id, 10);
+
+ } else
+ return 0; /* ignore -- unknown item */
+
+ if (rc < 0)
+ return 0; /* ignore -- parse failed */
+
+ return 1; /* success */
+}
+
+static void file_free_content(struct file *file)
+{
+ free(file->name);
+}
+
+static void file_class_initialize(void)
+{
+ username_cache = new_idcache();
+ if (!username_cache)
+ err(EXIT_FAILURE, _("failed to allocate UID cache"));
+}
+
+static void file_class_finalize(void)
+{
+ free_idcache(username_cache);
+}
+
+const struct file_class file_class = {
+ .super = NULL,
+ .size = sizeof(struct file),
+ .initialize_class = file_class_initialize,
+ .finalize_class = file_class_finalize,
+ .fill_column = file_fill_column,
+ .handle_fdinfo = file_handle_fdinfo,
+ .free_content = file_free_content,
+};
+
+/*
+ * Regular files on NSFS
+ */
+
+struct nsfs_file {
+ struct file file;
+ int clone_type;
+};
+
+static const char *get_ns_type_name(int clone_type)
+{
+ switch (clone_type) {
+#ifdef USE_NS_GET_API
+ case CLONE_NEWNS:
+ return "mnt";
+ case CLONE_NEWCGROUP:
+ return "cgroup";
+ case CLONE_NEWUTS:
+ return "uts";
+ case CLONE_NEWIPC:
+ return "ipc";
+ case CLONE_NEWUSER:
+ return "user";
+ case CLONE_NEWPID:
+ return "pid";
+ case CLONE_NEWNET:
+ return "net";
+#ifdef CLONE_NEWTIME
+ case CLONE_NEWTIME:
+ return "time";
+#endif /* CLONE_NEWTIME */
+#endif /* USE_NS_GET_API */
+ default:
+ return "unknown";
+ }
+}
+
+static void init_nsfs_file_content(struct file *file)
+{
+ struct nsfs_file *nsfs_file = (struct nsfs_file *)file;
+ nsfs_file->clone_type = -1;
+
+#ifdef USE_NS_GET_API
+ char *proc_fname = NULL;
+ int ns_fd;
+ int ns_type;
+
+ if (is_association (file, NS_CGROUP))
+ nsfs_file->clone_type = CLONE_NEWCGROUP;
+ else if (is_association (file, NS_IPC))
+ nsfs_file->clone_type = CLONE_NEWIPC;
+ else if (is_association (file, NS_MNT))
+ nsfs_file->clone_type = CLONE_NEWNS;
+ else if (is_association (file, NS_NET))
+ nsfs_file->clone_type = CLONE_NEWNET;
+ else if (is_association (file, NS_PID)
+ || is_association (file, NS_PID4C))
+ nsfs_file->clone_type = CLONE_NEWPID;
+#ifdef CLONE_NEWTIME
+ else if (is_association (file, NS_TIME)
+ || is_association (file, NS_TIME4C))
+ nsfs_file->clone_type = CLONE_NEWTIME;
+#endif
+ else if (is_association (file, NS_USER))
+ nsfs_file->clone_type = CLONE_NEWUSER;
+ else if (is_association (file, NS_UTS))
+ nsfs_file->clone_type = CLONE_NEWUTS;
+
+ if (nsfs_file->clone_type != -1)
+ return;
+
+ if (!is_opened_file(file))
+ return;
+
+ if (!file->name)
+ return;
+
+ xasprintf(&proc_fname, "/proc/%d/fd/%d",
+ file->proc->pid, file->association);
+ ns_fd = open(proc_fname, O_RDONLY);
+ free(proc_fname);
+ if (ns_fd < 0)
+ return;
+
+ ns_type = ioctl(ns_fd, NS_GET_NSTYPE);
+ close(ns_fd);
+ if (ns_type < 0)
+ return;
+
+ nsfs_file->clone_type = ns_type;
+#endif /* USE_NS_GET_API */
+}
+
+
+static bool nsfs_file_fill_column(struct proc *proc __attribute__((__unused__)),
+ struct file *file,
+ struct libscols_line *ln,
+ int column_id,
+ size_t column_index)
+{
+ struct nsfs_file *nsfs_file = (struct nsfs_file *)file;
+ char *name = NULL;
+
+ if (nsfs_file->clone_type == -1)
+ return false;
+
+ switch (column_id) {
+ case COL_NS_NAME:
+ xasprintf(&name, "%s:[%llu]",
+ get_ns_type_name(nsfs_file->clone_type),
+ (unsigned long long)file->stat.st_ino);
+ break;
+ case COL_NS_TYPE:
+ if (scols_line_set_data(ln, column_index,
+ get_ns_type_name(nsfs_file->clone_type)))
+ err(EXIT_FAILURE, _("failed to add output data"));
+ return true;
+ default:
+ return false;
+ }
+
+ if (name && scols_line_refer_data(ln, column_index, name))
+ err(EXIT_FAILURE, _("failed to add output data"));
+
+ return true;
+}
+
+const struct file_class nsfs_file_class = {
+ .super = &file_class,
+ .size = sizeof(struct nsfs_file),
+ .initialize_class = NULL,
+ .finalize_class = NULL,
+ .initialize_content = init_nsfs_file_content,
+ .free_content = NULL,
+ .fill_column = nsfs_file_fill_column,
+ .handle_fdinfo = NULL,
+};
generated by cgit v1.2.3 (git 2.39.1) at 2024-11-29 13:28:00 +0000