Llewellyn/conky
1
0
Fork 0
mirror of https://github.com/Llewellynvdm/conky.git synced 2024-09-29 21:49:07 +00:00
Code Issues Releases Activity

Conky for mac os master (#532)

Browse Source 
* Documentation fixes for macOS

This commit fixes documentation of a macOS specific variable (sip_status) as promised in #480.

Also, fix some identation problems in darwin.cc

* Amend #18 by polling less often! This will help lower CPU usage, too!
This commit is contained in:
Brenden Matthews 2018-07-04 15:32:54 -04:00 committed by GitHub
parent bf10130cae
commit 10621e61b1
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 54 additions and 48 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

53
doc/variables.xml
View File

@ -3780,30 +3780,37 @@
</term> </term>
<listitem>Prints info regarding System Integrity Protection (SIP) on macOS. <listitem>Prints info regarding System Integrity Protection (SIP) on macOS.
Specifically, prints SIP status (enabled / disabled) if no switch is If no switch is provided, prints SIP status (enabled / disabled), else,
provided OR status of specific SIP feature if a switch is provided. status of the specific SIP feature corresponding to the switch provided.
Below are the allowed switches: (each switch is a char)
SWITCH-----------------------RESULT-------------------------------
0 allows apple-internal? YES/NO
1 allows untrusted-kexts? YES/NO
2 allows task-for-pid? YES/NO
3 allows unrestricted-fs? YES/NO
4 allows kernel-debugger? YES/NO
5 allows unrestricted-dtrace? YES/NO
6 allows unrestricted-nvram? YES/NO
7 allows device-configuration? YES/NO
8 allows any-recovery-os? YES/NO
9 allows user-approved-kexts? YES/NO
a uses unsupported configuration?
If yes, prints "unsupported configuration, beware!"
Else, prints "configuration is ok".
------------------------------------------------------------------
EXAMPLE:
conky -t '${sip_status}' # print SIP status
conky -t '${sip_status 0}' # print allows apple-internal? Yes or No?
NOTES: exists only for macOS version of conky and works on any macOS Below are shown the available switches:
version (even the ones prior El Capitan where SIP was first introduced).
SWITCH--------------------------RESULT--------------------------STATUS
0 apple internal YES/NO
1 forbid untrusted kexts YES/NO
2 forbid task-for-pid YES/NO
3 restrict filesystem YES/NO
4 forbid kernel-debugger YES/NO
5 restrict dtrace YES/NO
6 restrict nvram YES/NO
7 forbid device-configuration YES/NO
8 forbid any-recovery-os YES/NO
9 forbid user-approved-kexts YES/NO
a uses unsupported configuration? (*)
(*): If yes, prints "unsupported configuration, beware!"
Else, prints "configuration is ok".
----------------------------------------------------------------------
USAGE:
conky -t '${sip_status}' # print SIP status
conky -t '${sip_status 0}' # print allows apple-internal? Yes or No?
NOTES:
* Available for all macOS versions (even the ones prior El Capitan
where SIP was first introduced)
* If run on versions prior El Capitan SIP is unavailable, so all
you will get is "unsupported"
<para /></listitem> <para /></listitem>
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>

49
src/darwin.cc
View File

@ -766,6 +766,7 @@ int update_running_threads() {
int update_total_processes() { int update_total_processes() {
helper_update_threads_processes(); helper_update_threads_processes();
return 0;
/* /*
* WARNING: You may stumble upon this implementation: * WARNING: You may stumble upon this implementation:
@ -774,7 +775,7 @@ int update_total_processes() {
* This method DOESN'T find the correct number of tasks. * This method DOESN'T find the correct number of tasks.
* *
* This is probably (??) because on macOS there is no option for * This is probably (??) because on macOS there is no option for
* KERN_PROC_KTHREAD like there is in FreeBSD * KERN_PROC_KTHREAD like there is in FreeBSD
* *
* In FreeBSD's sysctl.h we can see the following: * In FreeBSD's sysctl.h we can see the following:
* *
@ -799,8 +800,8 @@ int update_total_processes() {
* KERN_PROC_LCID by login context id * KERN_PROC_LCID by login context id
* *
* Probably by saying "everything" they mean that KERN_PROC_ALL gives all * Probably by saying "everything" they mean that KERN_PROC_ALL gives all
* processes (user-level plus kernel threads) ( So basically this is the * processes (user-level plus kernel threads) ( So basically this is the
* problem with the old implementation ) * problem with the old implementation )
*/ */
} }
@ -1057,7 +1058,6 @@ static void calc_cpu_usage_for_proc(struct process *proc, uint64_t total) {
*/ */
static void calc_cpu_total(struct process *proc, uint64_t *total) { static void calc_cpu_total(struct process *proc, uint64_t *total) {
uint64_t current_total = 0; /* of current iteration */ uint64_t current_total = 0; /* of current iteration */
// uint64_t total = 0; /* delta */
struct cpusample sample {}; struct cpusample sample {};
get_cpu_sample(&sample); get_cpu_sample(&sample);
@ -1161,7 +1161,7 @@ static void get_top_info_for_kinfo_proc(struct kinfo_proc *p) {
/* /*
* wait until done * wait until done
*/ */
while (!(calc_cpu_total_finished && calc_proc_total_finished)) { ; } while (!(calc_cpu_total_finished && calc_proc_total_finished)) { usleep(500); }
/* calc the amount(%) of CPU the process used */ /* calc the amount(%) of CPU the process used */
calc_cpu_usage_for_proc(proc, t); calc_cpu_usage_for_proc(proc, t);
@ -1179,12 +1179,12 @@ void get_top_info() {
* XXX if we run conky -t '${top_mem mem 1}' it will crash because * XXX if we run conky -t '${top_mem mem 1}' it will crash because
* info.cpu_count is not initialised. * info.cpu_count is not initialised.
* *
* We can initialise it down here, but it seems like in the linux * We can initialise it down here, but it seems like in the linux
* implementation of get_top_info() there is no call to the get_cpu_count() * implementation of get_top_info() there is no call to the get_cpu_count()
* function. Neither is there in core.cc... If this is the case, when is * function. Neither is there in core.cc... If this is the case, when is
* info.cpu_count initialised??? * info.cpu_count initialised???
* *
* Find a proper better place for get_cpu_count() call. (for comformance with * Find a proper better place for get_cpu_count() call. (for comformance with
* linux.cc) * linux.cc)
*/ */
get_cpu_count(); get_cpu_count();
@ -1273,32 +1273,31 @@ int get_sip_status() {
/* /*
* Prints SIP status or a specific SIP feature status depending on the argument * Prints SIP status or a specific SIP feature status depending on the argument
* passed to $sip_status command * passed to $sip_status command
* *
* Variables that can be passed to $sip_status command * Variables that can be passed to $sip_status command
* *
* nothing --> print enabled / disabled * nothing --> print enabled / disabled
* 0 --> allow_apple_internal * 0 --> apple internal
* 1 --> allow_untrusted_kexts * 1 --> forbid untrusted kexts
* 2 --> allow_task_for_pid * 2 --> forbid task-for-pid
* 3 --> allow_unrestricted_fs * 3 --> restrict filesystem
* 4 --> allow_kernel_debugger * 4 --> forbid kernel-debugger
* 5 --> allow_unrestricted_dtrace * 5 --> restrict dtrace
* 6 --> allow_unrestricted_nvram * 6 --> restrict nvram
* 7 --> allow_device_configuration * 7 --> forbid device-configuration
* 8 --> allow_any_recovery_os * 8 --> forbid any-recovery-os
* 9 --> allow_user_approved_kexts * 9 --> forbid user-approved-kexts
* a --> check if unsupported configuration ---> this is not an apple SIP * a --> check if unsupported configuration ---> this is not an apple SIP
* flag. This is for us. * flag. This is for us.
* *
* The print function is designed to show 'YES' if a specific protection * The print function is designed to show 'YES' if a specific protection
* measure is ENABLED. For example, if SIP is configured to disallow untrusted * measure is ENABLED. For example, if SIP is configured to disallow untrusted
* kexts, then our function will print 'YES'. Thus, it doesnt print 'YES' in the * kexts, then our function will print 'YES'.
* case SIP allows untrusted kexts.
* *
* For this reason, your conkyrc should say for example: Untrusted Kexts * For this reason, your conkyrc should say for example: Untrusted Kexts
* Protection: ${sip_status 1} You should not write: "Allow Untrusted Kexts", * Protection: ${sip_status 1} You should not write: "Allow Untrusted Kexts",
* this is wrong. * this is wrong.
*/ */
void print_sip_status(struct text_object *obj, char *p, int p_max_size) { void print_sip_status(struct text_object *obj, char *p, int p_max_size) {
if (csr_get_active_config == if (csr_get_active_config ==
@ -1388,7 +1387,7 @@ void print_sip_status(struct text_object *obj, char *p, int p_max_size) {
#else /* Mavericks and before */ #else /* Mavericks and before */
/* /*
* Versions prior to Yosemite DONT EVEN DEFINE csr_get_active_config() * Versions prior to Yosemite DONT EVEN DEFINE csr_get_active_config()
* function. Thus we must avoid calling this function! * function. Thus we must avoid calling this function!
*/ */