2 * lsblk(8) - list block devices
4 * Copyright (C) 2010-2018 Red Hat, Inc. All rights reserved.
5 * Written by Milan Broz <mbroz@redhat.com>
6 * Karel Zak <kzak@redhat.com>
8 * This program is free software; you can redistribute it and/or modify
9 * it under the terms of the GNU General Public License as published by
10 * the Free Software Foundation; either version 2 of the License, or
11 * (at your option) any later version.
13 * This program is distributed in the hope that it would be useful,
14 * but WITHOUT ANY WARRANTY; without even the implied warranty of
15 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 * GNU General Public License for more details.
18 * You should have received a copy of the GNU General Public License along
19 * with this program; if not, write to the Free Software Foundation, Inc.,
20 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
27 #include <sys/types.h>
32 #include <sys/ioctl.h>
43 #include "pathnames.h"
45 #include "canonicalize.h"
50 #include "closestream.h"
55 UL_DEBUG_DEFINE_MASK(lsblk
);
56 UL_DEBUG_DEFINE_MASKNAMES(lsblk
) = UL_DEBUG_EMPTY_MASKNAMES
;
58 #define LSBLK_EXIT_SOMEOK 64
59 #define LSBLK_EXIT_ALLFAILED 32
61 static int column_id_to_number(int id
);
119 /* basic table settings */
121 LSBLK_ASCII
= (1 << 0),
122 LSBLK_RAW
= (1 << 1),
123 LSBLK_NOHEADINGS
= (1 << 2),
124 LSBLK_EXPORT
= (1 << 3),
125 LSBLK_TREE
= (1 << 4),
126 LSBLK_JSON
= (1 << 5),
129 /* Types used for qsort() and JSON */
131 COLTYPE_STR
= 0, /* default */
132 COLTYPE_NUM
= 1, /* always u64 number */
133 COLTYPE_SORTNUM
= 2, /* string on output, u64 for qsort() */
134 COLTYPE_SIZE
= 3, /* srring by default, number when --bytes */
135 COLTYPE_BOOL
= 4 /* 0 or 1 */
140 const char *name
; /* header */
141 double whint
; /* width hint (N < 1 is in percent of termwidth) */
142 int flags
; /* SCOLS_FL_* */
144 int type
; /* COLTYPE_* */
147 /* columns descriptions */
148 static struct colinfo infos
[] = {
149 [COL_NAME
] = { "NAME", 0.25, SCOLS_FL_NOEXTREMES
, N_("device name") },
150 [COL_KNAME
] = { "KNAME", 0.3, 0, N_("internal kernel device name") },
151 [COL_PKNAME
] = { "PKNAME", 0.3, 0, N_("internal parent kernel device name") },
152 [COL_PATH
] = { "PATH", 0.3, 0, N_("path to the device node") },
153 [COL_MAJMIN
] = { "MAJ:MIN", 6, 0, N_("major:minor device number"), COLTYPE_SORTNUM
},
155 [COL_FSAVAIL
] = { "FSAVAIL", 5, SCOLS_FL_RIGHT
, N_("filesystem size available") },
156 [COL_FSSIZE
] = { "FSSIZE", 5, SCOLS_FL_RIGHT
, N_("filesystem size") },
157 [COL_FSTYPE
] = { "FSTYPE", 0.1, SCOLS_FL_TRUNC
, N_("filesystem type") },
158 [COL_FSUSED
] = { "FSUSED", 5, SCOLS_FL_RIGHT
, N_("filesystem size used") },
159 [COL_FSUSEPERC
] = { "FSUSE%", 3, SCOLS_FL_RIGHT
, N_("filesystem use percentage") },
161 [COL_TARGET
] = { "MOUNTPOINT", 0.10, SCOLS_FL_TRUNC
, N_("where the device is mounted") },
162 [COL_LABEL
] = { "LABEL", 0.1, 0, N_("filesystem LABEL") },
163 [COL_UUID
] = { "UUID", 36, 0, N_("filesystem UUID") },
165 [COL_PTUUID
] = { "PTUUID", 36, 0, N_("partition table identifier (usually UUID)") },
166 [COL_PTTYPE
] = { "PTTYPE", 0.1, 0, N_("partition table type") },
168 [COL_PARTTYPE
] = { "PARTTYPE", 36, 0, N_("partition type UUID") },
169 [COL_PARTLABEL
] = { "PARTLABEL", 0.1, 0, N_("partition LABEL") },
170 [COL_PARTUUID
] = { "PARTUUID", 36, 0, N_("partition UUID") },
171 [COL_PARTFLAGS
] = { "PARTFLAGS", 36, 0, N_("partition flags") },
173 [COL_RA
] = { "RA", 3, SCOLS_FL_RIGHT
, N_("read-ahead of the device"), COLTYPE_NUM
},
174 [COL_RO
] = { "RO", 1, SCOLS_FL_RIGHT
, N_("read-only device"), COLTYPE_BOOL
},
175 [COL_RM
] = { "RM", 1, SCOLS_FL_RIGHT
, N_("removable device"), COLTYPE_BOOL
},
176 [COL_HOTPLUG
]= { "HOTPLUG", 1, SCOLS_FL_RIGHT
, N_("removable or hotplug device (usb, pcmcia, ...)"), COLTYPE_BOOL
},
177 [COL_ROTA
] = { "ROTA", 1, SCOLS_FL_RIGHT
, N_("rotational device"), COLTYPE_BOOL
},
178 [COL_RAND
] = { "RAND", 1, SCOLS_FL_RIGHT
, N_("adds randomness"), COLTYPE_BOOL
},
179 [COL_MODEL
] = { "MODEL", 0.1, SCOLS_FL_TRUNC
, N_("device identifier") },
180 [COL_SERIAL
] = { "SERIAL", 0.1, SCOLS_FL_TRUNC
, N_("disk serial number") },
181 [COL_SIZE
] = { "SIZE", 5, SCOLS_FL_RIGHT
, N_("size of the device"), COLTYPE_SIZE
},
182 [COL_STATE
] = { "STATE", 7, SCOLS_FL_TRUNC
, N_("state of the device") },
183 [COL_OWNER
] = { "OWNER", 0.1, SCOLS_FL_TRUNC
, N_("user name"), },
184 [COL_GROUP
] = { "GROUP", 0.1, SCOLS_FL_TRUNC
, N_("group name") },
185 [COL_MODE
] = { "MODE", 10, 0, N_("device node permissions") },
186 [COL_ALIOFF
] = { "ALIGNMENT", 6, SCOLS_FL_RIGHT
, N_("alignment offset"), COLTYPE_NUM
},
187 [COL_MINIO
] = { "MIN-IO", 6, SCOLS_FL_RIGHT
, N_("minimum I/O size"), COLTYPE_NUM
},
188 [COL_OPTIO
] = { "OPT-IO", 6, SCOLS_FL_RIGHT
, N_("optimal I/O size"), COLTYPE_NUM
},
189 [COL_PHYSEC
] = { "PHY-SEC", 7, SCOLS_FL_RIGHT
, N_("physical sector size"), COLTYPE_NUM
},
190 [COL_LOGSEC
] = { "LOG-SEC", 7, SCOLS_FL_RIGHT
, N_("logical sector size"), COLTYPE_NUM
},
191 [COL_SCHED
] = { "SCHED", 0.1, 0, N_("I/O scheduler name") },
192 [COL_RQ_SIZE
]= { "RQ-SIZE", 5, SCOLS_FL_RIGHT
, N_("request queue size"), COLTYPE_NUM
},
193 [COL_TYPE
] = { "TYPE", 4, 0, N_("device type") },
194 [COL_DALIGN
] = { "DISC-ALN", 6, SCOLS_FL_RIGHT
, N_("discard alignment offset"), COLTYPE_NUM
},
195 [COL_DGRAN
] = { "DISC-GRAN", 6, SCOLS_FL_RIGHT
, N_("discard granularity"), COLTYPE_SIZE
},
196 [COL_DMAX
] = { "DISC-MAX", 6, SCOLS_FL_RIGHT
, N_("discard max bytes"), COLTYPE_SIZE
},
197 [COL_DZERO
] = { "DISC-ZERO", 1, SCOLS_FL_RIGHT
, N_("discard zeroes data"), COLTYPE_BOOL
},
198 [COL_WSAME
] = { "WSAME", 6, SCOLS_FL_RIGHT
, N_("write same max bytes"), COLTYPE_SIZE
},
199 [COL_WWN
] = { "WWN", 18, 0, N_("unique storage identifier") },
200 [COL_HCTL
] = { "HCTL", 10, 0, N_("Host:Channel:Target:Lun for SCSI") },
201 [COL_TRANSPORT
] = { "TRAN", 6, 0, N_("device transport type") },
202 [COL_SUBSYS
] = { "SUBSYSTEMS", 0.1, SCOLS_FL_NOEXTREMES
, N_("de-duplicated chain of subsystems") },
203 [COL_REV
] = { "REV", 4, SCOLS_FL_RIGHT
, N_("device revision") },
204 [COL_VENDOR
] = { "VENDOR", 0.1, SCOLS_FL_TRUNC
, N_("device vendor") },
205 [COL_ZONED
] = { "ZONED", 0.3, 0, N_("zone model") },
208 struct lsblk
*lsblk
; /* global handler */
211 * columns[] array specifies all currently wanted output column. The columns
212 * are defined by infos[] array and you can specify (on command line) each
213 * column twice. That's enough, dynamically allocated array of the columns is
214 * unnecessary overkill and over-engineering in this case
216 static int columns
[ARRAY_SIZE(infos
) * 2];
217 static size_t ncolumns
;
219 static inline void add_column(int id
)
221 if (ncolumns
>= ARRAY_SIZE(columns
))
222 errx(EXIT_FAILURE
, _("too many columns specified, "
223 "the limit is %zu columns"),
224 ARRAY_SIZE(columns
) - 1);
225 columns
[ ncolumns
++ ] = id
;
228 static inline void add_uniq_column(int id
)
230 if (column_id_to_number(id
) < 0)
234 static void lsblk_init_debug(void)
236 __UL_INIT_DEBUG_FROM_ENV(lsblk
, LSBLK_DEBUG_
, 0, LSBLK_DEBUG
);
240 * exclude/include devices filter based on major device numbers
242 static int excludes
[256];
243 static size_t nexcludes
;
245 static int includes
[256];
246 static size_t nincludes
;
248 static int is_maj_excluded(int maj
)
252 assert(ARRAY_SIZE(excludes
) > nexcludes
);
255 return 0; /* filter not enabled, device not excluded */
257 for (i
= 0; i
< nexcludes
; i
++) {
258 if (excludes
[i
] == maj
) {
259 DBG(FILTER
, ul_debug("exclude: maj=%d", maj
));
266 static int is_maj_included(int maj
)
270 assert(ARRAY_SIZE(includes
) > nincludes
);
273 return 1; /* filter not enabled, device is included */
275 for (i
= 0; i
< nincludes
; i
++) {
276 if (includes
[i
] == maj
) {
277 DBG(FILTER
, ul_debug("include: maj=%d", maj
));
284 /* Converts column sequential number to column ID (COL_*) */
285 static int get_column_id(int num
)
288 assert((size_t) num
< ncolumns
);
289 assert(columns
[num
] < (int) ARRAY_SIZE(infos
));
293 /* Returns column description for the column sequential number */
294 static struct colinfo
*get_column_info(int num
)
296 return &infos
[ get_column_id(num
) ];
299 /* Converts column name (as defined in the infos[] to the column ID */
300 static int column_name_to_id(const char *name
, size_t namesz
)
304 for (i
= 0; i
< ARRAY_SIZE(infos
); i
++) {
305 const char *cn
= infos
[i
].name
;
307 if (!strncasecmp(name
, cn
, namesz
) && !*(cn
+ namesz
))
310 warnx(_("unknown column: %s"), name
);
314 /* Converts column ID (COL_*) to column sequential number */
315 static int column_id_to_number(int id
)
319 for (i
= 0; i
< ncolumns
; i
++)
320 if (columns
[i
] == id
)
325 /* Checks for DM prefix in the device name */
326 static int is_dm(const char *name
)
328 return strncmp(name
, "dm-", 3) ? 0 : 1;
331 /* This is readdir()-like function, but skips "." and ".." directory entries */
332 static struct dirent
*xreaddir(DIR *dp
)
338 while ((d
= readdir(dp
))) {
339 if (!strcmp(d
->d_name
, ".") ||
340 !strcmp(d
->d_name
, ".."))
343 /* blacklist here? */
349 /* Returns full pat to the device node (TODO: what about sysfs_blkdev_get_path()) */
350 static char *get_device_path(struct lsblk_device
*dev
)
357 if (is_dm(dev
->name
))
358 return __canonicalize_dm_name(lsblk
->sysroot
, dev
->name
);
360 snprintf(path
, sizeof(path
), "/dev/%s", dev
->name
);
361 sysfs_devname_sys_to_dev(path
);
362 return xstrdup(path
);
365 static int is_readonly_device(struct lsblk_device
*dev
)
369 if (ul_path_scanf(dev
->sysfs
, "ro", "%d", &ro
) == 1)
372 /* fallback if "ro" attribute does not exist */
373 fd
= open(dev
->filename
, O_RDONLY
);
375 if (ioctl(fd
, BLKROGET
, &ro
) != 0)
382 static char *get_scheduler(struct lsblk_device
*dev
)
385 char *p
, *res
= NULL
;
387 if (ul_path_read_buffer(dev
->sysfs
, buf
, sizeof(buf
), "queue/scheduler") == 0)
389 p
= strchr(buf
, '[');
392 p
= strchr(res
, ']');
402 static char *get_type(struct lsblk_device
*dev
)
404 char *res
= NULL
, *p
;
406 if (device_is_partition(dev
))
407 return xstrdup("part");
409 if (is_dm(dev
->name
)) {
410 char *dm_uuid
= NULL
;
412 /* The DM_UUID prefix should be set to subsystem owning
413 * the device - LVM, CRYPT, DMRAID, MPATH, PART */
414 if (ul_path_read_string(dev
->sysfs
, &dm_uuid
, "dm/uuid") > 0
417 char *dm_uuid_prefix
= strsep(&tmp
, "-");
419 if (dm_uuid_prefix
) {
420 /* kpartx hack to remove partition number */
421 if (strncasecmp(dm_uuid_prefix
, "part", 4) == 0)
422 dm_uuid_prefix
[4] = '\0';
424 res
= xstrdup(dm_uuid_prefix
);
430 /* No UUID or no prefix - just mark it as DM device */
433 } else if (!strncmp(dev
->name
, "loop", 4)) {
434 res
= xstrdup("loop");
436 } else if (!strncmp(dev
->name
, "md", 2)) {
437 char *md_level
= NULL
;
439 ul_path_read_string(dev
->sysfs
, &md_level
, "md/level");
440 res
= md_level
? md_level
: xstrdup("md");
443 const char *type
= NULL
;
446 if (ul_path_read_s32(dev
->sysfs
, &x
, "device/type") == 0)
447 type
= blkdev_scsi_type_to_name(x
);
453 for (p
= res
; p
&& *p
; p
++)
454 *p
= tolower((unsigned char) *p
);
458 /* Thanks to lsscsi code for idea of detection logic used here */
459 static char *get_transport(struct lsblk_device
*dev
)
461 struct path_cxt
*sysfs
= dev
->sysfs
;
463 const char *trans
= NULL
;
466 /* SCSI - Serial Peripheral Interface */
467 if (sysfs_blkdev_scsi_host_is(sysfs
, "spi"))
470 /* FC/FCoE - Fibre Channel / Fibre Channel over Ethernet */
471 else if (sysfs_blkdev_scsi_host_is(sysfs
, "fc")) {
472 attr
= sysfs_blkdev_scsi_host_strdup_attribute(sysfs
, "fc", "symbolic_name");
475 trans
= strstr(attr
, " over ") ? "fcoe" : "fc";
479 /* SAS - Serial Attached SCSI */
480 else if (sysfs_blkdev_scsi_host_is(sysfs
, "sas") ||
481 sysfs_blkdev_scsi_has_attribute(sysfs
, "sas_device"))
485 /* SBP - Serial Bus Protocol (FireWire) */
486 else if (sysfs_blkdev_scsi_has_attribute(sysfs
, "ieee1394_id"))
490 else if (sysfs_blkdev_scsi_host_is(sysfs
, "iscsi"))
493 /* USB - Universal Serial Bus */
494 else if (sysfs_blkdev_scsi_path_contains(sysfs
, "usb"))
498 else if (sysfs_blkdev_scsi_host_is(sysfs
, "scsi")) {
499 attr
= sysfs_blkdev_scsi_host_strdup_attribute(sysfs
, "scsi", "proc_name");
502 if (!strncmp(attr
, "ahci", 4) || !strncmp(attr
, "sata", 4))
504 else if (strstr(attr
, "ata"))
508 } else if (strncmp(dev
->name
, "nvme", 4) == 0)
511 return trans
? xstrdup(trans
) : NULL
;
514 static char *get_subsystems(struct lsblk_device
*dev
)
517 char *sub
, *chain
, *res
= NULL
;
518 size_t len
= 0, last
= 0;
520 chain
= sysfs_blkdev_get_devchain(dev
->sysfs
, path
, sizeof(path
));
524 while (sysfs_blkdev_next_subsystem(dev
->sysfs
, chain
, &sub
) == 0) {
527 /* don't create "block:scsi:scsi", but "block:scsi" */
528 if (len
&& strcmp(res
+ last
, sub
) == 0) {
534 res
= xrealloc(res
, len
+ sz
+ 2);
538 memcpy(res
+ len
, sub
, sz
+ 1);
548 #define is_parsable(_l) (scols_table_is_raw((_l)->table) || \
549 scols_table_is_export((_l)->table) || \
550 scols_table_is_json((_l)->table))
552 static char *mk_name(const char *name
)
558 xasprintf(&p
, "/dev/%s", name
);
562 sysfs_devname_sys_to_dev(p
);
566 static char *mk_dm_name(const char *name
)
572 xasprintf(&p
, "/dev/mapper/%s", name
);
578 /* stores data to scols cell userdata (invisible and independent on output)
579 * to make the original values accessible for sort functions
581 static void set_sortdata_u64(struct libscols_line
*ln
, int col
, uint64_t x
)
583 struct libscols_cell
*ce
= scols_line_get_cell(ln
, col
);
588 data
= xmalloc(sizeof(uint64_t));
590 scols_cell_set_userdata(ce
, data
);
593 /* do not modify *data on any error */
594 static void str2u64(const char *str
, uint64_t *data
)
600 if (str
== NULL
|| *str
== '\0')
602 num
= strtoumax(str
, &end
, 10);
604 if (errno
|| str
== end
|| (end
&& *end
))
609 static void unref_sortdata(struct libscols_table
*tb
)
611 struct libscols_iter
*itr
;
612 struct libscols_line
*ln
;
614 if (!tb
|| !lsblk
->sort_col
)
616 itr
= scols_new_iter(SCOLS_ITER_FORWARD
);
619 while (scols_table_next_line(tb
, itr
, &ln
) == 0) {
620 struct libscols_cell
*ce
= scols_line_get_column_cell(ln
,
622 void *data
= scols_cell_get_userdata(ce
);
626 scols_free_iter(itr
);
629 static char *get_vfs_attribute(struct lsblk_device
*dev
, int id
)
632 uint64_t vfs_attr
= 0;
635 if (!dev
->fsstat
.f_blocks
) {
636 mnt
= lsblk_device_get_mountpoint(dev
);
637 if (!mnt
|| dev
->is_swap
)
639 if (statvfs(mnt
, &dev
->fsstat
) != 0)
645 vfs_attr
= dev
->fsstat
.f_frsize
* dev
->fsstat
.f_blocks
;
648 vfs_attr
= dev
->fsstat
.f_frsize
* dev
->fsstat
.f_bavail
;
651 vfs_attr
= dev
->fsstat
.f_frsize
* (dev
->fsstat
.f_blocks
- dev
->fsstat
.f_bfree
);
654 if (dev
->fsstat
.f_blocks
== 0)
657 xasprintf(&sizestr
, "%.0f%%",
658 (double)(dev
->fsstat
.f_blocks
- dev
->fsstat
.f_bfree
) /
659 dev
->fsstat
.f_blocks
* 100);
664 sizestr
= xstrdup("0");
665 else if (lsblk
->bytes
)
666 xasprintf(&sizestr
, "%ju", vfs_attr
);
668 sizestr
= size_to_human_string(SIZE_SUFFIX_1LETTER
, vfs_attr
);
673 static struct stat
*device_get_stat(struct lsblk_device
*dev
)
675 if (!dev
->st
.st_rdev
)
676 stat(dev
->filename
, &dev
->st
);
681 static int is_removable_device(struct lsblk_device
*dev
, struct lsblk_device
*parent
)
685 if (dev
->removable
!= -1)
687 if (ul_path_scanf(dev
->sysfs
, "removable", "%d", &dev
->removable
) == 1)
691 pc
= sysfs_blkdev_get_parent(dev
->sysfs
);
695 if (pc
== parent
->sysfs
)
696 /* dev is partition and parent is whole-disk */
697 dev
->removable
= is_removable_device(parent
, NULL
);
699 /* parent is something else, use sysfs parent */
700 ul_path_scanf(pc
, "removable", "%d", &dev
->removable
);
703 if (dev
->removable
== -1)
705 return dev
->removable
;
708 static uint64_t device_get_discard_granularity(struct lsblk_device
*dev
)
710 if (dev
->discard_granularity
== (uint64_t) -1
711 && ul_path_read_u64(dev
->sysfs
, &dev
->discard_granularity
,
712 "queue/discard_granularity") != 0)
713 dev
->discard_granularity
= 0;
715 return dev
->discard_granularity
;
719 * Generates data (string) for column specified by column ID for specified device. If sortdata
720 * is not NULL then returns number usable to sort the column if the data are available for the
723 static char *device_get_data(
724 struct lsblk_device
*dev
, /* device */
725 struct lsblk_device
*parent
, /* device parent as defined in the tree */
726 int id
, /* column ID (COL_*) */
727 uint64_t *sortdata
) /* returns sort data as number */
729 struct lsblk_devprop
*prop
;
734 str
= dev
->dm_name
? mk_dm_name(dev
->dm_name
) : mk_name(dev
->name
);
737 str
= mk_name(dev
->name
);
741 str
= mk_name(parent
->name
);
745 str
= xstrdup(dev
->filename
);
749 struct stat
*st
= device_get_stat(dev
);
750 struct passwd
*pw
= st
? getpwuid(st
->st_uid
) : NULL
;
752 str
= xstrdup(pw
->pw_name
);
757 struct stat
*st
= device_get_stat(dev
);
758 struct group
*gr
= st
? getgrgid(st
->st_gid
) : NULL
;
760 str
= xstrdup(gr
->gr_name
);
765 struct stat
*st
= device_get_stat(dev
);
766 char md
[11] = { '\0' };
769 str
= xstrdup(xstrmode(st
->st_mode
, md
));
773 if (is_parsable(lsblk
))
774 xasprintf(&str
, "%u:%u", dev
->maj
, dev
->min
);
776 xasprintf(&str
, "%3u:%-3u", dev
->maj
, dev
->min
);
778 *sortdata
= makedev(dev
->maj
, dev
->min
);
781 prop
= lsblk_device_get_properties(dev
);
782 if (prop
&& prop
->fstype
)
783 str
= xstrdup(prop
->fstype
);
789 str
= get_vfs_attribute(dev
, id
);
792 str
= xstrdup(lsblk_device_get_mountpoint(dev
));
795 prop
= lsblk_device_get_properties(dev
);
796 if (prop
&& prop
->label
)
797 str
= xstrdup(prop
->label
);
800 prop
= lsblk_device_get_properties(dev
);
801 if (prop
&& prop
->uuid
)
802 str
= xstrdup(prop
->uuid
);
805 prop
= lsblk_device_get_properties(dev
);
806 if (prop
&& prop
->ptuuid
)
807 str
= xstrdup(prop
->ptuuid
);
810 prop
= lsblk_device_get_properties(dev
);
811 if (prop
&& prop
->pttype
)
812 str
= xstrdup(prop
->pttype
);
815 prop
= lsblk_device_get_properties(dev
);
816 if (prop
&& prop
->parttype
)
817 str
= xstrdup(prop
->parttype
);
820 prop
= lsblk_device_get_properties(dev
);
821 if (prop
&& prop
->partlabel
)
822 str
= xstrdup(prop
->partlabel
);
825 prop
= lsblk_device_get_properties(dev
);
826 if (prop
&& prop
->partuuid
)
827 str
= xstrdup(prop
->partuuid
);
830 prop
= lsblk_device_get_properties(dev
);
831 if (prop
&& prop
->partflags
)
832 str
= xstrdup(prop
->partflags
);
835 prop
= lsblk_device_get_properties(dev
);
836 if (prop
&& prop
->wwn
)
837 str
= xstrdup(prop
->wwn
);
840 ul_path_read_string(dev
->sysfs
, &str
, "queue/read_ahead_kb");
842 str2u64(str
, sortdata
);
845 str
= xstrdup(is_readonly_device(dev
) ? "1" : "0");
848 str
= xstrdup(is_removable_device(dev
, parent
) ? "1" : "0");
851 str
= sysfs_blkdev_is_hotpluggable(dev
->sysfs
) ? xstrdup("1") : xstrdup("0");
854 ul_path_read_string(dev
->sysfs
, &str
, "queue/rotational");
857 ul_path_read_string(dev
->sysfs
, &str
, "queue/add_random");
860 if (!device_is_partition(dev
) && dev
->nslaves
== 0) {
861 prop
= lsblk_device_get_properties(dev
);
862 if (prop
&& prop
->model
)
863 str
= xstrdup(prop
->model
);
865 ul_path_read_string(dev
->sysfs
, &str
, "device/model");
869 if (!device_is_partition(dev
) && dev
->nslaves
== 0) {
870 prop
= lsblk_device_get_properties(dev
);
871 if (prop
&& prop
->serial
)
872 str
= xstrdup(prop
->serial
);
874 ul_path_read_string(dev
->sysfs
, &str
, "device/serial");
878 if (!device_is_partition(dev
) && dev
->nslaves
== 0)
879 ul_path_read_string(dev
->sysfs
, &str
, "device/rev");
882 if (!device_is_partition(dev
) && dev
->nslaves
== 0)
883 ul_path_read_string(dev
->sysfs
, &str
, "device/vendor");
889 xasprintf(&str
, "%ju", dev
->size
);
891 str
= size_to_human_string(SIZE_SUFFIX_1LETTER
, dev
->size
);
893 *sortdata
= dev
->size
;
896 if (!device_is_partition(dev
) && !dev
->dm_name
)
897 ul_path_read_string(dev
->sysfs
, &str
, "device/state");
898 else if (dev
->dm_name
) {
900 if (ul_path_read_s32(dev
->sysfs
, &x
, "dm/suspended") == 0)
901 str
= xstrdup(x
? "suspended" : "running");
905 ul_path_read_string(dev
->sysfs
, &str
, "alignment_offset");
907 str2u64(str
, sortdata
);
910 ul_path_read_string(dev
->sysfs
, &str
, "queue/minimum_io_size");
912 str2u64(str
, sortdata
);
915 ul_path_read_string(dev
->sysfs
, &str
, "queue/optimal_io_size");
917 str2u64(str
, sortdata
);
920 ul_path_read_string(dev
->sysfs
, &str
, "queue/physical_block_size");
922 str2u64(str
, sortdata
);
925 ul_path_read_string(dev
->sysfs
, &str
, "queue/logical_block_size");
927 str2u64(str
, sortdata
);
930 str
= get_scheduler(dev
);
933 ul_path_read_string(dev
->sysfs
, &str
, "queue/nr_requests");
935 str2u64(str
, sortdata
);
943 if (sysfs_blkdev_scsi_get_hctl(dev
->sysfs
, &h
, &c
, &t
, &l
) == 0)
944 xasprintf(&str
, "%d:%d:%d:%d", h
, c
, t
, l
);
948 str
= get_transport(dev
);
951 str
= get_subsystems(dev
);
954 if (device_get_discard_granularity(dev
) > 0)
955 ul_path_read_string(dev
->sysfs
, &str
, "discard_alignment");
959 str2u64(str
, sortdata
);
963 ul_path_read_string(dev
->sysfs
, &str
, "queue/discard_granularity");
965 str2u64(str
, sortdata
);
967 uint64_t x
= device_get_discard_granularity(dev
);
968 str
= size_to_human_string(SIZE_SUFFIX_1LETTER
, x
);
975 ul_path_read_string(dev
->sysfs
, &str
, "queue/discard_max_bytes");
977 str2u64(str
, sortdata
);
980 if (ul_path_read_u64(dev
->sysfs
, &x
, "queue/discard_max_bytes") == 0) {
981 str
= size_to_human_string(SIZE_SUFFIX_1LETTER
, x
);
988 if (device_get_discard_granularity(dev
) > 0)
989 ul_path_read_string(dev
->sysfs
, &str
, "queue/discard_zeroes_data");
995 ul_path_read_string(dev
->sysfs
, &str
, "queue/write_same_max_bytes");
997 str2u64(str
, sortdata
);
1001 if (ul_path_read_u64(dev
->sysfs
, &x
, "queue/write_same_max_bytes") == 0) {
1002 str
= size_to_human_string(SIZE_SUFFIX_1LETTER
, x
);
1011 ul_path_read_string(dev
->sysfs
, &str
, "queue/zoned");
1019 * Adds data for all wanted columns about the device to the smartcols table
1021 static void device_to_scols(
1022 struct lsblk_device
*dev
,
1023 struct lsblk_device
*parent
,
1024 struct libscols_table
*tab
,
1025 struct libscols_line
*parent_line
)
1028 struct libscols_line
*ln
;
1029 struct lsblk_iter itr
;
1030 struct lsblk_device
*child
= NULL
;
1033 ON_DBG(DEV
, if (ul_path_isopen_dirfd(dev
->sysfs
)) ul_debugobj(dev
, "%s ---> is open!", dev
->name
));
1035 /* Do not print device more than one in --list mode */
1036 if (!(lsblk
->flags
& LSBLK_TREE
) && dev
->is_printed
)
1039 if (lsblk
->merge
&& list_count_entries(&dev
->parents
) > 1) {
1040 if (!lsblk_device_is_last_parent(dev
, parent
))
1045 ln
= scols_table_new_line(tab
, link_group
? NULL
: parent_line
);
1047 err(EXIT_FAILURE
, _("failed to allocate output line"));
1049 dev
->is_printed
= 1;
1052 struct lsblk_device
*p
;
1053 struct libscols_line
*gr
= parent_line
;
1055 /* Merge all my parents to the one group */
1056 lsblk_reset_iter(&itr
, LSBLK_ITER_FORWARD
);
1057 while (lsblk_device_next_parent(dev
, &itr
, &p
) == 0) {
1060 scols_table_group_lines(tab
, gr
, p
->scols_line
, 0);
1063 /* Link the group -- this makes group->child connection */
1064 scols_line_link_group(ln
, gr
, 0);
1067 /* read column specific data and set it to smartcols table line */
1068 for (i
= 0; i
< ncolumns
; i
++) {
1070 int id
= get_column_id(i
);
1072 if (lsblk
->sort_id
!= id
)
1073 data
= device_get_data(dev
, parent
, id
, NULL
);
1075 uint64_t sortdata
= (uint64_t) -1;
1077 data
= device_get_data(dev
, parent
, id
, &sortdata
);
1078 if (data
&& sortdata
!= (uint64_t) -1)
1079 set_sortdata_u64(ln
, i
, sortdata
);
1081 if (data
&& scols_line_refer_data(ln
, i
, data
))
1082 err(EXIT_FAILURE
, _("failed to add output data"));
1085 dev
->scols_line
= ln
;
1087 if (dev
->npartitions
== 0)
1088 /* For partitions we often read from parental whole-disk sysfs,
1089 * otherwise we can close */
1090 ul_path_close_dirfd(dev
->sysfs
);
1093 lsblk_reset_iter(&itr
, LSBLK_ITER_FORWARD
);
1094 while (lsblk_device_next_child(dev
, &itr
, &child
) == 0)
1095 device_to_scols(child
, dev
, tab
, ln
);
1097 /* Let's be careful with number of open files */
1098 ul_path_close_dirfd(dev
->sysfs
);
1102 * Walks on tree and adds one line for each device to the smartcols table
1104 static void devtree_to_scols(struct lsblk_devtree
*tr
, struct libscols_table
*tab
)
1106 struct lsblk_iter itr
;
1107 struct lsblk_device
*dev
= NULL
;
1109 lsblk_reset_iter(&itr
, LSBLK_ITER_FORWARD
);
1111 while (lsblk_devtree_next_root(tr
, &itr
, &dev
) == 0)
1112 device_to_scols(dev
, NULL
, tab
, NULL
);
1116 * Reads very basic information about the device from sysfs into the device struct
1118 static int initialize_device(struct lsblk_device
*dev
,
1119 struct lsblk_device
*wholedisk
,
1124 DBG(DEV
, ul_debugobj(dev
, "initialize %s [wholedisk=%p %s]",
1125 name
, wholedisk
, wholedisk
? wholedisk
->name
: ""));
1127 dev
->name
= xstrdup(name
);
1130 dev
->wholedisk
= wholedisk
;
1131 lsblk_ref_device(wholedisk
);
1134 dev
->filename
= get_device_path(dev
);
1135 if (!dev
->filename
) {
1136 DBG(DEV
, ul_debugobj(dev
, "%s: failed to get device path", dev
->name
));
1139 DBG(DEV
, ul_debugobj(dev
, "%s: filename=%s", dev
->name
, dev
->filename
));
1141 devno
= __sysfs_devname_to_devno(lsblk
->sysroot
, dev
->name
, wholedisk
? wholedisk
->name
: NULL
);
1143 DBG(DEV
, ul_debugobj(dev
, "%s: unknown device name", dev
->name
));
1147 dev
->sysfs
= ul_new_sysfs_path(devno
, wholedisk
? wholedisk
->sysfs
: NULL
, lsblk
->sysroot
);
1149 DBG(DEV
, ul_debugobj(dev
, "%s: failed to initialize sysfs handler", dev
->name
));
1153 dev
->maj
= major(devno
);
1154 dev
->min
= minor(devno
);
1157 if (ul_path_read_u64(dev
->sysfs
, &dev
->size
, "size") == 0) /* in sectors */
1158 dev
->size
<<= 9; /* in bytes */
1160 /* Ignore devices of zero size */
1161 if (!lsblk
->all_devices
&& dev
->size
== 0) {
1162 DBG(DEV
, ul_debugobj(dev
, "zero size device -- ignore"));
1165 if (is_dm(dev
->name
)) {
1166 ul_path_read_string(dev
->sysfs
, &dev
->dm_name
, "dm/name");
1167 if (!dev
->dm_name
) {
1168 DBG(DEV
, ul_debugobj(dev
, "%s: failed to get dm name", dev
->name
));
1173 dev
->npartitions
= sysfs_blkdev_count_partitions(dev
->sysfs
, dev
->name
);
1174 dev
->nholders
= ul_path_count_dirents(dev
->sysfs
, "holders");
1175 dev
->nslaves
= ul_path_count_dirents(dev
->sysfs
, "slaves");
1177 DBG(DEV
, ul_debugobj(dev
, "%s: npartitions=%d, nholders=%d, nslaves=%d",
1178 dev
->name
, dev
->npartitions
, dev
->nholders
, dev
->nslaves
));
1180 /* ignore non-SCSI devices */
1181 if (lsblk
->scsi
&& sysfs_blkdev_scsi_get_hctl(dev
->sysfs
, NULL
, NULL
, NULL
, NULL
)) {
1182 DBG(DEV
, ul_debugobj(dev
, "non-scsi device -- ignore"));
1186 DBG(DEV
, ul_debugobj(dev
, "%s: context successfully initialized", dev
->name
));
1190 static struct lsblk_device
*devtree_get_device_or_new(struct lsblk_devtree
*tr
,
1191 struct lsblk_device
*disk
,
1194 struct lsblk_device
*dev
= lsblk_devtree_get_device(tr
, name
);
1197 dev
= lsblk_new_device();
1199 err(EXIT_FAILURE
, _("failed to allocate device"));
1201 if (initialize_device(dev
, disk
, name
) != 0) {
1202 lsblk_unref_device(dev
);
1205 lsblk_devtree_add_device(tr
, dev
);
1206 lsblk_unref_device(dev
); /* keep it referenced by devtree only */
1208 DBG(DEV
, ul_debugobj(dev
, "%s: already processed", name
));
1213 static int process_dependencies(
1214 struct lsblk_devtree
*tr
,
1215 struct lsblk_device
*dev
,
1219 * Read devices from whole-disk device into tree
1221 static int process_partitions(struct lsblk_devtree
*tr
, struct lsblk_device
*disk
)
1229 * Do not process further if there are no partitions for
1230 * this device or the device itself is a partition.
1232 if (!disk
->npartitions
|| device_is_partition(disk
))
1235 DBG(DEV
, ul_debugobj(disk
, "%s: probe whole-disk for partitions", disk
->name
));
1237 dir
= ul_path_opendir(disk
->sysfs
, NULL
);
1239 err(EXIT_FAILURE
, _("failed to open device directory in sysfs"));
1241 while ((d
= xreaddir(dir
))) {
1242 struct lsblk_device
*part
;
1244 if (!(sysfs_blkdev_is_partition_dirent(dir
, d
, disk
->name
)))
1247 DBG(DEV
, ul_debugobj(disk
, " checking %s", d
->d_name
));
1249 part
= devtree_get_device_or_new(tr
, disk
, d
->d_name
);
1253 if (lsblk_device_new_dependence(disk
, part
) == 0)
1254 process_dependencies(tr
, part
, 0);
1256 ul_path_close_dirfd(part
->sysfs
);
1259 /* For partitions we need parental (whole-disk) sysfs directory pretty
1260 * often, so close it now when all is done */
1261 ul_path_close_dirfd(disk
->sysfs
);
1263 DBG(DEV
, ul_debugobj(disk
, "probe whole-disk for partitions -- done"));
1268 static char *get_wholedisk_from_partition_dirent(DIR *dir
, struct dirent
*d
, char *buf
, size_t bufsz
)
1273 if ((len
= readlinkat(dirfd(dir
), d
->d_name
, buf
, bufsz
- 1)) < 0)
1278 /* The path ends with ".../<device>/<partition>" */
1279 p
= strrchr(buf
, '/');
1284 p
= strrchr(buf
, '/');
1293 * Reads slaves/holders and partitions for specified device into device tree
1295 static int process_dependencies(
1296 struct lsblk_devtree
*tr
,
1297 struct lsblk_device
*dev
,
1302 const char *depname
;
1309 /* read all or specified partition */
1310 if (do_partitions
&& dev
->npartitions
)
1311 process_partitions(tr
, dev
);
1313 DBG(DEV
, ul_debugobj(dev
, "%s: reading dependencies", dev
->name
));
1315 if (!(lsblk
->inverse
? dev
->nslaves
: dev
->nholders
)) {
1316 DBG(DEV
, ul_debugobj(dev
, " ignore (no slaves/holders)"));
1320 depname
= lsblk
->inverse
? "slaves" : "holders";
1321 dir
= ul_path_opendir(dev
->sysfs
, depname
);
1323 DBG(DEV
, ul_debugobj(dev
, " ignore (no slaves/holders directory)"));
1326 ul_path_close_dirfd(dev
->sysfs
);
1328 DBG(DEV
, ul_debugobj(dev
, " %s: checking for '%s' dependence", dev
->name
, depname
));
1330 while ((d
= xreaddir(dir
))) {
1331 struct lsblk_device
*dep
= NULL
;
1332 struct lsblk_device
*disk
= NULL
;
1334 /* Is the dependency a partition? */
1335 if (sysfs_blkdev_is_partition_dirent(dir
, d
, NULL
)) {
1340 DBG(DEV
, ul_debugobj(dev
, " %s: dependence is partition", d
->d_name
));
1342 diskname
= get_wholedisk_from_partition_dirent(dir
, d
, buf
, sizeof(buf
));
1344 disk
= devtree_get_device_or_new(tr
, NULL
, diskname
);
1346 DBG(DEV
, ul_debugobj(dev
, " ignore no wholedisk ???"));
1350 dep
= devtree_get_device_or_new(tr
, disk
, d
->d_name
);
1354 if (lsblk_device_new_dependence(dev
, dep
) == 0)
1355 process_dependencies(tr
, dep
, 1);
1358 && lsblk_device_new_dependence(dep
, disk
) == 0)
1359 process_dependencies(tr
, disk
, 0);
1361 /* The dependency is a whole device. */
1363 DBG(DEV
, ul_debugobj(dev
, " %s: %s: dependence is whole-disk",
1364 dev
->name
, d
->d_name
));
1366 dep
= devtree_get_device_or_new(tr
, NULL
, d
->d_name
);
1370 if (lsblk_device_new_dependence(dev
, dep
) == 0)
1371 /* For inverse tree we don't want to show partitions
1372 * if the dependence is on whole-disk */
1373 process_dependencies(tr
, dep
, lsblk
->inverse
? 0 : 1);
1376 if (dep
&& dep
->sysfs
)
1377 ul_path_close_dirfd(dep
->sysfs
);
1378 if (disk
&& disk
->sysfs
)
1379 ul_path_close_dirfd(disk
->sysfs
);
1383 DBG(DEV
, ul_debugobj(dev
, "%s: checking for '%s' -- done", dev
->name
, depname
));
1388 * Defines the device as root node in the device tree and walks on all dependencies of the device.
1390 static int __process_one_device(struct lsblk_devtree
*tr
, char *devname
, dev_t devno
)
1392 struct lsblk_device
*dev
= NULL
;
1393 struct lsblk_device
*disk
= NULL
;
1394 char buf
[PATH_MAX
+ 1], *name
= NULL
, *diskname
= NULL
;
1395 int real_part
= 0, rc
= -EINVAL
;
1400 DBG(DEV
, ul_debug("%s: reading alone device", devname
));
1402 if (stat(devname
, &st
) || !S_ISBLK(st
.st_mode
)) {
1403 warnx(_("%s: not a block device"), devname
);
1408 DBG(DEV
, ul_debug("%d:%d: reading alone device", major(devno
), minor(devno
)));
1410 /* TODO: sysfs_devno_to_devname() internally initializes path_cxt, it
1411 * would be better to use ul_new_sysfs_path() + sysfs_blkdev_get_name()
1412 * and reuse path_cxt for initialize_device()
1414 name
= sysfs_devno_to_devname(devno
, buf
, sizeof(buf
));
1417 warn(_("%s: failed to get sysfs name"), devname
);
1420 name
= xstrdup(name
);
1422 if (!strncmp(name
, "dm-", 3)) {
1423 /* dm mapping is never a real partition! */
1428 if (blkid_devno_to_wholedisk(devno
, buf
, sizeof(buf
), &diskno
)) {
1429 warn(_("%s: failed to get whole-disk device number"), name
);
1433 real_part
= devno
!= diskno
;
1438 * Device is not a partition.
1440 DBG(DEV
, ul_debug(" non-partition"));
1442 dev
= devtree_get_device_or_new(tr
, NULL
, name
);
1446 lsblk_devtree_add_root(tr
, dev
);
1447 process_dependencies(tr
, dev
, !lsblk
->inverse
);
1450 * Partition, read sysfs name of the disk device
1452 DBG(DEV
, ul_debug(" partition"));
1454 disk
= devtree_get_device_or_new(tr
, NULL
, diskname
);
1458 dev
= devtree_get_device_or_new(tr
, disk
, name
);
1462 lsblk_devtree_add_root(tr
, dev
);
1463 process_dependencies(tr
, dev
, 1);
1466 && lsblk_device_new_dependence(dev
, disk
) == 0)
1467 process_dependencies(tr
, disk
, 0);
1469 ul_path_close_dirfd(disk
->sysfs
);
1474 if (dev
&& dev
->sysfs
)
1475 ul_path_close_dirfd(dev
->sysfs
);
1476 if (disk
&& disk
->sysfs
)
1477 ul_path_close_dirfd(disk
->sysfs
);
1482 static int process_one_device(struct lsblk_devtree
*tr
, char *devname
)
1484 return __process_one_device(tr
, devname
, 0);
1488 * The /sys/block contains only root devices, and no partitions. It seems more
1489 * simple to scan /sys/dev/block where are all devices without exceptions to get
1490 * top-level devices for the reverse tree.
1492 static int process_all_devices_inverse(struct lsblk_devtree
*tr
)
1496 struct path_cxt
*pc
= ul_new_path(_PATH_SYS_DEVBLOCK
);
1498 assert(lsblk
->inverse
);
1501 err(EXIT_FAILURE
, _("failed to allocate /sys handler"));
1503 ul_path_set_prefix(pc
, lsblk
->sysroot
);
1504 dir
= ul_path_opendir(pc
, NULL
);
1508 DBG(DEV
, ul_debug("iterate on " _PATH_SYS_DEVBLOCK
));
1510 while ((d
= xreaddir(dir
))) {
1514 DBG(DEV
, ul_debug(" %s dentry", d
->d_name
));
1516 if (sscanf(d
->d_name
, "%d:%d", &maj
, &min
) != 2)
1518 devno
= makedev(maj
, min
);
1520 if (is_maj_excluded(maj
) || !is_maj_included(maj
))
1522 if (ul_path_countf_dirents(pc
, "%s/holders", d
->d_name
) != 0)
1524 if (sysfs_devno_count_partitions(devno
) != 0)
1526 __process_one_device(tr
, NULL
, devno
);
1532 DBG(DEV
, ul_debug("iterate on " _PATH_SYS_DEVBLOCK
" -- done"));
1537 * Reads root nodes (devices) from /sys/block into devices tree
1539 static int process_all_devices(struct lsblk_devtree
*tr
)
1543 struct path_cxt
*pc
;
1545 assert(lsblk
->inverse
== 0);
1547 pc
= ul_new_path(_PATH_SYS_BLOCK
);
1549 err(EXIT_FAILURE
, _("failed to allocate /sys handler"));
1551 ul_path_set_prefix(pc
, lsblk
->sysroot
);
1552 dir
= ul_path_opendir(pc
, NULL
);
1556 DBG(DEV
, ul_debug("iterate on " _PATH_SYS_BLOCK
));
1558 while ((d
= xreaddir(dir
))) {
1559 struct lsblk_device
*dev
= NULL
;
1561 DBG(DEV
, ul_debug(" %s dentry", d
->d_name
));
1562 dev
= devtree_get_device_or_new(tr
, NULL
, d
->d_name
);
1566 /* remove unwanted devices */
1567 if (is_maj_excluded(dev
->maj
) || !is_maj_included(dev
->maj
)) {
1568 DBG(DEV
, ul_debug(" %s: ignore (by filter)", d
->d_name
));
1569 lsblk_devtree_remove_device(tr
, dev
);
1574 DBG(DEV
, ul_debug(" %s: ignore (in-middle)", d
->d_name
));
1578 lsblk_devtree_add_root(tr
, dev
);
1579 process_dependencies(tr
, dev
, 1);
1581 /* Let's be careful with number of open files */
1582 if (dev
&& dev
->sysfs
)
1583 ul_path_close_dirfd(dev
->sysfs
);
1589 DBG(DEV
, ul_debug("iterate on " _PATH_SYS_BLOCK
" -- done"));
1594 * Parses major numbers as specified on lsblk command line
1596 static void parse_excludes(const char *str0
)
1598 const char *str
= str0
;
1600 while (str
&& *str
) {
1605 n
= strtoul(str
, &end
, 10);
1607 if (end
== str
|| (end
&& *end
&& *end
!= ','))
1608 errx(EXIT_FAILURE
, _("failed to parse list '%s'"), str0
);
1609 if (errno
!= 0 && (n
== ULONG_MAX
|| n
== 0))
1610 err(EXIT_FAILURE
, _("failed to parse list '%s'"), str0
);
1611 excludes
[nexcludes
++] = n
;
1613 if (nexcludes
== ARRAY_SIZE(excludes
))
1614 /* TRANSLATORS: The standard value for %d is 256. */
1615 errx(EXIT_FAILURE
, _("the list of excluded devices is "
1616 "too large (limit is %d devices)"),
1617 (int)ARRAY_SIZE(excludes
));
1619 str
= end
&& *end
? end
+ 1 : NULL
;
1624 * Parses major numbers as specified on lsblk command line
1625 * (TODO: what about refactor and merge parse_excludes() and parse_includes().)
1627 static void parse_includes(const char *str0
)
1629 const char *str
= str0
;
1631 while (str
&& *str
) {
1636 n
= strtoul(str
, &end
, 10);
1638 if (end
== str
|| (end
&& *end
&& *end
!= ','))
1639 errx(EXIT_FAILURE
, _("failed to parse list '%s'"), str0
);
1640 if (errno
!= 0 && (n
== ULONG_MAX
|| n
== 0))
1641 err(EXIT_FAILURE
, _("failed to parse list '%s'"), str0
);
1642 includes
[nincludes
++] = n
;
1644 if (nincludes
== ARRAY_SIZE(includes
))
1645 /* TRANSLATORS: The standard value for %d is 256. */
1646 errx(EXIT_FAILURE
, _("the list of included devices is "
1647 "too large (limit is %d devices)"),
1648 (int)ARRAY_SIZE(includes
));
1649 str
= end
&& *end
? end
+ 1 : NULL
;
1654 * see set_sortdata_u64() and columns initialization in main()
1656 static int cmp_u64_cells(struct libscols_cell
*a
,
1657 struct libscols_cell
*b
,
1658 __attribute__((__unused__
)) void *data
)
1660 uint64_t *adata
= (uint64_t *) scols_cell_get_userdata(a
),
1661 *bdata
= (uint64_t *) scols_cell_get_userdata(b
);
1663 if (adata
== NULL
&& bdata
== NULL
)
1669 return *adata
== *bdata
? 0 : *adata
>= *bdata
? 1 : -1;
1672 static void device_set_dedupkey(
1673 struct lsblk_device
*dev
,
1674 struct lsblk_device
*parent
,
1677 struct lsblk_iter itr
;
1678 struct lsblk_device
*child
= NULL
;
1680 dev
->dedupkey
= device_get_data(dev
, parent
, id
, NULL
);
1682 DBG(DEV
, ul_debugobj(dev
, "%s: de-duplication key: %s", dev
->name
, dev
->dedupkey
));
1684 if (dev
->npartitions
== 0)
1685 /* For partitions we often read from parental whole-disk sysfs,
1686 * otherwise we can close */
1687 ul_path_close_dirfd(dev
->sysfs
);
1689 lsblk_reset_iter(&itr
, LSBLK_ITER_FORWARD
);
1691 while (lsblk_device_next_child(dev
, &itr
, &child
) == 0)
1692 device_set_dedupkey(child
, dev
, id
);
1694 /* Let's be careful with number of open files */
1695 ul_path_close_dirfd(dev
->sysfs
);
1698 static void devtree_set_dedupkeys(struct lsblk_devtree
*tr
, int id
)
1700 struct lsblk_iter itr
;
1701 struct lsblk_device
*dev
= NULL
;
1703 lsblk_reset_iter(&itr
, LSBLK_ITER_FORWARD
);
1705 while (lsblk_devtree_next_root(tr
, &itr
, &dev
) == 0)
1706 device_set_dedupkey(dev
, NULL
, id
);
1709 static void __attribute__((__noreturn__
)) usage(void)
1714 fputs(USAGE_HEADER
, out
);
1715 fprintf(out
, _(" %s [options] [<device> ...]\n"), program_invocation_short_name
);
1717 fputs(USAGE_SEPARATOR
, out
);
1718 fputs(_("List information about block devices.\n"), out
);
1720 fputs(USAGE_OPTIONS
, out
);
1721 fputs(_(" -D, --discard print discard capabilities\n"), out
);
1722 fputs(_(" -E, --dedup <column> de-duplicate output by <column>\n"), out
);
1723 fputs(_(" -I, --include <list> show only devices with specified major numbers\n"), out
);
1724 fputs(_(" -J, --json use JSON output format\n"), out
);
1725 fputs(_(" -O, --output-all output all columns\n"), out
);
1726 fputs(_(" -P, --pairs use key=\"value\" output format\n"), out
);
1727 fputs(_(" -S, --scsi output info about SCSI devices\n"), out
);
1728 fputs(_(" -T, --tree[=<column>] use tree format output\n"), out
);
1729 fputs(_(" -a, --all print all devices\n"), out
);
1730 fputs(_(" -b, --bytes print SIZE in bytes rather than in human readable format\n"), out
);
1731 fputs(_(" -d, --nodeps don't print slaves or holders\n"), out
);
1732 fputs(_(" -e, --exclude <list> exclude devices by major number (default: RAM disks)\n"), out
);
1733 fputs(_(" -f, --fs output info about filesystems\n"), out
);
1734 fputs(_(" -i, --ascii use ascii characters only\n"), out
);
1735 fputs(_(" -l, --list use list format output\n"), out
);
1736 fputs(_(" -M, --merge group parents of sub-trees (usable for RAIDs, Multi-path)\n"), out
);
1737 fputs(_(" -m, --perms output info about permissions\n"), out
);
1738 fputs(_(" -n, --noheadings don't print headings\n"), out
);
1739 fputs(_(" -o, --output <list> output columns\n"), out
);
1740 fputs(_(" -p, --paths print complete device path\n"), out
);
1741 fputs(_(" -r, --raw use raw output format\n"), out
);
1742 fputs(_(" -s, --inverse inverse dependencies\n"), out
);
1743 fputs(_(" -t, --topology output info about topology\n"), out
);
1744 fputs(_(" -z, --zoned print zone model\n"), out
);
1745 fputs(_(" -x, --sort <column> sort output by <column>\n"), out
);
1746 fputs(_(" --sysroot <dir> use specified directory as system root\n"), out
);
1747 fputs(USAGE_SEPARATOR
, out
);
1748 printf(USAGE_HELP_OPTIONS(22));
1750 fprintf(out
, USAGE_COLUMNS
);
1752 for (i
= 0; i
< ARRAY_SIZE(infos
); i
++)
1753 fprintf(out
, " %11s %s\n", infos
[i
].name
, _(infos
[i
].help
));
1755 printf(USAGE_MAN_TAIL("lsblk(8)"));
1760 static void check_sysdevblock(void)
1762 if (access(_PATH_SYS_DEVBLOCK
, R_OK
) != 0)
1763 err(EXIT_FAILURE
, _("failed to access sysfs directory: %s"),
1764 _PATH_SYS_DEVBLOCK
);
1767 int main(int argc
, char *argv
[])
1769 struct lsblk _ls
= {
1772 .flags
= LSBLK_TREE
,
1775 struct lsblk_devtree
*tr
= NULL
;
1776 int c
, status
= EXIT_FAILURE
;
1777 char *outarg
= NULL
;
1779 int force_tree
= 0, has_tree_col
= 0;
1782 OPT_SYSROOT
= CHAR_MAX
+ 1
1785 static const struct option longopts
[] = {
1786 { "all", no_argument
, NULL
, 'a' },
1787 { "bytes", no_argument
, NULL
, 'b' },
1788 { "nodeps", no_argument
, NULL
, 'd' },
1789 { "discard", no_argument
, NULL
, 'D' },
1790 { "dedup", required_argument
, NULL
, 'E' },
1791 { "zoned", no_argument
, NULL
, 'z' },
1792 { "help", no_argument
, NULL
, 'h' },
1793 { "json", no_argument
, NULL
, 'J' },
1794 { "output", required_argument
, NULL
, 'o' },
1795 { "output-all", no_argument
, NULL
, 'O' },
1796 { "merge", no_argument
, NULL
, 'M' },
1797 { "perms", no_argument
, NULL
, 'm' },
1798 { "noheadings", no_argument
, NULL
, 'n' },
1799 { "list", no_argument
, NULL
, 'l' },
1800 { "ascii", no_argument
, NULL
, 'i' },
1801 { "raw", no_argument
, NULL
, 'r' },
1802 { "inverse", no_argument
, NULL
, 's' },
1803 { "fs", no_argument
, NULL
, 'f' },
1804 { "exclude", required_argument
, NULL
, 'e' },
1805 { "include", required_argument
, NULL
, 'I' },
1806 { "topology", no_argument
, NULL
, 't' },
1807 { "paths", no_argument
, NULL
, 'p' },
1808 { "pairs", no_argument
, NULL
, 'P' },
1809 { "scsi", no_argument
, NULL
, 'S' },
1810 { "sort", required_argument
, NULL
, 'x' },
1811 { "sysroot", required_argument
, NULL
, OPT_SYSROOT
},
1812 { "tree", optional_argument
, NULL
, 'T' },
1813 { "version", no_argument
, NULL
, 'V' },
1814 { NULL
, 0, NULL
, 0 },
1817 static const ul_excl_t excl
[] = { /* rows and cols in ASCII order */
1825 { 'P','T', 'l','r' },
1828 int excl_st
[ARRAY_SIZE(excl
)] = UL_EXCL_STATUS_INIT
;
1830 setlocale(LC_ALL
, "");
1831 bindtextdomain(PACKAGE
, LOCALEDIR
);
1832 textdomain(PACKAGE
);
1833 atexit(close_stdout
);
1839 while((c
= getopt_long(argc
, argv
,
1840 "abdDzE:e:fhJlnMmo:OpPiI:rstVST:x:", longopts
, NULL
)) != -1) {
1842 err_exclusive_options(c
, longopts
, excl
, excl_st
);
1846 lsblk
->all_devices
= 1;
1855 add_uniq_column(COL_NAME
);
1856 add_uniq_column(COL_DALIGN
);
1857 add_uniq_column(COL_DGRAN
);
1858 add_uniq_column(COL_DMAX
);
1859 add_uniq_column(COL_DZERO
);
1862 add_uniq_column(COL_NAME
);
1863 add_uniq_column(COL_ZONED
);
1866 parse_excludes(optarg
);
1872 lsblk
->flags
|= LSBLK_JSON
;
1875 lsblk
->flags
&= ~LSBLK_TREE
; /* disable the default */
1881 lsblk
->flags
|= LSBLK_NOHEADINGS
;
1887 for (ncolumns
= 0 ; ncolumns
< ARRAY_SIZE(infos
); ncolumns
++)
1888 columns
[ncolumns
] = ncolumns
;
1894 lsblk
->flags
|= LSBLK_EXPORT
;
1895 lsblk
->flags
&= ~LSBLK_TREE
; /* disable the default */
1898 lsblk
->flags
|= LSBLK_ASCII
;
1901 parse_includes(optarg
);
1904 lsblk
->flags
&= ~LSBLK_TREE
; /* disable the default */
1905 lsblk
->flags
|= LSBLK_RAW
; /* enable raw */
1911 add_uniq_column(COL_NAME
);
1912 add_uniq_column(COL_FSTYPE
);
1913 add_uniq_column(COL_LABEL
);
1914 add_uniq_column(COL_UUID
);
1915 add_uniq_column(COL_FSAVAIL
);
1916 add_uniq_column(COL_FSUSEPERC
);
1917 add_uniq_column(COL_TARGET
);
1920 add_uniq_column(COL_NAME
);
1921 add_uniq_column(COL_SIZE
);
1922 add_uniq_column(COL_OWNER
);
1923 add_uniq_column(COL_GROUP
);
1924 add_uniq_column(COL_MODE
);
1927 add_uniq_column(COL_NAME
);
1928 add_uniq_column(COL_ALIOFF
);
1929 add_uniq_column(COL_MINIO
);
1930 add_uniq_column(COL_OPTIO
);
1931 add_uniq_column(COL_PHYSEC
);
1932 add_uniq_column(COL_LOGSEC
);
1933 add_uniq_column(COL_ROTA
);
1934 add_uniq_column(COL_SCHED
);
1935 add_uniq_column(COL_RQ_SIZE
);
1936 add_uniq_column(COL_RA
);
1937 add_uniq_column(COL_WSAME
);
1942 add_uniq_column(COL_NAME
);
1943 add_uniq_column(COL_HCTL
);
1944 add_uniq_column(COL_TYPE
);
1945 add_uniq_column(COL_VENDOR
);
1946 add_uniq_column(COL_MODEL
);
1947 add_uniq_column(COL_REV
);
1948 add_uniq_column(COL_TRANSPORT
);
1953 lsblk
->tree_id
= column_name_to_id(optarg
, strlen(optarg
));
1956 lsblk
->sysroot
= optarg
;
1959 printf(UTIL_LINUX_VERSION
);
1960 return EXIT_SUCCESS
;
1962 lsblk
->dedup_id
= column_name_to_id(optarg
, strlen(optarg
));
1963 if (lsblk
->dedup_id
>= 0)
1965 errtryhelp(EXIT_FAILURE
);
1968 lsblk
->flags
&= ~LSBLK_TREE
; /* disable the default */
1969 lsblk
->sort_id
= column_name_to_id(optarg
, strlen(optarg
));
1970 if (lsblk
->sort_id
>= 0)
1974 errtryhelp(EXIT_FAILURE
);
1979 lsblk
->flags
|= LSBLK_TREE
;
1981 check_sysdevblock();
1984 add_column(COL_NAME
);
1985 add_column(COL_MAJMIN
);
1987 add_column(COL_SIZE
);
1989 add_column(COL_TYPE
);
1990 add_column(COL_TARGET
);
1993 if (outarg
&& string_add_to_idarray(outarg
, columns
, ARRAY_SIZE(columns
),
1994 &ncolumns
, column_name_to_id
) < 0)
1995 return EXIT_FAILURE
;
1997 if (lsblk
->all_devices
== 0 && nexcludes
== 0 && nincludes
== 0)
1998 excludes
[nexcludes
++] = 1; /* default: ignore RAM disks */
2000 if (lsblk
->sort_id
< 0)
2001 /* Since Linux 4.8 we have sort devices by default, because
2002 * /sys is no more sorted */
2003 lsblk
->sort_id
= COL_MAJMIN
;
2005 /* For --inverse --list we still follow parent->child relation */
2006 if (lsblk
->inverse
&& !(lsblk
->flags
& LSBLK_TREE
))
2007 lsblk
->force_tree_order
= 1;
2009 if (lsblk
->sort_id
>= 0 && column_id_to_number(lsblk
->sort_id
) < 0) {
2010 /* the sort column is not between output columns -- add as hidden */
2011 add_column(lsblk
->sort_id
);
2012 lsblk
->sort_hidden
= 1;
2015 if (lsblk
->dedup_id
>= 0 && column_id_to_number(lsblk
->dedup_id
) < 0) {
2016 /* the deduplication column is not between output columns -- add as hidden */
2017 add_column(lsblk
->dedup_id
);
2018 lsblk
->dedup_hidden
= 1;
2022 scols_init_debug(0);
2023 ul_path_init_debug();
2026 * initialize output columns
2028 if (!(lsblk
->table
= scols_new_table()))
2029 errx(EXIT_FAILURE
, _("failed to allocate output table"));
2030 scols_table_enable_raw(lsblk
->table
, !!(lsblk
->flags
& LSBLK_RAW
));
2031 scols_table_enable_export(lsblk
->table
, !!(lsblk
->flags
& LSBLK_EXPORT
));
2032 scols_table_enable_ascii(lsblk
->table
, !!(lsblk
->flags
& LSBLK_ASCII
));
2033 scols_table_enable_json(lsblk
->table
, !!(lsblk
->flags
& LSBLK_JSON
));
2034 scols_table_enable_noheadings(lsblk
->table
, !!(lsblk
->flags
& LSBLK_NOHEADINGS
));
2036 if (lsblk
->flags
& LSBLK_JSON
)
2037 scols_table_set_name(lsblk
->table
, "blockdevices");
2039 for (i
= 0; i
< ncolumns
; i
++) {
2040 struct colinfo
*ci
= get_column_info(i
);
2041 struct libscols_column
*cl
;
2042 int id
= get_column_id(i
), fl
= ci
->flags
;
2044 if ((lsblk
->flags
& LSBLK_TREE
)
2045 && has_tree_col
== 0
2046 && id
== lsblk
->tree_id
) {
2047 fl
|= SCOLS_FL_TREE
;
2048 fl
&= ~SCOLS_FL_RIGHT
;
2052 if (lsblk
->sort_hidden
&& lsblk
->sort_id
== id
)
2053 fl
|= SCOLS_FL_HIDDEN
;
2054 if (lsblk
->dedup_hidden
&& lsblk
->dedup_id
== id
)
2055 fl
|= SCOLS_FL_HIDDEN
;
2057 cl
= scols_table_new_column(lsblk
->table
, ci
->name
, ci
->whint
, fl
);
2059 warn(_("failed to allocate output column"));
2062 if (!lsblk
->sort_col
&& lsblk
->sort_id
== id
) {
2063 lsblk
->sort_col
= cl
;
2064 scols_column_set_cmpfunc(cl
,
2065 ci
->type
== COLTYPE_NUM
? cmp_u64_cells
:
2066 ci
->type
== COLTYPE_SIZE
? cmp_u64_cells
:
2067 ci
->type
== COLTYPE_SORTNUM
? cmp_u64_cells
: scols_cmpstr_cells
,
2070 if (lsblk
->flags
& LSBLK_JSON
) {
2077 scols_column_set_json_type(cl
, SCOLS_JSON_NUMBER
);
2080 scols_column_set_json_type(cl
, SCOLS_JSON_BOOLEAN
);
2083 scols_column_set_json_type(cl
, SCOLS_JSON_STRING
);
2089 tr
= lsblk_new_devtree();
2091 err(EXIT_FAILURE
, _("failed to allocate device tree"));
2093 if (optind
== argc
) {
2094 int rc
= lsblk
->inverse
?
2095 process_all_devices_inverse(tr
) :
2096 process_all_devices(tr
);
2098 status
= rc
== 0 ? EXIT_SUCCESS
: EXIT_FAILURE
;
2100 int cnt
= 0, cnt_err
= 0;
2102 while (optind
< argc
) {
2103 if (process_one_device(tr
, argv
[optind
++]) != 0)
2107 status
= cnt
== 0 ? EXIT_FAILURE
: /* nothing */
2108 cnt
== cnt_err
? LSBLK_EXIT_ALLFAILED
:/* all failed */
2109 cnt_err
? LSBLK_EXIT_SOMEOK
: /* some ok */
2110 EXIT_SUCCESS
; /* all success */
2113 if (lsblk
->dedup_id
> -1) {
2114 devtree_set_dedupkeys(tr
, lsblk
->dedup_id
);
2115 lsblk_devtree_deduplicate_devices(tr
);
2118 devtree_to_scols(tr
, lsblk
->table
);
2120 if (lsblk
->sort_col
)
2121 scols_sort_table(lsblk
->table
, lsblk
->sort_col
);
2122 if (lsblk
->force_tree_order
)
2123 scols_sort_table_by_tree(lsblk
->table
);
2125 scols_print_table(lsblk
->table
);
2128 if (lsblk
->sort_col
)
2129 unref_sortdata(lsblk
->table
);
2131 scols_unref_table(lsblk
->table
);
2134 lsblk_properties_deinit();
2135 lsblk_unref_devtree(tr
);