1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212
|
/*
* lslocks(8) - list local system locks
*
* Copyright (C) 2012 Davidlohr Bueso <dave@gnu.org>
*
* Very generally based on lslk(8) by Victor A. Abell <abe@purdue.edu>
* Since it stopped being maintained over a decade ago, this
* program should be considered its replacement.
*
* 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 <stdio.h>
#include <string.h>
#include <getopt.h>
#include <stdlib.h>
#include <assert.h>
#include <dirent.h>
#include <unistd.h>
#include <sys/stat.h>
#include <sys/types.h>
#include <stdbool.h>
#include <search.h>
#include <libmount.h>
#include <libsmartcols.h>
#include "pathnames.h"
#include "canonicalize.h"
#include "nls.h"
#include "xalloc.h"
#include "strutils.h"
#include "c.h"
#include "cctype.h"
#include "list.h"
#include "closestream.h"
#include "optutils.h"
#include "procfs.h"
#include "column-list-table.h"
#include "fileutils.h"
/* column IDs */
enum {
COL_SRC = 0,
COL_PID,
COL_TYPE,
COL_SIZE,
COL_INODE,
COL_MAJMIN,
COL_MODE,
COL_M,
COL_START,
COL_END,
COL_PATH,
COL_BLOCKER,
COL_HOLDERS,
};
/* column names */
struct colinfo {
const char * const name; /* header */
double whint; /* width hint (N < 1 is in percent of termwidth) */
int flags; /* SCOLS_FL_* */
const char *help;
};
/* columns descriptions */
static struct colinfo infos[] = {
[COL_SRC] = { "COMMAND",15, 0, N_("command of the process holding the lock") },
[COL_PID] = { "PID", 5, SCOLS_FL_RIGHT, N_("PID of the process holding the lock") },
[COL_TYPE] = { "TYPE", 5, SCOLS_FL_RIGHT, N_("kind of lock") },
[COL_SIZE] = { "SIZE", 4, SCOLS_FL_RIGHT, N_("size of the lock, use <number> if --bytes is given") },
[COL_INODE] = { "INODE", 5, SCOLS_FL_RIGHT, N_("inode number") },
[COL_MAJMIN] = { "MAJ:MIN", 6, 0, N_("major:minor device number") },
[COL_MODE] = { "MODE", 5, 0, N_("lock access mode") },
[COL_M] = { "M", 1, 0, N_("mandatory state of the lock: 0 (none), 1 (set)")},
[COL_START] = { "START", 10, SCOLS_FL_RIGHT, N_("relative byte offset of the lock")},
[COL_END] = { "END", 10, SCOLS_FL_RIGHT, N_("ending offset of the lock")},
[COL_PATH] = { "PATH", 0, SCOLS_FL_TRUNC, N_("path of the locked file")},
[COL_BLOCKER] = { "BLOCKER", 0, SCOLS_FL_RIGHT, N_("PID of the process blocking the lock") },
[COL_HOLDERS] = { "HOLDERS", 0, SCOLS_FL_WRAP, N_("holders of the lock") },
};
static int columns[ARRAY_SIZE(infos) * 2];
static size_t ncolumns;
static inline void add_column(int id)
{
if (ncolumns >= ARRAY_SIZE(columns))
errx(EXIT_FAILURE, _("too many columns specified, "
"the limit is %zu columns"),
ARRAY_SIZE(columns) - 1);
columns[ncolumns++] = id;
}
struct lock {
struct list_head locks;
char *cmdname;
pid_t pid;
char *path;
char *type;
char *mode;
off_t start;
off_t end;
ino_t inode;
dev_t dev;
bool mandatory,
blocked;
uint64_t size;
int fd;
int id;
};
struct lock_tnode {
dev_t dev;
ino_t inode;
struct list_head chain;
};
struct lslocks {
/* basic output flags */
int no_headings;
int no_inaccessible;
int raw;
int json;
int bytes;
pid_t target_pid;
struct list_head proc_locks;
void *pid_locks;
struct libmnt_table *tab; /* /proc/self/mountinfo */
};
static int lock_tnode_compare(const void *a, const void *b)
{
struct lock_tnode *anode = ((struct lock_tnode *)a);
struct lock_tnode *bnode = ((struct lock_tnode *)b);
if (anode->dev > bnode->dev)
return 1;
else if (anode->dev < bnode->dev)
return -1;
if (anode->inode > bnode->inode)
return 1;
else if (anode->inode < bnode->inode)
return -1;
return 0;
}
static void add_to_tree(void *troot, struct lock *l)
{
struct lock_tnode tmp = { .dev = l->dev, .inode = l->inode, };
struct lock_tnode **head = tfind(&tmp, troot, lock_tnode_compare);
struct lock_tnode *new_head;
if (head) {
list_add_tail(&l->locks, &(*head)->chain);
return;
}
new_head = xmalloc(sizeof(*new_head));
new_head->dev = l->dev;
new_head->inode = l->inode;
INIT_LIST_HEAD(&new_head->chain);
if (tsearch(new_head, troot, lock_tnode_compare) == NULL)
errx(EXIT_FAILURE, _("failed to allocate memory"));
list_add_tail(&l->locks, &new_head->chain);
}
static void rem_lock(struct lock *lock)
{
if (!lock)
return;
free(lock->path);
free(lock->mode);
free(lock->cmdname);
free(lock->type);
list_del(&lock->locks);
free(lock);
}
static void disable_columns_truncate(void)
{
for (size_t i = 0; i < ARRAY_SIZE(infos); i++)
infos[i].flags &= ~SCOLS_FL_TRUNC;
}
/*
* Associate the device's mountpoint for a filename
*/
static char *get_fallback_filename(struct libmnt_table *tab, dev_t dev)
{
struct libmnt_fs *fs;
char *res = NULL;
fs = mnt_table_find_devno(tab, dev, MNT_ITER_BACKWARD);
if (!fs)
return NULL;
xasprintf(&res, "%s...", mnt_fs_get_target(fs));
return res;
}
/*
* Return the absolute path of a file from
* a given inode number (and its size)
*/
static char *get_filename_sz(ino_t inode, pid_t lock_pid, size_t *size)
{
struct stat sb;
struct dirent *dp;
DIR *dirp;
int fd;
char path[PATH_MAX] = { 0 },
sym[PATH_MAX] = { 0 }, *ret = NULL;
*size = 0;
if (lock_pid < 0)
/* pid could be -1 for OFD locks */
return NULL;
/*
* We know the pid so we don't have to
* iterate the *entire* filesystem searching
* for the damn file.
*/
snprintf(path, sizeof(path), "/proc/%d/fd/", lock_pid);
if (!(dirp = opendir(path)))
return NULL;
if (strlen(path) >= (sizeof(path) - 2))
goto out;
if ((fd = dirfd(dirp)) < 0 )
goto out;
while ((dp = xreaddir(dirp))) {
ssize_t len;
errno = 0;
/* care only for numerical descriptors */
if (!strtol(dp->d_name, (char **) NULL, 10) || errno)
continue;
if (!fstatat(fd, dp->d_name, &sb, 0)
&& inode != sb.st_ino)
continue;
if ((len = readlinkat(fd, dp->d_name, sym, sizeof(sym) - 1)) < 1)
goto out;
*size = sb.st_size;
sym[len] = '\0';
ret = xstrdup(sym);
break;
}
out:
closedir(dirp);
return ret;
}
/*
* Return the inode number from a string
*/
static ino_t get_dev_inode(char *str, dev_t *dev)
{
unsigned int maj = 0, min = 0;
ino_t inum = 0;
if (sscanf(str, "%x:%x:%ju", &maj, &min, &inum) != 3)
errx(EXIT_FAILURE, _("failed to parse '%s'"), str);
*dev = (dev_t) makedev(maj, min);
return inum;
}
struct override_info {
pid_t pid;
const char *cmdname;
};
static bool is_holder(struct lock *l, struct lock *m)
{
return (l->start == m->start &&
l->end == m->end &&
l->inode == m->inode &&
l->dev == m->dev &&
l->mandatory == m->mandatory &&
l->blocked == m->blocked &&
strcmp(l->type, m->type) == 0 &&
strcmp(l->mode, m->mode) == 0);
}
static void patch_lock(struct lock *l, void *fallback)
{
struct lock_tnode tmp = { .dev = l->dev, .inode = l->inode, };
struct lock_tnode **head = tfind(&tmp, fallback, lock_tnode_compare);
struct list_head *p;
if (!head)
return;
list_for_each(p, &(*head)->chain) {
struct lock *m = list_entry(p, struct lock, locks);
if (is_holder(l, m)) {
/* size and id can be ignored. */
l->pid = m->pid;
l->cmdname = xstrdup(m->cmdname);
break;
}
}
}
static void add_to_list(struct list_head *locks, struct lock *l)
{
list_add(&l->locks, locks);
}
static struct lock *get_lock(char *buf, struct override_info *oinfo, void *fallback)
{
int i;
char *tok = NULL;
size_t sz;
struct lock *l = xcalloc(1, sizeof(*l));
INIT_LIST_HEAD(&l->locks);
l->fd = -1;
bool cmdname_unknown = false;
for (tok = strtok(buf, " "), i = 0; tok;
tok = strtok(NULL, " "), i++) {
/*
* /proc/locks has *exactly* 8 "blocks" of text
* separated by ' ' - check <kernel>/fs/locks.c
*/
switch (i) {
case 0: /* ID: */
if (oinfo)
l->id = -1;
else {
tok[strlen(tok) - 1] = '\0';
l->id = strtos32_or_err(tok, _("failed to parse ID"));
}
break;
case 1: /* posix, flock, etc */
if (strcmp(tok, "->") == 0) { /* optional field */
l->blocked = 1;
i--;
} else
l->type = xstrdup(tok);
break;
case 2: /* is this a mandatory lock? other values are advisory or noinode */
l->mandatory = *tok == 'M' ? 1 : 0;
break;
case 3: /* lock mode */
l->mode = xstrdup(tok);
break;
case 4: /* PID */
/*
* If user passed a pid we filter it later when adding
* to the list, no need to worry now. OFD locks use -1 PID.
*/
if (oinfo) {
l->pid = oinfo->pid;
l->cmdname = xstrdup(oinfo->cmdname);
} else {
/* strtopid_or_err() is not suitable here; tok can be -1.*/
l->pid = strtos32_or_err(tok, _("invalid PID argument"));
if (l->pid > 0) {
l->cmdname = pid_get_cmdname(l->pid);
if (!l->cmdname)
cmdname_unknown = true;
} else
l->cmdname = NULL;
}
break;
case 5: /* device major:minor and inode number */
l->inode = get_dev_inode(tok, &l->dev);
break;
case 6: /* start */
l->start = !strcmp(tok, "EOF") ? 0 :
strtou64_or_err(tok, _("failed to parse start"));
break;
case 7: /* end */
/* replace '\n' character */
tok[strlen(tok)-1] = '\0';
l->end = !strcmp(tok, "EOF") ? 0 :
strtou64_or_err(tok, _("failed to parse end"));
break;
default:
break;
}
}
if ((!l->blocked) && fallback && !l->cmdname)
patch_lock(l, fallback);
if (!l->cmdname) {
if (cmdname_unknown)
l->cmdname = xstrdup(_("(unknown)"));
else
l->cmdname = xstrdup(_("(undefined)"));
}
l->path = get_filename_sz(l->inode, l->pid, &sz);
if (l->path)
l->size = sz;
return l;
}
static struct lock *refine_lock(struct lock *lock,
int no_inaccessible, struct libmnt_table *tab)
{
/* no permissions -- ignore */
if (!lock->path && no_inaccessible) {
rem_lock(lock);
return NULL;
}
if (!lock->path) {
/* probably no permission to peek into l->pid's path */
lock->path = tab
? get_fallback_filename(tab, lock->dev)
: NULL;
lock->size = 0;
}
return lock;
}
static int get_pid_lock(struct lslocks *lslocks, FILE *fp,
pid_t pid, const char *cmdname, int fd)
{
char buf[PATH_MAX];
struct override_info oinfo = {
.pid = pid,
.cmdname = cmdname,
};
while (fgets(buf, sizeof(buf), fp)) {
struct lock *l;
if (strncmp(buf, "lock:\t", 6))
continue;
l = get_lock(buf + 6, &oinfo, NULL);
if (l)
l = refine_lock(l, lslocks->no_inaccessible,
lslocks->tab);
if (l) {
add_to_tree(&lslocks->pid_locks, l);
l->fd = fd;
}
/* no break here.
Multiple recode locks can be taken via one fd. */
}
return 0;
}
static int get_pid_locks(struct lslocks *lslocks,
struct path_cxt *pc,
pid_t pid, const char *cmdname)
{
DIR *sub = NULL;
struct dirent *d = NULL;
int rc = 0;
while (ul_path_next_dirent(pc, &sub, "fdinfo", &d) == 0) {
uint64_t num;
FILE *fdinfo;
if (ul_strtou64(d->d_name, &num, 10) != 0) /* only numbers */
continue;
fdinfo = ul_path_fopenf(pc, "r", "fdinfo/%ju", num);
if (fdinfo == NULL)
continue;
get_pid_lock(lslocks, fdinfo, pid, cmdname, (int)num);
fclose(fdinfo);
}
return rc;
}
static void get_pids_locks(struct lslocks *lslocks)
{
DIR *dir;
struct dirent *d;
struct path_cxt *pc = NULL;
pc = ul_new_path(NULL);
if (!pc)
err(EXIT_FAILURE, _("failed to alloc procfs handler"));
dir = opendir(_PATH_PROC);
if (!dir)
err(EXIT_FAILURE, _("failed to open /proc"));
while ((d = readdir(dir))) {
pid_t pid;
char buf[BUFSIZ];
const char *cmdname = NULL;
if (procfs_dirent_get_pid(d, &pid) != 0)
continue;
if (procfs_process_init_path(pc, pid) != 0)
continue;
if (procfs_process_get_cmdname(pc, buf, sizeof(buf)) <= 0)
continue;
cmdname = buf;
get_pid_locks(lslocks, pc, pid, cmdname);
}
closedir(dir);
ul_unref_path(pc);
return;
}
static int get_proc_locks(struct lslocks *lslocks)
{
FILE *fp;
char buf[PATH_MAX];
if (!(fp = fopen(_PATH_PROC_LOCKS, "r")))
return -1;
while (fgets(buf, sizeof(buf), fp)) {
struct lock *l = get_lock(buf, NULL, &lslocks->pid_locks);
if (l)
l = refine_lock(l, lslocks->no_inaccessible,
lslocks->tab);
if (l)
add_to_list(&lslocks->proc_locks, l);
}
fclose(fp);
return 0;
}
static int column_name_to_id(const char *name, size_t namesz)
{
assert(name);
for (size_t i = 0; i < ARRAY_SIZE(infos); i++) {
const char *cn = infos[i].name;
if (!c_strncasecmp(name, cn, namesz) && !*(cn + namesz))
return i;
}
warnx(_("unknown column: %s"), name);
return -1;
}
static inline int get_column_id(int num)
{
assert(num >= 0);
assert((size_t) num < ncolumns);
assert(columns[num] < (int) ARRAY_SIZE(infos));
return columns[num];
}
static inline const struct colinfo *get_column_info(unsigned num)
{
return &infos[ get_column_id(num) ];
}
static pid_t get_blocker(int id, struct list_head *locks)
{
struct list_head *p;
list_for_each(p, locks) {
struct lock *l = list_entry(p, struct lock, locks);
if (l->id == id && !l->blocked)
return l->pid;
}
return 0;
}
static void xstrcoholder(char **str, struct lock *l)
{
xstrfappend(str, "%d,%s,%d",
l->pid, l->cmdname, l->fd);
}
static char *get_data(struct lslocks *lslocks, struct lock *l, int num,
uint64_t *rawdata)
{
char *str = NULL;
/*
* Whenever cmdname or filename is NULL it is most
* likely because there's no read permissions
* for the specified process.
*/
const char *notfnd = "";
switch (get_column_id(num)) {
case COL_SRC:
xasprintf(&str, "%s", l->cmdname ? l->cmdname : notfnd);
break;
case COL_PID:
xasprintf(&str, "%d", l->pid);
if (l->pid >= 0 && rawdata)
*rawdata = (uint64_t)l->pid;
break;
case COL_TYPE:
xasprintf(&str, "%s", l->type);
break;
case COL_INODE:
xasprintf(&str, "%ju", (uintmax_t) l->inode);
break;
case COL_MAJMIN:
if (lslocks->json || lslocks->raw)
xasprintf(&str, "%u:%u", major(l->dev), minor(l->dev));
else
xasprintf(&str, "%3u:%-3u", major(l->dev), minor(l->dev));
break;
case COL_SIZE:
if (!l->size)
break;
if (lslocks->bytes)
xasprintf(&str, "%ju", l->size);
else
str = size_to_human_string(SIZE_SUFFIX_1LETTER, l->size);
if (rawdata)
*rawdata = l->size;
break;
case COL_MODE:
xasprintf(&str, "%s%s", l->mode, l->blocked ? "*" : "");
break;
case COL_M:
xasprintf(&str, "%d", l->mandatory ? 1 : 0);
break;
case COL_START:
xasprintf(&str, "%jd", l->start);
break;
case COL_END:
xasprintf(&str, "%jd", l->end);
break;
case COL_PATH:
xasprintf(&str, "%s", l->path ? l->path : notfnd);
break;
case COL_BLOCKER:
{
pid_t bl = l->blocked && l->id ?
get_blocker(l->id, &lslocks->proc_locks) : 0;
if (bl)
xasprintf(&str, "%d", (int) bl);
break;
}
case COL_HOLDERS:
{
struct lock_tnode tmp = { .dev = l->dev, .inode = l->inode, };
struct lock_tnode **head = tfind(&tmp, &lslocks->pid_locks, lock_tnode_compare);
struct list_head *p;
if (!head)
break;
list_for_each(p, &(*head)->chain) {
struct lock *m = list_entry(p, struct lock, locks);
if (!is_holder(l, m))
continue;
if (str)
xstrputc(&str, '\n');
xstrcoholder(&str, m);
}
break;
}
default:
break;
}
return str;
}
static void set_line_data(struct libscols_line *line, size_t i, char *data)
{
if (data && scols_line_refer_data(line, i, data))
err(EXIT_FAILURE, _("failed to add output data"));
}
struct filler_data {
struct lslocks *lslocks;
struct lock *l;
struct libscols_table *table;
};
/* stores data to scols cell userdata (invisible and independent on output)
* to make the original values accessible for sort functions
*/
static void set_rawdata_u64(struct libscols_line *ln, int col, uint64_t x)
{
struct libscols_cell *ce = scols_line_get_cell(ln, col);
uint64_t *data;
if (!ce)
return;
data = xmalloc(sizeof(uint64_t));
*data = x;
scols_cell_set_userdata(ce, data);
}
static int filter_filler_cb(struct libscols_filter *filter __attribute__((__unused__)),
struct libscols_line *line,
size_t column_index,
void *userdata)
{
struct filler_data *fid = (struct filler_data *)userdata;
struct libscols_column *cl = scols_table_get_column(fid->table, column_index);
bool needs_rawdata = !!scols_column_has_data_func(cl);
uint64_t rawdata = (uint64_t) -1;
char *data = get_data(fid->lslocks, fid->l, column_index,
needs_rawdata ? &rawdata : NULL);
if (data) {
set_line_data(line, column_index, data);
if (needs_rawdata && rawdata != (uint64_t) -1)
set_rawdata_u64(line, column_index, rawdata);
}
return 0;
}
static void unref_line_rawdata(struct libscols_line *ln, struct libscols_table *tb)
{
size_t i;
for (i = 0; i < ncolumns; i++) {
struct libscols_column *cl = scols_table_get_column(tb, i);
struct libscols_cell *ce;
void *data;
if (!scols_column_has_data_func(cl))
continue;
ce = scols_line_get_column_cell(ln, cl);
data = scols_cell_get_userdata(ce);
free(data);
}
}
static void add_scols_line(struct lslocks *lslocks,
struct libscols_table *table, struct libscols_filter *filter,
struct lock *l)
{
struct libscols_line *line;
struct filler_data fid = {
.lslocks = lslocks,
.l = l,
.table = table,
};
assert(l);
assert(table);
line = scols_table_new_line(table, NULL);
if (!line)
err(EXIT_FAILURE, _("failed to allocate output line"));
if (filter) {
int status = 0;
scols_filter_set_filler_cb(filter,
filter_filler_cb, (void *)&fid);
if (scols_line_apply_filter(line, filter, &status))
err(EXIT_FAILURE, _("failed to apply filter"));
if (status == 0) {
unref_line_rawdata(line, table);
scols_table_remove_line(table, line);
return;
}
}
for (size_t i = 0; i < ncolumns; i++) {
char *str;
if (scols_line_is_filled(line, i))
continue;
str = get_data(lslocks, l, i, NULL);
if (str)
set_line_data(line, i, str);
}
}
static void rem_locks(struct list_head *locks)
{
struct list_head *p, *pnext;
/* destroy the list */
list_for_each_safe(p, pnext, locks) {
struct lock *l = list_entry(p, struct lock, locks);
rem_lock(l);
}
}
static void rem_tnode(void *node)
{
struct lock_tnode *tnode = node;
rem_locks(&tnode->chain);
free(node);
}
static int get_json_type_for_column(int column_id, int bytes)
{
switch (column_id) {
case COL_SIZE:
if (!bytes)
return SCOLS_JSON_STRING;
FALLTHROUGH;
case COL_PID:
case COL_START:
case COL_END:
case COL_BLOCKER:
case COL_INODE:
return SCOLS_JSON_NUMBER;
case COL_M:
return SCOLS_JSON_BOOLEAN;
case COL_HOLDERS:
return SCOLS_JSON_ARRAY_STRING;
default:
return SCOLS_JSON_STRING;
}
}
static struct libscols_table *init_scols_table(int raw, int json, int no_headings, int bytes,
bool use_filter)
{
struct libscols_table *table;
table = scols_new_table();
if (!table)
err(EXIT_FAILURE, _("failed to allocate output table"));
scols_table_enable_raw(table, raw);
scols_table_enable_json(table, json);
scols_table_enable_noheadings(table, no_headings);
if (json)
scols_table_set_name(table, "locks");
for (size_t i = 0; i < ncolumns; i++) {
struct libscols_column *cl;
const struct colinfo *col = get_column_info(i);
cl = scols_table_new_column(table, col->name, col->whint, col->flags);
if (!cl)
err(EXIT_FAILURE, _("failed to allocate output column"));
if (col->flags & SCOLS_FL_WRAP) {
scols_column_set_wrapfunc(cl,
scols_wrapnl_chunksize,
scols_wrapnl_nextchunk,
NULL);
scols_column_set_safechars(cl, "\n");
}
if (json || use_filter) {
int id = get_column_id(i);
int json_type = get_json_type_for_column(id, bytes);
scols_column_set_json_type(cl, json_type);
}
}
return table;
}
static int show_locks(struct lslocks *lslocks, struct libscols_table *table,
struct libscols_filter *filter)
{
struct list_head *p;
/* prepare data for output */
list_for_each(p, &lslocks->proc_locks) {
struct lock *l = list_entry(p, struct lock, locks);
if (lslocks->target_pid && lslocks->target_pid != l->pid)
continue;
add_scols_line(lslocks, table, filter, l);
}
scols_print_table(table);
return 0;
}
static void __attribute__((__noreturn__)) usage(void)
{
FILE *out = stdout;
fputs(USAGE_HEADER, out);
fprintf(out,
_(" %s [options]\n"), program_invocation_short_name);
fputs(USAGE_SEPARATOR, out);
fputs(_("List local system locks.\n"), out);
fputs(USAGE_OPTIONS, out);
fputs(_(" -b, --bytes print SIZE in bytes rather than in human readable format\n"), out);
fputs(_(" -J, --json use JSON output format\n"), out);
fputs(_(" -i, --noinaccessible ignore locks without read permissions\n"), out);
fputs(_(" -n, --noheadings don't print headings\n"), out);
fputs(_(" -o, --output <list> output columns (see --list-columns)\n"), out);
fputs(_(" --output-all output all columns\n"), out);
fputs(_(" -p, --pid <pid> display only locks held by this process\n"), out);
fputs(_(" -Q, --filter <expr> apply display filter\n"), out);
fputs(_(" -r, --raw use the raw output format\n"), out);
fputs(_(" -u, --notruncate don't truncate text in columns\n"), out);
fputs(USAGE_SEPARATOR, out);
fprintf(out, USAGE_LIST_COLUMNS_OPTION(24));
fprintf(out, USAGE_HELP_OPTIONS(24));
fprintf(out, USAGE_MAN_TAIL("lslocks(8)"));
exit(EXIT_SUCCESS);
}
static void __attribute__((__noreturn__)) list_columns(struct lslocks *lslocks)
{
struct libscols_table *col_tb = xcolumn_list_table_new(
"lslocks-columns", stdout, lslocks->raw, lslocks->json);
for (size_t i = 0; i < ARRAY_SIZE(infos); i++) {
if (i != COL_SIZE) {
int json_type = get_json_type_for_column(i, lslocks->bytes);
xcolumn_list_table_append_line(col_tb, infos[i].name,
json_type, NULL,
_(infos[i].help));
} else
xcolumn_list_table_append_line(col_tb, infos[i].name,
-1, "<string|number>",
_(infos[i].help));
}
scols_print_table(col_tb);
scols_unref_table(col_tb);
exit(EXIT_SUCCESS);
}
static struct libscols_filter *new_filter(const char *query)
{
struct libscols_filter *f;
f = scols_new_filter(NULL);
if (!f)
err(EXIT_FAILURE, _("failed to allocate filter"));
if (query && scols_filter_parse_string(f, query) != 0)
errx(EXIT_FAILURE, _("failed to parse \"%s\": %s"), query,
scols_filter_get_errmsg(f));
return f;
}
static void *get_u64_cell(const struct libscols_column *cl __attribute__((__unused__)),
struct libscols_cell *ce,
void *data __attribute__((__unused__)))
{
return scols_cell_get_userdata(ce);
}
static void init_scols_filter(struct libscols_table *tb, struct libscols_filter *filter,
int bytes)
{
struct libscols_iter *itr;
const char *name = NULL;
int nerrs = 0;
itr = scols_new_iter(SCOLS_ITER_FORWARD);
if (!itr)
err(EXIT_FAILURE, _("failed to allocate iterator"));
while (scols_filter_next_holder(filter, itr, &name, 0) == 0) {
struct libscols_column *col = scols_table_get_column_by_name(tb, name);
int id = column_name_to_id(name, strlen(name));
const struct colinfo *ci = id >= 0 ? &infos[id] : NULL;
if (!ci) {
nerrs++;
continue; /* report all unknown columns */
}
if (!col) {
int json_type = get_json_type_for_column(id, bytes);
add_column(id);
col = scols_table_new_column(tb, ci->name,
ci->whint, SCOLS_FL_HIDDEN);
if (!col)
err(EXIT_FAILURE, _("failed to allocate output column"));
scols_column_set_json_type(col, json_type);
}
if ((id == COL_SIZE && !bytes) || id == COL_PID) {
scols_column_set_data_type(col, SCOLS_DATA_U64);
scols_column_set_data_func(col, get_u64_cell, NULL);
}
scols_filter_assign_column(filter, itr, name, col);
}
scols_free_iter(itr);
if (!nerrs)
return;
errx(EXIT_FAILURE, _("failed to initialize filter"));
}
static void unref_table_rawdata(struct libscols_table *tb)
{
struct libscols_iter *itr;
struct libscols_line *ln;
itr = scols_new_iter(SCOLS_ITER_FORWARD);
if (!itr)
return;
while (scols_table_next_line(tb, itr, &ln) == 0)
unref_line_rawdata(ln, tb);
scols_free_iter(itr);
}
static void lslocks_init(struct lslocks *lslocks)
{
memset(lslocks, 0, sizeof(*lslocks));
INIT_LIST_HEAD(&lslocks->proc_locks);
}
static void lslocks_free(struct lslocks *lslocks)
{
rem_locks(&lslocks->proc_locks);
tdestroy(lslocks->pid_locks, rem_tnode);
}
int main(int argc, char *argv[])
{
struct lslocks lslocks;
int c, rc = 0, collist = 0;
struct libscols_table *table;
struct libscols_filter *filter = NULL;
char *outarg = NULL;
enum {
OPT_OUTPUT_ALL = CHAR_MAX + 1
};
static const struct option long_opts[] = {
{ "bytes", no_argument, NULL, 'b' },
{ "json", no_argument, NULL, 'J' },
{ "pid", required_argument, NULL, 'p' },
{ "help", no_argument, NULL, 'h' },
{ "output", required_argument, NULL, 'o' },
{ "output-all", no_argument, NULL, OPT_OUTPUT_ALL },
{ "notruncate", no_argument, NULL, 'u' },
{ "version", no_argument, NULL, 'V' },
{ "noheadings", no_argument, NULL, 'n' },
{ "raw", no_argument, NULL, 'r' },
{ "noinaccessible", no_argument, NULL, 'i' },
{ "filter", required_argument, NULL, 'Q' },
{ "list-columns", no_argument, NULL, 'H' },
{ NULL, 0, NULL, 0 }
};
static const ul_excl_t excl[] = { /* rows and cols in ASCII order */
{ 'J','r' },
{ 0 }
};
int excl_st[ARRAY_SIZE(excl)] = UL_EXCL_STATUS_INIT;
setlocale(LC_ALL, "");
bindtextdomain(PACKAGE, LOCALEDIR);
textdomain(PACKAGE);
close_stdout_atexit();
lslocks_init(&lslocks);
while ((c = getopt_long(argc, argv,
"biJp:o:nruhVHQ:", long_opts, NULL)) != -1) {
err_exclusive_options(c, long_opts, excl, excl_st);
switch(c) {
case 'b':
lslocks.bytes = 1;
break;
case 'i':
lslocks.no_inaccessible = 1;
break;
case 'J':
lslocks.json = 1;
break;
case 'p':
lslocks.target_pid = strtopid_or_err(optarg, _("invalid PID argument"));
break;
case 'o':
outarg = optarg;
break;
case OPT_OUTPUT_ALL:
for (ncolumns = 0; ncolumns < ARRAY_SIZE(infos); ncolumns++)
columns[ncolumns] = ncolumns;
break;
case 'n':
lslocks.no_headings = 1;
break;
case 'r':
lslocks.raw = 1;
break;
case 'u':
disable_columns_truncate();
break;
case 'H':
collist = 1;
break;
case 'Q':
filter = new_filter(optarg);
break;
case 'V':
print_version(EXIT_SUCCESS);
case 'h':
usage();
default:
errtryhelp(EXIT_FAILURE);
}
}
if (collist)
list_columns(&lslocks); /* print end exit */
if (!ncolumns) {
/* default columns */
columns[ncolumns++] = COL_SRC;
columns[ncolumns++] = COL_PID;
columns[ncolumns++] = COL_TYPE;
columns[ncolumns++] = COL_SIZE;
columns[ncolumns++] = COL_MODE;
columns[ncolumns++] = COL_M;
columns[ncolumns++] = COL_START;
columns[ncolumns++] = COL_END;
columns[ncolumns++] = COL_PATH;
}
if (!outarg)
outarg = getenv("LSLOCKS_COLUMNS");
if (outarg && string_add_to_idarray(outarg, columns, ARRAY_SIZE(columns),
&ncolumns, column_name_to_id) < 0)
return EXIT_FAILURE;
scols_init_debug(0);
table = init_scols_table(lslocks.raw, lslocks.json, lslocks.no_headings, lslocks.bytes,
(bool)filter);
if (filter)
init_scols_filter(table, filter, lslocks.bytes);
/* get_pids_locks() get locks related information from "lock:" fields
* of /proc/$pid/fdinfo/$fd as fallback information.
* get_proc_locks() used the fallback information if /proc/locks
* doesn't provide enough information or provides stale information. */
lslocks.tab = mnt_new_table_from_file(_PATH_PROC_MOUNTINFO);
get_pids_locks(&lslocks);
rc = get_proc_locks(&lslocks);
mnt_unref_table(lslocks.tab);
if (!rc && !list_empty(&lslocks.proc_locks))
rc = show_locks(&lslocks, table, filter);
scols_unref_filter(filter);
unref_table_rawdata(table);
scols_unref_table(table);
lslocks_free(&lslocks);
return rc;
}
|