busybox df命令详细分析

本文基于busybox1.34.0版本 对df命令分析
下面是df命令用法

源码分析

#include <mntent.h>
#include <sys/statvfs.h>
#include "libbb.h"
#include "unicode.h"

#if !ENABLE_FEATURE_HUMAN_READABLE
static unsigned long kscale(unsigned long b, unsigned long bs)
{
	return (b * (unsigned long long) bs + 1024/2) / 1024;
}
#endif

int df_main(int argc, char **argv) MAIN_EXTERNALLY_VISIBLE;
int df_main(int argc UNUSED_PARAM, char **argv)
{
	unsigned long df_disp_hr = 1024;//默认情况下，磁盘空间以1K块显示。
	int status = EXIT_SUCCESS;
	unsigned opt;//保存标志值
	FILE *mount_table;//挂载文件
	struct mntent *mount_entry;//挂载入口（挂载表条目结构体）
	/*描述装载表条目的结构*/
	//struct mntent
	//{
	//	char *mnt_fsname;   /* 挂载文件系统的名称  */
	//	char *mnt_dir;      /*文件系统路径前缀  */
	//	char *mnt_type;     /* 挂载的文件系统类型: ufs, nfs等  */
	//	char *mnt_opts;     /*挂载选项  */
	//	int mnt_freq;       /* 以天为单位的转存频率  */
	//	int mnt_passno;     /* 并行fsck上的传递数字  */
	//};
	struct statvfs s;
	enum {//定义不同选项，根据输入选项内容解析处标志值与这个定义的选项进行比对进而设置输出内容
		OPT_KILO   = (1 << 0),//没意义
		OPT_POSIX  = (1 << 1),//df -P POSIX输出格式显示
		OPT_FSTYPE = (1 << 2),//df -T显示文件系统类型。
		OPT_t      = (1 << 3),//df -m 1M字节块显示
		OPT_ALL    = (1 << 4) * ENABLE_FEATURE_DF_FANCY,//df -a显示所有文件系统
		OPT_INODE  = (1 << 5) * ENABLE_FEATURE_DF_FANCY,//df -i显示inode信息而非块使用量。
		OPT_BSIZE  = (1 << 6) * ENABLE_FEATURE_DF_FANCY,//df -B根据用户输入块大小显示
		OPT_HUMAN  = (1 << (4 + 3*ENABLE_FEATURE_DF_FANCY)) * ENABLE_FEATURE_HUMAN_READABLE,//df -h  以容易理解的格式印出文件系统大小，例如136KB、254MB、21GB。
		OPT_MEGA   = (1 << (5 + 3*ENABLE_FEATURE_DF_FANCY)) * ENABLE_FEATURE_HUMAN_READABLE,//df -k以1024字节为单位列出磁盘空间使用情况。
	};
	const char *disp_units_hdr = NULL;//要显示选项名称字符指针
	char *chp, *opt_t;

	init_unicode();

	/* From the manpage of df from coreutils-6.10:
	 * Disk space is shown in 1K blocks by default, unless the environment
	 * variable POSIXLY_CORRECT is set, in which case 512-byte blocks are used.
	 */
	 /*从coreutils-6.10的df手册页：
	  *默认情况下，磁盘空间以1K块显示，除非环境
	  *设置变量POSIXLY_CORRECT，在这种情况下使用512字节块。
	 */
	if (getenv("POSIXLY_CORRECT")) /* TODO - a new libbb function? */  /*TODO-一个新的libbb函数*/
		df_disp_hr = 512;//要显示的长度

	opt = getopt32(argv, "^"
			"kPTt:"
			IF_FEATURE_DF_FANCY("aiB:")
			IF_FEATURE_HUMAN_READABLE("hm")
			"\0"
#if ENABLE_FEATURE_HUMAN_READABLE && ENABLE_FEATURE_DF_FANCY
			"k-mB:m-Bk:B-km"
#elif ENABLE_FEATURE_HUMAN_READABLE
			"k-m:m-k"
#endif
			, &opt_t
			IF_FEATURE_DF_FANCY(, &chp)
	);//根据输入不同的命令返回一个标志值
	if (opt & OPT_MEGA)//df -k以1024字节为单位列出磁盘空间使用情况。
		df_disp_hr = 1024*1024;//要显示的长度1024字节

	if (opt & OPT_BSIZE) {//df -B根据用户输入块大小显示
		/* GNU coreutils 8.25 accepts "-BMiB" form too */
		/*GNU更正8.25接受“-BMiB”表格所有*/
		int i;
		for (i = 0; kmg_i_suffixes[i].suffix[0]; i++) {//解析用户输入值并设置好显示长度
			if (strcmp(kmg_i_suffixes[i].suffix, chp) == 0) {
				df_disp_hr = kmg_i_suffixes[i].mult;
				goto got_it;
			}
		}
		/* Range used to disallow 0 */
		/*用于禁止0的范围*/
		df_disp_hr = xatoul_range_sfx(chp, 1, ULONG_MAX, kmg_i_suffixes);
 got_it: ;
	}

	if (opt & OPT_HUMAN) {//df -h  以容易理解的格式印出文件系统大小，例如136KB、254MB、21GB。
		df_disp_hr = 0;//这种方式不需要调整输出长度（每块的大小）
		disp_units_hdr = "     Size";
	}
	if (opt & OPT_INODE)//df -i显示inode信息而非块使用量。
		disp_units_hdr = "   Inodes";

	if (disp_units_hdr == NULL) {//df 如果要显示的类型未定义，选项也没有设置，那么显示原始类型块使用量
#if ENABLE_FEATURE_HUMAN_READABLE
		disp_units_hdr = xasprintf("%s-blocks",
			/* print df_disp_hr, show no fractionals,
			 * use suffixes if OPT_POSIX is set in opt */
			 /*打印df_disp_hr，不显示分数，
			  *如果在OPT中设置了OPT_POSIX，则使用后缀*/
			make_human_readable_str(df_disp_hr, 0, !!(opt & OPT_POSIX))
		);
#else
		disp_units_hdr = xasprintf("%lu-blocks", df_disp_hr);//按照1024k/块显示
#endif
	}

	printf("Filesystem           %s%-15sUsed Available %s Mounted on\n",
			(opt & OPT_FSTYPE) ? "Type       " : "",//df -T显示文件系统类型。
			disp_units_hdr,
			(opt & OPT_POSIX) ? "Capacity" : "Use%");//df -P POSIX输出格式显示

	mount_table = NULL;
	argv += optind;
	if (!argv[0]) {//如果没有设置参数
		mount_table = setmntent(bb_path_mtab_file, "r");//Busybox装载使用/proc/mounts或/etc/mtab获取当前装入的文件系统的列表
		if (!mount_table)
			bb_simple_perror_msg_and_die(bb_path_mtab_file);//没获取到mount_table，把错误信息写到perror并退出
	}

	while (1) {
		const char *device;
		const char *mount_point;
		const char *fs_type;

		if (mount_table) {//如果没有设置参数//所以mount_table不为空
			mount_entry = getmntent(mount_table);//从文件系统列表中解析挂载入口
			//得到mount_entry（挂载表条目信息）
			if (!mount_entry) {//解析失败
				endmntent(mount_table);//关闭流和与其相关联的文件系统描述文件
				break;
			}
		} else {
			mount_point = *argv++;//解析成功根据用户输入的位置解析挂载点得到挂载入口
			if (!mount_point)
				break;
			mount_entry = find_mount_point(mount_point, 1);
			if (!mount_entry) {
				bb_error_msg("%s: can't find mount point", mount_point);
 set_error:
				status = EXIT_FAILURE;
				continue;
			}
		}

		device = mount_entry->mnt_fsname;//device挂载文件系统的名称

		/* GNU coreutils 6.10 skips certain mounts, try to be compatible */
		/*GNU coreutils 6.10跳过某些挂载，尝试兼容*/
		if (ENABLE_FEATURE_SKIP_ROOTFS && strcmp(device, "rootfs") == 0)
			continue;

		mount_point = mount_entry->mnt_dir;//mount_point文件系统路径前缀
		fs_type = mount_entry->mnt_type;//fs_type挂载的文件系统类型: ufs, nfs等  

		if (opt & OPT_t) {//df -m 1M字节块显示
			if (strcmp(fs_type, opt_t) != 0)
				continue;
		}

		if (statvfs(mount_point, &s) != 0) {//得到mount_point路径下文件目录的大小存到s结构体中，用于计算总/可用/使用/有效容量
			bb_simple_perror_msg(mount_point);
			goto set_error;
		}
		/* Some uclibc versions were seen to lose f_frsize
		 * (kernel does return it, but then uclibc does not copy it)
		 */
		 /*一些uclibc版本被视为丢失了f_frsize大小
		  *（内核会返回它，但uclibc不会复制它）
		  */
		if (s.f_frsize == 0)
			s.f_frsize = s.f_bsize;//获取一个block的大小

		if ((s.f_blocks > 0) || !mount_table || (opt & OPT_ALL)) {//df -a显示所有文件系统
			unsigned long long blocks_used;
			unsigned long long blocks_total;
			unsigned blocks_percent_used;

			if (opt & OPT_INODE) {//df -i显示inode信息而非块使用量。
				s.f_blocks = s.f_files;
				s.f_bavail = s.f_bfree = s.f_ffree;//可用容量
				s.f_frsize = 1;
				if (df_disp_hr)
					df_disp_hr = 1;
			}
			blocks_used = s.f_blocks - s.f_bfree;//获取使用容量
			blocks_total = blocks_used + s.f_bavail;//获取总容量（可用+已用）
			blocks_percent_used = blocks_total; // 0% if blocks_total == 0, else... 使用率初始化 
			if (blocks_total != 0) {
				/* Downscale sizes for narrower division */
				/*缩小尺寸以缩小划分范围*/
				unsigned u;
				while (blocks_total >= INT_MAX / 101) {
					blocks_total >>= 1;
					blocks_used >>= 1;
				}
				u = (unsigned)blocks_used * 100u + (unsigned)blocks_total / 2;
				blocks_percent_used = u / (unsigned)blocks_total;//获取使用率
			}
//WHY_WE_DO_IT_FOR_DEV_ROOT_ONLY为什么我们只为开发者而做
#ifdef WHY_WE_DO_IT_FOR_DEV_ROOT_ONLY
			if (strcmp(device, "/dev/root") == 0) {
				/* Adjusts device to be the real root device,
				 * or leaves device alone if it can't find it */
				 /*将设备调整为实际根设备，
					或者，如果设备找不到它，
					就让它单独呆着*/
				device = find_block_device("/");
				if (!device) {
					goto set_error;
				}
			}
#endif
//启用UNICODE支持
#if ENABLE_UNICODE_SUPPORT
			{
				uni_stat_t uni_stat;
				char *uni_dev = unicode_conv_to_printable(&uni_stat, device);//转换成unicode形式
				if (uni_stat.unicode_width > 20 && !(opt & OPT_POSIX)) {
					printf("%s\n%20s", uni_dev, "");
				} else {
					printf("%s%*s", uni_dev, 20 - (int)uni_stat.unicode_width, "");//打印挂载文件系统的名称（unicode）
				}
				free(uni_dev);
				if (opt & OPT_FSTYPE) {//df -T显示文件系统类型。
					char *uni_type = unicode_conv_to_printable(&uni_stat, fs_type);
					if (uni_stat.unicode_width > 10 && !(opt & OPT_POSIX))
						printf(" %s\n%31s", uni_type, "");
					else
						printf(" %s%*s", uni_type, 10 - (int)uni_stat.unicode_width, "");//打印fs_type挂载的文件系统类型: ufs, nfs等（unicode）
					free(uni_type);
				}
			}
#else
			if (printf("\n%-20s" + 1, device) > 20 && !(opt & OPT_POSIX))//打印挂载文件系统的名称
				printf("\n%-20s", "");
			if (opt & OPT_FSTYPE) {//df -T显示文件系统类型。
				if (printf(" %-10s", fs_type) > 11 && !(opt & OPT_POSIX))//打印fs_type挂载的文件系统类型: ufs, nfs等  
					printf("\n%-30s", "");
			}
#endif
//启用用户可读功能
#if ENABLE_FEATURE_HUMAN_READABLE
			printf(" %9s ",
				/* f_blocks x f_frsize / df_disp_hr, show one fractional,
				 * use suffixes if df_disp_hr == 0 */
				make_human_readable_str(s.f_blocks, s.f_frsize, df_disp_hr));

			printf(" %9s " + 1,
				/* EXPR x f_frsize / df_disp_hr, show one fractional,
				 * use suffixes if df_disp_hr == 0 */
				make_human_readable_str((s.f_blocks - s.f_bfree),
						s.f_frsize, df_disp_hr));

			printf("%9s %3u%% %s\n",
				/* f_bavail x f_frsize / df_disp_hr, show one fractional,
				 * use suffixes if df_disp_hr == 0 */
				make_human_readable_str(s.f_bavail, s.f_frsize, df_disp_hr),
				blocks_percent_used, mount_point);
#else
			printf(" %9lu %9lu %9lu %3u%% %s\n",
				kscale(s.f_blocks, s.f_frsize),
				kscale(s.f_blocks - s.f_bfree, s.f_frsize),
				kscale(s.f_bavail, s.f_frsize),
				blocks_percent_used, mount_point);
#endif
		}
	}

	return status;
}