slstatus/components/entropy.c

/* See LICENSE file for copyright and license details. */
#include "../slstatus.h"
#if defined(__linux__)
	#include <stdint.h>
	#include <stdio.h>

	#include "../util.h"

	const char *
	entropy(void)
	{
		uintmax_t num;

		if (pscanf("/proc/sys/kernel/random/entropy_avail", "%ju", &num)
		    != 1) {
			return NULL;
		}

		return bprintf("%ju", num);
	}
#elif defined(__OpenBSD__) | defined(__FreeBSD__)
	const char *
	entropy(void)
	{
		/* Unicode Character 'INFINITY' (U+221E) */
		return "\xe2\x88\x9e";
	}
#endif
Added LICENSE statements to all source files 2017-09-17 23:45:03 +08:00			`/* See LICENSE file for copyright and license details. */`
components/*.c: include slstatus.h this gives the compiler a chance to check weather the prototype and definiton matches or not, which would catch issues like 3c47701. 2022-10-27 04:14:53 +08:00			`#include "../slstatus.h"`
Revert component-split this reverts the commits from 92ab9ef52ebcb097add97d9f78e67ad1c1d6a6ec up to d42870d6ca7fb587b38f8cf6d6821ae33a53a696. After heavy consideration, the component split has more disadvantages than advantages, especially given there will be utility-functions sharing quite a lot of code that would then need to be duplicated, as it does not fit into the util.c due to its speciality. One big advantage of the component-wise build is readability, and without doubt, this was achieved here. This point will be addressed with a different approach that will be visible in the upcoming commits. One big disadvantage of the component build is the fact that it introduces state to the build process which is not necessary. Before its introduction, the only influencing factors where the system-defines __linux__ and __OpenBSD__. With the components, we are also relying on the output of uname(1). Additionally, if the os.mk is not present, make gives the output $ make Makefile:5: os.mk: No such file or directory make: *** No rule to make target 'os.mk'. Stop. This could easily be fixed by providing some sort of meta-rule for this file, however, it indicates the problem we have here, and this entire statefulness will heavily complicate packaging of this tool and makes the build process much more complex than it actually has to be. 2018-05-02 00:10:39 +08:00			`#if defined(__linux__)`
Simplify format specifiers for uintmax_t 2018-07-07 17:08:26 +08:00			`#include <stdint.h>`
Use indentation to increase readability Granted, this style is definitely not common, but for the short utility-functions of this program it's just the right choice. This provides great flexibility, such that in the long run, it will be possible to also share code between the OS-implementations. This also keeps the state-keeping at a minimum and makes it clearer which functions are implemented on which OS without having to jiggle around with too many files in the process. 2018-05-02 01:01:22 +08:00			`#include <stdio.h>`
Split into multiple files For multiple reasons the program is now split: - Make future porting to OpenBSD easier - Assign header includes to individiual functions - Make future program extensions easier - Recompile only changed parts 2017-09-17 22:18:17 +08:00
Use indentation to increase readability Granted, this style is definitely not common, but for the short utility-functions of this program it's just the right choice. This provides great flexibility, such that in the long run, it will be possible to also share code between the OS-implementations. This also keeps the state-keeping at a minimum and makes it clearer which functions are implemented on which OS without having to jiggle around with too many files in the process. 2018-05-02 01:01:22 +08:00			`#include "../util.h"`
Split into multiple files For multiple reasons the program is now split: - Make future porting to OpenBSD easier - Assign header includes to individiual functions - Make future program extensions easier - Recompile only changed parts 2017-09-17 22:18:17 +08:00
Use indentation to increase readability Granted, this style is definitely not common, but for the short utility-functions of this program it's just the right choice. This provides great flexibility, such that in the long run, it will be possible to also share code between the OS-implementations. This also keeps the state-keeping at a minimum and makes it clearer which functions are implemented on which OS without having to jiggle around with too many files in the process. 2018-05-02 01:01:22 +08:00			`const char *`
			`entropy(void)`
			`{`
Change uint64_t to uintmax_t 2018-07-07 16:50:25 +08:00			`uintmax_t num;`
Split into multiple files For multiple reasons the program is now split: - Make future porting to OpenBSD easier - Assign header includes to individiual functions - Make future program extensions easier - Recompile only changed parts 2017-09-17 22:18:17 +08:00
Consistency with 80 char limit and breaks 2018-07-08 23:42:58 +08:00			`if (pscanf("/proc/sys/kernel/random/entropy_avail", "%ju", &num)`
			`!= 1) {`
Refactor entropy.c 2018-05-20 06:18:08 +08:00			`return NULL;`
			`}`

Simplify format specifiers for uintmax_t 2018-07-07 17:08:26 +08:00			`return bprintf("%ju", num);`
Use indentation to increase readability Granted, this style is definitely not common, but for the short utility-functions of this program it's just the right choice. This provides great flexibility, such that in the long run, it will be possible to also share code between the OS-implementations. This also keeps the state-keeping at a minimum and makes it clearer which functions are implemented on which OS without having to jiggle around with too many files in the process. 2018-05-02 01:01:22 +08:00			`}`
Add FreeBSD support for netspeeds, entropy and ip components 2019-01-30 19:21:54 +08:00			`#elif defined(__OpenBSD__) \| defined(__FreeBSD__)`
entropy: Port to OpenBSD OpenBSD's entropy design is superior to Linux. 2018-05-07 04:54:32 +08:00			`const char *`
			`entropy(void)`
			`{`
entropy: Small fix 2018-05-07 05:09:36 +08:00			`/* Unicode Character 'INFINITY' (U+221E) */`
			`return "\xe2\x88\x9e";`
entropy: Port to OpenBSD OpenBSD's entropy design is superior to Linux. 2018-05-07 04:54:32 +08:00			`}`
Revert component-split this reverts the commits from 92ab9ef52ebcb097add97d9f78e67ad1c1d6a6ec up to d42870d6ca7fb587b38f8cf6d6821ae33a53a696. After heavy consideration, the component split has more disadvantages than advantages, especially given there will be utility-functions sharing quite a lot of code that would then need to be duplicated, as it does not fit into the util.c due to its speciality. One big advantage of the component-wise build is readability, and without doubt, this was achieved here. This point will be addressed with a different approach that will be visible in the upcoming commits. One big disadvantage of the component build is the fact that it introduces state to the build process which is not necessary. Before its introduction, the only influencing factors where the system-defines __linux__ and __OpenBSD__. With the components, we are also relying on the output of uname(1). Additionally, if the os.mk is not present, make gives the output $ make Makefile:5: os.mk: No such file or directory make: *** No rule to make target 'os.mk'. Stop. This could easily be fixed by providing some sort of meta-rule for this file, however, it indicates the problem we have here, and this entire statefulness will heavily complicate packaging of this tool and makes the build process much more complex than it actually has to be. 2018-05-02 00:10:39 +08:00			`#endif`