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"
52 #include "fileutils.h"
56 UL_DEBUG_DEFINE_MASK(lsblk
);
57 UL_DEBUG_DEFINE_MASKNAMES(lsblk
) = UL_DEBUG_EMPTY_MASKNAMES
;
59 #define LSBLK_EXIT_SOMEOK 64
60 #define LSBLK_EXIT_ALLFAILED 32
62 static int column_id_to_number(int id
);
120 /* basic table settings */
122 LSBLK_ASCII
= (1 << 0),
123 LSBLK_RAW
= (1 << 1),
124 LSBLK_NOHEADINGS
= (1 << 2),
125 LSBLK_EXPORT
= (1 << 3),
126 LSBLK_TREE
= (1 << 4),
127 LSBLK_JSON
= (1 << 5),
130 /* Types used for qsort() and JSON */
132 COLTYPE_STR
= 0, /* default */
133 COLTYPE_NUM
= 1, /* always u64 number */
134 COLTYPE_SORTNUM
= 2, /* string on output, u64 for qsort() */
135 COLTYPE_SIZE
= 3, /* srring by default, number when --bytes */
136 COLTYPE_BOOL
= 4 /* 0 or 1 */
141 const char *name
; /* header */
142 double whint
; /* width hint (N < 1 is in percent of termwidth) */
143 int flags
; /* SCOLS_FL_* */
145 int type
; /* COLTYPE_* */
148 /* columns descriptions */
149 static struct colinfo infos
[] = {
150 [COL_NAME
] = { "NAME", 0.25, SCOLS_FL_NOEXTREMES
, N_("device name") },
151 [COL_KNAME
] = { "KNAME", 0.3, 0, N_("internal kernel device name") },
152 [COL_PKNAME
] = { "PKNAME", 0.3, 0, N_("internal parent kernel device name") },
153 [COL_PATH
] = { "PATH", 0.3, 0, N_("path to the device node") },
154 [COL_MAJMIN
] = { "MAJ:MIN", 6, 0, N_("major:minor device number"), COLTYPE_SORTNUM
},
156 [COL_FSAVAIL
] = { "FSAVAIL", 5, SCOLS_FL_RIGHT
, N_("filesystem size available") },
157 [COL_FSSIZE
] = { "FSSIZE", 5, SCOLS_FL_RIGHT
, N_("filesystem size") },
158 [COL_FSTYPE
] = { "FSTYPE", 0.1, SCOLS_FL_TRUNC
, N_("filesystem type") },
159 [COL_FSUSED
] = { "FSUSED", 5, SCOLS_FL_RIGHT
, N_("filesystem size used") },
160 [COL_FSUSEPERC
] = { "FSUSE%", 3, SCOLS_FL_RIGHT
, N_("filesystem use percentage") },
162 [COL_TARGET
] = { "MOUNTPOINT", 0.10, SCOLS_FL_TRUNC
, N_("where the device is mounted") },
163 [COL_LABEL
] = { "LABEL", 0.1, 0, N_("filesystem LABEL") },
164 [COL_UUID
] = { "UUID", 36, 0, N_("filesystem UUID") },
166 [COL_PTUUID
] = { "PTUUID", 36, 0, N_("partition table identifier (usually UUID)") },
167 [COL_PTTYPE
] = { "PTTYPE", 0.1, 0, N_("partition table type") },
169 [COL_PARTTYPE
] = { "PARTTYPE", 36, 0, N_("partition type UUID") },
170 [COL_PARTLABEL
] = { "PARTLABEL", 0.1, 0, N_("partition LABEL") },
171 [COL_PARTUUID
] = { "PARTUUID", 36, 0, N_("partition UUID") },
172 [COL_PARTFLAGS
] = { "PARTFLAGS", 36, 0, N_("partition flags") },
174 [COL_RA
] = { "RA", 3, SCOLS_FL_RIGHT
, N_("read-ahead of the device"), COLTYPE_NUM
},
175 [COL_RO
] = { "RO", 1, SCOLS_FL_RIGHT
, N_("read-only device"), COLTYPE_BOOL
},
176 [COL_RM
] = { "RM", 1, SCOLS_FL_RIGHT
, N_("removable device"), COLTYPE_BOOL
},
177 [COL_HOTPLUG
]= { "HOTPLUG", 1, SCOLS_FL_RIGHT
, N_("removable or hotplug device (usb, pcmcia, ...)"), COLTYPE_BOOL
},
178 [COL_ROTA
] = { "ROTA", 1, SCOLS_FL_RIGHT
, N_("rotational device"), COLTYPE_BOOL
},
179 [COL_RAND
] = { "RAND", 1, SCOLS_FL_RIGHT
, N_("adds randomness"), COLTYPE_BOOL
},
180 [COL_MODEL
] = { "MODEL", 0.1, SCOLS_FL_TRUNC
, N_("device identifier") },
181 [COL_SERIAL
] = { "SERIAL", 0.1, SCOLS_FL_TRUNC
, N_("disk serial number") },
182 [COL_SIZE
] = { "SIZE", 5, SCOLS_FL_RIGHT
, N_("size of the device"), COLTYPE_SIZE
},
183 [COL_STATE
] = { "STATE", 7, SCOLS_FL_TRUNC
, N_("state of the device") },
184 [COL_OWNER
] = { "OWNER", 0.1, SCOLS_FL_TRUNC
, N_("user name"), },
185 [COL_GROUP
] = { "GROUP", 0.1, SCOLS_FL_TRUNC
, N_("group name") },
186 [COL_MODE
] = { "MODE", 10, 0, N_("device node permissions") },
187 [COL_ALIOFF
] = { "ALIGNMENT", 6, SCOLS_FL_RIGHT
, N_("alignment offset"), COLTYPE_NUM
},
188 [COL_MINIO
] = { "MIN-IO", 6, SCOLS_FL_RIGHT
, N_("minimum I/O size"), COLTYPE_NUM
},
189 [COL_OPTIO
] = { "OPT-IO", 6, SCOLS_FL_RIGHT
, N_("optimal I/O size"), COLTYPE_NUM
},
190 [COL_PHYSEC
] = { "PHY-SEC", 7, SCOLS_FL_RIGHT
, N_("physical sector size"), COLTYPE_NUM
},
191 [COL_LOGSEC
] = { "LOG-SEC", 7, SCOLS_FL_RIGHT
, N_("logical sector size"), COLTYPE_NUM
},
192 [COL_SCHED
] = { "SCHED", 0.1, 0, N_("I/O scheduler name") },
193 [COL_RQ_SIZE
]= { "RQ-SIZE", 5, SCOLS_FL_RIGHT
, N_("request queue size"), COLTYPE_NUM
},
194 [COL_TYPE
] = { "TYPE", 4, 0, N_("device type") },
195 [COL_DALIGN
] = { "DISC-ALN", 6, SCOLS_FL_RIGHT
, N_("discard alignment offset"), COLTYPE_NUM
},
196 [COL_DGRAN
] = { "DISC-GRAN", 6, SCOLS_FL_RIGHT
, N_("discard granularity"), COLTYPE_SIZE
},
197 [COL_DMAX
] = { "DISC-MAX", 6, SCOLS_FL_RIGHT
, N_("discard max bytes"), COLTYPE_SIZE
},
198 [COL_DZERO
] = { "DISC-ZERO", 1, SCOLS_FL_RIGHT
, N_("discard zeroes data"), COLTYPE_BOOL
},
199 [COL_WSAME
] = { "WSAME", 6, SCOLS_FL_RIGHT
, N_("write same max bytes"), COLTYPE_SIZE
},
200 [COL_WWN
] = { "WWN", 18, 0, N_("unique storage identifier") },
201 [COL_HCTL
] = { "HCTL", 10, 0, N_("Host:Channel:Target:Lun for SCSI") },
202 [COL_TRANSPORT
] = { "TRAN", 6, 0, N_("device transport type") },
203 [COL_SUBSYS
] = { "SUBSYSTEMS", 0.1, SCOLS_FL_NOEXTREMES
, N_("de-duplicated chain of subsystems") },
204 [COL_REV
] = { "REV", 4, SCOLS_FL_RIGHT
, N_("device revision") },
205 [COL_VENDOR
] = { "VENDOR", 0.1, SCOLS_FL_TRUNC
, N_("device vendor") },
206 [COL_ZONED
] = { "ZONED", 0.3, 0, N_("zone model") },
209 struct lsblk
*lsblk
; /* global handler */
212 * columns[] array specifies all currently wanted output column. The columns
213 * are defined by infos[] array and you can specify (on command line) each
214 * column twice. That's enough, dynamically allocated array of the columns is
215 * unnecessary overkill and over-engineering in this case
217 static int columns
[ARRAY_SIZE(infos
) * 2];
218 static size_t ncolumns
;
220 static inline void add_column(int id
)
222 if (ncolumns
>= ARRAY_SIZE(columns
))
223 errx(EXIT_FAILURE
, _("too many columns specified, "
224 "the limit is %zu columns"),
225 ARRAY_SIZE(columns
) - 1);
226 columns
[ ncolumns
++ ] = id
;
229 static inline void add_uniq_column(int id
)
231 if (column_id_to_number(id
) < 0)
235 static void lsblk_init_debug(void)
237 __UL_INIT_DEBUG_FROM_ENV(lsblk
, LSBLK_DEBUG_
, 0, LSBLK_DEBUG
);
241 * exclude/include devices filter based on major device numbers
243 static int excludes
[256];
244 static size_t nexcludes
;
246 static int includes
[256];
247 static size_t nincludes
;
249 static int is_maj_excluded(int maj
)
253 assert(ARRAY_SIZE(excludes
) > nexcludes
);
256 return 0; /* filter not enabled, device not excluded */
258 for (i
= 0; i
< nexcludes
; i
++) {
259 if (excludes
[i
] == maj
) {
260 DBG(FILTER
, ul_debug("exclude: maj=%d", maj
));
267 static int is_maj_included(int maj
)
271 assert(ARRAY_SIZE(includes
) > nincludes
);
274 return 1; /* filter not enabled, device is included */
276 for (i
= 0; i
< nincludes
; i
++) {
277 if (includes
[i
] == maj
) {
278 DBG(FILTER
, ul_debug("include: maj=%d", maj
));
285 /* Converts column sequential number to column ID (COL_*) */
286 static int get_column_id(int num
)
289 assert((size_t) num
< ncolumns
);
290 assert(columns
[num
] < (int) ARRAY_SIZE(infos
));
294 /* Returns column description for the column sequential number */
295 static struct colinfo
*get_column_info(int num
)
297 return &infos
[ get_column_id(num
) ];
300 /* Converts column name (as defined in the infos[] to the column ID */
301 static int column_name_to_id(const char *name
, size_t namesz
)
305 for (i
= 0; i
< ARRAY_SIZE(infos
); i
++) {
306 const char *cn
= infos
[i
].name
;
308 if (!strncasecmp(name
, cn
, namesz
) && !*(cn
+ namesz
))
311 warnx(_("unknown column: %s"), name
);
315 /* Converts column ID (COL_*) to column sequential number */
316 static int column_id_to_number(int id
)
320 for (i
= 0; i
< ncolumns
; i
++)
321 if (columns
[i
] == id
)
326 /* Checks for DM prefix in the device name */
327 static int is_dm(const char *name
)
329 return strncmp(name
, "dm-", 3) ? 0 : 1;
332 /* Returns full pat to the device node (TODO: what about sysfs_blkdev_get_path()) */
333 static char *get_device_path(struct lsblk_device
*dev
)
340 if (is_dm(dev
->name
))
341 return __canonicalize_dm_name(lsblk
->sysroot
, dev
->name
);
343 snprintf(path
, sizeof(path
), "/dev/%s", dev
->name
);
344 sysfs_devname_sys_to_dev(path
);
345 return xstrdup(path
);
348 static int is_readonly_device(struct lsblk_device
*dev
)
352 if (ul_path_scanf(dev
->sysfs
, "ro", "%d", &ro
) == 1)
355 /* fallback if "ro" attribute does not exist */
356 fd
= open(dev
->filename
, O_RDONLY
);
358 if (ioctl(fd
, BLKROGET
, &ro
) != 0)
365 static char *get_scheduler(struct lsblk_device
*dev
)
368 char *p
, *res
= NULL
;
370 if (ul_path_read_buffer(dev
->sysfs
, buf
, sizeof(buf
), "queue/scheduler") == 0)
372 p
= strchr(buf
, '[');
375 p
= strchr(res
, ']');
385 static char *get_type(struct lsblk_device
*dev
)
387 char *res
= NULL
, *p
;
389 if (device_is_partition(dev
))
390 return xstrdup("part");
392 if (is_dm(dev
->name
)) {
393 char *dm_uuid
= NULL
;
395 /* The DM_UUID prefix should be set to subsystem owning
396 * the device - LVM, CRYPT, DMRAID, MPATH, PART */
397 if (ul_path_read_string(dev
->sysfs
, &dm_uuid
, "dm/uuid") > 0
400 char *dm_uuid_prefix
= strsep(&tmp
, "-");
402 if (dm_uuid_prefix
) {
403 /* kpartx hack to remove partition number */
404 if (strncasecmp(dm_uuid_prefix
, "part", 4) == 0)
405 dm_uuid_prefix
[4] = '\0';
407 res
= xstrdup(dm_uuid_prefix
);
413 /* No UUID or no prefix - just mark it as DM device */
416 } else if (!strncmp(dev
->name
, "loop", 4)) {
417 res
= xstrdup("loop");
419 } else if (!strncmp(dev
->name
, "md", 2)) {
420 char *md_level
= NULL
;
422 ul_path_read_string(dev
->sysfs
, &md_level
, "md/level");
423 res
= md_level
? md_level
: xstrdup("md");
426 const char *type
= NULL
;
429 if (ul_path_read_s32(dev
->sysfs
, &x
, "device/type") == 0)
430 type
= blkdev_scsi_type_to_name(x
);
436 for (p
= res
; p
&& *p
; p
++)
437 *p
= tolower((unsigned char) *p
);
441 /* Thanks to lsscsi code for idea of detection logic used here */
442 static char *get_transport(struct lsblk_device
*dev
)
444 struct path_cxt
*sysfs
= dev
->sysfs
;
446 const char *trans
= NULL
;
449 /* SCSI - Serial Peripheral Interface */
450 if (sysfs_blkdev_scsi_host_is(sysfs
, "spi"))
453 /* FC/FCoE - Fibre Channel / Fibre Channel over Ethernet */
454 else if (sysfs_blkdev_scsi_host_is(sysfs
, "fc")) {
455 attr
= sysfs_blkdev_scsi_host_strdup_attribute(sysfs
, "fc", "symbolic_name");
458 trans
= strstr(attr
, " over ") ? "fcoe" : "fc";
462 /* SAS - Serial Attached SCSI */
463 else if (sysfs_blkdev_scsi_host_is(sysfs
, "sas") ||
464 sysfs_blkdev_scsi_has_attribute(sysfs
, "sas_device"))
468 /* SBP - Serial Bus Protocol (FireWire) */
469 else if (sysfs_blkdev_scsi_has_attribute(sysfs
, "ieee1394_id"))
473 else if (sysfs_blkdev_scsi_host_is(sysfs
, "iscsi"))
476 /* USB - Universal Serial Bus */
477 else if (sysfs_blkdev_scsi_path_contains(sysfs
, "usb"))
481 else if (sysfs_blkdev_scsi_host_is(sysfs
, "scsi")) {
482 attr
= sysfs_blkdev_scsi_host_strdup_attribute(sysfs
, "scsi", "proc_name");
485 if (!strncmp(attr
, "ahci", 4) || !strncmp(attr
, "sata", 4))
487 else if (strstr(attr
, "ata"))
491 } else if (strncmp(dev
->name
, "nvme", 4) == 0)
494 return trans
? xstrdup(trans
) : NULL
;
497 static char *get_subsystems(struct lsblk_device
*dev
)
500 char *sub
, *chain
, *res
= NULL
;
501 size_t len
= 0, last
= 0;
503 chain
= sysfs_blkdev_get_devchain(dev
->sysfs
, path
, sizeof(path
));
507 while (sysfs_blkdev_next_subsystem(dev
->sysfs
, chain
, &sub
) == 0) {
510 /* don't create "block:scsi:scsi", but "block:scsi" */
511 if (len
&& strcmp(res
+ last
, sub
) == 0) {
517 res
= xrealloc(res
, len
+ sz
+ 2);
521 memcpy(res
+ len
, sub
, sz
+ 1);
531 #define is_parsable(_l) (scols_table_is_raw((_l)->table) || \
532 scols_table_is_export((_l)->table) || \
533 scols_table_is_json((_l)->table))
535 static char *mk_name(const char *name
)
541 xasprintf(&p
, "/dev/%s", name
);
545 sysfs_devname_sys_to_dev(p
);
549 static char *mk_dm_name(const char *name
)
555 xasprintf(&p
, "/dev/mapper/%s", name
);
561 /* stores data to scols cell userdata (invisible and independent on output)
562 * to make the original values accessible for sort functions
564 static void set_sortdata_u64(struct libscols_line
*ln
, int col
, uint64_t x
)
566 struct libscols_cell
*ce
= scols_line_get_cell(ln
, col
);
571 data
= xmalloc(sizeof(uint64_t));
573 scols_cell_set_userdata(ce
, data
);
576 /* do not modify *data on any error */
577 static void str2u64(const char *str
, uint64_t *data
)
583 if (str
== NULL
|| *str
== '\0')
585 num
= strtoumax(str
, &end
, 10);
587 if (errno
|| str
== end
|| (end
&& *end
))
592 static void unref_sortdata(struct libscols_table
*tb
)
594 struct libscols_iter
*itr
;
595 struct libscols_line
*ln
;
597 if (!tb
|| !lsblk
->sort_col
)
599 itr
= scols_new_iter(SCOLS_ITER_FORWARD
);
602 while (scols_table_next_line(tb
, itr
, &ln
) == 0) {
603 struct libscols_cell
*ce
= scols_line_get_column_cell(ln
,
605 void *data
= scols_cell_get_userdata(ce
);
609 scols_free_iter(itr
);
612 static char *get_vfs_attribute(struct lsblk_device
*dev
, int id
)
615 uint64_t vfs_attr
= 0;
618 if (!dev
->fsstat
.f_blocks
) {
619 mnt
= lsblk_device_get_mountpoint(dev
);
620 if (!mnt
|| dev
->is_swap
)
622 if (statvfs(mnt
, &dev
->fsstat
) != 0)
628 vfs_attr
= dev
->fsstat
.f_frsize
* dev
->fsstat
.f_blocks
;
631 vfs_attr
= dev
->fsstat
.f_frsize
* dev
->fsstat
.f_bavail
;
634 vfs_attr
= dev
->fsstat
.f_frsize
* (dev
->fsstat
.f_blocks
- dev
->fsstat
.f_bfree
);
637 if (dev
->fsstat
.f_blocks
== 0)
640 xasprintf(&sizestr
, "%.0f%%",
641 (double)(dev
->fsstat
.f_blocks
- dev
->fsstat
.f_bfree
) /
642 dev
->fsstat
.f_blocks
* 100);
647 sizestr
= xstrdup("0");
648 else if (lsblk
->bytes
)
649 xasprintf(&sizestr
, "%ju", vfs_attr
);
651 sizestr
= size_to_human_string(SIZE_SUFFIX_1LETTER
, vfs_attr
);
656 static struct stat
*device_get_stat(struct lsblk_device
*dev
)
659 && stat(dev
->filename
, &dev
->st
) != 0)
665 static int is_removable_device(struct lsblk_device
*dev
, struct lsblk_device
*parent
)
669 if (dev
->removable
!= -1)
671 if (ul_path_scanf(dev
->sysfs
, "removable", "%d", &dev
->removable
) == 1)
675 pc
= sysfs_blkdev_get_parent(dev
->sysfs
);
679 if (pc
== parent
->sysfs
)
680 /* dev is partition and parent is whole-disk */
681 dev
->removable
= is_removable_device(parent
, NULL
);
683 /* parent is something else, use sysfs parent */
684 ul_path_scanf(pc
, "removable", "%d", &dev
->removable
);
687 if (dev
->removable
== -1)
689 return dev
->removable
;
692 static uint64_t device_get_discard_granularity(struct lsblk_device
*dev
)
694 if (dev
->discard_granularity
== (uint64_t) -1
695 && ul_path_read_u64(dev
->sysfs
, &dev
->discard_granularity
,
696 "queue/discard_granularity") != 0)
697 dev
->discard_granularity
= 0;
699 return dev
->discard_granularity
;
703 * Generates data (string) for column specified by column ID for specified device. If sortdata
704 * is not NULL then returns number usable to sort the column if the data are available for the
707 static char *device_get_data(
708 struct lsblk_device
*dev
, /* device */
709 struct lsblk_device
*parent
, /* device parent as defined in the tree */
710 int id
, /* column ID (COL_*) */
711 uint64_t *sortdata
) /* returns sort data as number */
713 struct lsblk_devprop
*prop
;
718 str
= dev
->dm_name
? mk_dm_name(dev
->dm_name
) : mk_name(dev
->name
);
721 str
= mk_name(dev
->name
);
725 str
= mk_name(parent
->name
);
729 str
= xstrdup(dev
->filename
);
733 struct stat
*st
= device_get_stat(dev
);
734 struct passwd
*pw
= st
? getpwuid(st
->st_uid
) : NULL
;
736 str
= xstrdup(pw
->pw_name
);
741 struct stat
*st
= device_get_stat(dev
);
742 struct group
*gr
= st
? getgrgid(st
->st_gid
) : NULL
;
744 str
= xstrdup(gr
->gr_name
);
749 struct stat
*st
= device_get_stat(dev
);
750 char md
[11] = { '\0' };
753 str
= xstrdup(xstrmode(st
->st_mode
, md
));
757 if (is_parsable(lsblk
))
758 xasprintf(&str
, "%u:%u", dev
->maj
, dev
->min
);
760 xasprintf(&str
, "%3u:%-3u", dev
->maj
, dev
->min
);
762 *sortdata
= makedev(dev
->maj
, dev
->min
);
765 prop
= lsblk_device_get_properties(dev
);
766 if (prop
&& prop
->fstype
)
767 str
= xstrdup(prop
->fstype
);
773 str
= get_vfs_attribute(dev
, id
);
776 str
= xstrdup(lsblk_device_get_mountpoint(dev
));
779 prop
= lsblk_device_get_properties(dev
);
780 if (prop
&& prop
->label
)
781 str
= xstrdup(prop
->label
);
784 prop
= lsblk_device_get_properties(dev
);
785 if (prop
&& prop
->uuid
)
786 str
= xstrdup(prop
->uuid
);
789 prop
= lsblk_device_get_properties(dev
);
790 if (prop
&& prop
->ptuuid
)
791 str
= xstrdup(prop
->ptuuid
);
794 prop
= lsblk_device_get_properties(dev
);
795 if (prop
&& prop
->pttype
)
796 str
= xstrdup(prop
->pttype
);
799 prop
= lsblk_device_get_properties(dev
);
800 if (prop
&& prop
->parttype
)
801 str
= xstrdup(prop
->parttype
);
804 prop
= lsblk_device_get_properties(dev
);
805 if (prop
&& prop
->partlabel
)
806 str
= xstrdup(prop
->partlabel
);
809 prop
= lsblk_device_get_properties(dev
);
810 if (prop
&& prop
->partuuid
)
811 str
= xstrdup(prop
->partuuid
);
814 prop
= lsblk_device_get_properties(dev
);
815 if (prop
&& prop
->partflags
)
816 str
= xstrdup(prop
->partflags
);
819 prop
= lsblk_device_get_properties(dev
);
820 if (prop
&& prop
->wwn
)
821 str
= xstrdup(prop
->wwn
);
824 ul_path_read_string(dev
->sysfs
, &str
, "queue/read_ahead_kb");
826 str2u64(str
, sortdata
);
829 str
= xstrdup(is_readonly_device(dev
) ? "1" : "0");
832 str
= xstrdup(is_removable_device(dev
, parent
) ? "1" : "0");
835 str
= sysfs_blkdev_is_hotpluggable(dev
->sysfs
) ? xstrdup("1") : xstrdup("0");
838 ul_path_read_string(dev
->sysfs
, &str
, "queue/rotational");
841 ul_path_read_string(dev
->sysfs
, &str
, "queue/add_random");
844 if (!device_is_partition(dev
) && dev
->nslaves
== 0) {
845 prop
= lsblk_device_get_properties(dev
);
846 if (prop
&& prop
->model
)
847 str
= xstrdup(prop
->model
);
849 ul_path_read_string(dev
->sysfs
, &str
, "device/model");
853 if (!device_is_partition(dev
) && dev
->nslaves
== 0) {
854 prop
= lsblk_device_get_properties(dev
);
855 if (prop
&& prop
->serial
)
856 str
= xstrdup(prop
->serial
);
858 ul_path_read_string(dev
->sysfs
, &str
, "device/serial");
862 if (!device_is_partition(dev
) && dev
->nslaves
== 0)
863 ul_path_read_string(dev
->sysfs
, &str
, "device/rev");
866 if (!device_is_partition(dev
) && dev
->nslaves
== 0)
867 ul_path_read_string(dev
->sysfs
, &str
, "device/vendor");
873 xasprintf(&str
, "%ju", dev
->size
);
875 str
= size_to_human_string(SIZE_SUFFIX_1LETTER
, dev
->size
);
877 *sortdata
= dev
->size
;
880 if (!device_is_partition(dev
) && !dev
->dm_name
)
881 ul_path_read_string(dev
->sysfs
, &str
, "device/state");
882 else if (dev
->dm_name
) {
884 if (ul_path_read_s32(dev
->sysfs
, &x
, "dm/suspended") == 0)
885 str
= xstrdup(x
? "suspended" : "running");
889 ul_path_read_string(dev
->sysfs
, &str
, "alignment_offset");
891 str2u64(str
, sortdata
);
894 ul_path_read_string(dev
->sysfs
, &str
, "queue/minimum_io_size");
896 str2u64(str
, sortdata
);
899 ul_path_read_string(dev
->sysfs
, &str
, "queue/optimal_io_size");
901 str2u64(str
, sortdata
);
904 ul_path_read_string(dev
->sysfs
, &str
, "queue/physical_block_size");
906 str2u64(str
, sortdata
);
909 ul_path_read_string(dev
->sysfs
, &str
, "queue/logical_block_size");
911 str2u64(str
, sortdata
);
914 str
= get_scheduler(dev
);
917 ul_path_read_string(dev
->sysfs
, &str
, "queue/nr_requests");
919 str2u64(str
, sortdata
);
927 if (sysfs_blkdev_scsi_get_hctl(dev
->sysfs
, &h
, &c
, &t
, &l
) == 0)
928 xasprintf(&str
, "%d:%d:%d:%d", h
, c
, t
, l
);
932 str
= get_transport(dev
);
935 str
= get_subsystems(dev
);
938 if (device_get_discard_granularity(dev
) > 0)
939 ul_path_read_string(dev
->sysfs
, &str
, "discard_alignment");
943 str2u64(str
, sortdata
);
947 ul_path_read_string(dev
->sysfs
, &str
, "queue/discard_granularity");
949 str2u64(str
, sortdata
);
951 uint64_t x
= device_get_discard_granularity(dev
);
952 str
= size_to_human_string(SIZE_SUFFIX_1LETTER
, x
);
959 ul_path_read_string(dev
->sysfs
, &str
, "queue/discard_max_bytes");
961 str2u64(str
, sortdata
);
964 if (ul_path_read_u64(dev
->sysfs
, &x
, "queue/discard_max_bytes") == 0) {
965 str
= size_to_human_string(SIZE_SUFFIX_1LETTER
, x
);
972 if (device_get_discard_granularity(dev
) > 0)
973 ul_path_read_string(dev
->sysfs
, &str
, "queue/discard_zeroes_data");
979 ul_path_read_string(dev
->sysfs
, &str
, "queue/write_same_max_bytes");
981 str2u64(str
, sortdata
);
985 if (ul_path_read_u64(dev
->sysfs
, &x
, "queue/write_same_max_bytes") == 0) {
986 str
= size_to_human_string(SIZE_SUFFIX_1LETTER
, x
);
995 ul_path_read_string(dev
->sysfs
, &str
, "queue/zoned");
1003 * Adds data for all wanted columns about the device to the smartcols table
1005 static void device_to_scols(
1006 struct lsblk_device
*dev
,
1007 struct lsblk_device
*parent
,
1008 struct libscols_table
*tab
,
1009 struct libscols_line
*parent_line
)
1012 struct libscols_line
*ln
;
1013 struct lsblk_iter itr
;
1014 struct lsblk_device
*child
= NULL
;
1018 DBG(DEV
, ul_debugobj(dev
, "add '%s' to scols", dev
->name
));
1019 ON_DBG(DEV
, if (ul_path_isopen_dirfd(dev
->sysfs
)) ul_debugobj(dev
, " %s ---> is open!", dev
->name
));
1021 /* Do not print device more than one in --list mode */
1022 if (!(lsblk
->flags
& LSBLK_TREE
) && dev
->is_printed
)
1025 if (lsblk
->merge
&& list_count_entries(&dev
->parents
) > 1) {
1026 if (!lsblk_device_is_last_parent(dev
, parent
))
1031 ln
= scols_table_new_line(tab
, link_group
? NULL
: parent_line
);
1033 err(EXIT_FAILURE
, _("failed to allocate output line"));
1035 dev
->is_printed
= 1;
1038 struct lsblk_device
*p
;
1039 struct libscols_line
*gr
= parent_line
;
1041 /* Merge all my parents to the one group */
1042 DBG(DEV
, ul_debugobj(dev
, " grouping parents [--merge]"));
1043 lsblk_reset_iter(&itr
, LSBLK_ITER_FORWARD
);
1044 while (lsblk_device_next_parent(dev
, &itr
, &p
) == 0) {
1045 if (!p
->scols_line
) {
1046 DBG(DEV
, ul_debugobj(dev
, " *** ignore '%s' no scols line yet", p
->name
));
1049 DBG(DEV
, ul_debugobj(dev
, " group '%s'", p
->name
));
1050 scols_table_group_lines(tab
, p
->scols_line
, gr
, 0);
1053 /* Link the group -- this makes group->child connection */
1054 DBG(DEV
, ul_debugobj(dev
, " linking the group [--merge]"));
1055 scols_line_link_group(ln
, gr
, 0);
1058 /* read column specific data and set it to smartcols table line */
1059 for (i
= 0; i
< ncolumns
; i
++) {
1061 int id
= get_column_id(i
);
1063 if (lsblk
->sort_id
!= id
)
1064 data
= device_get_data(dev
, parent
, id
, NULL
);
1066 uint64_t sortdata
= (uint64_t) -1;
1068 data
= device_get_data(dev
, parent
, id
, &sortdata
);
1069 if (data
&& sortdata
!= (uint64_t) -1)
1070 set_sortdata_u64(ln
, i
, sortdata
);
1072 DBG(DEV
, ul_debugobj(dev
, " refer data[%zu]=\"%s\"", i
, data
));
1073 if (data
&& scols_line_refer_data(ln
, i
, data
))
1074 err(EXIT_FAILURE
, _("failed to add output data"));
1077 dev
->scols_line
= ln
;
1079 if (dev
->npartitions
== 0)
1080 /* For partitions we often read from parental whole-disk sysfs,
1081 * otherwise we can close */
1082 ul_path_close_dirfd(dev
->sysfs
);
1084 lsblk_reset_iter(&itr
, LSBLK_ITER_FORWARD
);
1085 while (lsblk_device_next_child(dev
, &itr
, &child
) == 0) {
1086 DBG(DEV
, ul_debugobj(dev
, "%s -> continue to child", dev
->name
));
1087 device_to_scols(child
, dev
, tab
, ln
);
1088 DBG(DEV
, ul_debugobj(dev
, "%s <- child done", dev
->name
));
1091 /* Let's be careful with number of open files */
1092 ul_path_close_dirfd(dev
->sysfs
);
1096 * Walks on tree and adds one line for each device to the smartcols table
1098 static void devtree_to_scols(struct lsblk_devtree
*tr
, struct libscols_table
*tab
)
1100 struct lsblk_iter itr
;
1101 struct lsblk_device
*dev
= NULL
;
1103 lsblk_reset_iter(&itr
, LSBLK_ITER_FORWARD
);
1105 while (lsblk_devtree_next_root(tr
, &itr
, &dev
) == 0)
1106 device_to_scols(dev
, NULL
, tab
, NULL
);
1110 * Reads very basic information about the device from sysfs into the device struct
1112 static int initialize_device(struct lsblk_device
*dev
,
1113 struct lsblk_device
*wholedisk
,
1118 DBG(DEV
, ul_debugobj(dev
, "initialize %s [wholedisk=%p %s]",
1119 name
, wholedisk
, wholedisk
? wholedisk
->name
: ""));
1121 dev
->name
= xstrdup(name
);
1124 dev
->wholedisk
= wholedisk
;
1125 lsblk_ref_device(wholedisk
);
1128 dev
->filename
= get_device_path(dev
);
1129 if (!dev
->filename
) {
1130 DBG(DEV
, ul_debugobj(dev
, "%s: failed to get device path", dev
->name
));
1133 DBG(DEV
, ul_debugobj(dev
, "%s: filename=%s", dev
->name
, dev
->filename
));
1135 devno
= __sysfs_devname_to_devno(lsblk
->sysroot
, dev
->name
, wholedisk
? wholedisk
->name
: NULL
);
1137 DBG(DEV
, ul_debugobj(dev
, "%s: unknown device name", dev
->name
));
1141 dev
->sysfs
= ul_new_sysfs_path(devno
, wholedisk
? wholedisk
->sysfs
: NULL
, lsblk
->sysroot
);
1143 DBG(DEV
, ul_debugobj(dev
, "%s: failed to initialize sysfs handler", dev
->name
));
1147 dev
->maj
= major(devno
);
1148 dev
->min
= minor(devno
);
1151 if (ul_path_read_u64(dev
->sysfs
, &dev
->size
, "size") == 0) /* in sectors */
1152 dev
->size
<<= 9; /* in bytes */
1154 /* Ignore devices of zero size */
1155 if (!lsblk
->all_devices
&& dev
->size
== 0) {
1156 DBG(DEV
, ul_debugobj(dev
, "zero size device -- ignore"));
1159 if (is_dm(dev
->name
)) {
1160 ul_path_read_string(dev
->sysfs
, &dev
->dm_name
, "dm/name");
1161 if (!dev
->dm_name
) {
1162 DBG(DEV
, ul_debugobj(dev
, "%s: failed to get dm name", dev
->name
));
1167 dev
->npartitions
= sysfs_blkdev_count_partitions(dev
->sysfs
, dev
->name
);
1168 dev
->nholders
= ul_path_count_dirents(dev
->sysfs
, "holders");
1169 dev
->nslaves
= ul_path_count_dirents(dev
->sysfs
, "slaves");
1171 DBG(DEV
, ul_debugobj(dev
, "%s: npartitions=%d, nholders=%d, nslaves=%d",
1172 dev
->name
, dev
->npartitions
, dev
->nholders
, dev
->nslaves
));
1174 /* ignore non-SCSI devices */
1175 if (lsblk
->scsi
&& sysfs_blkdev_scsi_get_hctl(dev
->sysfs
, NULL
, NULL
, NULL
, NULL
)) {
1176 DBG(DEV
, ul_debugobj(dev
, "non-scsi device -- ignore"));
1180 DBG(DEV
, ul_debugobj(dev
, "%s: context successfully initialized", dev
->name
));
1184 static struct lsblk_device
*devtree_get_device_or_new(struct lsblk_devtree
*tr
,
1185 struct lsblk_device
*disk
,
1188 struct lsblk_device
*dev
= lsblk_devtree_get_device(tr
, name
);
1191 dev
= lsblk_new_device();
1193 err(EXIT_FAILURE
, _("failed to allocate device"));
1195 if (initialize_device(dev
, disk
, name
) != 0) {
1196 lsblk_unref_device(dev
);
1199 lsblk_devtree_add_device(tr
, dev
);
1200 lsblk_unref_device(dev
); /* keep it referenced by devtree only */
1202 DBG(DEV
, ul_debugobj(dev
, "%s: already processed", name
));
1207 static int process_dependencies(
1208 struct lsblk_devtree
*tr
,
1209 struct lsblk_device
*dev
,
1213 * Read devices from whole-disk device into tree
1215 static int process_partitions(struct lsblk_devtree
*tr
, struct lsblk_device
*disk
)
1223 * Do not process further if there are no partitions for
1224 * this device or the device itself is a partition.
1226 if (!disk
->npartitions
|| device_is_partition(disk
))
1229 DBG(DEV
, ul_debugobj(disk
, "%s: probe whole-disk for partitions", disk
->name
));
1231 dir
= ul_path_opendir(disk
->sysfs
, NULL
);
1233 err(EXIT_FAILURE
, _("failed to open device directory in sysfs"));
1235 while ((d
= xreaddir(dir
))) {
1236 struct lsblk_device
*part
;
1238 if (!(sysfs_blkdev_is_partition_dirent(dir
, d
, disk
->name
)))
1241 DBG(DEV
, ul_debugobj(disk
, " checking %s", d
->d_name
));
1243 part
= devtree_get_device_or_new(tr
, disk
, d
->d_name
);
1247 if (lsblk_device_new_dependence(disk
, part
) == 0)
1248 process_dependencies(tr
, part
, 0);
1250 ul_path_close_dirfd(part
->sysfs
);
1253 /* For partitions we need parental (whole-disk) sysfs directory pretty
1254 * often, so close it now when all is done */
1255 ul_path_close_dirfd(disk
->sysfs
);
1257 DBG(DEV
, ul_debugobj(disk
, "probe whole-disk for partitions -- done"));
1262 static char *get_wholedisk_from_partition_dirent(DIR *dir
, struct dirent
*d
, char *buf
, size_t bufsz
)
1267 if ((len
= readlinkat(dirfd(dir
), d
->d_name
, buf
, bufsz
- 1)) < 0)
1272 /* The path ends with ".../<device>/<partition>" */
1273 p
= strrchr(buf
, '/');
1278 p
= strrchr(buf
, '/');
1287 * Reads slaves/holders and partitions for specified device into device tree
1289 static int process_dependencies(
1290 struct lsblk_devtree
*tr
,
1291 struct lsblk_device
*dev
,
1296 const char *depname
;
1303 /* read all or specified partition */
1304 if (do_partitions
&& dev
->npartitions
)
1305 process_partitions(tr
, dev
);
1307 DBG(DEV
, ul_debugobj(dev
, "%s: reading dependencies", dev
->name
));
1309 if (!(lsblk
->inverse
? dev
->nslaves
: dev
->nholders
)) {
1310 DBG(DEV
, ul_debugobj(dev
, " ignore (no slaves/holders)"));
1314 depname
= lsblk
->inverse
? "slaves" : "holders";
1315 dir
= ul_path_opendir(dev
->sysfs
, depname
);
1317 DBG(DEV
, ul_debugobj(dev
, " ignore (no slaves/holders directory)"));
1320 ul_path_close_dirfd(dev
->sysfs
);
1322 DBG(DEV
, ul_debugobj(dev
, " %s: checking for '%s' dependence", dev
->name
, depname
));
1324 while ((d
= xreaddir(dir
))) {
1325 struct lsblk_device
*dep
= NULL
;
1326 struct lsblk_device
*disk
= NULL
;
1328 /* Is the dependency a partition? */
1329 if (sysfs_blkdev_is_partition_dirent(dir
, d
, NULL
)) {
1334 DBG(DEV
, ul_debugobj(dev
, " %s: dependence is partition", d
->d_name
));
1336 diskname
= get_wholedisk_from_partition_dirent(dir
, d
, buf
, sizeof(buf
));
1338 disk
= devtree_get_device_or_new(tr
, NULL
, diskname
);
1340 DBG(DEV
, ul_debugobj(dev
, " ignore no wholedisk ???"));
1344 dep
= devtree_get_device_or_new(tr
, disk
, d
->d_name
);
1348 if (lsblk_device_new_dependence(dev
, dep
) == 0)
1349 process_dependencies(tr
, dep
, 1);
1352 && lsblk_device_new_dependence(dep
, disk
) == 0)
1353 process_dependencies(tr
, disk
, 0);
1355 /* The dependency is a whole device. */
1357 DBG(DEV
, ul_debugobj(dev
, " %s: %s: dependence is whole-disk",
1358 dev
->name
, d
->d_name
));
1360 dep
= devtree_get_device_or_new(tr
, NULL
, d
->d_name
);
1364 if (lsblk_device_new_dependence(dev
, dep
) == 0)
1365 /* For inverse tree we don't want to show partitions
1366 * if the dependence is on whole-disk */
1367 process_dependencies(tr
, dep
, lsblk
->inverse
? 0 : 1);
1370 if (dep
&& dep
->sysfs
)
1371 ul_path_close_dirfd(dep
->sysfs
);
1372 if (disk
&& disk
->sysfs
)
1373 ul_path_close_dirfd(disk
->sysfs
);
1377 DBG(DEV
, ul_debugobj(dev
, "%s: checking for '%s' -- done", dev
->name
, depname
));
1382 * Defines the device as root node in the device tree and walks on all dependencies of the device.
1384 static int __process_one_device(struct lsblk_devtree
*tr
, char *devname
, dev_t devno
)
1386 struct lsblk_device
*dev
= NULL
;
1387 struct lsblk_device
*disk
= NULL
;
1388 char buf
[PATH_MAX
+ 1], *name
= NULL
, *diskname
= NULL
;
1389 int real_part
= 0, rc
= -EINVAL
;
1394 DBG(DEV
, ul_debug("%s: reading alone device", devname
));
1396 if (stat(devname
, &st
) || !S_ISBLK(st
.st_mode
)) {
1397 warnx(_("%s: not a block device"), devname
);
1402 DBG(DEV
, ul_debug("%d:%d: reading alone device", major(devno
), minor(devno
)));
1404 /* TODO: sysfs_devno_to_devname() internally initializes path_cxt, it
1405 * would be better to use ul_new_sysfs_path() + sysfs_blkdev_get_name()
1406 * and reuse path_cxt for initialize_device()
1408 name
= sysfs_devno_to_devname(devno
, buf
, sizeof(buf
));
1411 warn(_("%s: failed to get sysfs name"), devname
);
1414 name
= xstrdup(name
);
1416 if (!strncmp(name
, "dm-", 3)) {
1417 /* dm mapping is never a real partition! */
1422 if (blkid_devno_to_wholedisk(devno
, buf
, sizeof(buf
), &diskno
)) {
1423 warn(_("%s: failed to get whole-disk device number"), name
);
1427 real_part
= devno
!= diskno
;
1432 * Device is not a partition.
1434 DBG(DEV
, ul_debug(" non-partition"));
1436 dev
= devtree_get_device_or_new(tr
, NULL
, name
);
1440 lsblk_devtree_add_root(tr
, dev
);
1441 process_dependencies(tr
, dev
, !lsblk
->inverse
);
1444 * Partition, read sysfs name of the disk device
1446 DBG(DEV
, ul_debug(" partition"));
1448 disk
= devtree_get_device_or_new(tr
, NULL
, diskname
);
1452 dev
= devtree_get_device_or_new(tr
, disk
, name
);
1456 lsblk_devtree_add_root(tr
, dev
);
1457 process_dependencies(tr
, dev
, 1);
1460 && lsblk_device_new_dependence(dev
, disk
) == 0)
1461 process_dependencies(tr
, disk
, 0);
1463 ul_path_close_dirfd(disk
->sysfs
);
1468 if (dev
&& dev
->sysfs
)
1469 ul_path_close_dirfd(dev
->sysfs
);
1470 if (disk
&& disk
->sysfs
)
1471 ul_path_close_dirfd(disk
->sysfs
);
1476 static int process_one_device(struct lsblk_devtree
*tr
, char *devname
)
1478 return __process_one_device(tr
, devname
, 0);
1482 * The /sys/block contains only root devices, and no partitions. It seems more
1483 * simple to scan /sys/dev/block where are all devices without exceptions to get
1484 * top-level devices for the reverse tree.
1486 static int process_all_devices_inverse(struct lsblk_devtree
*tr
)
1490 struct path_cxt
*pc
= ul_new_path(_PATH_SYS_DEVBLOCK
);
1492 assert(lsblk
->inverse
);
1495 err(EXIT_FAILURE
, _("failed to allocate /sys handler"));
1497 ul_path_set_prefix(pc
, lsblk
->sysroot
);
1498 dir
= ul_path_opendir(pc
, NULL
);
1502 DBG(DEV
, ul_debug("iterate on " _PATH_SYS_DEVBLOCK
));
1504 while ((d
= xreaddir(dir
))) {
1508 DBG(DEV
, ul_debug(" %s dentry", d
->d_name
));
1510 if (sscanf(d
->d_name
, "%d:%d", &maj
, &min
) != 2)
1512 devno
= makedev(maj
, min
);
1514 if (is_maj_excluded(maj
) || !is_maj_included(maj
))
1516 if (ul_path_countf_dirents(pc
, "%s/holders", d
->d_name
) != 0)
1518 if (sysfs_devno_count_partitions(devno
) != 0)
1520 __process_one_device(tr
, NULL
, devno
);
1526 DBG(DEV
, ul_debug("iterate on " _PATH_SYS_DEVBLOCK
" -- done"));
1531 * Reads root nodes (devices) from /sys/block into devices tree
1533 static int process_all_devices(struct lsblk_devtree
*tr
)
1537 struct path_cxt
*pc
;
1539 assert(lsblk
->inverse
== 0);
1541 pc
= ul_new_path(_PATH_SYS_BLOCK
);
1543 err(EXIT_FAILURE
, _("failed to allocate /sys handler"));
1545 ul_path_set_prefix(pc
, lsblk
->sysroot
);
1546 dir
= ul_path_opendir(pc
, NULL
);
1550 DBG(DEV
, ul_debug("iterate on " _PATH_SYS_BLOCK
));
1552 while ((d
= xreaddir(dir
))) {
1553 struct lsblk_device
*dev
= NULL
;
1555 DBG(DEV
, ul_debug(" %s dentry", d
->d_name
));
1556 dev
= devtree_get_device_or_new(tr
, NULL
, d
->d_name
);
1560 /* remove unwanted devices */
1561 if (is_maj_excluded(dev
->maj
) || !is_maj_included(dev
->maj
)) {
1562 DBG(DEV
, ul_debug(" %s: ignore (by filter)", d
->d_name
));
1563 lsblk_devtree_remove_device(tr
, dev
);
1569 DBG(DEV
, ul_debug(" %s: ignore (in-middle)", d
->d_name
));
1573 lsblk_devtree_add_root(tr
, dev
);
1574 process_dependencies(tr
, dev
, 1);
1576 /* Let's be careful with number of open files */
1577 if (dev
&& dev
->sysfs
)
1578 ul_path_close_dirfd(dev
->sysfs
);
1584 DBG(DEV
, ul_debug("iterate on " _PATH_SYS_BLOCK
" -- done"));
1589 * Parses major numbers as specified on lsblk command line
1591 static void parse_excludes(const char *str0
)
1593 const char *str
= str0
;
1595 while (str
&& *str
) {
1600 n
= strtoul(str
, &end
, 10);
1602 if (end
== str
|| (end
&& *end
&& *end
!= ','))
1603 errx(EXIT_FAILURE
, _("failed to parse list '%s'"), str0
);
1604 if (errno
!= 0 && (n
== ULONG_MAX
|| n
== 0))
1605 err(EXIT_FAILURE
, _("failed to parse list '%s'"), str0
);
1606 excludes
[nexcludes
++] = n
;
1608 if (nexcludes
== ARRAY_SIZE(excludes
))
1609 /* TRANSLATORS: The standard value for %d is 256. */
1610 errx(EXIT_FAILURE
, _("the list of excluded devices is "
1611 "too large (limit is %d devices)"),
1612 (int)ARRAY_SIZE(excludes
));
1614 str
= end
&& *end
? end
+ 1 : NULL
;
1619 * Parses major numbers as specified on lsblk command line
1620 * (TODO: what about refactor and merge parse_excludes() and parse_includes().)
1622 static void parse_includes(const char *str0
)
1624 const char *str
= str0
;
1626 while (str
&& *str
) {
1631 n
= strtoul(str
, &end
, 10);
1633 if (end
== str
|| (end
&& *end
&& *end
!= ','))
1634 errx(EXIT_FAILURE
, _("failed to parse list '%s'"), str0
);
1635 if (errno
!= 0 && (n
== ULONG_MAX
|| n
== 0))
1636 err(EXIT_FAILURE
, _("failed to parse list '%s'"), str0
);
1637 includes
[nincludes
++] = n
;
1639 if (nincludes
== ARRAY_SIZE(includes
))
1640 /* TRANSLATORS: The standard value for %d is 256. */
1641 errx(EXIT_FAILURE
, _("the list of included devices is "
1642 "too large (limit is %d devices)"),
1643 (int)ARRAY_SIZE(includes
));
1644 str
= end
&& *end
? end
+ 1 : NULL
;
1649 * see set_sortdata_u64() and columns initialization in main()
1651 static int cmp_u64_cells(struct libscols_cell
*a
,
1652 struct libscols_cell
*b
,
1653 __attribute__((__unused__
)) void *data
)
1655 uint64_t *adata
= (uint64_t *) scols_cell_get_userdata(a
),
1656 *bdata
= (uint64_t *) scols_cell_get_userdata(b
);
1658 if (adata
== NULL
&& bdata
== NULL
)
1664 return *adata
== *bdata
? 0 : *adata
>= *bdata
? 1 : -1;
1667 static void device_set_dedupkey(
1668 struct lsblk_device
*dev
,
1669 struct lsblk_device
*parent
,
1672 struct lsblk_iter itr
;
1673 struct lsblk_device
*child
= NULL
;
1675 dev
->dedupkey
= device_get_data(dev
, parent
, id
, NULL
);
1677 DBG(DEV
, ul_debugobj(dev
, "%s: de-duplication key: %s", dev
->name
, dev
->dedupkey
));
1679 if (dev
->npartitions
== 0)
1680 /* For partitions we often read from parental whole-disk sysfs,
1681 * otherwise we can close */
1682 ul_path_close_dirfd(dev
->sysfs
);
1684 lsblk_reset_iter(&itr
, LSBLK_ITER_FORWARD
);
1686 while (lsblk_device_next_child(dev
, &itr
, &child
) == 0)
1687 device_set_dedupkey(child
, dev
, id
);
1689 /* Let's be careful with number of open files */
1690 ul_path_close_dirfd(dev
->sysfs
);
1693 static void devtree_set_dedupkeys(struct lsblk_devtree
*tr
, int id
)
1695 struct lsblk_iter itr
;
1696 struct lsblk_device
*dev
= NULL
;
1698 lsblk_reset_iter(&itr
, LSBLK_ITER_FORWARD
);
1700 while (lsblk_devtree_next_root(tr
, &itr
, &dev
) == 0)
1701 device_set_dedupkey(dev
, NULL
, id
);
1704 static void __attribute__((__noreturn__
)) usage(void)
1709 fputs(USAGE_HEADER
, out
);
1710 fprintf(out
, _(" %s [options] [<device> ...]\n"), program_invocation_short_name
);
1712 fputs(USAGE_SEPARATOR
, out
);
1713 fputs(_("List information about block devices.\n"), out
);
1715 fputs(USAGE_OPTIONS
, out
);
1716 fputs(_(" -D, --discard print discard capabilities\n"), out
);
1717 fputs(_(" -E, --dedup <column> de-duplicate output by <column>\n"), out
);
1718 fputs(_(" -I, --include <list> show only devices with specified major numbers\n"), out
);
1719 fputs(_(" -J, --json use JSON output format\n"), out
);
1720 fputs(_(" -O, --output-all output all columns\n"), out
);
1721 fputs(_(" -P, --pairs use key=\"value\" output format\n"), out
);
1722 fputs(_(" -S, --scsi output info about SCSI devices\n"), out
);
1723 fputs(_(" -T, --tree[=<column>] use tree format output\n"), out
);
1724 fputs(_(" -a, --all print all devices\n"), out
);
1725 fputs(_(" -b, --bytes print SIZE in bytes rather than in human readable format\n"), out
);
1726 fputs(_(" -d, --nodeps don't print slaves or holders\n"), out
);
1727 fputs(_(" -e, --exclude <list> exclude devices by major number (default: RAM disks)\n"), out
);
1728 fputs(_(" -f, --fs output info about filesystems\n"), out
);
1729 fputs(_(" -i, --ascii use ascii characters only\n"), out
);
1730 fputs(_(" -l, --list use list format output\n"), out
);
1731 fputs(_(" -M, --merge group parents of sub-trees (usable for RAIDs, Multi-path)\n"), out
);
1732 fputs(_(" -m, --perms output info about permissions\n"), out
);
1733 fputs(_(" -n, --noheadings don't print headings\n"), out
);
1734 fputs(_(" -o, --output <list> output columns\n"), out
);
1735 fputs(_(" -p, --paths print complete device path\n"), out
);
1736 fputs(_(" -r, --raw use raw output format\n"), out
);
1737 fputs(_(" -s, --inverse inverse dependencies\n"), out
);
1738 fputs(_(" -t, --topology output info about topology\n"), out
);
1739 fputs(_(" -z, --zoned print zone model\n"), out
);
1740 fputs(_(" -x, --sort <column> sort output by <column>\n"), out
);
1741 fputs(_(" --sysroot <dir> use specified directory as system root\n"), out
);
1742 fputs(USAGE_SEPARATOR
, out
);
1743 printf(USAGE_HELP_OPTIONS(22));
1745 fprintf(out
, USAGE_COLUMNS
);
1747 for (i
= 0; i
< ARRAY_SIZE(infos
); i
++)
1748 fprintf(out
, " %11s %s\n", infos
[i
].name
, _(infos
[i
].help
));
1750 printf(USAGE_MAN_TAIL("lsblk(8)"));
1755 static void check_sysdevblock(void)
1757 if (access(_PATH_SYS_DEVBLOCK
, R_OK
) != 0)
1758 err(EXIT_FAILURE
, _("failed to access sysfs directory: %s"),
1759 _PATH_SYS_DEVBLOCK
);
1762 int main(int argc
, char *argv
[])
1764 struct lsblk _ls
= {
1767 .flags
= LSBLK_TREE
,
1770 struct lsblk_devtree
*tr
= NULL
;
1771 int c
, status
= EXIT_FAILURE
;
1772 char *outarg
= NULL
;
1774 int force_tree
= 0, has_tree_col
= 0;
1777 OPT_SYSROOT
= CHAR_MAX
+ 1
1780 static const struct option longopts
[] = {
1781 { "all", no_argument
, NULL
, 'a' },
1782 { "bytes", no_argument
, NULL
, 'b' },
1783 { "nodeps", no_argument
, NULL
, 'd' },
1784 { "discard", no_argument
, NULL
, 'D' },
1785 { "dedup", required_argument
, NULL
, 'E' },
1786 { "zoned", no_argument
, NULL
, 'z' },
1787 { "help", no_argument
, NULL
, 'h' },
1788 { "json", no_argument
, NULL
, 'J' },
1789 { "output", required_argument
, NULL
, 'o' },
1790 { "output-all", no_argument
, NULL
, 'O' },
1791 { "merge", no_argument
, NULL
, 'M' },
1792 { "perms", no_argument
, NULL
, 'm' },
1793 { "noheadings", no_argument
, NULL
, 'n' },
1794 { "list", no_argument
, NULL
, 'l' },
1795 { "ascii", no_argument
, NULL
, 'i' },
1796 { "raw", no_argument
, NULL
, 'r' },
1797 { "inverse", no_argument
, NULL
, 's' },
1798 { "fs", no_argument
, NULL
, 'f' },
1799 { "exclude", required_argument
, NULL
, 'e' },
1800 { "include", required_argument
, NULL
, 'I' },
1801 { "topology", no_argument
, NULL
, 't' },
1802 { "paths", no_argument
, NULL
, 'p' },
1803 { "pairs", no_argument
, NULL
, 'P' },
1804 { "scsi", no_argument
, NULL
, 'S' },
1805 { "sort", required_argument
, NULL
, 'x' },
1806 { "sysroot", required_argument
, NULL
, OPT_SYSROOT
},
1807 { "tree", optional_argument
, NULL
, 'T' },
1808 { "version", no_argument
, NULL
, 'V' },
1809 { NULL
, 0, NULL
, 0 },
1812 static const ul_excl_t excl
[] = { /* rows and cols in ASCII order */
1821 { 'P','T', 'l','r' },
1824 int excl_st
[ARRAY_SIZE(excl
)] = UL_EXCL_STATUS_INIT
;
1826 setlocale(LC_ALL
, "");
1827 bindtextdomain(PACKAGE
, LOCALEDIR
);
1828 textdomain(PACKAGE
);
1829 close_stdout_atexit();
1835 while((c
= getopt_long(argc
, argv
,
1836 "abdDzE:e:fhJlnMmo:OpPiI:rstVST:x:", longopts
, NULL
)) != -1) {
1838 err_exclusive_options(c
, longopts
, excl
, excl_st
);
1842 lsblk
->all_devices
= 1;
1851 add_uniq_column(COL_NAME
);
1852 add_uniq_column(COL_DALIGN
);
1853 add_uniq_column(COL_DGRAN
);
1854 add_uniq_column(COL_DMAX
);
1855 add_uniq_column(COL_DZERO
);
1858 add_uniq_column(COL_NAME
);
1859 add_uniq_column(COL_ZONED
);
1862 parse_excludes(optarg
);
1865 lsblk
->flags
|= LSBLK_JSON
;
1868 lsblk
->flags
&= ~LSBLK_TREE
; /* disable the default */
1874 lsblk
->flags
|= LSBLK_NOHEADINGS
;
1880 for (ncolumns
= 0 ; ncolumns
< ARRAY_SIZE(infos
); ncolumns
++)
1881 columns
[ncolumns
] = ncolumns
;
1887 lsblk
->flags
|= LSBLK_EXPORT
;
1888 lsblk
->flags
&= ~LSBLK_TREE
; /* disable the default */
1891 lsblk
->flags
|= LSBLK_ASCII
;
1894 parse_includes(optarg
);
1897 lsblk
->flags
&= ~LSBLK_TREE
; /* disable the default */
1898 lsblk
->flags
|= LSBLK_RAW
; /* enable raw */
1904 add_uniq_column(COL_NAME
);
1905 add_uniq_column(COL_FSTYPE
);
1906 add_uniq_column(COL_LABEL
);
1907 add_uniq_column(COL_UUID
);
1908 add_uniq_column(COL_FSAVAIL
);
1909 add_uniq_column(COL_FSUSEPERC
);
1910 add_uniq_column(COL_TARGET
);
1913 add_uniq_column(COL_NAME
);
1914 add_uniq_column(COL_SIZE
);
1915 add_uniq_column(COL_OWNER
);
1916 add_uniq_column(COL_GROUP
);
1917 add_uniq_column(COL_MODE
);
1920 add_uniq_column(COL_NAME
);
1921 add_uniq_column(COL_ALIOFF
);
1922 add_uniq_column(COL_MINIO
);
1923 add_uniq_column(COL_OPTIO
);
1924 add_uniq_column(COL_PHYSEC
);
1925 add_uniq_column(COL_LOGSEC
);
1926 add_uniq_column(COL_ROTA
);
1927 add_uniq_column(COL_SCHED
);
1928 add_uniq_column(COL_RQ_SIZE
);
1929 add_uniq_column(COL_RA
);
1930 add_uniq_column(COL_WSAME
);
1935 add_uniq_column(COL_NAME
);
1936 add_uniq_column(COL_HCTL
);
1937 add_uniq_column(COL_TYPE
);
1938 add_uniq_column(COL_VENDOR
);
1939 add_uniq_column(COL_MODEL
);
1940 add_uniq_column(COL_REV
);
1941 add_uniq_column(COL_TRANSPORT
);
1946 lsblk
->tree_id
= column_name_to_id(optarg
, strlen(optarg
));
1949 lsblk
->sysroot
= optarg
;
1952 lsblk
->dedup_id
= column_name_to_id(optarg
, strlen(optarg
));
1953 if (lsblk
->dedup_id
>= 0)
1955 errtryhelp(EXIT_FAILURE
);
1958 lsblk
->flags
&= ~LSBLK_TREE
; /* disable the default */
1959 lsblk
->sort_id
= column_name_to_id(optarg
, strlen(optarg
));
1960 if (lsblk
->sort_id
>= 0)
1962 errtryhelp(EXIT_FAILURE
);
1968 print_version(EXIT_SUCCESS
);
1970 errtryhelp(EXIT_FAILURE
);
1975 lsblk
->flags
|= LSBLK_TREE
;
1977 check_sysdevblock();
1980 add_column(COL_NAME
);
1981 add_column(COL_MAJMIN
);
1983 add_column(COL_SIZE
);
1985 add_column(COL_TYPE
);
1986 add_column(COL_TARGET
);
1989 if (outarg
&& string_add_to_idarray(outarg
, columns
, ARRAY_SIZE(columns
),
1990 &ncolumns
, column_name_to_id
) < 0)
1991 return EXIT_FAILURE
;
1993 if (lsblk
->all_devices
== 0 && nexcludes
== 0 && nincludes
== 0)
1994 excludes
[nexcludes
++] = 1; /* default: ignore RAM disks */
1996 if (lsblk
->sort_id
< 0)
1997 /* Since Linux 4.8 we have sort devices by default, because
1998 * /sys is no more sorted */
1999 lsblk
->sort_id
= COL_MAJMIN
;
2001 /* For --inverse --list we still follow parent->child relation */
2002 if (lsblk
->inverse
&& !(lsblk
->flags
& LSBLK_TREE
))
2003 lsblk
->force_tree_order
= 1;
2005 if (lsblk
->sort_id
>= 0 && column_id_to_number(lsblk
->sort_id
) < 0) {
2006 /* the sort column is not between output columns -- add as hidden */
2007 add_column(lsblk
->sort_id
);
2008 lsblk
->sort_hidden
= 1;
2011 if (lsblk
->dedup_id
>= 0 && column_id_to_number(lsblk
->dedup_id
) < 0) {
2012 /* the deduplication column is not between output columns -- add as hidden */
2013 add_column(lsblk
->dedup_id
);
2014 lsblk
->dedup_hidden
= 1;
2018 scols_init_debug(0);
2019 ul_path_init_debug();
2022 * initialize output columns
2024 if (!(lsblk
->table
= scols_new_table()))
2025 errx(EXIT_FAILURE
, _("failed to allocate output table"));
2026 scols_table_enable_raw(lsblk
->table
, !!(lsblk
->flags
& LSBLK_RAW
));
2027 scols_table_enable_export(lsblk
->table
, !!(lsblk
->flags
& LSBLK_EXPORT
));
2028 scols_table_enable_ascii(lsblk
->table
, !!(lsblk
->flags
& LSBLK_ASCII
));
2029 scols_table_enable_json(lsblk
->table
, !!(lsblk
->flags
& LSBLK_JSON
));
2030 scols_table_enable_noheadings(lsblk
->table
, !!(lsblk
->flags
& LSBLK_NOHEADINGS
));
2032 if (lsblk
->flags
& LSBLK_JSON
)
2033 scols_table_set_name(lsblk
->table
, "blockdevices");
2035 for (i
= 0; i
< ncolumns
; i
++) {
2036 struct colinfo
*ci
= get_column_info(i
);
2037 struct libscols_column
*cl
;
2038 int id
= get_column_id(i
), fl
= ci
->flags
;
2040 if ((lsblk
->flags
& LSBLK_TREE
)
2041 && has_tree_col
== 0
2042 && id
== lsblk
->tree_id
) {
2043 fl
|= SCOLS_FL_TREE
;
2044 fl
&= ~SCOLS_FL_RIGHT
;
2048 if (lsblk
->sort_hidden
&& lsblk
->sort_id
== id
)
2049 fl
|= SCOLS_FL_HIDDEN
;
2050 if (lsblk
->dedup_hidden
&& lsblk
->dedup_id
== id
)
2051 fl
|= SCOLS_FL_HIDDEN
;
2054 && lsblk
->flags
& LSBLK_JSON
2055 && has_tree_col
== 0
2056 && i
+ 1 == ncolumns
)
2057 /* The "--tree --json" specified, but no column with
2058 * SCOLS_FL_TREE yet; force it for the last column
2060 fl
|= SCOLS_FL_TREE
;
2062 cl
= scols_table_new_column(lsblk
->table
, ci
->name
, ci
->whint
, fl
);
2064 warn(_("failed to allocate output column"));
2067 if (!lsblk
->sort_col
&& lsblk
->sort_id
== id
) {
2068 lsblk
->sort_col
= cl
;
2069 scols_column_set_cmpfunc(cl
,
2070 ci
->type
== COLTYPE_NUM
? cmp_u64_cells
:
2071 ci
->type
== COLTYPE_SIZE
? cmp_u64_cells
:
2072 ci
->type
== COLTYPE_SORTNUM
? cmp_u64_cells
: scols_cmpstr_cells
,
2075 if (lsblk
->flags
& LSBLK_JSON
) {
2082 scols_column_set_json_type(cl
, SCOLS_JSON_NUMBER
);
2085 scols_column_set_json_type(cl
, SCOLS_JSON_BOOLEAN
);
2088 scols_column_set_json_type(cl
, SCOLS_JSON_STRING
);
2094 tr
= lsblk_new_devtree();
2096 err(EXIT_FAILURE
, _("failed to allocate device tree"));
2098 if (optind
== argc
) {
2099 int rc
= lsblk
->inverse
?
2100 process_all_devices_inverse(tr
) :
2101 process_all_devices(tr
);
2103 status
= rc
== 0 ? EXIT_SUCCESS
: EXIT_FAILURE
;
2105 int cnt
= 0, cnt_err
= 0;
2107 while (optind
< argc
) {
2108 if (process_one_device(tr
, argv
[optind
++]) != 0)
2112 status
= cnt
== 0 ? EXIT_FAILURE
: /* nothing */
2113 cnt
== cnt_err
? LSBLK_EXIT_ALLFAILED
:/* all failed */
2114 cnt_err
? LSBLK_EXIT_SOMEOK
: /* some ok */
2115 EXIT_SUCCESS
; /* all success */
2118 if (lsblk
->dedup_id
> -1) {
2119 devtree_set_dedupkeys(tr
, lsblk
->dedup_id
);
2120 lsblk_devtree_deduplicate_devices(tr
);
2123 devtree_to_scols(tr
, lsblk
->table
);
2125 if (lsblk
->sort_col
)
2126 scols_sort_table(lsblk
->table
, lsblk
->sort_col
);
2127 if (lsblk
->force_tree_order
)
2128 scols_sort_table_by_tree(lsblk
->table
);
2130 scols_print_table(lsblk
->table
);
2133 if (lsblk
->sort_col
)
2134 unref_sortdata(lsblk
->table
);
2136 scols_unref_table(lsblk
->table
);
2139 lsblk_properties_deinit();
2140 lsblk_unref_devtree(tr
);