CVS log for src/usr.sbin/envstat/envstat.c

Up to [cvs.NetBSD.org] / src / usr.sbin / envstat

Request diff between arbitrary revisions

Keyword substitution: kv
Default branch: MAIN

Pull up following revision(s) (requested by rin in ticket #450):

	usr.sbin/envstat/envstat.c: revision 1.104

Silence wrong maybe-uninitialized raised by GCC/x86_64 10.4.0 -Os.

Silence wrong maybe-uninitialized raised by GCC/x86_64 10.4.0 -Os.

A driver for the Bosch BMP280 / BME280 temperature, humidity and
atmospheric pressure sensor.  This is an inexpensive to moderately
expensive chip available from a large number of places.  The driver
supports all aspects of the two chips, except for the repeating read
mode which would allow for sub-second queries, such as fall detection
or perhaps even as an altimeter.  This driver also only supports the
I2C interface and not the SPI interface.

The BME280, the one with humidity, is not fully tested at this point,
awaiting upon a breakout board and may not show proper humidity.

fix various typos, mainly in comments.

usr.sbin: remove unnecessary CONSTCOND, lint no longer needs it

Since 2021-01-31, lint no longer requires a CONSTCOND comment in a
do-while-0 statement since this is a common code pattern, especially in
statement-like macros.

sed -i -E 's,} while \(/\* ?CONSTCOND ?\*/ ?0\),} while (0),' */*.[ch]

Add option -n to print only the value of a sensor.
If statistics are selected with -T, then also display max, min and average.
The empty line between each display is skipped when one or more sensors are
selected with -s.

Allow to select raw output for a single device or a list of sensors.

For raw output (-x) allow to extract individual properties like drvctl -p.
E.g.

# envstat -x /vcmbox0/0/cur-value
328150000

Update for proplib(3) API changes.

Sync with HEAD

Add support for light sensors that report Illuminance in lux.

Rebase to HEAD as of a few days ago.

Rebase.

add HYT-221/271/939 humidity/temperature I2C sensor
extend envsys(4) framework by %rH (relative humidity)

resync with head

sync with head

Since we're no longer making a copy of the option args, we shouldn't
attempt to free it.

- no point in allocating memory to hold command line arguments.
- allocate memory inside the function used.

PR/47316: Henning Petersen: Memory leak in envstat with config file.

sync with head.

Fix alignment display for temperature, fans and integer units.

sync with head

Various English usage, spelling and markup fixes for envstat(4)-related
things, from Snader_LB.

change printed indicator and battery charge strings from ON and OFF to TRUE
and FALSE, because messages like "battery present: ON" are difficult for my
brain to parse.

Catchup with rmind-uvmplock merge.

Zero is a valid value for some sensors so update statistics code to
handle that.

1. Don't print blank for Integer sensors with value of zero
2. Properly print percentages in -T statistics mode
3. Always set Sensor Type (units) to a non-NULL value
4. Enable printing of percentages for Integer sensors

Since there is no longer a value-avg property, remove the code that
extracts it.

When skipping output for a temperature of absolute zero, don't forget to
skip past the display columns that the value would otherwise occupy.

Fixes display issue when swsensor(4) is used and it has a value of 0K,
as reported by njoly@

Use a consistent approach for rump kernel calls made by libs.
Should investigate a dynamic approach in the future.

RUMP_ACTION -> RUMPPRG

adapt to new rumpclient_init() signature

support rump client mode

Some Integer-type sensors can have limits, so allow them to be displayed.

Use <paths.h>. Remove trailing white space.

Print the correct value for critmin of a fan sensor.

Update userland envstat(8) to handle new {high,maximum}-capacity limits.

Fix double free, when requesting an invalid sensor.

remove the fourth (empty) column from the -T printouts; ok pgoyette

fix a typo resulting in warn-max being shown in two columns (one time instead of crit-min); ok pgoyette

Since we never have both a limit value and a limit %capacity value,
remove the Capacity column.

Reduce inter-column spacing, and display all four limits on one page,
rather than using the -W command line option to switch between critical
and warning limits.  (The -W option is still permitted, but has no
effect.)

%capacity limits are displayed in the WarnMin and CritMin columns, but
have a trailing % sign.

Sync with HEAD.

Third (and last) commit. See http://mail-index.netbsd.org/source-changes/2009/05/13/msg221222.html

Pull up following revision(s) (requested by christos in ticket #666):
	usr.sbin/envstat/envstat.c: revision 1.72
fix pasto: don't print the critcap when the warncap was asked. Also off by
one in length. From Anon-Ymous.
XXX: Should pull up to 5.0

fix pasto: don't print the critcap when the warncap was asked. Also off by
one in length. From Anon-Ymous.
XXX: Should pull up to 5.0

Add support for showing temperatures in Kelvin.

Sync with wrstuden-revivesa-base-2.

1. provide for warning-min and warning-max alarm levels in addition to
   critical-min and critical-max; also, a battery warning-capacity is
   added in addition to a critical-capacity.

2. usr.sbin/envstat is modified to introduce a -W command line switch to
   display the warning-* values instead of the critical-* values, and
   envstat(8) and envsys.conf(5) man pages are updated appropriately.

3. Treat user-defined limits as a single continuum and generate a single
   event regardless of how many boundaries a change in sensor value
   crosses;  ditto for driver-defined limits.

Fixes my PR/39021
Fixes my PR/39022

OK'd by christos@ bouyer@ cube@

simplify the code, from xtraeme.

Sync w/ -current. 34 merge conflicts to follow.

sync with head

remove printf when the sensor has no statistics; requested by xtraeme.

Don't code using side-effects (eliminate queue variable). Unconfuses Coverity
CID 5031.

Coverity CID 5034: Use after free. Restructure the code to simplify it and
print the error.

sync with head.

Don't show statistics in sensors that will provide a percentage.

Add missing cast, noticed by Paul Goyette in current-users@.

Cur -> Current for the header.

In default display mode, fix up the indentation for the critical
limits so that they appear in the correct column.

* Improve default display output by adding a header that will match
  current value as well as critical limits set and sensor unit.

* Add a new flag: -T. When it's enabled statistics will be created for
  the sensors. Max, min and average statistics as well as sensor unit
  will be displayed. Must be used with an interval.

You can see the new code in action here:

http://www.netbsd.org/~xtraeme/envstat_stats.txt

Thanks to jmcneill@ for comments and ideas.

Remove the 'dvnprinted' bool member of sensor_t, it's unused.

* Add support to show output from specified sensors in multiple devices
  via the -s flag (the requirement for -d is not there anymore). [1]

You can do something like the following now:

$ envstat -s "acpibat0:charge,acpibat0:charge state,acpitz0:temperature"
[acpibat0]
       charge:      3.015 Ah (79.70%)
 charge state:     NORMAL
[acpitz0]
  temperature:     54.000 degC
$

* As bonus, the code has been modified to use a simple queue for
  the sensors, and this has simplified and improved some parts of the
  code as well.

[1] Item requested by joerg@ yesterday.

sync with HEAD

Implement the 'refresh-timeout' property in device blocks for the
configuration files. This sets the timeout value that will be used
to check for critical limits.

The value can be viewed by the 'envstat -D' command.

sync with HEAD

- Rename ENVSYS_BATTERY_STATE units to ENVSYS_BATTERY_CAPACITY and
  introduce ENVSYS_BATTERY_CHARGE, which is the same than an Indicator and
  it's used to know if the battery is currently charging or discharging.

- Require two sensors at least for SME_CLASS_BATTERY to make the low-power
  condition work: a ENVSYS_BATTERY_CAPACITY plus ENVSYS_BATTERY_CHARGE.

- Simplify sme_event_check_lowpower() and make it check the required
  sensors in the SME_CLASS_ACADAPTER and SME_CLASS_BATTERY classes.
  If the acadapter is not ready, trust the state returned by the battery
  device.

Based on suggestion from joerg@.

Pull up following revisions via patch (requested by bouyer in ticket #1838):
	distrib/sets/lists/man/mi: revision 1.997
	sbin/bioctl/strtonum.c: revision 1.1
	sys/dev/Makefile: revision 1.25
	sys/arch/amd64/conf/GENERIC: revision 1.139
	sbin/bioctl/strtonum.h: revision 1.1
	sys/dev/bio.c: revision 1.1
	sbin/bioctl/bioctl.c: revision 1.1
	share/man/man4/bio.4: revision 1.1
	sbin/bioctl/bioctl.8: revision 1.1
	sys/sys/envsys.h: revision 1.11
	sbin/bioctl/bioctl.8: revision 1.3
	sbin/bioctl/bioctl.8: revision 1.4
	sys/arch/i386/conf/XEN2_DOM0: revision 1.25
	distrib/sets/lists/base/mi: revision 1.704
	sys/conf/majors: revision 1.34
	share/man/man4/Makefile: revision 1.426
	etc/MAKEDEV.tmpl: revision 1.86
	sys/arch/i386/conf/GENERIC: revision 1.825
	distrib/sets/lists/comp/mi: revision 1.1022
	sys/conf/files: revision 1.839
	usr.sbin/envstat/envstat.c: revision 1.24
	sbin/Makefile: revision 1.105
	sys/dev/ic/mfi.c: revision 1.4
	sys/dev/biovar.h: revision 1.1
	sys/dev/ic/mfivar.h: revision 1.4
	sbin/bioctl/Makefile: revision 1.1
Fix typo.
Add bio(4) and associated bioctl(8) from OpenBSD, a driver control block
device controllers, and more specifically raid controllers.
Add a new sensor type, ENVSYS_DRIVE, to report drive status. From OpenBSD.
Add bio and sysmon support to mfi(4). This allow userland to query
status for drives and logical volumes attached to a mfi(4) controller. While
there fix some debug printfs in mfi so they compile.
Add bio(4) to amd64 and i386 GENERIC.
Add bio(4) and associated bioctl(8) from OpenBSD, a driver control block
device controllers, and more specifically raid controllers.
Add a new sensor type, ENVSYS_DRIVE, to report drive status. From OpenBSD.
Add bio and sysmon support to mfi(4). This allow userland to query
status for drives and logical volumes attached to a mfi(4) controller. While
there fix some debug printfs in mfi so they compile.
Add bio(4) to amd64 and i386 GENERIC.
Fix Dd argument (use full month names).
Use more markup.
Comment out references to safte(4) and softraid(4), which don't exist in
NetBSD.
Remove trailing whitespace.
Use macros instead of characters for HTML output (replace ">", "<"
with \*[Gt], \*[Lt]).
Sort sections.
Create /dev/bio

New configuration file format for the envsys framework:

foo0 {
	#
	# CPU Temperature
	#
	sensor0 {
		critical-max = 70C;
		critical-min = 20C;
	}
	...
}
...

Removed the -m flag that was previously used to set properties for
sensors. Now the -c flag will process all properties specified in
the file (accepted as argument).

To remove all properties that were set, the new -S flag can be used.
This will restore default values for all devices.

- Simplify find_sensors().
- Remove a block that is not used anymore in check_sensors().

Merge a patch from Iain Hibbert (plunky@):

- some unclear language cleaned up
- inconsistent usage of 'device' and 'driver' to refer to the same thing
- difficult error handling

And print the device name if -d flag is not specified for any driver
registered, e.g:

$ envstat
[aiboost0]
  CPU Temperature:     36.000 degC  max:   70.000 degC  min:   15.000 degC
   MB Temperature:     38.000 degC  max:   50.000 degC  min:   15.000 degC
    Vcore Voltage:      1.232 V     max:    1.350 V     min:    1.150 V
     +3.3 Voltage:      3.264 V     max:    3.500 V     min:    3.000 V
       +5 Voltage:      5.017 V     max:    5.600 V     min:    4.500 V
      +12 Voltage:     11.932 V     max:   13.500 V     min:   11.200 V
    CPU FAN Speed:       1268 RPM
$

sort options

Another typo in a comment.

Fix a comment.

Check argc before calling open(2), and use the out label in another
error case.

Fix a lint(1) warning and remove oldsize in print_sensors(), it's
not used.

Don't forget to check if -s was specified without -d, and add a macro
to check it in two places.

Redo how the arguments are processed, so that arguments not allowed
will call usage(). Also remove an extra free().

Update to match current kernel code.

Add the -I flag that skips sensors with invalid state. They are shown
by default, but this is for users that don't want to print them.

Add a new sensor type to sysmon_envsys(9): ENVSYS_GSTRING.

ENVSYS_GSTRING (aka Generic String) uses the genstr member in
the envsys_data_t struct to add a generic string that envstat(8)
will show as value or state.

It's like the ENVSYS_DRIVER, but doesn't use value_cur. Below
is the dictionary created on these sensors:

<dict>
	<key>description</key>
	<string>acpibat0 charge state</string>
	<key>generic-state-string</key>
	<string>NORMAL</string>
	<key>monitoring-supported</key>
	<false/>
	<key>state</key>
	<string>valid</string>
	<key>type</key>
	<string>Generic string</string>
</dict>

Note that it's limited to 32 chars, but we can grow it if needed.

envstat(8) will print ENVSYS_GSTRING sensors as:

$ envstat -dacpibat0 -s"acpibat0 charge state"
  acpibat0 charge state:     NORMAL
$

In temperature sensors, do not convert to degC or degF if there's
no value returned.

Check if the dictionary is empty and print a message if it's true.

The caller of prop_dictionary_externalize is responsible to free the
returned buffer... make it so. Reminded by prop_dictionary(3).

file envstat.c was added on branch matt-mips64 on 2007-08-05 23:20:45 +0000

The caller of prop_dictionary_externalize is responsible to free the
returned buffer... make it so. Reminded by prop_dictionary(3).

Erm... fix previous.

Fix a logic bug: report a message and error if -s or -m is being used
without -d.

Return the value returned by prop_dictionary_recv_ioctl() if the -x flag
is specified too.

- Return the value returned by prop_dictionary_{recv,send}_ioctl
  in all cases.
- Skip sensors that do not have a description object in its dictionary.

Only allow to use ENVSYS_SETDICTIONARY if the user has write permission
in the /dev/sysmon device.

Use O_RDONLY for ENVSYS_GETDICTIONARY and O_RDWR for ENVSYS_SETDICTIONARY
in envstat(8).

Fixes PR kern/36661 by YAMAMOTO Takashi.

Add the -r flag, which is a dummy flag... only added for compatibility
reasons.

Define a set of macros to avoid writting same code many times.

Add a missing printf in parse_dictionary() and simplify this part to
avoid code duplication in two places.

Remove a comment that is not valid anymore.

- Do not refrence memory already freed, thanks to Geoff C. Wing for
  the analysis. Closes PR bin/36636.
- Also use the longest string for the column alignment counting all
  sensors available from all devices, not per-device.

Thanks to rmind@ for help.

Align drive state string like other sensor types.

Before checking sensor type:

- check if if its state is invalid
- print the 'N/A' string and continue

This avoids code duplication.

Print invalid state with 'N/A' for Indicators, like any other sensors.

We follow the following scheme now:

value_cur set => ON
value_cur not set => OFF
invalid state => N/A

Print 'N/A' for invalid sensors rather than an asterisk, with the
exception of Indicator sensors.

Indicator sensors now will print "ON" if they are in valid state, or
"OFF" if they are in invalid state.

By popular demand, do not skip sensors with invalid state. Print them
with an asterisk, as was suggested by Greg. A. Woods.

Example:

$ ./envstat -dlm0 -s "CPU Fan,System Fan,Aux Fan"
     System Fan:       *
     CPU Fan:       1308 RPM
     Aux Fan:          *
$

Except Integer and Driver sensors, which shouldn't need that.

Imported envsys 2, a brief description of the new features:
(Part 3: userland)

* Support for detachable sensors.
* Cleaned up the API for simplicity and efficiency.
* Ability to send capacity/critical/warning events to powerd(8).
* Adapted all the code to the new locking order.
* Compatibility with the old envsys API: the ENVSYS_GTREINFO
  and ENVSYS_GTREDATA ioctl(2)s are supported.
* Added support for a 'dictionary based communication channel' between
  sysmon_power(9) and powerd(8), that means there is no 32 bytes event
  size restriction anymore.
* Binary compatibility with old envstat(8) and powerd(8) via COMPAT_40.
* All drivers with the n^2 gtredata bug were fixed, PR kern/36226.

Tested by:

blymn: smsc(4).
bouyer: ipmi(4), mfi(4).
kefren: ug(4).
njoly: viaenv(4), adt7463.c.
riz: owtemp(4).
xtraeme: acpiacad(4), acpibat(4), acpitz(4), aiboost(4), it(4), lm(4).

Pull up following revision(s) (requested by bouyer in ticket #603):
	distrib/sets/lists/base/mi: revision 1.704
	distrib/sets/lists/comp/mi: revision 1.1022
	distrib/sets/lists/man/mi: revision 1.997
	doc/CHANGES: revision 1.839
	sbin/Makefile: patch
	sbin/bioctl/Makefile: revision 1.1
	sbin/bioctl/bioctl.8: revision 1.1
	sbin/bioctl/bioctl.c: revision 1.1
	sbin/bioctl/strtonum.c: revision 1.1
	sbin/bioctl/strtonum.h: revision 1.1
	share/man/man4/Makefile: revision 1.426
	share/man/man4/bio.4: revision 1.1
	sys/arch/amd64/conf/GENERIC: revision 1.139
	sys/arch/i386/conf/GENERIC: revision 1.825
	sys/arch/i386/conf/XEN2_DOM0: revision 1.25
	sys/conf/files: revision 1.839
	sys/conf/majors: patch
	sys/dev/Makefile: revision 1.25
	sys/dev/bio.c: patch
	sys/dev/biovar.h: patch
	sys/dev/ic/mfi.c: revision 1.4-1.5
	sys/dev/ic/mfivar.h: revision 1.4
	sys/sys/envsys.h: revision 1.11
	usr.sbin/envstat/envstat.c: revision 1.24
Add bio(4) and associated bioctl(8) from OpenBSD, a driver control block
device controllers, and more specifically raid controllers.
Add a new sensor type, ENVSYS_DRIVE, to report drive status. From OpenBSD.
Add bio and sysmon support to mfi(4). This allow userland to query
status for drives and logical volumes attached to a mfi(4) controller. While
there fix some debug printfs in mfi so they compile.
Add bio(4) to amd64 and i386 GENERIC.

note bio(4), envsys(4) DRIVE, and mfi(4) support for both.

tred->sensor is a u_int.

Add bio(4) and associated bioctl(8) from OpenBSD, a driver control block
device controllers, and more specifically raid controllers.
Add a new sensor type, ENVSYS_DRIVE, to report drive status. From OpenBSD.
Add bio and sysmon support to mfi(4). This allow userland to query
status for drives and logical volumes attached to a mfi(4) controller. While
there fix some debug printfs in mfi so they compile.
Add bio(4) to amd64 and i386 GENERIC.

In -i mode, flush standard output after each line.  This is needed to
make the output appear in a timely fashion when redirected to a file
or pipe.

One r in the option string is enough; from Jeff Ito.

Remove unhandled option letter c from option string, noted by Jeff Ito.

Sync usage with man page.
From Kouichirou Hiratsuka in PR 25798.

- move the row printing code into it's own function.
- pay attention to interval processing with row printing (-r -iN).

the latter fixes PR#24522.

in -r mode, if given "-s sensor_list", only list the given sensors instead
of always listing them all

As pointed out by Dave Huang, revert back to using 273.15 rather than 273.16
when converting between kelvin and celsius.

C = K + 273.16.

Homogenize usage messages: make the 'usage' word all lowercase, as this seems
to be the most common practice in our tree.

Don't display data for sensors with ENVSYS_FCURVALID not set.
Clean up a little.

Not all size_t's are equal to int...

- pass lint
- use size_t where appropriate
- use err/warn instead of printf, and don't hide the error messages from ioctl.
- keep units in sync (someone added integer in the header file and forgot
  to update envsys.c)

fix usage [add -r]

exit 0 when -r

Update -r option to display data in correct units, IE temperature in degC or
degF, fan speed is now correct, and indicators will now show ON/OFF.

Include <paths.h>

ANSIfy.

add ENVSYS_INDICATOR and ENVSYS_INTEGER types

convert to use getprogname()

Pull up (requested by thorpej):
envstat.8 1.1->1.2
envstat.c 1.2->1.3

If the `device' argument is not specified, attempt to open /dev/sysmon.

Indicate that the device argument is not mandatory.

If the `device' argument is not specified, attempt to open /dev/sysmon.

Don't declare 'extern opt*' getopt variables.

Add envstat(8) for displaying sensor readings from any envsys(4)
compatible device.