[thirdparty/util-linux.git] / misc-utils / lsblk.h

/*
 * Copyright (C) 2010-2018 Red Hat, Inc. All rights reserved.
 * Written by Milan Broz <mbroz@redhat.com>
 *            Karel Zak <kzak@redhat.com>
 */
#ifndef UTIL_LINUX_LSBLK_H
#define UTIL_LINUX_LSBLK_H

#include <stdint.h>
#include <inttypes.h>
#include <sys/stat.h>
#include <sys/statvfs.h>

#include <libsmartcols.h>

#include "c.h"
#include "list.h"
#include "debug.h"

#define LSBLK_DEBUG_INIT	(1 << 1)
#define LSBLK_DEBUG_FILTER	(1 << 2)
#define LSBLK_DEBUG_DEV		(1 << 3)
#define LSBLK_DEBUG_TREE	(1 << 4)
#define LSBLK_DEBUG_DEP		(1 << 5)
#define LSBLK_DEBUG_ALL		0xFFFF

UL_DEBUG_DECLARE_MASK(lsblk);
#define DBG(m, x)       __UL_DBG(lsblk, LSBLK_DEBUG_, m, x)
#define ON_DBG(m, x)    __UL_DBG_CALL(lsblk, LSBLK_DEBUG_, m, x)

#define UL_DEBUG_CURRENT_MASK	UL_DEBUG_MASK(lsblk)
#include "debugobj.h"

struct lsblk {
	struct libscols_table *table;	/* output table */

	struct libscols_column *sort_col;/* sort output by this column */

	int sort_id;			/* id of the sort column */
	int tree_id;			/* od of column used for tree */

	int dedup_id;

	const char *sysroot;
	int flags;			/* LSBLK_* */

	unsigned int all_devices:1;	/* print all devices, including empty */
	unsigned int bytes:1;		/* print SIZE in bytes */
	unsigned int inverse:1;		/* print inverse dependencies */
	unsigned int merge:1;           /* merge sub-trees */
	unsigned int nodeps:1;		/* don't print slaves/holders */
	unsigned int scsi:1;		/* print only device with HCTL (SCSI) */
	unsigned int paths:1;		/* print devnames with "/dev" prefix */
	unsigned int sort_hidden:1;	/* sort column not between output columns */
	unsigned int dedup_hidden :1;	/* deduplication column not between output columns */
	unsigned int force_tree_order:1;/* sort lines by parent->tree relation */
};

extern struct lsblk *lsblk;     /* global handler */

struct lsblk_devprop {
	char *fstype;		/* detected fs, NULL or "?" if cannot detect */
	char *uuid;		/* filesystem UUID (or stack uuid) */
	char *ptuuid;		/* partition table UUID */
	char *pttype;		/* partition table type */
	char *label;		/* filesystem label */
	char *parttype;		/* partition type UUID */
	char *partuuid;		/* partition UUID */
	char *partlabel;	/* partition label */
	char *partflags;	/* partition flags */
	char *wwn;		/* storage WWN */
	char *serial;		/* disk serial number */
	char *model;		/* disk model */
};

/* Device dependence
 *
 * Note that the same device may be slave/holder for more another devices. It
 * means we need to allocate list member rather than use @child directly.
 */
struct lsblk_devdep {
	struct list_head        ls_childs;	/* item in parent->childs */
	struct list_head	ls_parents;	/* item in child->parents */

	struct lsblk_device	*child;
	struct lsblk_device	*parent;
};

struct lsblk_device {
	int	refcount;

	struct list_head	childs;		/* list with lsblk_devdep */
	struct list_head	parents;
	struct list_head	ls_roots;	/* item in devtree->roots list */
	struct list_head	ls_devices;	/* item in devtree->devices list */

	struct lsblk_device	*wholedisk;	/* for partitions */

	struct libscols_line	*scols_line;

	struct lsblk_devprop	*properties;
	struct stat	st;

	char *name;		/* kernel name in /sys/block */
	char *dm_name;		/* DM name (dm/block) */

	char *filename;		/* path to device node */
	char *dedupkey;		/* de-duplication key */

	struct path_cxt	*sysfs;

	char *mountpoint;	/* device mountpoint */
	struct statvfs fsstat;	/* statvfs() result */

	int npartitions;	/* # of partitions this device has */
	int nholders;		/* # of devices mapped directly to this device
				 * /sys/block/.../holders */
	int nslaves;		/* # of devices this device maps to */
	int maj, min;		/* devno */

	uint64_t discard_granularity;	/* sunknown:-1, yes:1, not:0 */

	uint64_t size;		/* device size */
	int removable;		/* unknown:-1, yes:1, not:0 */

	unsigned int	is_mounted : 1,
			is_swap : 1,
			is_printed : 1,
			udev_requested : 1,
			blkid_requested : 1;
};

#define device_is_partition(_x)		((_x)->wholedisk != NULL)

/*
 * Note that lsblk tree uses bottom devices (devices without slaves) as root
 * of the tree, and partitions are interpreted as a dependence too; it means:
 *    sda -> sda1 -> md0
 *
 * The flag 'is_inverted' turns the tree over (root is device without holders):
 *    md0 -> sda1 -> sda
 */
struct lsblk_devtree {
	int	refcount;

	struct list_head	roots;		/* tree root devices */
	struct list_head	devices;	/* all devices */

	unsigned int	is_inverse : 1;		/* inverse tree */
};


/*
 * Generic iterator
 */
struct lsblk_iter {
	struct list_head        *p;		/* current position */
	struct list_head        *head;		/* start position */
	int			direction;	/* LSBLK_ITER_{FOR,BACK}WARD */
};

#define LSBLK_ITER_FORWARD	0
#define LSBLK_ITER_BACKWARD	1

#define IS_ITER_FORWARD(_i)	((_i)->direction == LSBLK_ITER_FORWARD)
#define IS_ITER_BACKWARD(_i)	((_i)->direction == LSBLK_ITER_BACKWARD)

#define LSBLK_ITER_INIT(itr, list) \
	do { \
		(itr)->p = IS_ITER_FORWARD(itr) ? \
				(list)->next : (list)->prev; \
		(itr)->head = (list); \
	} while(0)

#define LSBLK_ITER_ITERATE(itr, res, restype, member) \
	do { \
		res = list_entry((itr)->p, restype, member); \
		(itr)->p = IS_ITER_FORWARD(itr) ? \
				(itr)->p->next : (itr)->p->prev; \
	} while(0)


/* lsblk-mnt.c */
extern void lsblk_mnt_init(void);
extern void lsblk_mnt_deinit(void);

extern char *lsblk_device_get_mountpoint(struct lsblk_device *dev);

/* lsblk-properties.c */
extern void lsblk_device_free_properties(struct lsblk_devprop *p);
extern struct lsblk_devprop *lsblk_device_get_properties(struct lsblk_device *dev);
extern void lsblk_properties_deinit(void);

/* lsblk-devtree.c */
void lsblk_reset_iter(struct lsblk_iter *itr, int direction);
struct lsblk_device *lsblk_new_device(void);
void lsblk_ref_device(struct lsblk_device *dev);
void lsblk_unref_device(struct lsblk_device *dev);
int lsblk_device_new_dependence(struct lsblk_device *parent, struct lsblk_device *child);
int lsblk_device_has_child(struct lsblk_device *dev, struct lsblk_device *child);
int lsblk_device_next_child(struct lsblk_device *dev,
                          struct lsblk_iter *itr,
                          struct lsblk_device **child);

int lsblk_device_is_last_parent(struct lsblk_device *dev, struct lsblk_device *parent);
int lsblk_device_next_parent(
                        struct lsblk_device *dev,
                        struct lsblk_iter *itr,
                        struct lsblk_device **parent);

struct lsblk_devtree *lsblk_new_devtree(void);
void lsblk_ref_devtree(struct lsblk_devtree *tr);
void lsblk_unref_devtree(struct lsblk_devtree *tr);
int lsblk_devtree_add_root(struct lsblk_devtree *tr, struct lsblk_device *dev);
int lsblk_devtree_next_root(struct lsblk_devtree *tr,
                            struct lsblk_iter *itr,
                            struct lsblk_device **dev);
int lsblk_devtree_add_device(struct lsblk_devtree *tr, struct lsblk_device *dev);
int lsblk_devtree_next_device(struct lsblk_devtree *tr,
                            struct lsblk_iter *itr,
                            struct lsblk_device **dev);
int lsblk_devtree_has_device(struct lsblk_devtree *tr, struct lsblk_device *dev);
struct lsblk_device *lsblk_devtree_get_device(struct lsblk_devtree *tr, const char *name);
int lsblk_devtree_remove_device(struct lsblk_devtree *tr, struct lsblk_device *dev);
int lsblk_devtree_deduplicate_devices(struct lsblk_devtree *tr);

#endif /* UTIL_LINUX_LSBLK_H */
Commit	Line	Data
14560b7f KZ	1	/*
	2	* Copyright (C) 2010-2018 Red Hat, Inc. All rights reserved.
	3	* Written by Milan Broz <mbroz@redhat.com>
	4	* Karel Zak <kzak@redhat.com>
	5	*/
	6	#ifndef UTIL_LINUX_LSBLK_H
	7	#define UTIL_LINUX_LSBLK_H
	8
	9	#include <stdint.h>
	10	#include <inttypes.h>
6529212d	11	#include <sys/stat.h>
14560b7f KZ	12	#include <sys/statvfs.h>
	13
	14	#include <libsmartcols.h>
	15
	16	#include "c.h"
5bb395f4	17	#include "list.h"
14560b7f KZ	18	#include "debug.h"
	19
	20	#define LSBLK_DEBUG_INIT (1 << 1)
	21	#define LSBLK_DEBUG_FILTER (1 << 2)
	22	#define LSBLK_DEBUG_DEV (1 << 3)
3bf2a36c	23	#define LSBLK_DEBUG_TREE (1 << 4)
0986f29a	24	#define LSBLK_DEBUG_DEP (1 << 5)
14560b7f KZ	25	#define LSBLK_DEBUG_ALL 0xFFFF
	26
	27	UL_DEBUG_DECLARE_MASK(lsblk);
	28	#define DBG(m, x) __UL_DBG(lsblk, LSBLK_DEBUG_, m, x)
	29	#define ON_DBG(m, x) __UL_DBG_CALL(lsblk, LSBLK_DEBUG_, m, x)
	30
	31	#define UL_DEBUG_CURRENT_MASK UL_DEBUG_MASK(lsblk)
	32	#include "debugobj.h"
	33
	34	struct lsblk {
	35	struct libscols_table table; / output table */
dc4662f0	36
14560b7f	37	struct libscols_column sort_col;/ sort output by this column */
b9c088f2 KZ	38
	39	int sort_id; /* id of the sort column */
	40	int tree_id; /* od of column used for tree */
14560b7f	41
dc4662f0 KZ	42	int dedup_id;
dc4662f0 KZ	43
14560b7f KZ	44	const char *sysroot;
	45	int flags; /* LSBLK_* */
	46
	47	unsigned int all_devices:1; /* print all devices, including empty */
	48	unsigned int bytes:1; /* print SIZE in bytes */
	49	unsigned int inverse:1; /* print inverse dependencies */
0bd05f5e	50	unsigned int merge:1; /* merge sub-trees */
14560b7f KZ	51	unsigned int nodeps:1; /* don't print slaves/holders */
	52	unsigned int scsi:1; /* print only device with HCTL (SCSI) */
	53	unsigned int paths:1; /* print devnames with "/dev" prefix */
	54	unsigned int sort_hidden:1; /* sort column not between output columns */
dc4662f0	55	unsigned int dedup_hidden :1; /* deduplication column not between output columns */
14560b7f KZ	56	unsigned int force_tree_order:1;/* sort lines by parent->tree relation */
	57	};
	58
	59	extern struct lsblk lsblk; / global handler */
	60
baad6dcc KZ	61	struct lsblk_devprop {
	62	char fstype; / detected fs, NULL or "?" if cannot detect */
	63	char uuid; / filesystem UUID (or stack uuid) */
	64	char ptuuid; / partition table UUID */
	65	char pttype; / partition table type */
	66	char label; / filesystem label */
	67	char parttype; / partition type UUID */
	68	char partuuid; / partition UUID */
	69	char partlabel; / partition label */
	70	char partflags; / partition flags */
	71	char wwn; / storage WWN */
	72	char serial; / disk serial number */
	73	char model; / disk model */
	74	};
	75
5bb395f4 KZ	76	/* Device dependence
	77	*
	78	* Note that the same device may be slave/holder for more another devices. It
	79	* means we need to allocate list member rather than use @child directly.
	80	*/
	81	struct lsblk_devdep {
0986f29a KZ	82	struct list_head ls_childs; /* item in parent->childs */
	83	struct list_head ls_parents; /* item in child->parents */
	84
5bb395f4	85	struct lsblk_device *child;
0986f29a	86	struct lsblk_device *parent;
5bb395f4 KZ	87	};
5bb395f4 KZ	88
fed34a1e	89	struct lsblk_device {
5bb395f4 KZ	90	int refcount;
5bb395f4 KZ	91
0986f29a KZ	92	struct list_head childs; /* list with lsblk_devdep */
0986f29a KZ	93	struct list_head parents;
5bb395f4 KZ	94	struct list_head ls_roots; /* item in devtree->roots list */
5bb395f4 KZ	95	struct list_head ls_devices; /* item in devtree->devices list */
14560b7f	96
10501add	97	struct lsblk_device wholedisk; / for partitions */
5bb395f4	98
0bd05f5e KZ	99	struct libscols_line *scols_line;
0bd05f5e KZ	100
5bb395f4	101	struct lsblk_devprop *properties;
14560b7f KZ	102	struct stat st;
	103
	104	char name; / kernel name in /sys/block */
	105	char dm_name; / DM name (dm/block) */
	106
	107	char filename; / path to device node */
dc4662f0	108	char dedupkey; / de-duplication key */
14560b7f KZ	109
	110	struct path_cxt *sysfs;
	111
14560b7f KZ	112	char mountpoint; / device mountpoint */
	113	struct statvfs fsstat; /* statvfs() result */
	114
	115	int npartitions; /* # of partitions this device has */
	116	int nholders; /* # of devices mapped directly to this device
	117	* /sys/block/.../holders */
	118	int nslaves; /* # of devices this device maps to */
	119	int maj, min; /* devno */
8a2f175c KZ	120
8a2f175c KZ	121	uint64_t discard_granularity; /* sunknown:-1, yes:1, not:0 */
14560b7f KZ	122
14560b7f KZ	123	uint64_t size; /* device size */
81a8936c	124	int removable; /* unknown:-1, yes:1, not:0 */
14560b7f	125
82dae67d	126	unsigned int is_mounted : 1,
baad6dcc	127	is_swap : 1,
0bd05f5e	128	is_printed : 1,
baad6dcc KZ	129	udev_requested : 1,
baad6dcc KZ	130	blkid_requested : 1;
14560b7f KZ	131	};
14560b7f KZ	132
10501add	133	#define device_is_partition(_x) ((_x)->wholedisk != NULL)
5bb395f4 KZ	134
5bb395f4 KZ	135	/*
11026083	136	* Note that lsblk tree uses bottom devices (devices without slaves) as root
5bb395f4 KZ	137	* of the tree, and partitions are interpreted as a dependence too; it means:
	138	* sda -> sda1 -> md0
	139	*
	140	* The flag 'is_inverted' turns the tree over (root is device without holders):
	141	* md0 -> sda1 -> sda
	142	*/
	143	struct lsblk_devtree {
	144	int refcount;
	145
	146	struct list_head roots; /* tree root devices */
	147	struct list_head devices; /* all devices */
	148
	149	unsigned int is_inverse : 1; /* inverse tree */
	150	};
	151
	152
	153	/*
	154	* Generic iterator
	155	*/
	156	struct lsblk_iter {
	157	struct list_head p; / current position */
	158	struct list_head head; / start position */
	159	int direction; /* LSBLK_ITER_{FOR,BACK}WARD */
	160	};
	161
	162	#define LSBLK_ITER_FORWARD 0
	163	#define LSBLK_ITER_BACKWARD 1
	164
	165	#define IS_ITER_FORWARD(_i) ((_i)->direction == LSBLK_ITER_FORWARD)
	166	#define IS_ITER_BACKWARD(_i) ((_i)->direction == LSBLK_ITER_BACKWARD)
	167
	168	#define LSBLK_ITER_INIT(itr, list) \
	169	do { \
	170	(itr)->p = IS_ITER_FORWARD(itr) ? \
	171	(list)->next : (list)->prev; \
	172	(itr)->head = (list); \
	173	} while(0)
	174
	175	#define LSBLK_ITER_ITERATE(itr, res, restype, member) \
	176	do { \
	177	res = list_entry((itr)->p, restype, member); \
	178	(itr)->p = IS_ITER_FORWARD(itr) ? \
	179	(itr)->p->next : (itr)->p->prev; \
	180	} while(0)
	181
	182
04be258d	183	/* lsblk-mnt.c */
e0c016f1 KZ	184	extern void lsblk_mnt_init(void);
	185	extern void lsblk_mnt_deinit(void);
	186
fed34a1e	187	extern char lsblk_device_get_mountpoint(struct lsblk_device dev);
cfb715ed	188
ccafadb7 KZ	189	/* lsblk-properties.c */
ccafadb7 KZ	190	extern void lsblk_device_free_properties(struct lsblk_devprop *p);
fed34a1e	191	extern struct lsblk_devprop lsblk_device_get_properties(struct lsblk_device dev);
ccafadb7 KZ	192	extern void lsblk_properties_deinit(void);
ccafadb7 KZ	193
5bb395f4 KZ	194	/* lsblk-devtree.c */
5bb395f4 KZ	195	void lsblk_reset_iter(struct lsblk_iter *itr, int direction);
10501add	196	struct lsblk_device *lsblk_new_device(void);
5bb395f4 KZ	197	void lsblk_ref_device(struct lsblk_device *dev);
5bb395f4 KZ	198	void lsblk_unref_device(struct lsblk_device *dev);
e2d7870b	199	int lsblk_device_new_dependence(struct lsblk_device parent, struct lsblk_device child);
0986f29a	200	int lsblk_device_has_child(struct lsblk_device dev, struct lsblk_device child);
5bb395f4 KZ	201	int lsblk_device_next_child(struct lsblk_device *dev,
	202	struct lsblk_iter *itr,
	203	struct lsblk_device **child);
	204
0bd05f5e KZ	205	int lsblk_device_is_last_parent(struct lsblk_device dev, struct lsblk_device parent);
	206	int lsblk_device_next_parent(
	207	struct lsblk_device *dev,
	208	struct lsblk_iter *itr,
	209	struct lsblk_device **parent);
	210
5bb395f4 KZ	211	struct lsblk_devtree *lsblk_new_devtree(void);
	212	void lsblk_ref_devtree(struct lsblk_devtree *tr);
	213	void lsblk_unref_devtree(struct lsblk_devtree *tr);
	214	int lsblk_devtree_add_root(struct lsblk_devtree tr, struct lsblk_device dev);
	215	int lsblk_devtree_next_root(struct lsblk_devtree *tr,
	216	struct lsblk_iter *itr,
	217	struct lsblk_device **dev);
	218	int lsblk_devtree_add_device(struct lsblk_devtree tr, struct lsblk_device dev);
	219	int lsblk_devtree_next_device(struct lsblk_devtree *tr,
	220	struct lsblk_iter *itr,
	221	struct lsblk_device **dev);
21d4a48c	222	int lsblk_devtree_has_device(struct lsblk_devtree tr, struct lsblk_device dev);
5bb395f4	223	struct lsblk_device lsblk_devtree_get_device(struct lsblk_devtree tr, const char *name);
21d4a48c	224	int lsblk_devtree_remove_device(struct lsblk_devtree tr, struct lsblk_device dev);
dc4662f0	225	int lsblk_devtree_deduplicate_devices(struct lsblk_devtree *tr);
5bb395f4	226
14560b7f	227	#endif /* UTIL_LINUX_LSBLK_H */