logo

utils-std

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

df.c (10951B)

    

  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 "../lib/reallocarray.h"
  9. #include "../libutils/getopt_nolong.h"
  10. #include "../libutils/humanize.h"
  12. #include <ctype.h> // iscntrl, isspace
  13. #include <errno.h> // errno
  14. #include <mntent.h>
  15. #include <stdbool.h>
  16. #include <stdio.h>    // printf
  17. #include <stdlib.h>   // abort, exit
  18. #include <string.h>   // strerror
  19. #include <sys/stat.h> // stat, dev_t
  20. #include <sys/statvfs.h>
  21. #include <unistd.h> // getopt
  23. #define STR(s) #s
  25. /*
  26.  * Rough idea of builtin filesystems in Linux 6.12.31:
  27.  * $ grep -RI '\bregister_filesystem(' /usr/src/linux/fs/ | wc -l
  28.  * 79
  29.  */
  30. #define DF_MNT_TYPE_MAX 128
  32. // Grabbed from OpenRC rc-functions.sh
  33. // clang-format off
  34. static const char *net_fs_list[] = {
  35. 	"afs", "ceph", "cifs", "coda", "davfs", "fuse", "fuse.glusterfs",
  36. 	"fuse.sshfs", "gfs", "glusterfs", "lustre", "ncpfs", "nfs", "nfs4",
  37. 	"ocfs2", "shfs", "smbfs"
  38. };
  39. // clang-format on
  41. blksize_t forced_bsize = 0;
  42. const char *argv0 = "df";
  44. // Replaces control characters and whitespaces with '?' in-place (no allocation)
  45. static void
  46. static_escape(char *str)
  47. {
  48. 	for(size_t i = 0; i < strlen(str); i++)
  49. 		if(iscntrl(str[i]) || isspace(str[i])) str[i] = '?';
  50. }
  52. int
  53. main(int argc, char *argv[])
  54. {
  55. 	bool opt_P = false, opt_h = false, opt_a = false, opt_T = false, opt_l = false, opt_i = false;
  56. 	int fs_col_width = 20;
  57. 	dev_t *devices = NULL;
  59. 	size_t excluded_count = 0;
  60. 	static char *excluded[DF_MNT_TYPE_MAX];
  62. 	size_t only_count = 0;
  63. 	static char *only[DF_MNT_TYPE_MAX];
  65. 	for(int c = -1; (c = getopt_nolong(argc, argv, ":ahilPkTt:x:")) != -1;)
  66. 	{
  67. 		switch(c)
  68. 		{
  69. 		case 'a':
  70. 			opt_a = true;
  71. 			break;
  72. 		case 'P':
  73. 			if(forced_bsize == 0) forced_bsize = 512;
  75. 			opt_P = true;
  76. 			break;
  77. 		case 'k':
  78. 			forced_bsize = 1024;
  79. 			break;
  80. 		case 'h':
  81. 			opt_h = true;
  82. 			fs_col_width = 30;
  83. 			break;
  84. 		case 'i':
  85. 			opt_i = true;
  86. 			break;
  87. 		case 'l':
  88. 			opt_l = true;
  89. 			break;
  90. 		case 'T':
  91. 			opt_T = true;
  92. 			break;
  93. 		case 't':
  94. 			if(only_count >= (DF_MNT_TYPE_MAX - 1))
  95. 			{
  96. 				fprintf(
  97. 				    stderr,
  98. 				    "%s: error: Can only select up to " STR(DF_MNT_TYPE_MAX) " mnt_types via option `-t`\n",
  99. 				    argv0);
  100. 				return 1;
  101. 			}
  103. 			only[only_count++] = optarg;
  104. 			break;
  105. 		case 'x':
  106. 			if(excluded_count >= (DF_MNT_TYPE_MAX - 1))
  107. 			{
  108. 				fprintf(
  109. 				    stderr,
  110. 				    "%s: error: Can only select up to " STR(DF_MNT_TYPE_MAX) " mnt_types via option `-x`\n",
  111. 				    argv0);
  112. 				return 1;
  113. 			}
  115. 			excluded[excluded_count++] = optarg;
  116. 			break;
  117. 		case ':':
  118. 			fprintf(stderr, "%s: error: Missing operand for option: '-%c'\n", argv0, optopt);
  119. 			return 1;
  120. 		case '?':
  121. 			GETOPT_UNKNOWN_OPT
  122. 			return 1;
  123. 		}
  124. 	}
  126. 	if(opt_P && opt_T)
  127. 	{
  128. 		fprintf(stderr, "%s: error: Options -P and -T are incompatible\n", argv0);
  129. 		return 1;
  130. 	}
  132. 	if(opt_P) opt_h = false;
  134. 	argc -= optind;
  135. 	argv += optind;
  137. 	int args_left = argc != 0 ? argc : 1;
  139. 	bool tty_out = isatty(1);
  140. 	int col_width = tty_out ? 10 : 0;
  142. 	if(!tty_out)
  143. 	{
  144. 		errno = 0;
  145. 		fs_col_width = 0;
  146. 	}
  148. 	dev_t *arg_devs = NULL;
  150. 	if(argc > 0)
  151. 	{
  152. 		arg_devs = calloc(argc, sizeof(dev_t));
  153. 		if(arg_devs == NULL)
  154. 		{
  155. 			fprintf(stderr, "%s: error: Failed to allocate arg_devs array: %s\n", argv0, strerror(errno));
  156. 			return 1;
  157. 		}
  158. 	}
  160. 	for(int i = 0; i < argc; i++)
  161. 	{
  162. 		struct stat file_stats;
  163. 		if(stat(argv[i], &file_stats) != 0)
  164. 		{
  165. 			fprintf(stderr,
  166. 			        "%s: error: Failed getting status for file '%s': %s\n",
  167. 			        argv0,
  168. 			        argv[i],
  169. 			        strerror(errno));
  170. 			goto error;
  171. 		}
  173. 		arg_devs[i] = file_stats.st_dev;
  174. 	}
  176. 	// Begin: Print header
  178. 	printf("%-*s ", fs_col_width, "Filesystem");
  180. 	if(opt_T) printf("%*s ", col_width, "Type");
  182. 	if(opt_i)
  183. 	{
  184. 		printf("%*s %*s %*s ", col_width, "Inodes", col_width, "Iused", col_width, "IFree");
  186. 		if(opt_P)
  187. 			printf("IUse%% Mounted on\n");
  188. 		else
  189. 			printf("IUse%% Mountpoint\n");
  190. 	}
  191. 	else
  192. 	{
  193. 		if(forced_bsize != 0)
  194. 			printf("%zd-blocks ", forced_bsize);
  195. 		else
  196. 			printf("%*s ", col_width, "Total");
  198. 		printf("%*s %*s ", col_width, "Used", col_width, "Available");
  200. 		if(opt_P)
  201. 			printf("Capacity Mounted on\n");
  202. 		else
  203. 			printf("Use%% Mountpoint\n");
  204. 	}
  205. 	// End: Print header
  207. 	FILE *mounted = setmntent(MOUNTED, "r");
  208. 	if(mounted == NULL)
  209. 	{
  210. 		fprintf(stderr,
  211. 		        "%s: error: Failed opening setmntent(\"" MOUNTED "\", \"r\"): %s\n",
  212. 		        argv0,
  213. 		        strerror(errno));
  214. 		goto error;
  215. 	}
  217. 	// Linux has a configurable limit of maximum mounts which defaults to 100_000
  218. 	// See /proc/sys/fs/mount-max introduced in Linux 4.9 for CVE-2016-6213
  219. 	// https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git/commit/?id=d29216842a85c7970c536108e093963f02714498
  220. 	//
  221. 	// Which is way too much to be either stack-allocated or statically allocated:
  222. 	// 100000*sizeof(dev_t) = 100000*8 bytes ≈ 781.25 KiB
  223. 	// So reallocarray to the rescue
  224. 	size_t devices_found = 0;
  225. 	size_t devices_len = 100;
  226. 	devices = reallocarray(NULL, devices_len, sizeof(dev_t));
  227. 	if(!devices)
  228. 	{
  229. 		fprintf(stderr,
  230. 		        "%s: error: Failed to allocate memory for storing (%zd) devices: %s\n",
  231. 		        argv0,
  232. 		        devices_len,
  233. 		        strerror(errno));
  234. 		goto error;
  235. 	}
  237. 	// Even with argc>0 we still need to go over mntent for the filesystem mountpoint and type
  238. 	while(args_left > 0)
  239. 	{
  240. 		struct mntent *mntent = getmntent(mounted);
  241. 		if(mntent == NULL) break;
  243. 		if(excluded_count > 0)
  244. 		{
  245. 			bool exclude = false;
  247. 			for(size_t i = 0; i < excluded_count; i++)
  248. 				if(strcmp(excluded[i], mntent->mnt_type) == 0)
  249. 				{
  250. 					exclude = true;
  251. 					break;
  252. 				}
  254. 			if(exclude) continue;
  255. 		}
  257. 		if(only_count > 0)
  258. 		{
  259. 			bool include = false;
  261. 			for(size_t i = 0; i < only_count; i++)
  262. 				if(strcmp(only[i], mntent->mnt_type) == 0)
  263. 				{
  264. 					include = true;
  265. 					break;
  266. 				}
  268. 			if(!include) continue;
  269. 		}
  271. 		if(opt_l)
  272. 		{
  273. 			bool remote = false;
  275. 			for(size_t i = 0; i < sizeof(net_fs_list) / sizeof(char *); i++)
  276. 				if(strcmp(net_fs_list[i], mntent->mnt_type) == 0)
  277. 				{
  278. 					remote = true;
  279. 					break;
  280. 				}
  282. 			if(remote) continue;
  283. 		}
  285. 		struct stat file_stats;
  286. 		if(!opt_a || argc > 0)
  287. 		{
  288. 			if(stat(mntent->mnt_dir, &file_stats) != 0)
  289. 			{
  290. 				fprintf(stderr,
  291. 				        "%s: warning: Failed getting status for file '%s': %s\n",
  292. 				        argv0,
  293. 				        mntent->mnt_dir,
  294. 				        strerror(errno));
  295. 				errno = 0;
  296. 			}
  297. 		}
  299. 		if(argc > 0)
  300. 		{
  301. 			bool found = false;
  302. 			for(int i = 0; i < argc; i++)
  303. 				if(arg_devs[i] == file_stats.st_dev)
  304. 				{
  305. 					found = true;
  306. 					break;
  307. 				}
  309. 			if(!found) continue;
  311. 			args_left--;
  312. 		}
  314. 		if(!opt_a)
  315. 		{
  316. 			bool dupe = false;
  317. 			for(size_t i = 0; i < devices_found; i++)
  318. 				if(devices[i] == file_stats.st_dev)
  319. 				{
  320. 					dupe = true;
  321. 					break;
  322. 				}
  324. 			if(dupe) continue;
  326. 			if(devices_found + 1 >= devices_len)
  327. 			{
  328. 				devices_len *= 2;
  329. 				if(devices_len <= 0) abort();
  331. 				devices = reallocarray(devices, devices_len, sizeof(dev_t));
  333. 				if(!devices)
  334. 				{
  335. 					fprintf(stderr,
  336. 					        "%s: error: Failed to allocate memory for storing (%zd) devices: %s\n",
  337. 					        argv0,
  338. 					        devices_len,
  339. 					        strerror(errno));
  340. 					goto error;
  341. 				}
  342. 			}
  344. 			devices[devices_found++] = file_stats.st_dev;
  345. 		}
  347. 		// Note: musl prior to 1.2.5 has broken getmntent when octal sequences and carriage return is used
  348. 		// https://git.musl-libc.org/cgit/musl/commit/src/misc/mntent.c?id=f314e133929b6379eccc632bef32eaebb66a7335
  349. 		// https://git.musl-libc.org/cgit/musl/commit/src/misc/mntent.c?id=ee1d39bc1573c1ae49ee6b658938b56bbef95a6c
  350. 		struct statvfs stats;
  351. 		if(statvfs(mntent->mnt_dir, &stats) != 0)
  352. 		{
  353. 			fprintf(stderr,
  354. 			        "%s: warning: Failed getting statistics for filesystem '%s': %s\n",
  355. 			        argv0,
  356. 			        mntent->mnt_dir,
  357. 			        strerror(errno));
  358. 			errno = 0;
  360. 			static_escape(mntent->mnt_fsname);
  361. 			static_escape(mntent->mnt_dir);
  363. 			if(opt_a)
  364. 			{
  365. 				printf("%-*s ", fs_col_width, mntent->mnt_fsname);
  367. 				if(opt_T) printf("%*s ", col_width, mntent->mnt_type);
  369. 				printf("%*s ", col_width, "-");       // total
  370. 				printf("%*s ", col_width, "-");       // used
  371. 				printf("%*s ", col_width, "-");       // free
  372. 				printf("%*s ", tty_out ? 3 : 0, "-"); // percent
  373. 				printf("%s\n", mntent->mnt_dir);
  374. 			}
  376. 			continue;
  377. 		}
  379. 		// Skip null filesystems
  380. 		if(!opt_a && stats.f_blocks == 0) continue;
  382. 		// Needs to be done after calling statvfs(3) and stat(3)
  383. 		static_escape(mntent->mnt_fsname);
  384. 		static_escape(mntent->mnt_dir);
  386. 		printf("%-*s ", fs_col_width, mntent->mnt_fsname);
  388. 		if(opt_T) printf("%*s ", col_width, mntent->mnt_type);
  390. 		if(opt_i)
  391. 		{
  392. 			fsfilcnt_t used = stats.f_files - stats.f_ffree;
  393. 			fsfilcnt_t percent = (used / stats.f_files) * 100;
  395. 			if(opt_h && !opt_P)
  396. 			{
  397. 				struct si_scale total_scl = dtosi(stats.f_files, false);
  398. 				struct si_scale used_scl = dtosi(used, false);
  399. 				struct si_scale free_scl = dtosi(stats.f_ffree, false);
  401. 				int width_num = tty_out ? col_width - 1 : 0;
  402. 				int width_pre = tty_out ? 1 : 0;
  404. 				printf("%*.2f%-*s ", width_num, total_scl.number, width_pre, total_scl.prefix);
  405. 				printf("%*.2f%-*s ", width_num, used_scl.number, width_pre, used_scl.prefix);
  406. 				printf("%*.2f%-*s ", width_num, free_scl.number, width_pre, free_scl.prefix);
  407. 			}
  408. 			else
  409. 			{
  410. 				printf("%*zd ", col_width, stats.f_files);
  411. 				printf("%*zd ", col_width, used);
  412. 				printf("%*zd ", col_width, stats.f_ffree);
  413. 			}
  415. 			printf("%*zd%% ", tty_out ? 4 : 0, percent);
  416. 			printf("%s\n", mntent->mnt_dir);
  418. 			continue;
  419. 		}
  421. 		off_t percent = 0;
  422. 		off_t total = stats.f_frsize * (stats.f_blocks != 0 ? stats.f_blocks : 1);
  423. 		off_t free = stats.f_bfree * (stats.f_bsize != 0 ? stats.f_bsize : 1);
  424. 		off_t used = total - free;
  426. 		if(used + free)
  427. 		{
  428. 			percent = (used * 100) / (used + free);
  429. 			if(used * 100 != percent * (used + free)) percent++;
  430. 		}
  432. 		if(forced_bsize != 0)
  433. 		{
  434. 			total /= forced_bsize;
  435. 			free /= forced_bsize;
  436. 			used /= forced_bsize;
  437. 		}
  439. 		if(opt_h && !opt_P)
  440. 		{
  441. 			struct si_scale total_scl = dtosi(total, true);
  442. 			struct si_scale used_scl = dtosi(used, true);
  443. 			struct si_scale free_scl = dtosi(free, true);
  445. 			int width_num = tty_out ? col_width - 3 : 0;
  446. 			int width_pre = tty_out ? 3 : 0;
  448. 			printf("%*.2f%-*s ", width_num, total_scl.number, width_pre, total_scl.prefix);
  449. 			printf("%*.2f%-*s ", width_num, used_scl.number, width_pre, used_scl.prefix);
  450. 			printf("%*.2f%-*s ", width_num, free_scl.number, width_pre, free_scl.prefix);
  451. 		}
  452. 		else
  453. 		{
  454. 			printf("%*zd ", col_width, total);
  455. 			printf("%*zd ", col_width, used);
  456. 			printf("%*zd ", col_width, free);
  457. 		}
  459. 		printf("%*zd%% ", tty_out ? 3 : 0, percent);
  460. 		printf("%s\n", mntent->mnt_dir);
  461. 	}
  463. 	endmntent(mounted);
  465. 	free(devices);
  466. 	free(arg_devs);
  468. 	return 0;
  470. error:
  471. 	free(devices);
  472. 	free(arg_devs);
  474. 	return 1;
  475. }