logo

utils-std

Collection of commonly available Unix tools git clone https://anongit.hacktivis.me/git/utils-std.git/

df.c (11770B)

    

  1. // utils-std: Collection of commonly available Unix tools
  2. // SPDX-FileCopyrightText: 2017 Haelwenn (lanodan) Monnier <contact+utils@hacktivis.me>
  3. // SPDX-License-Identifier: MPL-2.0
  5. #define _POSIX_C_SOURCE 202405L
  6. #define _DEFAULT_SOURCE // mntent in glibc 2.19+
  8. #include "../config.h"
  9. #include "../lib/reallocarray.h"
  10. #include "../libutils/getopt_nolong.h"
  11. #include "../libutils/humanize.h"
  13. #include <ctype.h> // iscntrl, isspace
  14. #include <errno.h> // errno
  15. #include <mntent.h>
  16. #include <stdbool.h>
  17. #include <stdio.h>    // printf
  18. #include <stdlib.h>   // abort, exit
  19. #include <string.h>   // strerror
  20. #include <sys/stat.h> // stat, dev_t
  21. #include <sys/statvfs.h>
  22. #include <unistd.h> // getopt
  23. #ifdef HAS_GETOPT_LONG
  24. #include <getopt.h>
  25. #endif
  27. #define STR(s) #s
  29. /*
  30.  * Rough idea of builtin filesystems in Linux 6.12.31:
  31.  * $ grep -RI '\bregister_filesystem(' /usr/src/linux/fs/ | wc -l
  32.  * 79
  33.  */
  34. #define DF_MNT_TYPE_MAX 128
  36. // Grabbed from OpenRC rc-functions.sh
  37. // clang-format off
  38. static const char *net_fs_list[] = {
  39. 	"afs", "ceph", "cifs", "coda", "davfs", "fuse", "fuse.glusterfs",
  40. 	"fuse.sshfs", "gfs", "glusterfs", "lustre", "ncpfs", "nfs", "nfs4",
  41. 	"ocfs2", "shfs", "smbfs"
  42. };
  43. // clang-format on
  45. blksize_t forced_bsize = 0;
  46. const char *argv0 = "df";
  48. // Replaces control characters and whitespaces with '?' in-place (no allocation)
  49. static void
  50. static_escape(char *str)
  51. {
  52. 	for(size_t i = 0; i < strlen(str); i++)
  53. 		if(iscntrl(str[i]) || isspace(str[i])) str[i] = '?';
  54. }
  56. int
  57. main(int argc, char *argv[])
  58. {
  59. 	bool opt_P = false, opt_h = false, opt_a = false, opt_T = false, opt_l = false, opt_i = false;
  60. 	int fs_col_width = 20;
  61. 	dev_t *devices = NULL;
  63. 	size_t excluded_count = 0;
  64. 	static char *excluded[DF_MNT_TYPE_MAX];
  66. 	size_t only_count = 0;
  67. 	static char *only[DF_MNT_TYPE_MAX];
  69. #ifdef HAS_GETOPT_LONG
  70. 	// Strictly for GNUisms compatibility so no long-only options
  71. 	// clang-format off
  72. 	static struct option opts[] = {
  73. 		{"all", no_argument, NULL, 'a'},
  74. 		{"human-readable", no_argument, NULL, 'h'},
  75. 		{"inodes", no_argument, NULL, 'i'},
  76. 		{"local", no_argument, NULL, 'l'},
  77. 		{"portability", no_argument, NULL, 'P'},
  78. 		{"type", required_argument, NULL, 't'},
  79. 		{"exclude-type", required_argument, NULL, 'x'},
  80. 		{0, 0, 0, 0},
  81. 	};
  82. 	// clang-format on
  84. 	// Need + as first character to get POSIX-style option parsing
  85. 	for(int c = -1; (c = getopt_long(argc, argv, "+:ahilPkTt:x:", opts, NULL)) != -1;)
  86. #else
  87. 	for(int c = -1; (c = getopt_nolong(argc, argv, ":ahilPkTt:x:")) != -1;)
  88. #endif
  89. 	{
  90. 		switch(c)
  91. 		{
  92. 		case 'a':
  93. 			opt_a = true;
  94. 			break;
  95. 		case 'P':
  96. 			if(forced_bsize == 0) forced_bsize = 512;
  98. 			opt_P = true;
  99. 			break;
  100. 		case 'k':
  101. 			forced_bsize = 1024;
  102. 			break;
  103. 		case 'h':
  104. 			opt_h = true;
  105. 			fs_col_width = 30;
  106. 			break;
  107. 		case 'i':
  108. 			opt_i = true;
  109. 			break;
  110. 		case 'l':
  111. 			opt_l = true;
  112. 			break;
  113. 		case 'T':
  114. 			opt_T = true;
  115. 			break;
  116. 		case 't':
  117. 			if(only_count >= (DF_MNT_TYPE_MAX - 1))
  118. 			{
  119. 				fprintf(
  120. 				    stderr,
  121. 				    "%s: error: Can only select up to " STR(DF_MNT_TYPE_MAX) " mnt_types via option `-t`\n",
  122. 				    argv0);
  123. 				return 1;
  124. 			}
  126. 			only[only_count++] = optarg;
  127. 			break;
  128. 		case 'x':
  129. 			if(excluded_count >= (DF_MNT_TYPE_MAX - 1))
  130. 			{
  131. 				fprintf(
  132. 				    stderr,
  133. 				    "%s: error: Can only select up to " STR(DF_MNT_TYPE_MAX) " mnt_types via option `-x`\n",
  134. 				    argv0);
  135. 				return 1;
  136. 			}
  138. 			excluded[excluded_count++] = optarg;
  139. 			break;
  140. 		case ':':
  141. 			fprintf(stderr, "%s: error: Missing operand for option: '-%c'\n", argv0, optopt);
  142. 			return 1;
  143. 		case '?':
  144. 			GETOPT_UNKNOWN_OPT
  145. 			return 1;
  146. 		}
  147. 	}
  149. 	if(opt_P && opt_T)
  150. 	{
  151. 		fprintf(stderr, "%s: error: Options -P and -T are incompatible\n", argv0);
  152. 		return 1;
  153. 	}
  155. 	if(opt_P) opt_h = false;
  157. 	argc -= optind;
  158. 	argv += optind;
  160. 	int args_left = argc != 0 ? argc : 1;
  162. 	bool tty_out = isatty(1);
  163. 	int col_width = tty_out ? 10 : 0;
  165. 	if(!tty_out)
  166. 	{
  167. 		errno = 0;
  168. 		fs_col_width = 0;
  169. 	}
  171. 	dev_t *arg_devs = NULL;
  173. 	if(argc > 0)
  174. 	{
  175. 		arg_devs = calloc(argc, sizeof(dev_t));
  176. 		if(arg_devs == NULL)
  177. 		{
  178. 			fprintf(stderr, "%s: error: Failed to allocate arg_devs array: %s\n", argv0, strerror(errno));
  179. 			return 1;
  180. 		}
  181. 	}
  183. 	for(int i = 0; i < argc; i++)
  184. 	{
  185. 		struct stat file_stats;
  186. 		if(stat(argv[i], &file_stats) != 0)
  187. 		{
  188. 			fprintf(stderr,
  189. 			        "%s: error: Failed getting status for file '%s': %s\n",
  190. 			        argv0,
  191. 			        argv[i],
  192. 			        strerror(errno));
  193. 			goto error;
  194. 		}
  196. 		arg_devs[i] = file_stats.st_dev;
  197. 	}
  199. 	// Begin: Print header
  201. 	printf("%-*s ", fs_col_width, "Filesystem");
  203. 	if(opt_T) printf("%*s ", col_width, "Type");
  205. 	if(opt_i)
  206. 	{
  207. 		printf("%*s %*s %*s ", col_width, "Inodes", col_width, "Iused", col_width, "IFree");
  209. 		if(opt_P)
  210. 			printf("IUse%% Mounted on\n");
  211. 		else
  212. 			printf("IUse%% Mountpoint\n");
  213. 	}
  214. 	else
  215. 	{
  216. 		// cast to (long int) as POSIX.1-2024 defines blksize_t as signed
  217. 		// integer no longer than `long`
  218. 		if(forced_bsize != 0)
  219. 			printf("%ld-blocks ", (long int)forced_bsize);
  220. 		else
  221. 			printf("%*s ", col_width, "Total");
  223. 		printf("%*s %*s ", col_width, "Used", col_width, "Available");
  225. 		if(opt_P)
  226. 			printf("Capacity Mounted on\n");
  227. 		else
  228. 			printf("Use%% Mountpoint\n");
  229. 	}
  230. 	// End: Print header
  232. 	FILE *mounted = setmntent(MOUNTED, "r");
  233. 	if(mounted == NULL)
  234. 	{
  235. 		fprintf(stderr,
  236. 		        "%s: error: Failed opening setmntent(\"" MOUNTED "\", \"r\"): %s\n",
  237. 		        argv0,
  238. 		        strerror(errno));
  239. 		goto error;
  240. 	}
  242. 	// Linux has a configurable limit of maximum mounts which defaults to 100_000
  243. 	// See /proc/sys/fs/mount-max introduced in Linux 4.9 for CVE-2016-6213
  244. 	// https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git/commit/?id=d29216842a85c7970c536108e093963f02714498
  245. 	//
  246. 	// Which is way too much to be either stack-allocated or statically allocated:
  247. 	// 100000*sizeof(dev_t) = 100000*8 bytes ≈ 781.25 KiB
  248. 	// So reallocarray to the rescue
  249. 	size_t devices_found = 0;
  250. 	size_t devices_len = 100;
  251. 	devices = reallocarray(NULL, devices_len, sizeof(dev_t));
  252. 	if(!devices)
  253. 	{
  254. 		fprintf(stderr,
  255. 		        "%s: error: Failed to allocate memory for storing (%zd) devices: %s\n",
  256. 		        argv0,
  257. 		        devices_len,
  258. 		        strerror(errno));
  259. 		goto error;
  260. 	}
  262. 	// Even with argc>0 we still need to go over mntent for the filesystem mountpoint and type
  263. 	while(args_left > 0)
  264. 	{
  265. 		struct mntent *mntent = getmntent(mounted);
  266. 		if(mntent == NULL) break;
  268. 		if(excluded_count > 0)
  269. 		{
  270. 			bool exclude = false;
  272. 			for(size_t i = 0; i < excluded_count; i++)
  273. 				if(strcmp(excluded[i], mntent->mnt_type) == 0)
  274. 				{
  275. 					exclude = true;
  276. 					break;
  277. 				}
  279. 			if(exclude) continue;
  280. 		}
  282. 		if(only_count > 0)
  283. 		{
  284. 			bool include = false;
  286. 			for(size_t i = 0; i < only_count; i++)
  287. 				if(strcmp(only[i], mntent->mnt_type) == 0)
  288. 				{
  289. 					include = true;
  290. 					break;
  291. 				}
  293. 			if(!include) continue;
  294. 		}
  296. 		if(opt_l)
  297. 		{
  298. 			bool remote = false;
  300. 			for(size_t i = 0; i < sizeof(net_fs_list) / sizeof(char *); i++)
  301. 				if(strcmp(net_fs_list[i], mntent->mnt_type) == 0)
  302. 				{
  303. 					remote = true;
  304. 					break;
  305. 				}
  307. 			if(remote) continue;
  308. 		}
  310. 		struct stat file_stats;
  311. 		if(!opt_a || argc > 0)
  312. 		{
  313. 			if(stat(mntent->mnt_dir, &file_stats) != 0)
  314. 			{
  315. 				fprintf(stderr,
  316. 				        "%s: warning: Failed getting status for file '%s': %s\n",
  317. 				        argv0,
  318. 				        mntent->mnt_dir,
  319. 				        strerror(errno));
  320. 				errno = 0;
  321. 			}
  322. 		}
  324. 		if(argc > 0)
  325. 		{
  326. 			bool found = false;
  327. 			for(int i = 0; i < argc; i++)
  328. 				if(arg_devs[i] == file_stats.st_dev)
  329. 				{
  330. 					found = true;
  331. 					break;
  332. 				}
  334. 			if(!found) continue;
  336. 			args_left--;
  337. 		}
  339. 		if(!opt_a)
  340. 		{
  341. 			bool dupe = false;
  342. 			for(size_t i = 0; i < devices_found; i++)
  343. 				if(devices[i] == file_stats.st_dev)
  344. 				{
  345. 					dupe = true;
  346. 					break;
  347. 				}
  349. 			if(dupe) continue;
  351. 			if(devices_found + 1 >= devices_len)
  352. 			{
  353. 				devices_len *= 2;
  354. 				if(devices_len <= 0) abort();
  356. 				devices = reallocarray(devices, devices_len, sizeof(dev_t));
  358. 				if(!devices)
  359. 				{
  360. 					fprintf(stderr,
  361. 					        "%s: error: Failed to allocate memory for storing (%zd) devices: %s\n",
  362. 					        argv0,
  363. 					        devices_len,
  364. 					        strerror(errno));
  365. 					goto error;
  366. 				}
  367. 			}
  369. 			devices[devices_found++] = file_stats.st_dev;
  370. 		}
  372. 		// Note: musl prior to 1.2.5 has broken getmntent when octal sequences and carriage return is used
  373. 		// https://git.musl-libc.org/cgit/musl/commit/src/misc/mntent.c?id=f314e133929b6379eccc632bef32eaebb66a7335
  374. 		// https://git.musl-libc.org/cgit/musl/commit/src/misc/mntent.c?id=ee1d39bc1573c1ae49ee6b658938b56bbef95a6c
  375. 		struct statvfs stats;
  376. 		if(statvfs(mntent->mnt_dir, &stats) != 0)
  377. 		{
  378. 			fprintf(stderr,
  379. 			        "%s: warning: Failed getting statistics for filesystem '%s': %s\n",
  380. 			        argv0,
  381. 			        mntent->mnt_dir,
  382. 			        strerror(errno));
  383. 			errno = 0;
  385. 			static_escape(mntent->mnt_fsname);
  386. 			static_escape(mntent->mnt_dir);
  388. 			if(opt_a)
  389. 			{
  390. 				printf("%-*s ", fs_col_width, mntent->mnt_fsname);
  392. 				if(opt_T) printf("%*s ", col_width, mntent->mnt_type);
  394. 				printf("%*s ", col_width, "-");       // total
  395. 				printf("%*s ", col_width, "-");       // used
  396. 				printf("%*s ", col_width, "-");       // free
  397. 				printf("%*s ", tty_out ? 3 : 0, "-"); // percent
  398. 				printf("%s\n", mntent->mnt_dir);
  399. 			}
  401. 			continue;
  402. 		}
  404. 		// Skip null filesystems
  405. 		if(!opt_a && stats.f_blocks == 0) continue;
  407. 		// Needs to be done after calling statvfs(3) and stat(3)
  408. 		static_escape(mntent->mnt_fsname);
  409. 		static_escape(mntent->mnt_dir);
  411. 		printf("%-*s ", fs_col_width, mntent->mnt_fsname);
  413. 		if(opt_T) printf("%*s ", col_width, mntent->mnt_type);
  415. 		if(opt_i)
  416. 		{
  417. 			fsfilcnt_t used = stats.f_files - stats.f_ffree;
  418. 			fsfilcnt_t percent = (used / stats.f_files) * 100;
  420. 			if(opt_h && !opt_P)
  421. 			{
  422. 				struct si_scale total_scl = dtosi(stats.f_files, false);
  423. 				struct si_scale used_scl = dtosi(used, false);
  424. 				struct si_scale free_scl = dtosi(stats.f_ffree, false);
  426. 				int width_num = tty_out ? col_width - 1 : 0;
  427. 				int width_pre = tty_out ? 1 : 0;
  429. 				printf("%*.2f%-*s ", width_num, total_scl.number, width_pre, total_scl.prefix);
  430. 				printf("%*.2f%-*s ", width_num, used_scl.number, width_pre, used_scl.prefix);
  431. 				printf("%*.2f%-*s ", width_num, free_scl.number, width_pre, free_scl.prefix);
  432. 			}
  433. 			else
  434. 			{
  435. 				printf("%*zd ", col_width, stats.f_files);
  436. 				printf("%*zd ", col_width, used);
  437. 				printf("%*zd ", col_width, stats.f_ffree);
  438. 			}
  440. 			printf("%*zd%% ", tty_out ? 4 : 0, percent);
  441. 			printf("%s\n", mntent->mnt_dir);
  443. 			continue;
  444. 		}
  446. 		off_t percent = 0;
  447. 		off_t total = stats.f_frsize * (stats.f_blocks != 0 ? stats.f_blocks : 1);
  448. 		off_t free = stats.f_bfree * (stats.f_bsize != 0 ? stats.f_bsize : 1);
  449. 		off_t used = total - free;
  451. 		if(used + free)
  452. 		{
  453. 			percent = (used * 100) / (used + free);
  454. 			if(used * 100 != percent * (used + free)) percent++;
  455. 		}
  457. 		if(forced_bsize != 0)
  458. 		{
  459. 			total /= forced_bsize;
  460. 			free /= forced_bsize;
  461. 			used /= forced_bsize;
  462. 		}
  464. 		if(opt_h && !opt_P)
  465. 		{
  466. 			struct si_scale total_scl = dtosi(total, true);
  467. 			struct si_scale used_scl = dtosi(used, true);
  468. 			struct si_scale free_scl = dtosi(free, true);
  470. 			int width_num = tty_out ? col_width - 3 : 0;
  471. 			int width_pre = tty_out ? 3 : 0;
  473. 			printf("%*.2f%-*s ", width_num, total_scl.number, width_pre, total_scl.prefix);
  474. 			printf("%*.2f%-*s ", width_num, used_scl.number, width_pre, used_scl.prefix);
  475. 			printf("%*.2f%-*s ", width_num, free_scl.number, width_pre, free_scl.prefix);
  476. 		}
  477. 		else
  478. 		{
  479. 			printf("%*zd ", col_width, total);
  480. 			printf("%*zd ", col_width, used);
  481. 			printf("%*zd ", col_width, free);
  482. 		}
  484. 		printf("%*zd%% ", tty_out ? 3 : 0, percent);
  485. 		printf("%s\n", mntent->mnt_dir);
  486. 	}
  488. 	endmntent(mounted);
  490. 	free(devices);
  491. 	free(arg_devs);
  493. 	return 0;
  495. error:
  496. 	free(devices);
  497. 	free(arg_devs);
  499. 	return 1;
  500. }