Commit graph

1942 commits

Author SHA1 Message Date
Harald Hope c3d0e551a4 lintian edit 2021-12-14 10:42:16 -08:00
Harald Hope 4c3ab65d46 Huge refactor of CPU physical/core/cache logic. That was some very old logic
with a lot of hacks and patches, but it had never been actually rewritten to
take advantage of Perl's far more powerful and robust data structures and logic.
This caused a continuous stream of error cases in subtle ways, or not so subtle,
and fixes were just changing how the errors manifested.

Tnanks very much to linuxquestions.org Slackware forum people for massive help,
and also to linux.org forum members for ongoing help and data and debugging.

Note Changes 5, change of default widths in display to 80 columns, and out (aka,
console, or ssh into remote system), 100. You can still use other widths if you
like something wider using the configuration options shown. Also upped max
columns wrapping line starters to own rows to 110 columns from 90, again the
idea being to make output more readable to other users when posted in public.

I've been thinking of this change for a long time, but was hoping -y would
register with users, but it hasn't gained enough traction, so the result is way
too many super hard to read issue reports, forum posts, linux kernel issues,
etc, it's honestly gotten sort of embarrassing because they make it look like
inxi has bad output. Sidescrolling code blocks in forums in particular are
absurdly hard to read and scan rapidly for data.

Going along with the width and indentation changes, for most main row types, if
they wrap to a second row, they are further indented 2 column2, to make it
easier to see what they belong to. The two levels of indentation contain more
useful visual cues as to what belongs to what.

There was a temptation to release this as either 3.4.00 or 4.0.00 but in the
end, I decided to follow the numbering rules, and to just roll it to 3.3.10
since there aren't really any primary new features even though CPU was basically
rewritten in large part, and big parts of inxi were also changed, upgraded, and
enhanced. But no truly new features, just some display control items like -Y,
--indent, --indents.

I hope this refactor meets its primary goals, and that the new defaults for
display help resolve public posting issues which have grown increasingly
annoying for anyone trying to read those pasted in too long outputs.

--------------------------------------------------------------------------------
KNOWN ISSUES:

1. Android seems to have CPU cache data, but does not show any 'size' item. But
it does have the other data for each cache type internally, which is odd.

2. In some instances, the parent key:value pairs with '' as value, those are
parents of children key:value pairs, are left hanging at end of line, with the
children on the following line. This can look awkward, but in other cases,
actually looks very good, it depends if it's at the start or end of the line.

I won't say this is not correctable, but it would be very difficult, and outside
the scope of this release, but that is something that I may look at for a future
release now that the output generator logic was reworked slightly for Change 5b.

It's tricky though, because in cases where it's the first item on the line, you
want that behavior, but when it's last, you don't. But this may be worth
revisiting in the future.

3. In some cases, -Y + -y1 may lead to the start of the block scrolling off the
top of the visible screen. This isn't really correctable, so if that's an issue
for you, just don't use -y1 with -Y and all the output will wrap nicely.

4. There is an unaccountable ~10-20ms delay reading cpufreq/scaling_cur_freq,
per thread/core, which really adds up on high thread count CPUs. There is a
workaround in inxi to use cpufreq_cur_freq if it is readable, ie, if you are
root or use sudo, but to fallback to scaling_cur_freq if can't read cpuinfo_...

This is a drag, and really looks like a kernel bug, or a frequency driver bug.

--------------------------------------------------------------------------------
BUGS:

1. 3.3.09 and 3.3.10 CPU bug fixes:
* Failed to filter out certain virtual machine CPU core speeds, and showed more
speeds than the instance actually has. Noticed this with KVM running on Xeon
CPUs.
* For many cases, L2 cache, particularly for Intel, was completely wrong, it was
showing L3 caches, or L3+L2. Failed to handle cases where L2 cache belongs to
more than 1 core, except for using a crude hack for AMD Bulldozer microarch.
Older Intel Core 4 core CPUs would sometimes be 1 L2 per die, and the 4 cores
were actually 2 core duo cpu dies, with one L2 cache per die.
* Shows wrong core count for complex core complexes like those found in Intel
Alder Lake, now shows correct count of actual cores, regardless of the MT or ST
state of each core.
* Showed invalid L3 cache values in some legacy cpus that had no L3 cache, that
is due to a bug in the dmidecode data itself. Solution is to never use dmidecode
cache data if any other valid L1, L2, or L3 cache data found for Linux, and to
only use dmidecode data for bsds if no L1, or L2, or L3 data found. Or if forced
with --dmidecode.

2. An unfortunately long standing bug found and fixed, thanks slackware users!
cp_cpu_arch was, and has been for a while, failing to convert hex stepping to
decimal, or test if the string it gets is even a possible hex value, this
resulted in all Intel CPUs with stepping > 9 failing to ID correctly for cpu
arch.

3. In a related bug, hex to decimal tool used to create --admin hex/decimal
output for family/model/stepping was also not testing if the string was an
actual valid hex number. Case in particular, power pc with revision field
contained a long string, which was of course not a valid hex number, and that
tripped a Perl error when it was asked to convert a non hex string to decimal.

4. Long standing bug found while doing Change 5: inxi actually never applied
separate in/out of dispay to widths because using a legacy boolean that was not
updated, so it was always using out of display widths.

--------------------------------------------------------------------------------
FIXES:

1. Incorrectly calling PowerPC 'revision' 'stepping' for -Ca, that is now stored
as $cpu{'revision'} to avoid mixing up the logics there. For PowerPC shows as
rev: [string].

2. Microarch:
* AMD family 15, model 2 as bulldozer, actually piledriver.
* AMD family 17, model 18, was supposed to be zen/zen+, since I can't tell those
apart, seen stepping 1 is zen+, but had incorrect match.
* Intel family 6, model 25, stepping 2 as nehalem, should have been westmere.
* Changed Penryn to Core Penryn, intel family 6, model 17
* misc other micro arch fine tunings.

3. Code fix 8, switched to global %risc for arm, mips, ppc, riscv, sparc. This
corrects many sloppy handlers, and makes all risc processing the same, and calls
device tree readers for all risc systems, not just arm or arm and mips.

4. In cases where bogomips were 0 due to false values in risc results, show N/A.

5. Removed all attempts to guess at what /proc/cpuinfo cache size: refers to,
it can literally be anything, a per core L1, a per core or cpu L2, or an L3.
So applying any math to it is just a random guess at that point. If any L1,2,3
cache data is found, don't use the cache: value at all, but that will only be
present if no /sys data was found anyway, and if cpuinfo had no specific cache
type fields, only generic cache.

6. Added failsafe tests for stepping and model id before doing conversion to
hex. Make sure integer!

7. Added L1 D cache, was only using I cache for BSDs. Output will show total for
L1 A + L1 D. No idea why I didn't use L1 D, makes little sense, but that's how
it goes.

8. Made bogomips tests more granular, now only rejects low sub 50 bogomips
values if %risc cpu type. Legacy ancient cpus like 486 could and did have
bogomip counts below 50.
https://tldp.org/HOWTO/BogoMips/bogo-list.html

9. See Enhancement 12 as well. If OpenBSD, which has no per core data or
physical cpu data, is running on MT capable cpu, but for security OpenBSD has
disabled MT, will now force MT to be not shown via the hw.smt value. This
removes a small glitch that would have bothered OpenBSD users who know that
OpenBSD has disabled MT for security purposes.

10. Changed BSD hack to use L2 cache totals to deduce > 1 physical cpus, that
was flat out dumb, since we can just use dmidecode type 4 to iterate physical
cpu counts and skip the pointless logic. Thus, if dmidecode, and if > 1
dmidecode type 4 found, and if physical cpu counts equal 1, then replace the
found counts with the dmidecode physical cpu counts.

11. Corrected bad assumption that threads would always be 2 per core for MT
tests. Still no way to reliably determine threads per core for non x86 cpus like
powerpc however, but those are very fringe and should rarely be an issue since
that data is only missing on very old linux now I think.

12. Fixed 'parameters:' going to its own line with -Sa, that wasn't supposed to.
-S is two lines, the kernel / host stuff, and the desktop/console/distro stuff.

13. Fixed case when key: value first word plus other parts of line longer than
max width, failed to wrap as expected.

14. Added start/end ' and " start / end \s to main filters.

--------------------------------------------------------------------------------
ENHANCEMENTS:

1. CPU: most Linux will now show L1 and L3 cache with -Cx without needing
sudo/root, and it will be more accurate than ever before.

2. CPU: shows per CPU L1/L2/L3 totals, and shows actual full system physical
processor count * L1/L2/L3 total in parentheses, like: L2: 1.5 MiB (3 MiB).

3. CPU: A long standing annoyance, previously for main CPU 'Speed:' item, showed
the fastest core speed found, now shows avg: [speed] and with -Cx, shows the
'high:' as well if > 1 cores, and if 1 or more cores have a higher speed than
the other(s).

4. CPU: Handles advanced cases of new architectures, like Alder Lake with
Performance and Efficiency cores, future Zen, and existing ARM CPUs with 2 or
more different core sets, with different max/min frequencies. Previously a hack
was used to handle only ARM CPUs with this type of architecture. Will show
correct CPU core counts, which previous inxi versions would fail to do for Alder
Lake type scenarios of 8 single threaded CPUs and 4-8 multithreaded )MT)
perforance cores.

This should also in theory show different the different min/max speeds if they
were detected. Those did not seem to be set correctly in Alder Lake sample data
I saw however, P and E cores were set to the same min/max speeds.

5. Added CPU types MST (Multi+Single Thread), AMP (Asymmetric Multi Processing),
and AMCP (Asymmetrical Multi Core Processor). This will be applied to any CPU
that has this type of complex topology that has been dynamically detected, like
Alder Lake or different core count or min/max speed RISC CPUs.

6. CPU: shows with -Ca for cases where different L1/L2/L3 caches found per
physical CPU, as with Alder Lake, but also many other variants that were poorly
or not at all handled before, how many of each cache type (L1 Data, instruction)
were found, otherwise will show how many of each cache were found.

7. CPU: shows with -Ca in Topology: report, for cases like Alder Lake with
different core types in one physical CPU (type: MST AMCP), the number that are
single threaded (st) and number that are multi-threaded (mt).

8. Basic support for rsyc-v systems, going along with code fix 8, fix 3, now
it's easy to add this type of support.

9. Added shortcut options for --filter-label (--zl), --filter-uuid (--zu), and
andded new filter option, --filter-vulnerabilities (--zv). The latter is added
by request, a decent idea to have option to not show cpu vulnerabilities.

10. Going with fix 7, switched to a sort of pseudo L1 d/i with desc report for
any BSD with L1 I/D cache found, or elbrus cache0 (icache) / cache1 (d cache).
Elbrus should hopefully be handled by the /sys tool. Guesses on the L1 are ok,
since those are almost always per core, so it's fine. Didn't expect to enhance
any BSD cpu data this time around, but there you go!! If they have the data,
then it will be used. Not going to go overboard though in that, quite useless
overall since usually can't see how many CPUs are present, at least not usually.

11. For -Ca, full CPU topology report if any complex topogy is detected,
otherwise shows the same basic Info: 2x 6-core or Info: dual core as before, no
point in wasting a line for something with no more data than the short string.
Complex types include MT CPUs since they will have different thread counts etc,
and will have 2 or more threads per core, which will also be listed.

12. If smt status is defined (0/1), shows smt: enabled|disabled in Topology
section, can be useful for systems with disabled MT, but supporting it. If no
topology data found (OpenBSD for example), for -C shows 'smt: disabled' after
'type:' section, and enabled if -Cxxx (since MT really already tells you that).

13. For -Ca Speed: report, added 'governor:' item, if found. Can show 1 or more
active governors.

14. Output height (in lines) control: -Y [-2|-1|0|1-xxx]]. This lets you break
up any of the output into whatever number of lines you want. Also useful out of
DISPLAY for reading -h options menu items etc.

It came tp my attention that the long standing shift+pgup/pgdown (aka
'softscrollback) behavior had stopped working, and in fact has been removed from
the current Linux kernel, at least until it is rewritten to be more clean and
understandable. Read more about it in these kernel post/commit messages:

https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git/commit/?id=50145474f6ef4a9c19205b173da6264a644c7489
https://lwn.net/ml/linux-kernel/CAHk-=whe4ZdTdCebneWqC4gSQZwsVJ5-Emg0BucOGCwPhOAJpw@mail.gmail.com/

Options for -Y are:
* -Y 0 or -Y: Set maximum block height to terminal line height.
* -Y [1-xxx]: Set maximum block line height to given integer.
* -Y -1: Print out one primary data block item at a time, with -F for example.
* -Y -2: Restore default unlimited height if LINES_MAX configuration item used.

15. And finally, more disk vendors/vendor ids. As usual. As expected.

--------------------------------------------------------------------------------
CHANGES:

1. If /sys or /proc/cpuinfo speed data available:
* For -b CPU item:
   speed: [speed MHz] min/max: [min]/[max] MHz
  becomes:
   speed (MHz): avg: [speed] min/max: [min]/[max]
* For -C, Speed item
   Speed: [speed MHz] min/max: [min]/[max] MHz Cores (MHz): ...
  becomes:
   Speed (MHz): avg: [speed] min/max: [min]/[max] cores: ...
* For short form, shows speed/min/max but uses average speed if available.

For -b and -C, only shows one MHz in Speed line starter, which slightly shortens
the line even with the added 'avg:' item since 3 MHz are replaced with 1.

2. Going with change 1, now the 'avg:' item shows not the fastest cpu speed
found, which was the case before, but shows an average of all cpu speeds found.
Showing the fastest made some sense back in the days of single core, or even
dual core CPUs, but makes little sense today with many core/threaded cpus.

With -x, it will show the high: [speed] item as well, after 'avg:'.

3. By suggestion, wrapped first Type item in Vulnerabilities to its own line,
that's a verbose --admin option after all, no need to save lines!

4. Going along with Fix 5, give up on trying to pretend we can guess at L2
cache, now if only 'cache' data was available from cpuinfo, will just say:
cache: [cache size]
 note: check

and call it a day.

5a. Change default width to 80 columns, in and out of display. Too many users
are posting horribly wrapping inxi output in forums, issue trackers, etc, and it
frankly makes inxi look really bad, creates awful side scrolling code boxes,
etc. So now default widths in and out of console are 80 (since often data is
generated in SSH or out of X/Wayland) for issues.

This essentially makes -y 80/-y the default width. This is what I've been using
for a few years now, and after seeing far too many side scrolling or badly
wrapping inxi outputs online, I think it's probably time to just force 80 column
widths as default and call it a day.

You can change these new defaults using configuration options (these are the
previous options, though due to a bug, COLS_MAX_CONSOLE was never being used):

 COLS_MAX_CONSOLE=115 # in display, terminal client max width
 COLS_MAX_IRC=100
 COLS_MAX_NO_DISPLAY=130 # not in display, no X/Wayland running

5b. Changed output wrapped indent to 1 column from 2, and make second and
greater rows of a line indent +1 to make it more clear that it is a child row of
its parent row. Note that because no arg short form, -S, and -I are special
types of rows, this behavior is not used, they just print out as usual. This 1
column indent also applies to -y1, making for a little more data per line but
more readable and easy to follow.

6. If > 1 physical cpu detected, no longer uses single/dual/triple/quad core
strings, rather uses: 2x 2-core. Also uses lower case -core, not -Core.

7. Only show die counts for CPU (on rare occasions > 1 found) with -xx. Not
particularly important bit of data afterall.

8. Make L1, L3 cache data show with -Cx, not -Cxx, now that it's working well.

9. Removed CPU die for -Cxx, that's only going to show with -Ca now.

10. If -Ca, and if certain complexity conditions are met, shows a separate
Topology line rather than the Info: 6-core type item. For -b, short, -Cx, -Cxxx
shows the Info: topology short form.

11. Bogomips always shows before flags data, whether -f or just -Cx trips flag
output.

12. Flags/Features now shows in the same place, under Speeds: always, whether
-Cx shortlist, or -Cf full list. Makes more sense that way, and code is much
cleaner too.

13. Bogomips, being essentially bogus units of speed for cpu, are moved into
Speed: report.

--------------------------------------------------------------------------------
DOCUMENTATION:

1. Updated man/help for new CPU extra data options and output changes.

2. Cleaned up and added sample outputs for man CPU items.

3. Now that doas is getting into Linux distros, removed all mentions of doas as
a BSD option, and made it a general doas/sudo item. Glad to see doas making it
into linux distros, it's a good tool, much easier to configure and use than
sudo. Good job OpenBSD guys. Note that inxi already has had full doas support
for a while now, but this finalizes it, and makes it fully agnostic. Internally
doas is actually preferred over sudo, by the way.

4. Added documention items for INDENT (--indent), INDENT_MIN (--inident-min).

5. Re-ordered help menu and man page, created new Filters and Output Controls
sections to make stuff easier to find. In man page, also added on top a list of
OPTIONS sections to make finding stuff easier.

--------------------------------------------------------------------------------
CODE:

1. Removed legacy /sys cpu functions: cpu_bugs_sys(); get_boost_status();
set_cpu_speeds_sys(). cpu_speeds() is deprecated and now will only be used for
legacy Linux and BSDs if they had any per core speeds found; get_caches() was
only a placeholder for the full featured cpu_sys data source, and was removed;
cpu_speeds() no longer needed, integrated into other logic; cpu_dies_sys()
removed, integrated into other logic.

This logic is now integrated into cpu_data_sys() data generator.

2. Changed the main CpuItems functions to use array/hash references, not passing
full hashes or arrays in most cases now.

3. For machine_data_soc(), switched to CpuItem::cpuinfo_grabber() which then
sets the global @cpuinfo and %cpuinfo_machine items, which will be used again
in Cpu if cpu data is requested. This gets rid of a full parsing of cpuinfo
just to get the machine data section, and also makes it so cpuinfo in cpu does
not need to worry about the machine data block, which is not related to the
processor blocks anyway, that was always a hack done by the kernel guys to toss
that SOC data somewhere as far as I can tell.

4. New tools:
* either_or() - takes a list, and returns the first defined element of list.
* regex_range() - generate ranges from comma, space, or ranges like 2-29, or any
combination of those, like 3,6,12-29

5. Added --force cpuinfo to bypass all /sys based cpu logic, useful for testing
to see what would have happened using old logic.

6. Added --dbg switches 39, 40, 41, for the new cpu sys data features, also made
more consistent --dbg 8 and --dbg 38 switches.

7. Added sys/cpuinfo pair debugger to support debugging complex sys/cpuinfo
issues.

8. Got rid of $b_arm,$b_mips,$b_ppc,$b_sparc, replaced with global %risc, also
added $risc{'riscv'} type. this makes general risc type feature testing a lot
easier since inxi can either test for %risc defined, or for a specific type of
risc cpu. This is much cleaner, and use $risc{'id'} for print purposes, which
got rid of a lot of tests. Also made all risc tests consistent, some were ARM
only, or arm/mips, but were supposed to be for all risc cpus.

9. Set help menu code to roughly 80 columns width assuming 2 space tab
indentation.

10. Changed all xxx_cleaner subs to clean_xxx, all filter subs to filter_xxx,
and row_defaults() to message().

11. Dumped redundant fallback logic in get_kernel_bits, if first getconf method
fails, use $sys_bits, and call it good, it was repeating the 32/64 bit tests
pointlessly.

12. Cleaned up print_data() to allow for more fine tuned indentation for the new
2 indent levels.

13. Made help menu code more or less wrap to 80 columns, or close. Ongoing to
bring to 80 columns where practical, but never at expense of clarity or logic.

--------------------------------------------------------------------------------
-- Harald Hope - Tue, 13 Dec 2021 10:25:49 -0800
2021-12-14 10:35:42 -08:00
Harald Hope 2feaf0b853 Thanks manjaro user alven for finding a bunch of corner and not so corner case
errors, glitches, documentation oversights, etc.

This is a point release between the coming full CPU refactor and the current
set of bug fixes and issue handlings.

This release also contains the debuggers for the new CPU data logic, which are
important to get this CPU refactor stable and reliable across old/new systems,
different operating systems and platforms.

Wanted to do this intermediate releaase to get the current fixes out, which
make inxi overall better for CPU issues, but do not handle the core requirement
to do a full refactor.

--------------------------------------------------------------------------------

CORRECTION:

1. On release notes for 3.3.08: due to a long delay to get real debugger data
from the person who had the issue, but finally getting it after the release of
3.3.08, there was NO bug in ps wwaux output. Something else was creating the
linewraps, maybe the subshell, it's basically impossible to know since we never
got a real debugger data set, which is the only real way to get the actual same
data inxi will see.

Was it a subshell wrapping the output? We just can't know, nor are we likely to
ever find out.

This highlights very well however why some issues are essentially impossible to
ever fully resolve without the --debug 22 dataset. This bug/fix is definitely in
that class of issues.

It's never good to accuse another program of having a bug when it doesn't, so
sorry to ps authors, no bug or issue exists for ps in this area.

--------------------------------------------------------------------------------
KNOWN ISSUES:

1. wiryonolau issue #259 points out that if --tty is used, default IRC filter
rule is still active and on. Because his case appears to be from an autostart
using Bash, which then gives up to find the parent at dash, which then makes
inxi believe it's in an IRC shell client, that issue doesn't appear to be
resolvable.

--------------------------------------------------------------------------------
BUGS:

1. Documentation, help menu and man page showed wmctl instead of wmctrl,
which for someone who reads the help man, leads to command --fake wmctl failing.
Thanks manjaro user alven for finding this typo.

2. For dmidecode cpu data, had global total values for cache that could result
in wrong output values, 2x or more wrong for L1 / L3 cache on linux. Difficulty
is preserving that data for bsd, which in general do not show phys cpu counts,
and thus make showing totals off. Created new '-total' item for each L cache
type, which will handle > 1 cpus, and also can be used to determine if > 1 cpus
present!.

3. Manjaro user pointed out that hub types were wrong, this is because inxi was
using the INTERFACE ID values for hubs instead of the TYPE values. For all other
device types, INTERFACE is correct, but for hubs, we needed TYPE, so fix is to
detect INTERFACE 9/0/0 and if TYPE present for that, swap.

--------------------------------------------------------------------------------
FIXES:

1. For > 1 cpu systems, with dmidecode sourced cpu cache data, can now determine
physical cpu count based on comparing L2 and L2-total values. This means that
when dmidecode is used on BSD for CPU data, inxi may now be able to deduce that
it is a > 1 cpu system.

2. Forgot to set $run{'filter'} to 0 for whitelist start client detection.

3. Going along with bug 3, changed 'Full speed (or root) hub' to:
Full speed or root hub, to make more clear that it's one or the other, or both.

4. For apply_filter(), added test if <superuser required> just return the
string.

--------------------------------------------------------------------------------
ENHANCEMENTS:

1. Going with bug 1, and fix 1, for > 1 cpu systems, will now show for all
cache: items L1: 2x 1.5 MiB (3 MiB), same for L2 and L3. This is far less
confusing than showing the totals without explaining what they are.

2. Going along with 1, now root is not required to show L1 and L3 -Cxx on Linux
as long as the system is reasonably new, about after 2008, and has getconf -a
supported. That support is came in somewhere around 2.10, not sure exactly when.
Debian Etch had it, Sarge did not, Ubuntu 9.10 had it. Tinycore does not have
getconf at all. This will probably be replaced by a more robust full cpu /sys
data tool.

3. Added ht to default short -Cx flag list, that should show, and it's short.

4. Added --no-filter to activate -Z, --filter-override isn't consistent with
other --no-xxx options, even I forgot it. No changes, just another way to use
-Z.

5. For issue #260 added pch as a new sensor output type, it's kind of a builtin
southbridge / northbridge in the CPU die, but it's not a core, and has a
different temp. Will anyone even know what pch is? probably not, but who cares.

--------------------------------------------------------------------------------
CHANGES:

1. No longer showing for > 1 physical cpu systems the sum total of L1/2/3 cache
data. Now shows per cpu L1/L2/L3, and if > 1 cpu, shows for example:

cache: L1: 2x 512 KiB (1024 KiB) L2: 2x 2 MiB (4 MiB)  L3: 2x 20 MiB (40 MiB)

For single physical cpu output remains the same:

cache: L1: 576 KiB L2: 3 MiB L3: 16 MiB

--------------------------------------------------------------------------------
DOCUMENTATION:

1. Updated help/man for L1/L3 cache -Cxx changes.

2. Updated man and help to suggest -Z for --tty.

3. Forgot to note -v 7 adds -f, added to man/help.

--------------------------------------------------------------------------------
CODE:

* Added 'getconf -a' to debugger, that may be usable for cpu cache data, need to
gather data on that to confirm. that's regading issue #257 cache glitches.

2. Removed all * $physical_count for cache data in cpu_properties, that is now
handled by creating string with cpu count, per cpu caches, and total in parens.

3. Added in fallback failure case for the ZFS file system issue exposed by
accident in issue #258 - will now log in debugger the error, so we can try to
find what is going on there, impossible to reproduce until we find what zfs or
more likely, freebsd, changed there. Could be hyper specific, some weird thing
like a person making a zfs device name with space, impossible to guess. Note
that since the freebsd user declined to supply any data to help resolve this
issue, then closed it, we're back where we usually end up with FreeBSD issues,
either a Linux user (or worse, me) willing and able to find the issue and supply
the debugger data required shows up, OR the issue is ignored as valid but
impossible to resolve.

RANT: Note that this also confirmed to me that in order to preserve my own
sanity and not waste endless hours trying to get data, from now on, unless
utterly trivial, if a FreeBSD user refuses to promptly supply the required data,
the issue will be closed with a freebsd-closed-no-data-supplied label, which
means, valid but not possible to solve due to user refusing to help me help
them.

Come on FreeBSD users!! If you want help, and inxi to support your distro, help
me help you!! If not, then why are you even filing an issue in the first place?
Do you expect faeries to spread magic bug / issue fixing faerie dust over inxi
and then activate it with their little wands? This is growing tiresome to be
honest because it's so utterly predictable.

4. Shuffled order of sensor type detections, there was a slim chance that a non
gpu sensor type could have string intel in it, so put the gpu sensors second
to last, before 'main'.

5. Started refactor of cpu core/cache logic. Added feature to cpu_arch, and
changed it to cpu_info since now it gives by vendor/family/model/stepping both
micorarch and cache/core math array returns. Also started refactor to make more
predictable, with increased comments, about what is going on in cpu_properties
to avoid breaking existing correct results.

6. Added to --debug /sys cpu data globber tool, that will help debugging the new
/sys cpu data feature, will let me insert the file data directly into the logic.

7. Added CpuItem::cpu_data_sys() with debuggers, that will now start collecting
user cpu data whenever the debugger is run, though it's not active yet.

8. Set $Data::Dumper::SortKeys = 1; dugh, could have saved big headaches if had
found this before. Makes all keys sorted cleanly, gets rid of random hash sorts.
2021-11-22 12:47:54 -08:00
Harald Hope a36210924e changelog tweak 2021-10-21 12:28:39 -07:00
Harald Hope 385e91e602 Bug fix release. 2 bugs that can impact all users under the right circumstances
were detected and fixed. Thanks manjaro users there for finding and reporting
those. No other changes.

--------------------------------------------------------------------------------
BUGS:

1. Manjaro user ben81 located a critical bug in hardware raid output, this bug
impacts ALL users of hwraid that run inxi with -xx option. Bug was a bad copy
paste, the classic, had updated all the pci type data blocks at once, and hw
raid unfortunately had a slightly different logic due to being part of the more
complex RAID block of logic. Was trying to use an array, not a hash, reference.

Thanks ben81, I would never have spotted this one, and it would impact 100% of
all inxi users with hwraid on their machine who ran inxi with -xx option.

2. Also, ps wwaux parser was spitting out an undefined index error. This is
caused by one of two things:

* ps has an issue, and is apparently at times failing to respect ww, unlimited
line length, and wrapping anyway. This is the likely cause.
* the user terminal for some inexpicable reason has decided to hard wrap long
lines. This is very unlikely, but has to be considered as a possible cause.
Since these commands run in a subshell, this is VERY unlikely.

Workaround this failure by double checking that line split item is defined, if
not, next row. Thanks Carpenter for finding that one.

--------------------------------------------------------------------------------
CODE:

1. Added workarounds for bug 2. Corrected silly copy/paste error for bug 1.
2021-10-21 12:26:48 -07:00
Harald Hope a6c1c46db2 --------------------------------------------------------------------------------
RELEASE NOTES:
--------------------------------------------------------------------------------

Some very nice issue reports have helped correct various corner case issues.
Mint users helped find a big one with lspci.

--------------------------------------------------------------------------------
KNOWN ISSUES:

1. Unsure how to handle Android case where inxi correctly does -r test, see bug
3 fixes 6, but android incorrectly claims it is readable when it is not
readable, then the reader tool can't read the file and fails with permissions
error. This is one of those weird android errors that are pretty much impossible
to fully work around, but we can get rid of the readline() errors when reader()
was trying to work on a file handle that did not exist, that part was an inxi
bug.

--------------------------------------------------------------------------------
BUGS:

1. dm detection was not using case sensitive search for duplicates, leading to
cases where dm like slim / SLiM failed to get detected and then repeated in
output. Anonymous BSD debugger dataset exposed this issue, thanks.

2. In certain corner cases, like ARM Android, sub reader got passed a file that
had passed the is readable -r test, but it still failed with permissions error,
which then led reader to try to keep working with a null $fh. While in theory
nothing non readable should be passed to reader(), that fails when the OS fails
to actually follow correct readable rules, as in this case. Added protections in
reader() to handle this case, now will show error, but will not try to work with
$fh, that is how it should have been all along, but this is a very corner case.
Exposed by an anoymous ARM debugger dataset.

Thanks Termux user for creating the debugger dataset that exposed this issue.

3. lspci parser didn't null port value each iteration, resulting in all pci
items getting port values. Not a big deal, port is only used one place, but good
to find and correct that error.

4. Not an inxi bug, but would appear so to end users: lspsci -nnv implements a
truncating routine and breaks the first line for each bus id. See Fix 6 and Code
fix 3.

--------------------------------------------------------------------------------
FIXES:

1. -S and -I would show Console: tty pts/3 even though pts device is a pty, not
a tty. The only time this happened was when connecting to a remote system using
ssh or something like that. Local console still shows Console: tty 2 since that
was correct, but Console: tty pts/2 was confusing since technically it's not a
tty, it's a pty, pseudo terminal.

Now shows, when relevant: Console: tty 2 OR Console: pty pts/2.

2. Issue #252 notes that Emacs (and possibly other code/text editors with native
embedded terminals) includes a native virtual terminal that also follows
configuration rules from the editor to highlight trailing spaces. This created
odd looking screen output in Emacs vt mode since inxi always sets key/value
pairs with a white space ending as separator for next key value pair for screen
output mode, resulting always in a trailing space on each vt screen line. Fix
was to remove the last trailing space just prior to the print line point to
avoid this issue.

As a general thing, I'm curious to learn if any editor other than Emacs actually
contains its own virtual terminal that also follows the editor rules for output.
Or if any virtual terminal has such a highlight trailing space rule, which would
be imo so annoying it's hard to understand why a vt would implement it. Easy to
understand why Emacs (or any editor) does it, but an editor also being a vt AND
applying certain editor display configurations to the vt is a very specific and
unique circumstance I'd say.

Odd, historical, but there it is, why not handle it?

3. ARM / Android case where certain files passed the read -r test, but failed
with permission denied error. This tripped a further glitch where reader() would
then try to work with the failed $fh, see bug 2. This was really more a fix
than a bug, since the bug in this case was in android permissions tests, not
inxi, but it appears to be a bug to end users, so it's handled now.

4. Another ARM/Android, there was a voltage regulator IP that contained the term
wlan so it tripped false positive for network match. Added a new type,
regulator, to filter out those, like codec and dummy do already.

5. For issue #254, fix for cygwin ERR-102 in partitions, add cygwin test, new
dev type, 'windows', dev base then becomes E: or whatever. To avoid confusing D:
for a key: with no value, added D:/ slash.

6. Mint people discovered lspci issue, lspci -nnv has a bug where it will
truncate the output of the first line per bus ID if it's over some arbitrary
amount, then tack on rev and other items to end of that string, which leads to
the block: [vendorID:productID] getting truncated or removed altogether. Clearly
an oversight, at least I hope it's an oversight on lspci's part, but have to
work around the issue anyway since it may never get fixed, and has been around a
long time. Bug is in lspci 3.7, 3.6.4, and probably earlier.

Also added in a fillin tool for this rare case, lspci -n data is used to replace
the missing values.

Note that while lspci recommends using -mmv, for machine parsing, apparently
nobody noticed that -mmv doesn't have the same data items as -nnv, sigh.

7. Issue #255 noted that the combination of:
GoogleDrive Hogne: fuse.rclone 15728640
which is two word remote fs AND a fs type with a '.' in it would fail to trip
the handler for that multi word remote mount name. Also failed to detect as
remote fs, added fs specific test since the actual mount name doesn't permit
reliable detection as remote type. Testing for trailing ':' isn't safe since
':' alone is not an invalid character in a file system name as far as I know.

Further, this exposed that the ^^ space replacements for $row[0] fs > 1 word
name were not being reset soon enough in the logic, that's also corrected.

--------------------------------------------------------------------------------
ENHANCEMENTS:

1. Neglected to support standard package config file override
/etc/inxi.d/inxi.conf item. This is mainly useful for packaged inxi's who want
to override the distro maintainer /etc/inxi.conf file. Test priority is the same
except /etc/inxi.d/inxi.conf comes right after /etc/inxi.conf now in the test
sequence.

2. Added basic cygwin id, yes, inxi works in cygwin, apparently, with some
issues. Added cygwin os id to distro ids.

3. Added --version info for debugger, sometimes we want to know what verion of
a tool, like lspci, in case it has a bug or something.

4. Added exfat and apfs to unmounted fs types.

5. More disk vendors!! New vendor ID matches!! Yes, yes, you've heard it all
before, the list never ends!! The eternal chaos of existence manifested in just
how many IDs can be generated for new and old disk vendors alike!!!

--------------------------------------------------------------------------------
CHANGES:

1. No changes this release.

--------------------------------------------------------------------------------
DOCUMENTATION:

1. Pull request #253 corrected typos, urls, and other errors in man page,
inxi/pinxi comments, pinxi.1/inxi.1, README.txt, and updated LICENSE.txt to
current gnu wording.

--------------------------------------------------------------------------------
CODE:

1. Forgot to add lspci debugger fake data option, that's corrected. That's
--fake lspci, now works, didn't before, only the bsd pci tools had fake switches
previously, since lspci never needs debugging really, but did now to test an
issue report.

2. Added -CYGWIN to debugger file name. Added -ANDROID if ARM and if android.

3. With Fix 6, refactored entire lspci_data block, added lspci_n_data item,
which matches bus id of lspci -nnv when corruption occurs and replaces vendor,
product, and if also missing, rev version. I kind of knew I'd have to do this
fix one day, that was the same fix logic used on the BSD pci tools, which have
similar issues with consistency in output, or lack thereof.

This refactor is long term very good because it avoids an entire class of
possible errors, and makes pci detections far more robust.

4. Created new repo, for legacy code, inxi-legacy. Moved branch inxi-c to
inxi-legacy/xorg-c, moved branch xiin to /xiin, moved branch inxi-legacy (binxi)
to inxi-legacy/inxi-legacy. Those directories each contain all the files each
branch had in it.

This gets rid of some branches clutter, and nobody needs to see those anymore,
but if they care, they can look at them. Note that to do this, I had to merge
their histories, which was not that nice, but git is just really bad at this
type of stuff, so that's how it goes.

Times like this really make me miss svn's directory based branch approach...

5. Simplified sub fs_excludes, simplified regex constructors for all function
that use this data, made list more fault tolerate by adding global (fs)?(\d{0,2}
which means all file systems can have or not have 'fs' at end, and all can have
or not have a version number in string.

6. Exposed by issue #255, refactored slightly ordering of partition filter
logics and variable resets in the df output processing loop.

7. Added --fake partitions, to help debug odd corner cases like cygwin glitches.
2021-10-11 18:56:00 -07:00
Harald Hope 1e2bef0163 readme update for move of binxi to inxi-legacy repo 2021-09-24 20:40:56 -07:00
Harald Hope 73d9643907 redid patches, I think 2021-08-24 20:39:33 -07:00
Harald Hope b737838957 small fix 2021-08-24 20:32:53 -07:00
Harald Hope 8d7b06ef88 Merge branch 'a1346054-fixes' 2021-08-24 20:15:43 -07:00
a1346054 06aba8cd5a fix whitespace alignment in manpage 2021-08-25 02:14:11 +00:00
a1346054 e09ec42630 fix spelling 2021-08-25 02:13:54 +00:00
a1346054 d6b01b07b1 use https instead of http 2021-08-25 01:46:29 +00:00
a1346054 d03e50d4b7 use identical license file as provided by gnu.org
File was retrieved from:
https://www.gnu.org/licenses/gpl-3.0.txt
2021-08-25 01:38:06 +00:00
Harald Hope a4a420edf7 wrong date on changelog, oops 2021-07-21 21:03:54 -07:00
Harald Hope f571b45973 New version! Fixes!! Bug fixes! More bug fixes!! Cleanups!
Most of these were exposed by issue #251 filed by LukasNickel, then further
revealed via his debugger data set, which showed two more bugs. Well, bugs,
changed syntaxes, same difference to end users.

--------------------------------------------------------------------------------
KNOWN ISSUES:

1. Work is ongoing to add btrfs support to -R (similar to softraid or zfs),
basic stubs and debuggers added, but reporting tools are not as robust (and
often require sudo/root for reasons that escape me) as I would have hoped, so
it's slow. One of these days... Normally would not release with working stubs,
but there were enough real issues/bugs to warrant just getting 3.3.06 out the
door, then going on with the btrfs feature for -R. But so far I view the
reporting tools as inadequate, unfortunately.

--------------------------------------------------------------------------------
BUGS:

1. As initially discovered in issue #251 there are alternate syntaxes which had
never been seen before for remote mounts, fuse mounts, etc. In this case, it was
fuse.sshfs that was not removed from the Disk total:... used: leading to silly
1000+% used percentage. Note that while technically inxi could try to be clever
about reporting impossible percentages, so far those have led to bugs getting
reported, then fixed, so I think it worth leaving it as is.

2. When --swap/-j is used with no other arguments, failed to show uuid or label.
Discovered this while testing fix 2.

3. Bug which is not a bug but will appear as such to users, nvme temps were
failing in -Dx due to a change in how those values are located in /sys. See fix
3.

--------------------------------------------------------------------------------
FIXES:

1. Going along with Bug 1, and considering that only in 3.3.05 was the nfs4
remote fs failure to identify/exclude, the entire section involving remote/ fuse
etc file systems was refactored, and extended to add many more previously
non-handled remote and fuse type file systems. Significant extension of known
remote filesystem types, distributed file systems, overlay file systems, all to
try to avoid having more distributed/remote/fuse file system issues. Also added
test to support fuse. or fuseblk. type prefixes for any of these. Hopefully
there will be fewer issues related to distributed and remote and overlay type
file systems in the future.

2. Made all label/uuid triggers global, that is, -ol shows unmounted with
labels, -ju shows swap with uuid, and so on. This may require a bit more tweaks
to get exactly right, but in general, this is a purely cosmetic fix, that is,
try not to show label/uuid for partition/mounts that probably can't have those
values.

3. There was a change in the way nvme /sys temperature paths were handled, an
actually understandable, albeit as always annoying, one, because inxi actually
had to do a sort of convoluted hack to get the nvme block devices temperatore
paths before, now that hack is not required for newer kernels (5.12+), though
for kernels that had the old paths (5,8, 5.9 at least, don't know when paths
changed) left in the old method. Now tests are more granular, and inxi should
find temperatures regardless of which method is used for nvme and sd type
drives.

4. Another somewhat irksome random change, again, understandable since the new
syntax is more consistent in output than the previous one, but still breaks all
existing parsers that use the changed field names. Lsblk did NOT change the -o
input field names, but DID change the output field names, which broke the
internal inxi parser, and led to null lsblk data.

Changes were - or : separators in input values are output as _ always. that is,
MAJ:MIN becomes MAJ_MIN. Also corrected the debugger lsblk to use the same
output fields for -P -o as the actual lsblk parser uses internally so these
failures can be spotted more readily, as it was, it was literally only because
someone submitted the debugger dataset, and was running lsblk 2.37, where I
believe this behavior change happened. Solution was to just use regex patterns
instead, [:_-], in the parser. Big fear now is that they will randomly stop
supporting the -o input field names that contain - or : and change that too
without any real warning or deprecation notice.

--------------------------------------------------------------------------------
ENHANCEMENTS:

1. Going with bug and fix 1, added avfs, afs, archivemount, avfs, ceph, gfs,
glusterfs, gmailfs, hdfs, ipfs, kosmos/kfs, lafs, mergerfs, mhddfs, moosefs,
ocfs, openafs, orangefs, overlayfs, pvfs, s3fs, sheepdog, vmfs, and several
others to the exclude list for disk used and show label/uuids for partitions.

2. A smattering of disk vendors added.

--------------------------------------------------------------------------------
CHANGES:

1. Going with fix 2, -l and -u no longer will trigger -P by default, now if -l
or -u are used without -j, -o, -p, -P, an  error will explain that you must use
one of those together with -l or -u. This was the only way to get the -l and -u
switches to turn off/on label/uuid reports in swap, unmounted, and partitions
consistently. Triggering -P was really a legacy behavior from when the only
options were -p or -P, and --swap and --unmounted did not exist. I found it
increasingly odd that unmounted would show label/uuid always but partitions only
with -l/-u.

2. This was a pet peeve, sometimes field names just bug me (like 'Topology: did
for CPU, now  corrected to Info:), the Drive: rotation: was one such annoyance.
I had recycled that to indicate SSD, which was a feature request, but that was
always a sloppy solution, and made no sense, since SSD isn't a rotation speed.

Now it reports a much more logical:

ID-1:...... type: HDD rpm: 7200
or
ID-1:...... type: SSD
or
ID-1:...... type: N/A

This also corresponds to the intended meaning much better. The HDD type was
always present internally if rotation speed is detected, but was not used. Now
will also show type: N/A if reliable type detection failed, which will also be
more consistent.

--------------------------------------------------------------------------------
DOCUMENTATION:

1. Brought most of inxi.changelog (this file) into a consistent state, re
whitespaces, readability, consistent use of various header / section names.
Ideally while I don't expect anyone to ever sit down and read this changelog, it
will be now much easier to scan to find whatever interests you. This change goes
along with ongoing changes in docs to in general try to be usually 80 columns
wide.

2. inxi-resources.txt, inxi-data.txt are updated with more raid, partition, file
system values and data to go along with bug, fix, enhancement 1.

3. Man and help updated to indicate -u and -l no longer trigger -P by default.

--------------------------------------------------------------------------------
CODE:

1. Ongoing refactors, bringing the codebase to the point that matches current
coding styles. Removed remainder of whitespaces in conditions and for/while
loops, for example:

if ( condition ) {
becomes:
if (condition){
and
if ( ( test set 1 ) && ( test set 2 ) ) {
becomes:
if ((test set 1) && (test set 2)){

and so on. That dropped over 2 KiB of whitespaces. This went along with fixes
that have been ongoing to change to this whitespace use style, but previously it
was only being  done when that situation was hit in a local block, now it's been
completed globally.

This continues the style refactor that has been ongoing for a while now, to
bring inxi into a consistent state, since when it started, it was more pressing
to get the bash/gawk mess translated to Perl than it was to get the Perl itself
to be as good/consistent as possible, so now those issues are being slowly
unravelled, and hopefully will set inxi on course for its next 10 years.

It was starting to get annoying, because some parts of inxi used those spaces,
and all newer ones didn't in general. Now it's one behavior throughout the whole
program file.

2. Refactored the entire fs exclude for disk used data, and integrated those
values into a global tool that is used either to exclude file systems from disk
used totals, or to not show uuid/labels for the excluded
remote/distributed/overlay type file systems, which in general don't have uuid
or labels.
2021-07-21 20:30:58 -07:00
Harald Hope 30e5bdf563 changed CHANGES: to UPDATES: and ALTERATIONS: to CHANGES: 2021-07-19 14:04:23 -07:00
Harald Hope 27dcadde46 last cleanups 2021-07-19 13:59:02 -07:00
Harald Hope ea19edaa1f more cleanups 2021-07-19 13:53:07 -07:00
Harald Hope f6f7b744eb more changelog cleanups, now it's all consistent! 2021-07-19 13:48:00 -07:00
Harald Hope 6b3c4c6517 more changelog updates/cleanups 2021-07-19 13:22:03 -07:00
Harald Hope efe175fc9f Updated/cleaned up inxi.changelog to make it more consistent and
easier to locate change types etc.
2021-07-19 13:16:01 -07:00
Harald Hope 994ab96b7a bug fix: long standing issue, if mobo temp undefined, was showing
temp 0, not N/A as intended.
2021-07-11 20:49:31 -07:00
Harald Hope 9ff2bd262f more changelog cleanups, why not, spring cleaning! 2021-07-11 20:31:43 -07:00
Harald Hope 452a19eb41 changelog edits/cleanups 2021-07-11 20:23:51 -07:00
Harald Hope 84d3c866ae changelog edits 2021-07-11 19:44:01 -07:00
Harald Hope 70b381fb24 changelog cleanups 2021-07-11 19:41:19 -07:00
Harald Hope 55ca175e5a Many small updates, enhancements, bug fixes!!! We've been saving them up!! Here
they are!! Don't wait!!

Thanks mr. mazda for many issue finds, and suggestions.

--------------------------------------------------------------------------------
KNOWN ISSUES BUT CAN'T OR WON'T BE FIXED:

1. Due to unfixable rpm slowdowns, removed package counts for default output for
rpm based systems. We were seeing delays of up to 30+ seconds just to list the
rpm package count, which is absurd, even after the rpm optimizations inxi
already runs. To allow rpm users to get excluded by default for rpm package list
counts, added --pkg flag plus a  short message telling them to use that flag to
get the installed package count if they want it.

Changes like this are very unfortunate, but in 2021 for a package manager at
times to require over 30 seconds to generate a trivial installed package list is
just not acceptable. One of the reasons this release was delayed was this was
not an easy decision to make, it's very rare support for a feature is removed
for specific tools due to how badly the tools may perform. Note that whatever
higher level tool is used, like dnf, zypp, it's still the same speed, they all
appear to use the same core engine.

Basically this decision was forced since either inxi looks really bad and slow,
when it's not, or the actual cause was removed from default outputs.

--------------------------------------------------------------------------------
BUGS:

1. Small bug in nfs blacklist for disk used led to nfs used being added, which
leads to silly used percents. This is corrected.

2. If ram vendor ID failed, inxi would delete the part number. Oops. This was
related to the Mushkin failures.

3. Close to a bug, though not one internally, but to users would appear as one:
ZFS does not act as expected, zpool list did not in fact return the pool size,
which I had always assumed to be the case, but in a very strange decision, does
return something very close to the pool size for mirrors, but NOT for z1 or z2
pools, then it returns the total size of the drives that make up the pool. To
call this strange behavior would be an understatement. The fix was to modify the
logic to use zfs list instead to get the size data. This also makes the drive
total report far more accurate, since it lists usable space now for ZFS as was
always intended. The cause of this was simply that I'd always had access to zfs
mirrors, not z1 or z2 arrays.

--------------------------------------------------------------------------------
FIXES:

1. OpenSuse and maybe others use kdm3 for Trinity, not kdm, so dm was failing.

2. Going along with fix 1, made kde version detection more robust so may catch
more fringe / corner cases for kde desktops. These were mainly added to correct
Trinity desktop version detections.

3. Mushkin ram vendor ID was failing, that is or should be corrected.

4. Added in /dev/disk/by-id handlers for zpool components, there are several
variants, wwn-, pci-, scsi-, ata-, but they all map to the real /dev drive IDs.
Failure to unmap these led to failing to match components and get size info
etc for zfs.

5. See DOCUMENTATION: 2, language changes for weather feature abuse.

--------------------------------------------------------------------------------
ENHANCEMENTS:

1. Going along with the rpm issues, added dnf.conf support to yum/dnf repo
types. Not sure how that one was missed, but there it is. This should tighten
repo reports for dnf/yum/zypp types.

2. Added LeftWM. LeftWM confirmed working. Added unverifed detections for:
penrose, 2bwm, 5dwm, catwm, mcwm, monsterwm, snapwm, uwm, wingo, wmfs, wmfs2.

3. Added xfwm as a compositor type, that had bee left out, somewhat on purpose,
since xfwm can run in compositing or non compositing mode. But should show
since many users use compositing mode now.

4. Added OpenMediaVault distro ID and systembase handlers.

5. Going along with zfs bug fix 3, using zfs list data for free, size,
allocated. Trying to understand how zfs developers actually thought about this
is nearly impossible so just used what seems to correspond to reality most.
Also shows raw values for zfs data in RAID along with regular ones to make
clear which is which value.

6. Added more CPU architecture ID matches for AMD Zen and a variety of Intel.
Both vendors finally released some new CPUs and the data became available,
which doesn't always happen quickly.

7. A bunch of new disk vendors and vendor IDs added. Never stops, like the
sands of time, like the ocean waves, like the scuttling crabs scrounding around
in the seaweed in the foam where the outgoing wave left its mark...

--------------------------------------------------------------------------------
DOCUMENTATION:

1. Added leftwm keybindinigs to inxi-data.txt desktop/wm section. Updated more
wm in that section as well, and list more info on wms for future reference etc.
Also reorganized and more more readable wm section.

2. Help/Man now make more clear that automated requests or excessive use of the
inxi weather feature are not under any circumstance permitted. There had been
some ambiguity and lack of clarity about what abuse is, now it should be more
clear.

--------------------------------------------------------------------------------
CODE CHANGES:

1. Refactored uptime parser logic, the code and regex was just getting too
messy and difficult to work with and debug, now it works similar to how the
revised BSD parsers run, the regex are pulled apart and made more granular so
a small syntax change ideally won't break the detections as easily.

2. Cleaned up sub cpu_arch() and made all the arch values line up nicely, over
time I notice that almost invariably stuff done to save lines of code makes
code harder to read as the feature expands, so it's generally worth just
unravelling it so it all stacks and is easy to scan/read. Also removed extra
white space in parens, which is something I'm leaning more towards but it's
not worth fixing all at once so it's just done where it's noticed.

That's using:
if ( /test/ ){
rather than:
if (/test){

I believe using more white space helped with Perl comprehension in the
intermediate stages, but is not required anymore and just looks like extra
whitespace now.
2021-07-11 19:32:13 -07:00
Harald Hope 0bf234846f Readme cleanup, fixed widths, wraps, so it's following the same rules
as inxi.changelog.
2021-04-17 12:51:26 -07:00
Harald Hope 68d61476b4 help edit 2021-04-16 21:25:39 -07:00
Harald Hope 75fa0391e3 last edits 2021-04-16 21:23:37 -07:00
Harald Hope 573c272bda edits 2021-04-16 21:12:52 -07:00
Harald Hope 991a35d665 Enhanced features!! Huge BSD upgrades! Bug Fixes!! Elbrus Fixes!! More bluetooth
fixes!! What are you waiting for?!!?

A special thanks for significant help, ongoing, leading to a huge boost to BSD
support, Stan Vandiver, who did a lot of BSD testing, and setup many remote
access systems for testing and development of the latest BSD upgrades. If you're
a BSD user, you can thank him for helping to expand BSD support!

Take special note of the code folding fixes in Fix 1, those open up possible
free software code editors that can be used to work with inxi to more than just
Kwrite/Kate, to include scite and geany, nice lightweight code editors. You
can't do real work in inxi without code folding, so getting this finally
resolved was I think worth it.

Also, for the first time ever!! inxi is now using Pledge, well, if
OpenBSD::Pledge module is available, which is currently only in OpenBSD, since
that's the only system that supports Pledge security, except for Serenity, but
inxi doesn't support Serenity. Note that OpenBSD was smart and added
OpenBSD::Pledge and OpenBSD::Unveil to Perl Core modules, thus removing any hoop
that might stop a Perl program from implementing it. Nice going OpenBSD guys!

The addition of OpenBSD softraid support for RAID and CRYPTO types highlights
the problem with --raid and --logical, where --raid is really just a subset of
Logical volume management. Note that while the hardware RAID feature only lists
the actual PCI RAID device, OpenBSD bioctl supports hardware RAID out of the
box, something I'd thought of doing in inxi for a few years, but it's too much
work, but bioctl has done the work, which is impressive. Can't do much without a
lot of debugger data there though, but it's worth being aware of. In this case,
since softraid is the primary device, I opted to call Crypto and RAID types all
RAID, same as with linear zfs.

--------------------------------------------------------------------------------
KNOWN ISSUES BUT CAN'T OR  WON'T BE FIXED:

1. FreeBSD: USB drivers. I really gave this a try, but could not get any logic
to be stable across systems and varying syntaxes used. Will wait for FreeBSD to
add drivers to usbconfig -vl. Note that this makes it not possible to correctly
match USB networking devices to their respective IF data, so USB networking IF
will fall back to the undetected IF-ID, which means it was found but not
connected to a specific hardware device.

2. FreeBSD Battery Report: there are non-objective values for Battery state data
in sysctl output, as in minutes remaining, which has no meaning, and percent
charge (percent of what? original design capacity? current actual capacity?). If
data with voltages, design/current capacity in Ah or Wh, is made available,
support will be added. Note that there are 3rd party tools that do supply this
data in a usable format, but they are not in core so no point.

3. BSDs All: have found no way to get physical CPU counts. this will lead to odd
outputs in some cases, like a 2 cpu system reporting itself as a 2x the actual
core counts single CPU, but the data just isn't there as far as I know.
Dragonfly in some cases appears to have that data.

4. BSDs All: so far no way to get live per core cpu speeds using a file or fast
command query. Thought I'd found a way in FreeBSD but that was not the correct
clockrate values, or inconsistently right/wrong, so not using it. Also saw the
same issue with max/min frequencies in FreeBSD so removed that item, it's
better to show nothing than data that is not reliable or actually not even
referring to what it seems to be.

5. BSD SOC Support: An issue poster asked why FreeBSD (but really BSD in
general) SOC ARM device, like RaPi, support, was so weak in inxi. The reason is
simple: to do SOC ARM device data in a meaningful way requires a complete path
based data structure, which the BSDs do not appear to have, at least from what
I've seen so far. See Linux's /sys data structures for examples of what is
required to add or expand inxi SOC device support in inxi. It's hard even with
that type of rich path based data, and without it I won't try.

The bright side is inxi runs perfectly on such devices, no errors, which was
amazing to see, and spoke volumes of the recent work done to extend support for
the BSDs.

6. Perl / inxi, when run as root, shows read error when trying to open a 200 /
--w------- permission /sys uevent file for reading. The test works as expected
as user, but not as root. Perl will try to read it when run as root even though
it has no read permissions, only write. This in reality only manifests on very
old /sys, from Debian Etch kernel 2.26 days.

--------------------------------------------------------------------------------
BUGS:

1. tput + urxvt / FreeBSD: There appears to be a bug in Arch Linux urxvt that
leads to failed terminal/console size from tput. Also while trying to resolve
this bug, discovered that if you use "tput cols 2>/dev/null" in FreeBSD, for
some inexplicable reason tput puts out defaults 80 cols x 24 rows. Why? Who
knows. Added in non numeric tests of output to handle errors from tput instead.

The bug appears to be what rxvt reports itself as vs what it is actually running
as. This issue isn't present in any other distro I tried, but could just be a
new bug in urxvt, don't know.

2. Elbrus CPU: Ongoing issue #197 Elbrus poster gave sample of new 2C3 cpuinfo,
that exposed some bugs internally in inxi Elbrus handling, I was using integer
values instead of hex for model IDs in the Elbrus logic, which would fail after
model 9.

3. BSD dmesg.boot: The logic used for dmesg.boot data processing had errors, and
had to be fully redone because of the need to detect in a reliable way the
current state of USB drives. This logic now is much more robust and reliable,
and no longer relies on using 'uniq' values per line, which would fail in all
kinds of situations.

4. OpenBSD USB Speeds: bugs fixed for OpenBSD speeds, these were found during
the USB data refactor testing process.

5. BSDs: in some cases, wrong memory used values were being generated, this
should be largely corrected now. Also pulled the weird NetBSD use of
/proc/meminfo which had wrong data in it, and now use vmstat for all BSDs, which
after the used bug fixes, is more reliable for BSDs.

6. All systems: CPU stepping would report as N/A if stepping 0, luckily I came
across some systems with an actual stepping: 0, which are not common.

7. FreeBSD: dmidecode sourced L2 cache data failed to show correct totals in
some cases. Due to no MT detection possible for FreeBSD currently, these totals
will still be wrong, but now it says note; check to let users know.

8. dmidecode: some cases were getting the wrong failure error message, this bug
became exposed due to OpenBSD locking /dev/mem even to root, which then failed
to show the expected message. This was a bug, and is now corrected.

9. FreeBSD: partition swap size didn't show in at least some cases, that's
corrected.

10. Linux Partitions: partitions would let doubled swap items through in several
cases, and also failed to create in rare cases matches for hidden partition
mapped id's. Finally tracked down the actual cause, when moving the partition
filters I'd forgotten to add swap into the filter list, oops. But now it will
catch duplicates in several different ways, so that's fine.

11. Unmounted: Failed to properly handle detecting RAID components in the case
of lvm, mdraid, it was only working for zfs. This was an accident, and should
now be corrected.

--------------------------------------------------------------------------------
FIXES:

1. Code Folding: Note that this was NOT a bug or failure in inxi, it was a bug
in scintilla/scite geany code editors with folding, basically if you commented
out logic, without using a space or other marker after the comment #, folding
would break in weird ways. Obviously the core scintilla engine should IGNORE the
darned # commented out lines, but it doesn't, which is a real bug. But not in
inxi.

This was however worth working around, because without folding, you can't work
on or learn how inxi works, and the only editor I know of in the free software
eco-system that can handle folding reasonably accurately was until now
Kwrite/Kate code editors, and those have some real, long standing, weaknesses,
and bugs around folding that have never been resolved, and yes, did notify them
about them, and no, they remain unfixed after years, or they were fixed briefly,
then broke again.

So it was important to expand the base of possible code editors to more than
just the KDE stuff. Fixing this was tedious, but I think worth it. On the bright
side, geany/scite folding / unfolding is FAST, and once the code issues that
triggered folding failures were resolved, very accurate, much better than Kate's
to be honest, though Kate isn't as picky, but Kate's unfold top nodes has been
broken more often than it's worked.

To avoid this issue, it's also important to configure geany/scite to use a space
after the comment when using keyboard shortcuts to comment out lines/blocks.
Same goes for Kate/Kwrite, by the way.

2. Battery: Forgot to add battery-force to -v7, which means you would never see
the battery line in full output if there was no battery present, this is similar
to how raid-forced worked, it was just an oversight which I hadn't noticed until
testing the new BSD battery logic.

3. Indentation: small indentation fixes on Sound Server data. Those are visible
with -y1, that is.

4. OpenBSD PCI: enabled Device matching to PCI networking device, this required
an odd little hack, but seems to be pretty reliable, and allowed me to add
driver to PCI device reports as well. Not sure why driver isn't in pcidump -v
but it probably will be in the future. Note to self: add in support for that so
if they include it in a future release, it will suddenly 'just work', assume
they use the same basic syntax as usbdevs -vv output.

5. BSDs: Added in some null data protections for BSDs, which do not always have
all the data types found in Linux, those would trigger Perl undefined value
errors, which are warnings that inxi failed internally to test for null data in
that, but it's hard to know when to do that when the data is basically always
there in Linux.

6. Debugger: Added test for required Net::FTP module in debugger, had forgotten
to make that test explicit, which led to odd failures.

7. BSDs: nvme detections should be better now. But I have seen no live test
system to confirm the fixes work as expected, plus, at least, OpenBSD swaps
nvme0 to sd0 internally, so I'm not actually sure how that data will even work,
we'll see how that goes.

8. BSDs: oddly, despite using 0x hex numbers almost everywhere, for CPU
stepping, the stepping is in decimal, which is even odder because CPU makers
list their steppings as hex in many if not most cases. In case this is corrected
in the future, if 0x appears before stepping number, will not then try to
convert to hex since it already is.

9a. CPU L3: Subtle, probably won't change behaviors, but L3 cache is per physical
CPU in every case I've found, so never multiply value by cores for L3. Like
everything, this may lead to corner cases being wrong, but that's life, it will
also lead to the data being right for most users.

9b. CPU L1: Different L1 syntaxes found so inxi now uses more loose detections,
should cover most OpenBSD L1 variants at least.

10. BSDs: inxi was using internal 'sleep' right before reading /proc/cpuinfo,
but that was silly for BSDs since cpu speeds there come from sysctl, so the BSD
sleeps are now running before sysctl if CPU data feature is required.

11. Too many to remember, but lots of subtle message output changes to make more
clear, more accurate, shorter, whatever.

12. USB: a very subtle fix, some devices can be both audio and video, like
cameras, but inxi would default to the first detected. Now it checks for both
before going to the list of checks, and correctly assigns a type that is both
audio and video to the audio and video hashes so both features will show the USB
device, not just Audio.

13: BSD: fixes for BSD ifconfig IF status, it was slicing off the full status
string, like 'no network' to 'no', which is silly. Now shows full string.

14. OpenBSD: restored USB Hub ports: xx item, I hadn't realized that the data
was still there with usbdevs but it required an extra -v, like: usbdevs -vv to
trigger, so now the OpenBSD USB ports works fine again.

15. Fedora Xorg: updated --recommends to use the newer split apart xorg utils
package names, only xrandr I think needed updating. Thanks Mr. Mazda for keeping
up with that stuff!

16. OpenBSD SMART: the actual device being queried turns out to the 'c'
partition, the one that represents the entire disk, NOT the main device ID, like
sd0, so now inxi tacks on 'c', sd0c, when smartctl runs, and it works fine. So
previously SMART report would never have worked in OpenBSD.

17. Partion labels/uuids: in Partitions and Unmounted, does not show label/uuid
if fs type is ffs or if fs is a logical type one, like zfs, hammer, and remote
fs mounts etc. This cleans up output, since these file system types will never
have labels or uuids.

18. Mr Mazda inxi was missing data and showing errors if run in Debian Etch with
Perl 5.008, and I realized I'd slipped up and had used the -k option without
testing lspci version, but -k was only available in 3.0 in Lenny. But -v turns
on -k automatically, so the easy solution was just to remove the -k and leave
the -nnv, which is the same thing, but does not cause errors in early lspci.

There are also errors with reading as root some /sys uevent files, but upon
examination, those had only root write permission, so the perl -r test isn't
right. Don't think that can be fixed. See Can't/Won't fix for more.

Another issue I noticed was that in some cases Perl seemed to lose track of some
hash values in local %trigger in OptionsHandler, and just lose them, thus
leading to things like --help --version --recommends not working. Moving
%trigger to globals %show and %use fixed that one, but that's weird, no idea
what happened, but it works now.

Tested in Sarge 3.1, where core modules have to be explicitly installed, they
were not included in base Perl install. Kernel 2.4 had some key differences,
different lspci syntax, different /proc/partitions, so the block device output
and device output is flawed, but otherwise inxi worked fine in Sarge, from 2005!
But these issues will not be corrected, kernel 2.24 is just too old, lol.

inxi should always run ok in very old systems, like Etch, back to when Perl 5.8
was standard, so bugs like this are always welcome, it's easy to slip up and use
something that didn't work in those old systems, then forget to test.

19. Corner case SMART errors, sometimes occur much later in output than inxi
expects, this is now corrected and errors should show in smart data no matter
where the main error type occured.

--------------------------------------------------------------------------------
ENHANCEMENTS:

1. Elbrus: Going along with Bug 2, Updated Elbrus microarch to use family 6,
assuming models 10, 11, are the same, which they should be since 12 is the same
as in family 4.

2. IPMI Sensors: More sensor syntax detections, sensors will never be stable...

3. OpenBSD: Rolled out live battery state feature, they have very good data,
simple, but solid, that allows for a quality battery state report. Handles both
Wh/Ah, though I am slightly suspicious of the reality of the arithmetic for Ah >
Wh conversion, it seems to be too high. That's Ah * Design Voltage. But Linux
battery data has the same issue, though I think in most cases, the data is in
Wh, so this issue isn't BSD specific. My suspicion is that the voltages used to
determine Ah may actually be slightly lower than the listed design voltage,
which inxi calls min: but it's actually the design voltage.

Unknown if NetBSD data is the same as OpenBSD for battery, was unable to locate
any samples, so can't say, if you have a NetBSD laptop that correctly reports
battery state in sysctl -a, please file an issue with some sample battery
charge/voltage syntax and values, ideally from > 1 system. If the data is
complete, it's easy to add support.

4a. BSD USB rev: inxi now emulates USB rev versions for BSD USB speed/rev
version data. Note that this is not guaranteed to be right, because USB devices
can be different rev versions than the speed they run at, but as far as I could
find, the USB revision data is not available in any practical sense, unless I
create a complicated recursive tool to build up a snapshot of the usb system and
devices from dmesg data, but I already blew a day on that attempt, so will wait
for more complete data in the usb tools in future. The rev version is based on
the device/hub speed, using a standard USB rev speed mapping. But a 12 Mbps
device can be rev 2, not rev 1.1, for example, that is, it's actually a USB 2.0
device, but a slow speed one.

4b. USB Type: Expanded fallback USB device type tests, these are useful for
cases where it's either a vendor defined type, or for Open/NetBSD, which do not
yet show USB class/subclass data. But it's a good fallback tool, added Mass
Storage, expanded detections.

5. BSD Sensors: Going along with Enhancement 3, rolled out live sensors data.
Confirmed working in OpenBSD and FreeBSD, not sure about NetBSD, no data,
problem with vm testing is no sensors, but don't have any NetBSD hardware
installs to verify. Stan gave it a good try, but could not get NetBSD running so
far, maybe later.

This basically means the -B and -s features are largely feature complete for the
BSDs as far as practical, though due to difficulties in getting the data in a
consistent clear way, some more advanced features, like gpu temps, which are now
available in Linux kernel values and lm-sensors, do not yet appear to be present
in the BSDs, though if this changes, the structures are in  place to make
updates to these logics very easy to implement now.

Note that the --sensors-include and --sensors-exclude items, or config items,
work fine with this BSD logic, though you have to figure out what exact syntax
to use, but that's the same in Linux.

6. OpenBSD Pledge: Yes, that's right, inxi is now Pledged!!! In OpenBSD, anyway,
they did a really good job, and the OpenBSD Perl packager made a very nice Perl
modules, OpenBSD::Pledge, which was very easy to implement. Now I know what inxi
needs to run its features!!

So far OpenBSD only, but Pledge seems like a really good idea, so I figured,
let's give it a spin, even if it will only currently work on OpenBSD, but that's
fine, inxi is pledged as tightly as I could make it, including unpledging
features not required post options processing, once inxi knows what it's
actually going to be doing.

Note that I'm aware of OpenBSD::Unveil, but that's a lot harder to implement due
to never really being sure about what files inxi will need to be looking at
until well into the logic. I may look at that in the future.

7. Bluetooth Rfkill: Due to ongoing failures in current inxi to show consistent
Bluetooth hci report on Linux, added in one last fallback, rfkill state, which
allows inxi to always fallback to at least that basic data. Also added in which
tool is providing the report mostly, like: Report: bt-adapter ID: hci0 and so
on.

Also integrated into -xxx data, or for down state, the full rfkill report, since
that can be quite useful.

Note that bluetooth is a real pain for users to debug because you can have:

 * Bluetooth Service: enabled/disabled * Bluetooth Service: started/stopped *
bluetoothctl: start/stop * bt-adapter: start/stop * hciconfig: start/stop *
rfkill: software: block/unblock; hardware: block/unblock - however, for
hardware, that means a physical button has been pressed to disable it, on the
laptop that is.

To make matters worse, one tool does not always even know when another tool has
changed something, for example, if I rfkill blocked hci0, then unblocked it,
hciconfig would keep seeing it as down until it was switched to on with
hciconfig explicitly. This is I suspect one reason hciconfig is being dropped,
it doesn't know how to listen to the newer tools like bluetoothctl, bt-adapter,
or rfkill.

8. OpenBSD: Going along with Code Change 1, now has disk serial (doas/root),
more consistent physical block size data, more reliable disk data, and for
-Dxxx, duid, if available. Also added disk partition table scheme, aka MBR /
GPT. Some of these new items may also work with NetBSD. See also Fix 17, SMART
fix for OpenBSD.

9. OpenBSD/NetBSD/FreeBSD: the DiskDataBSD refactor now allows Unmounted
partitions report.

10. OpenBSD: added in CPU MT detections using siblings data, I think only
OpenBSD and Dragonfly support proper MT cpu core counts. Still no way to get
physical cpu counts in OpenBSD or FreeBSD or NetBSD that I am aware of.

11. OpenBSD: added in cpu speed min/max data, that was available in most cases,
didn't realize that.

12. BSDs: expanded and made more robust cpu L1/L2/L3 cache detections, now for
example, OpenBSD will report its L1/L2/L3 cache without root. FreeBSD requires
root since that data is coming from dmidecode.

This logic update made BSD L-cache data much more reliable and consistent, and,
important, easy to work with. This was directly connected to Code Changes 2 and
3, which made dealing with those data sources a lot easier.

Note that L1/L2 cache data if not from OpenBSD will show note: check because
it's not possible to determine if it's a multithreaded MT cpu or not, and thus
if L1/L2 * core count would so often be totally wrong that inxi won't try to
guess, it will just list the single value found, and tell the user to check it
themselves.

13. OpenBSD: Added rcctl tool to init tools, I hadn't known about that one, that
replaces the fallback default used before, /etc/rc.d.

14. RAM Vendor: Issue #245 raised the point that it would be good to try to show
RAM vendor data when the manufactorer field is empty, and since that logic is
already present in disk_vendor, it was just matter of researching the product
IDs to find the matching patterns for the RAM vendors, the initial list is
pretty good, but will need updates now and then to correct errors. Also will
override only vendor ID 4 character hex value and see if it can find a better
value.

15. OpenBSD RAM: data quality is decent (no vendor/product no, unfortunately).
The data is often, but sadly not always, available. I'm not clear why sometimes
it isn't, but since OpenBSD also defaults to blocking /dev/mem to even root
user, which then blocks dmidecode, this is the only practical way to give basic
RAM data for OpenBSD, so that's running fine now, when the data is available,
with the added bonus of not needing doas/root.

Note that due to the way that this data is present, I can have inxi deduce some
things like how many arrays there are, and then guess at overall capacity, max
stick size, and so on, but all Array-x: values are followed by note: est because
they are never based on hard data, just extrapolations. I debated if inxi should
even show the guesses, but I think by saying note: est after each Array-x: item,
it's pretty clear that it's not hard data, and it does give an idea roughly. I
made an initial guess at > 1 ram array but found no data samples to let me see
if my guess was right or not, so > 1 array remains roughly theoretical until
shown to work or not work empirically.

While NetBSD sometimes has the system ram data in a similar way that OpenBSD
does in dmesg.boot, it varies too much, and is too inconsistent. There are not
enough data samples with good consistent data, and the samples I did see
suggested that it would take too much code and convoluted logic to handle the
variations, so I'm leaving this one alone. Also, NetBSD probably doesn't block
/dev/mem so dmidecode should work fine.

16. Using system clang version info for OpenBSD kernel compiler, the assumption
being that a BSD is an OS, so the Clang version it shipped with would be the
clang version that compiled the kernel. Please correct if this is wrong.

17. OpenBSD RAID: support added for softraid, including for drive storage
totals, unmounted raid component detections. Plugged in pretty smoothly, able to
generate a partial report for non root, and shows message if not root.

18. VM detections upgraded, particularly for BSDs, now includes vmm, hvm,
hyper-v, kvm. Not all of these would have been detected before. Also cleaned up
vm logic, moved all vm detections into $dboot{'machine-vm'}, and only use the
first found item.

19. Disk Vendors!!: Yes, last, but not least!! More disk vendors, vendor ID
matches!! Yep. What else can I say? Eternity? Man's quest for something that
cannot be found, yet these strivings never cease, here manifested by always new
vendors and ID matches!

--------------------------------------------------------------------------------
DOCUMENTATION:

1. Very significant ongoing upgrades to the docs in inxi-perl/docs/,
particularly in inxi-values.txt, inxi-resources.txt, and inxi-data.txt. These
are now increasingly useful, and I am trying to keep in particular
inxi-values.txt up to date as a primary reference for various features, though
it will always lag, because that's how it is, lol.

2. Cleaned up changelog, made 80 cols wide for text, bars, etc, made numbered
lists and headers consistent, but otherwise did not change any of the actual
content.

--------------------------------------------------------------------------------
CODE CHANGES:

1. Complete rewrite of BSD disk/partition data tools, now  there is one core
tool that generates a mega-disk/partition hash, which is then used for all
features that need partition/disk data. This worked out super well, and allowed
new features like BSD Unmounted disk data to be generated for the first time
ever, along with filling in various block device fields that were missing
before.

2. Change 1 also went along with a refactor of dmesg data tool for BSDs, which
allowed for much more granular data generation, along with a complex %dboot hash
which stores all sub types as well as the main full dataset. This allowed inxi
to stop looping through all of dmesg data each time a feature needed it. Now all
the data types are assigned if required by a feature, and only then. This, along
with change 1, worked really well.

See also Bug 3, which mandated completely changing how dmesg.boot and dmesg live
data were / are merged, the result is far more robust now, and far less prone to
error.

3. Similar to dmesg changes, used same methods for sysctl data, now all the data
is assigned to %sysctl data structure based on if needed or not, so it only does
the assignments one time, in one location. Much cleaner code this way, and
allows for testing set/unset substructures, like $sysctl{'cpu'}.

4. The %dboot and %sysctl refactors went so well that I switched the core USB
and Devices to also use %usb and %devices structures. These updates let me dump
a lot of global hashes and arrays, and leaned everything down a lot, and also
removed basically all the testing loops for these data types, now the Item
features just test to see if a reference to the specific type exists, if it
does, it has data, if not, it doesn't, this is a lot easier to manage.

5. Ongoing: moving related subroutines to Packages, the goal is to have pretty
much all related subroutines (functions) contained in parent classes/packages,
makes it easier to maintain.

6. Ongoing: making all internal package tools have similar sub names, getting
rid of the specific names for output and data generator functions. This makes
each Item Generator increasingly like all the others, as much as practical.

7. A big one, renamed all the feature generators to be XxxxxItem, instead of
XxxxData, which was colliding as a package name with actual data generator
tools, now all the Feature generators are [Feature]Item, and all the Data
generators have Data type names where relevant. This avoided in particular the
silly case where I was relying on case to differentiate UsbData and USBData,
feature vs data generator.

8. As part of the move to data hash global structures, also moved as many of the
top global scalars and hashes and arrays to these now much more heavily utilized
global hashes, like %alerts, %use, %fake, %force, and so on. There are now far
fewer globals running than before, and where it makes sense, I keep moving them
into global hashes, and giving the global hashes more work to do.

9. Significantly expanded list of debuggers for specific data types always
available, see docs/inxi-values.txt for list of options there. Decided for rapid
development, it was too much of a pain to always be uncommenting the debuggers,
so now am uncommenting, adding to @dbg supported items, then documenting. I
guess this means the @dbg items are more or less stable and consistent now, give
or take.

10. Refactored UsbData and DeviceData, for in particular the BSDs, to be much
more robust and to rely less on very fragile regex parsing patterns, takes more
lines of code, but better than having the detections break every other BSD
release. This was part of the %device and %usb refactors as well.

11. Fixed system_files()  too, which was really silly logic, it used a global
packed hash of system files, then would do a function call for the paths when
required, which was redundant since the values were already in a hash which
could be used directly. This was a throwback to inxi gawk/bash, where hashes
were not really used in this way, and the logic had been translated to Perl
without thinking about it, but once I thought about it, I realized how silly
that was. This must have knocked off a good 50 or more unnecessary, and always
expensive, function calls.
2021-04-16 20:41:58 -07:00
Harald Hope a539c8fd47 readme edits 2021-03-29 14:32:48 -07:00
Harald Hope 7ecea586ae small fix for console irc tty 2021-03-17 20:14:09 -07:00
Harald Hope 1660107ddb removed debugger 2021-03-17 19:40:27 -07:00
Harald Hope 3d4d1f533c Bugs!! Fixes! Spring cleaning!
Because these are either newly created, or newly discovered, bugs,
this release was pushed as early as possible to get them fixed asap.

BUGS:
1. Desktop: Lumina detection had a syntax error which made it not work.
This has been broken for a while.

2. Logical: if not root, and if LUKS / bcache detected, failed to load
proc_partitions, which generates error on --logical --admin since the
required components data was not loaded. This was an oversight.

3. The 3.3.02 ShellData refactor created a bug for console IRC, showed
shell, not irc client, name, and set default shell data which also
showed.

4. Console IRC tty: there was also an older bug that made -S, -G
not work consistently, and there were errors that had been missed
for many years in that logic. These should all be corrected, console
irc out of display, or in display as root, should now show tty info,
tty size in -G.

FIXES:
1. Memory: restored $bsd_type block on /proc/meminfo and force NetBSD
to use a corrected vmstat. This leaves that block of logic to correct
the NetBSD oddities in meminfo, but it may fix future isses that popup.

2. -Sxxx man page item incorrectly said XDG_VTNR was systemd/linux, it's
not, it's various things, GhostBSD has it, for example. See what you get
for believing what people say!

3. Logical: added in N/A for null maj-min in --logical report. While
bug 2 triggered those errors, there could be future cases where maj-min
are null, like BSD lvm data etc.

ENHANCEMENTS:
1. Going along with Fix 1, added '--force meminfo' in case you really want that.

2. Distro: System Base: Added TrueNAS detection.

3. Package Data: Added mport [MidnightBSD] type. That requires root to run
for some odd reason, so won't see the best output if not root.

CHANGES:
1. Moved logical to -v7 from -v8, it's stable enough now.

CODE CHANGES:
1. Moved get_tty_number and get_tty_console_irc to ShellData:tty_number
and ShellData::tty_console_irc.

ShellData::tty_number was being loaded several times, added
$loaded{'tty-number'} test, and made client{'tty-number'} to store value.

tty_console_irc changed to console_irc_tty, which is what it gets, removed
hacks and made it load once and store result in client hash.

2. Optimization: retested sub vs package::method and they run at exactly
the same time, give or take, so moving more stuff into packages to make
it easier to maintain.
2021-03-17 19:39:02 -07:00
Harald Hope c54ff52417 changelog update 2021-03-15 20:16:12 -07:00
Harald Hope 75433a383a Huge upgrade!! Bug Fixes!! Refactors!!! BSDs!!! More BSDs!!!
raspberry pi!! New Features!!! Enhanced old features!!! Did I
mention bluetooth?! USB? Audio? No? well, all hugely upgraded!

------------------------------------------------------------------------
BUGS:

1. Sadly, 3.3.01 went out with a bug, forgot to remove a debugger,
resulted in hardcoded kernel compiler version always showing.

Note that there is a new inxi-perl/docs/inxi-bugs.txt file to
track such bugs, and matched to specific tagged releases so you
know the line number and items to update to fix it.

2. Typo in manjaro system base match resulted in failing to report
system base as expected.

------------------------------------------------------------------------
KNOWN ISSUES BUT CAN'T OR WON'T BE FIXED:

1. OpenBSD made fvwm -version output an error along with the
version, and not in the normal format for standard fvwm, this
is just too complicated to work around for now, though it could
be in theory by creating a dedicated fvwm-oBSD item in
program_values. But that kind of granularity gets too hard to track,
and they are likely to change or fix this in the future anyway.
Best is they just restore default -version output to what it is
elsewhere, not nested in error outputs.

2. Discovered an oddity, don't know how widespread this
is, but Intel SSDs take about 200 milliseconds to get the sys
hwmon based drive temps, when it should take under a
millisecond, this may be a similar cause as those drives having
a noticeable SMART report delay, not sure. This is quite
noticeable since 200 ms is about 15% of the total execution
time on my test system.

------------------------------------------------------------------------
FIXES:

1. For --recommends, added different rpm SUSE xdpyinfo package name.

2. Distro Data: added double term filter for lsb-release due to sometimes
generating repeated names in distro.

3. Packages: fix for appimage package counts.

4. Desktop: fixed ID for some wm when no xprop installed, fallback to
using @ps_cmd detections, which usually work fine.

5a. When swap used was 0, showed N/A, fixed to correctly show 0 KiB.

5b. If no swap devices found, BSDs were not correctly showing
no swap data found message. Corrected.

6a. Bluetooth: Removed hcidump from debugger, in some cases, that will
just hang endlessly. Also wrapped bluetoothctl and bt-adapter debugger
data collection with @ps_cmd bluetooth running test. Only run if
bluetooth service is running.

6b. Bluetooth: running detections have to be very strict, only
bluetoothd, not bluetooth, the latter can show true when bluetoothd
is not running, and did in my tests.

7. USB: with Code Change 1, found a few places where fallback usb type
detections were creating false matches, which resulted in say,
bluetooth devices showing up as network devices due to the presence
of the word 'wireless' in the device description. These matches are
all updated and revised to be more accurate and less error prone.

8. Battery: an oversight, had forgotten to have percent used of
available capacity, which made Battery data hard to decipher, now
it shows the percent of available total, as well as the condition
percent, so it's easier to understand the data now, and hopefully
more clear.

9a. OpenBSD changed usbdevs output format sometime in the latest
releases, which made the delicate matching patterns fail. Updated
to handle both variants. They also changed pcidump -v formatting
at some point, now inxi will try to handle either. Note that
usbdevs updates also work fine on NetBSD.

9b. FreeBSD also changed their pciconf output in beta 13.0, which
also broke the detections completely, now checks for old and new
formats. Sigh. It should not take this much work to parse tools
whose output should be consistent and reliable. Luckily I ran
the beta prior to this release, or all pci device detections
would simply have failed, without fallback.

9c. Dragonfly BSD also changed an output format, in vmstat, that
made the RAM used report fail. Since it's clearly not predictable
which BSD will change support for which vmstat options, now just
running vmstat without options, and then using processing logic
to determine what to do with the results.

10. It turns out NetBSD is using /proc/meminfo, who would have
thought? for memory data, but they use it in a weird way that
could result in either negative or near 0 ram used. Added in
some filters to not allow such values to print, now it tries
to make an educated guess about how much ram the system is
really using based on some tests.

11. Something you'd only notice if testing a lot, uptime failed
when the uptime was < 1 minute, it had failed to handle the seconds
only option, now it does, seconds, minutes, hours:minutes,
days hours:minutes, all work.

12. Missed linsysfs type to exclude in partitons, that was a partner
to linprocfs type, both are BSD types.

13. Added -ww to ps arguments, that stops the cutting width to terminal
size default behavior in BSDs, an easy fix, wish I'd known about
that a long time ago.

15. gpart seems to show sizes in bytes, not the expected KiB, so
that's now handled internally. Hopefully that odd behavior won't
randomly change in the future, sigh.

16. Fixed slim dm detection, saw instance where it's got slim.pid
like normal dms, not the slim.lock which inxi was looking for, so
now inxi looks for both, and we're all happy!

------------------------------------------------------------------------
ENHANCEMENTS:

1. Added in something that should have been there all along, now inxi
validates the man page download as well as the self, this avoids
corrupted downloads breaking the man.

2. Init: added support for shepherd init system.

3. Distro Data: added support for guix distro ID; added support for
NomadBSD, GhostBSD, HardenedBSD system base. GhostBSD also shows the main
package version for the distro version ID, which isn't quite the
same as the version you download, but it's close. Also added os-release
support for BSDs, using similar tests as for linux distros, that
results in nicer outputs for example for Dragonfly BSD.

4. Package Data: added guix/scratch [venom]/kiss/nix package managers.
Update for slackware 15 package manager data directory relocation,
now handles either legacy current or future one.

5. Repos: added scratch/kiss/nix-channels; Added GhostBSD, HardenedBSD
pkg repos.

6. USB Data: added usbconfig. That's FreeBSD's, and related systems.

7. Device Data: Added pcictl support, that's NetBSD's, I thought
inxi had supported that, but then I remembered last time I tried to
run netBSD in a vm, I couldn't get it figured out. Now debugged and
working reasonably well.

8. Raspberry Pi 3, 4: ethernet nic now detected; wifi device,
which is on a special mmcnr type, now works, that stopped working in
pi 3, due to the change, now it's handled cleanly. Also added support
for pi bluetooth, which lives on a special serial bus, not usb.
For Raspberry Pi OS, added system base detections, which are tricky.
Also matched mmcnr devices to IF data, which was trickyy as well.
Note that as far as I could discover, only pi puts wifi on mmcnr.

9. Bluetooth: due to deprecated nature of the fine hciconfig
utility, added in support for bt-adapter, which also allows matching
of bluetooth data to device data, but is very sparse in info
supplied compared to hciconfig. bluetoothctl does not have enough
data to show the hci device, so it's not used, since inxi can't
match the bluetooth data to the device (no hci[x]). This should help
the distros that are moving away from hciconfig, in particular,
AUR is only way arch users can get hciconfig, which isn't ideal.

10. New tool and feature, ServiceData, this does two things,
as cross platform as practical, show status of bluetooth service,
this should help a lot in support people debugging bluetooth problems,
since you have bluetooth enabled but down, or up, disabled, and you
can also have the device itself down or up, so now it shows all that
data together for when it's down, but when the device is up, it just
shows the device status since the other stuff is redundant then.

In -Sa, it now shows the OS service manager that inxi detected
using a bunch of fallback tests, that's useful to admins who
are on a machine they don't know, then you can see the service
manager to use, like rc-service, systemctl, service, sv, etc.

11. Big update for -A: Sound Servers: had always been really
just only ALSA, now it shows all detected sound servers, and whether
they are running or not. Includes: ALSA, OSS, PipeWire, PulseAudio,
sndio, JACK. Note that OSS version is a guess, might be wrong source
for the version info.

12. Added USB device 'power:' item, that's in mA, not a terrible
thing to have listed, -xxx. This new feature was launched cross
platform, which is nice. Whether the BSD detections will break
in the future of course depends on whether they change the output
formats again or not. Also added in USB more chip IDs, which can
be useful. For BSDs, also added in a synthetic USB rev, taken
from the device/hub speeds. Yes, I know, USB 2 can have low speed,
full speed, or high speed, and 1.1 can have low and full speeds,
so you actually can't tell the USB revision version from the speeds,
but it's close enough.

13. Made all USB/Device data the same syntax and order, more
predictable, bus, chip, class IDs all the same now.

14. Added in support for hammer and null/nullfs file system types,
which trigger 'logical:' type device in partitions, that's also
more correct than the source: Err-102 that used to show, which
was really just a flag to alert me visibly that the partition
type detection had simply failed internally. Now for detected
types, like zfs tank/name or null/nullfs, it knows they are
logical structures.

15. Expanded BSD CPU data, where available, now can show L1/L2/
L3 cache, cpu arch, stepping, family/model ids, etc, which is
kind of nifty, although, again, delicate fragile rules that
will probably break in the future, but easier to fix now.

16. By an old request, added full native BSD doas support.
That's a nice little tool, and it plugged in fairly seamlessly
to existing sudo support. Both the internal doas/sudo stuff
should work the same, and the detection of sudo/doas start
should work the same too.

17a. Shell/Parent Data: Big refactor of the shell start/parent logic,
into ShellData which helped resolve some issues with running-in
showing shell name, not vt terminal or program name. Cause of that
is lots of levels of parents before inxi could reach the actual
program that was running inxi. Solution was to change to a longer
loop, and let it iterate 8 times, until it finds something that is
not a shell or sudo/doas/su type parent, this seems to work quite
well, you can only make it fail now if you actually try to do it on
purpose, which is fine.

This was very old logic, and carried some mistakes and
redundancies that made it very hard to understand, that's cleaned
up now. Also restored the old (login) value, which shows
when you use your normal login account on console, some system
will also now show (sudo,login) if the login user sudos inxi,
but that varies system to system.

17b. BSD running-in: Some of the BSDs now support the -f flag
for ps, which made the parent logic for running-in possible for
BSDs, which was nice. Some still don't support it, like OpenBSD
and NetBSD, but that's fine, inxi tests, and if no support detected,
just shows tty number. Adding in more robust support here cleaned
up some redundant logic internally as well.

17c. Updated terminal and shell ID detections, there's quite a few
new terminals this year, and a new shell or two. Those are needed
for more reliable detections of when the parent is NOT a shell,
which is how we find what it is.

18. Added ctwm wm support, that's the new default for NetBSD,
based on twm, has version numbers.

19. Upgraded BSD support for gpart and glabel data, now should
catch more more often.

20. For things like zfs raid, added component size, that doesn't
always work due to how zfs refers to its components, but it often
does, which is better than never before.

21. To make BSD support smoother, got rid of some OpenBSD only
rules, which in fact often apply to NetBSD as well. That may
lead to some glitches, but overall it's better to totally stay
away from OpenBSD only tests, and all BSD variant tests, and
just do dynamic testing that will work when it applies, and
not when it doesn't. In this case, added ftp downloader support
for netBSD by removing the openBSD only flag for that item.

There's a bit of a risk there in a sense since if different ftp
programs with different options were to be the fallback for something
else, it might get used, but that's fine, it's a corner case, better
to have them all work now than to worry about weird future things.
But limiting it to only BSDs should get rid of most of the problem.

vmstat and optical drive still use net/openbsd specifics because
it is too tricky to figure out it out in any more dynamic way.

22. For -Sxxx, added if systemd, display, virtual terminal number.
Could be useful to debug subtle issues, if the user is for example
not running their desktop in vt 7, the default for most systems.

------------------------------------------------------------------------
CHANGES:

1. Moved battery voltage to -Bx output, the voltage is quite
important to know since that is the key indicator of battery state.
If voltage is within .5 volts of specified minimum, shows voltage
for -B since that's a prefail condition, it's getting close to
death.

2. In partitions and raid, when the device was linear raid logical
type layout, it said, no-raid, when it should be 'linear', that's
now cleaner and more correct.

3. When running-in is a tty value, it will now show the entire
tty ID, minus the '/dev/tty', this will be more precise, and also
may resolve cases where tty was fully alpha, no numbers, previously
inxi filtered out everything that was not a number, but that can
in some tty types remove critical tty data, so now it will show:

running-in:
tty 2 [not changed]; tty pts/2 [adds pts/]; tty E2 [adds the E];
tty rx [would have not shown at ll before]

------------------------------------------------------------------------
CODE CHANGES:

NOTE: unlike the previous refactors, a lot of these changes were
done to make inxi more maintainable, which means, slightly less
optimized, which has been my preference in the past, but if the
stuff can't be maintained, it doesn't matter how fast it runs!

These changes have really enhanced the quality of the code and
made it a lot easier to work with. It's also now a lot easier to
add debuggers, force/fake data switches, etc, so it gets done,
unlike before, when it was a pain, so it got skipped, and then
caused bugs because of stray debuggers left in place, and so on.

The bright side is while reading up on this, I learned that using
very large subs is much more efficient than many small ones,
which I've always felt was the case, and it is, so the style
used internally in inxi proves to be the best one for optimizations.

These refactors, ongoing, have now touched at least 1/3, almost
1/2, of the entire inxi codebase, so the stuff is getting more
and more consistent and up to date, but given how old the logic
is in places, there will be more refactors in the future, and
maybe once the code is easier to maintain, some renewed
optimizations!, if we can find anything that makes sense, like
passing array/hash references back to the caller, already the
first half is done, passing references to the sub/method always.

The second part is started, using the Benchmark Perl module,
which really speeds up testing and helps avoid pointless tweaks
that do little re speed improvements.

I could see with some care some areas where working on data
directly via references could really speed things up, but it's
hard to write and read that type of code, but it's already being
done in the recursive data and output logics, and a few other
places.

1. Large refactor of USBData, that was done in part to help make
it work for BSDs better, but also to get it better organized.

This refactor also made all the device items, like -A,-G,-N,-E
use the same methods for creating USB output, previously they
had used a hodgepodge of methods, some super old, it was not
possible to add USB support more extensively for BSDs without
this change.

Also added in some fallback usb type detection tools using
several large online collections of that info to see what possible
matching patterns could catch more devices and correctly match
them to their type, which is the primary way now that usb output
per type is created. This really helps with BSDs, though BSD
usb utilities suffer from less data than lsusb so they don't always
get device name strings in a form where they can be readily ID'ed,
but it's way better than it was before, so that's fine!

Moved all previous methods of detecting if a card/device was USB
into USBData itself so it would all be in one place, and easier
to maintain.

All USB tools now use bus_id_alpha for sorting, and all now
sort as well, that was an oversight, previously the BSD usb
tools were not sorted, but those have been enhanced a lot, so
sorting on alpha synthetic bus ids became possible.

Removed lsusb as a BSD option, it's really unreliable, and the data
is different, and also varies a lot, it didn't really work at all
in Dragonfly, or had strange output, so lsusb is now a linux only
item.

2. Moved various booleans that were global to %force, %loaded, and
some to the already present, but lightly used, %use hashes. It was
getting too hard to add tests etc, which was causing bugs to happen.
Yes, using hashes is slower than hardcoding in the boolean scalars,
but this change was done to improve maintainability, which is starting
to matter more.

3. Moved several sets of subs to new packages, again, to help with
debugging and maintainability. MemoryData, redone in part to
handle the oddities with NetBSD reporting of free, cached, and
buffers, but really just to make it easier to work with overall.
Also moved kernel parameter logic to KernelParameters, gpart logic
to GpartData, glabel logic to GlabelData, ip data IpData, check_tools
to CheckTools, which was also enhanced largely, and simplified,
making it much easier to work with.

4. Wrapped more debugger logic in $fake{data} logic, that makes
it harder to leave a debugger uncommented, now to run it, you have
to trigger it with $fake{item} so the test runs, that way even if
I forget to comment it out, it won't run for regular user.

5. Big update to docs in branch inxi-perl/docs, those are now
much more usable for development. Updated in particular
inxi-values.txt to be primary reference doc for $fake, $dbg,
%force, %use, etc types and values. Also updated inxi-optimization.txt
and inxi-resources.txt to bring them closer to the present.

Created inxi-bugs.txt as well, which will help to know which known
bugs belonged to which frozen pools. These bugs will only refer
to bugs known to exist in tagged releases in frozen pool distros.

6. For sizes, moved most of the sizing to use main::translate_size,
this is more predictable, though as noted, these types of
changes make inxi a bit slower since it moved stuff out of inline
to using quick expensive sub calls, but it's a lot easier to
maintain, and that's getting to be more important to me now.

7. In order to catch live events, added in dmesg to dmesg.boot data
in BSDs, that's the only way I could find to readily detect
usb flash drives that were plugged in after boot. Another hack,
these will all come back to bite me, but that's fine, the base
is easier to work on and debug now, so if I want to spend time
revisiting the next major version BSD releases, it will be easier
to resolve the next sets of failures.

8. A big change, I learned about the non greedy operator for
regex patterns, ?, as in, .*?(next match rule), it will now
go up only to the next match rule. Not knowing this simple
little thing made inxi use some really convoluted regex to
avoid such greedy patterns. Still some gotchas with ?, like
it ignores following rules that are zero or 1, ? type, and
just treats it as zero instances. But that's easy to work with.

9. Not totally done, but now moved more to having set data
tools set their $loaded{item} value in get data, not externally,
that makes it easier to track the stuff. Only where it makes
sense, but there's a lot of those set/get items, they should
probably all become package/classes, with set/get I think.

10. Optimized reader() and grabber() and set_ps_aux_data(), all
switched from using grep/map to using for loops, that means
inxi doesn't have to go through each array 2x anymore, actually
4x in  the case of set_ps_aux_data(). This saved a visible
amount of execution time, I noticed this lag when running
pinxi through NYTProf optimizer, there was a quite visible
time difference between grabber/reader and  the subshell
time, these optimizations almost removed that difference,
meaning only the subshell now really takes any time to run.

Optimized url_cleaner and data_cleaner in RepoData, those
now just work directy on the array references, no returns.

Ran some more optimization tests, but will probably hold off
on some of them, for example, using cleaner() by reference is
about 50% faster than by copy, but redoing that requires
adding in many copies from read only things like $1, so
the change would lead to slightly less clean code, but may
revisit this in the future, we'll see.

But in theory, basically all the core internal tools that
take a value and modify it should do that by reference
purely since it's way faster, up to 10x.
2021-03-15 18:44:00 -07:00
Harald Hope d11f2a7a89 small man fix 2021-02-08 17:15:46 -08:00
Harald Hope 2b49b32223 Bug fixes!! Fixes!!! Refactors!!! Edits!!!
Bugs:
1. Big bug, 3.2 appears to have introduced this bug, for disks, rotation and
partition scheme would never show, oops.

2. Tiny bug kept one specific smart value from ever showing, typo.

Fixes:
1. Accidentally followed Arch linux derived distro page, which claims KaOS as
arch derived, when of course it's not, it's its own distro, own toolchain, etc.
I kind of knew this but had forgotten, then I believed the Arch derived distro
page, oh well. Resulted in KaOS being listed with arch linux as system base
with -Sx. Arch should fix this, it's not like it's hard, just remove the distro
from the page.

2. Cleared up explanations for drivetemp vs hddtemp use, updated --recommends,
man, and help to hopefully make this clear. Debian will be dropping hddtemp,
which is not maintained, sometime in the coming years, sooner than later.
Note that users unfortunately have to manually enable drivetemp module unless
their distros enable it by default, but the man/recommands/help explain that.

3. Fixed smart indentation issues, that went along with code change 1, was
failing to indent one further level for failed/age values like it's supposed
to.

Enhancements:
1. Added /proc/device to debugger, that will help track block device main numbers

2. More disk vendors, more disk vendor IDs!!! As noted, the enternal flow flows
eternally, thanks linux-lite hardware database users!! and other inxi users,
whose outputs sometimes reveal a failure or two.

3. Added loaded kernel module tests to --recommends, this was mostly to let users
know that drivetemp is needed if you want non superuser fast drive temps, and
that this came along with kernels 5.6 or newer. Hopefully word will start drifting
out. Note that if inxi is using drivetemp values, drive temps will appear as
regular user with -Dx, and will be to 1 decimal place. hddtemp temps are
integers, and requires sudo to display the temps.

4. To handle issue #239  which I'd thought of trying off and on, but never did,
added option to -Dxxx to show SSD if a positive SSD ID was made to rotation:
So rotation will show either nothing, if no rotation or ssd data is detected,
the disk speed in rpm, or SSD if an SSD device. There may be corner cases where
this is wrong, but I don't have data for that, for example, if a disk is parked
and has zero rotation but is a HDD, not as SSD. I don't know what the data
looksl ike in that case. Note that if sudo inxi -Da is used, and smartctl is
installed, it should be right almost all the time, and with regular -Dxxx, it's
going to be right almost always, with a few corner cases. That slight
uncertainty is why I never implemented this before. Legacy drives also sometimes
did not report rotation speeds even when HDD, so those may create issues,
but inxi will only call it an SSD if it's an nvme, mmcblk device, both are
easy to ID as SSD, or if it meets certain conditions. It will not call a drive
an SSD if it was unable to meet those conditions.

INTERNAL CODE CHANGES:
1. Refactored the output logic for DiskData, that was messy, split it into a few
subs, and also refactored the way smartctl data was loaded and used, that's
much cleaner and easier to use now. Split the previous 1 big sub into:
totals_output(), drives_output(), and smart_output().
Also split out the smart field arrays into a separate sub, which loads
references to avoid creating new arrays and copying them all over when outputting
smart data. References are weird to work with directly but they are MUCH faster
to use, so I'm moving as much of the internal logic to use array raferences
instead of dereferenced arrays/hashes assigned to a new array, or hash.

2. Redid all the output modules and renamed them to be more consistent and
predictable, and redid the logic here and there to make the get() items be fairly
similar on all the data builder packages. Now as with the data subs, which
generally end in _data, now most of the output subs end with _output.

3. Roughly finished the process started in 3.2, got rid of redundant array loads,
changed:
@something = something_data();
push (@rows,@something);
to:
push (@rows,something_data());
which avoids creating an extra array, this also let me remove many arrays overall.

4. Missed a few hashes in machine data that were being passed directly, not as
references, to other subs, corrected that. I think I missed those because they
were %, so the search I did for @ in sub arg lists didn't catch the % hashes.
2021-02-08 17:07:34 -08:00
Harald Hope 6c9b259375 changelog, added one more bug item. 2021-01-28 23:09:29 -08:00
Harald Hope 244a8f3035 zfs raid level fix 2021-01-28 22:27:04 -08:00
Harald Hope 3a625f13ea Failed to use all possible sd block device major number matches, which
led to false disk total/used reports, that is, totals less than used.
2021-01-28 20:58:58 -08:00
Harald Hope 287b8cfe77 tiny fix for weird sdaj type > 26 drive systems 2021-01-28 20:29:12 -08:00
Harald Hope a68b1e8358 Bug fixes!! New Feature!! Edits, cleanups!!
Bugs:
1. Small bug, wrong regex would make mdraid unused report never show.
Was looking for ^used, not ^unused. No idea how that happened, but it's fixed.

2. Big RAID bug. Due to never having seen an 'inactive' state mdraid dataset,
inxi had a bunch of bugs around that. I'd assumed active and inactive would have
roughly the same syntax, but they don't. This is now corrected. Thanks Solus user
for giving me the required data. This case when not corrected resulted in a
spray of errors as RAID ran, and a fairly incomplete RAID report for mdraid.

3. A bug that probably never impacted anyone, but in SMART the matching rules
failed to match field name Size[s]? in the logical/physical block sizes.
However, those were already coming in from I believe pre-existing /sys data
for the drives but now it's fixed anyway. I had not realized that smartctl
made it plural when logical/physical were different, and singular when
they were the same.

Fixes:
1. Going along with bug 2, fixed some other admin/non admin report glitches.
Made patterns more aggressively matching, whitelist based to avoid the types
of syntax issues that caused bug 2.

2. Added 'faulty' type to mdraid matches, that had not been handled.

3. Found even more of those pesky 'card' references in help and man page,
replaced all of them with 'device[s]'.

4. Subtle fix, for debugger data collectors, added -y1 support, which can
be useful at times.

Enhancements:
1. In USB data grabber, added fallback case for unspecified type cases, now
uses a simple name/driver string test to determine if it's graphics, audio,
or bluetooth. This was mainly to make sure bluetooth usb devices get caught.

2. New feature! -E/--bluetooth. Gives an -n like bluetooth Device-x/Report.
Requires for the 'Report:' part hciconfig, which most all distros still have
in their repos. With -a, shows an additional Info: line that has more obscure
bluetooth hci data: acl-mtu sco-mtu, link-policy, link-mode, service-classes.

This closes the ancient, venerable issue #79, filed by mikaela so many years
ago. Better late than never!! However, features like this were really difficult
in legacy bash/gawk inxi 2.x, and became fairly easy with inxi 3.x, so I guess
we'll slowly whittle away at these things when the mood, and global pandemic
lockdowns, make that seem like a good idea...

Includes a small lookup table to match LMP number to Bluetooth version (bt-v:),
hopefully that's a correct way to determine bluetooth version, there was some
ambiguity about that.

-x, -xx, and -xxx function pretty much the same way as with -A, -G, and -N
devices, adding Chip IDs, Bus IDs, version info, and so on.
Since this bluetooth report does not require root and is an upper case option,
it's been added to default -F, similar to -R, and -v 5, where raid/bluetooth
shows only if data is found. With -v7 or -R or -E, always shows, including
no data found message.

Includes a fallback report Report-ID: case where for some reason, inxi could
not match the HCI ID with the device. That's similar to IF-ID in -n, which
does the same when some of the IFs could not be matched to a specific device.

3. For -A, -G, -N, and -E, new item for -xxx, classID, I realized this is
actually useful for many cases of trying to figure out what devices are,
though most users would not know what to do with that information, but that's
why it's an -xxx option!

4. Yes! You've been paying attention!! More disk vendors, and new vendor IDs!!
The cornucopia flows its endless bounty over the grateful data collector, and,
hopefully, inxi users!! Thanks as always, linux-lite hardware database, and
linux-lite users who really seem set on the impossible project of obtaining
all the disks/vendors known to man.

Changes:
1. Small change in wording for mdraid report:
'System supported mdraid' becomes 'Supported mdraid levels' which is cleaner
and much more precise.
2021-01-28 20:02:42 -08:00
Harald Hope 1e2d470c69 That damned Kate editor bug where it randomly sprays out characters
that were in the desktop clipboard caused 3 random pastes of the
characters 'failed' into the man page. Kate needs to get their damned
crap in order!!! It's becoming unusable.
2021-01-13 17:32:13 -08:00
Harald Hope 23b86ad5f2 typo fix 2021-01-10 21:01:32 -08:00
Harald Hope 6e4cd28791 New version, man page, bug fixes, changes, adjustments and cleanups!!!
Special thanks to mr. mazda for his ongoing suggestions, ideas, and observations.

Bugs:
1. In certain corner cases, it appears that lsusb has blank lines, which tripped
errors in inxi output when the usb parser was trying to access split keys that did
not exist. Added in check to make sure split actually resulted in expected data.

2. A red face bug, I'd left the output debugger switched on with json output, so
it was printing out the json data structure with Dumper, that's now switched off.
Hope this doesn't mess anyone up, but it would have mattered only if the person
was using:
--output json --output-type print
It did not effect xml output.

Fixes:
1. Got rid of extra level of -L data structure and output handler. Not visible
to users, but still irksome, so nice to get that fixed. Recursive structures are
confusing, lol, but this extra level was pointless, but to fix it required redoing
the logic a bit for both data generator and output feature.

2. Added in support for --display :0.0, previously it did not support the
.0 addition, but why not, if it works for people, good, if not, makes no difference.

3. There were some missing cases for LVM missing data messages, so the following
fixes were added:
 * In cases where lsblk is installed and user is non root, or lvs is not installed,
 but no lvm data is present, inxi now shows the expected 'Message: No LVM data found.'
 instead of the permissions or missing program error that showed before.
 If lsblk is not installed, and lvm is installed (or missing), with lvs not root
 readable, the permissiosn message (or missing program) will show since at that
 point, inxi has no way to know if there is lvm data or not.

 * Not an inxi, but rather an Arch Linux packaging bug, the maintainer of lvm
 has made lvs and vgs fail to return error number on non root start, which is
 a bug (pvs does return expected error return). Rather than wait for this bug
 to be fixed, inxi will just test if lvs and lsblk lvm data, it will show
 permissions message, otherwse the no lvm data message as expected.

I think these cover the last unhandled LVM cases I came across, so ideally, the
lvm data messages will be reasonably correct.

4. Some man page lintian fixes.

5. Changed usb data parser to use 'unless' instead of 'if' in tests since
it's easier to read unless positive tests are true than if negative or
negative etc.

Enhancements:
1. Since I see too often things like -F --no-host -z which is redundant, the
help and man now make it more clear that -z implies --no-host.

2. Even though it's not that pointful, I added in derived Arch Linux system
base like Ubuntu/Debian have. It's not that meaningful because unlike
Ubuntu/Debian, where you want to know what version the derived distro is
based on, Arch is rolling thus no versions, but I figured, why not, it's
easy to do, so might as well make the system base feature a bit more complete.

Note that the way I did this requires that the distro is ID'ed as its derived
distro nanme, not Arch Linux, that will vary depending on how they did their
os-release etc, or distro files, but that's not really an inxi issue, that's
up to them. From what I've been seeing, it looks like more of the derived
distros are being ID'ed in inxi as the derived name, so those should all work
fine. Note that seeing 'base:' requires -Sx.

3. More disk vendors!! More disk vendor IDs!!! I really dug into the stuff,
and refactored slightly the backend tools I use, so it's now a bit easier
to handle the data. Thanks linux-lite hardware database, as always, for
having users that really seemt to use every disk variant known to humanity.

Changes:
1. In -G, made FAILED: lower case, and also moved it to be after unloaded:
It was too easy to think that the loaded driver had failed. Also to make it
more explicit, made output like this, in other words, driver: is a container
for the possible children: loaded: unloaded: failed: alternate: which should be
easier to parse and read without mixing up what belongs to what.

driver: loaded: modesetting unloaded: nouvean,vesa alternate: nv
driver: loaded: amdgpu unloaded: vesa failed: ati

Note that if there is no unloaded: driver, failed: would still appear to come after
loaded:, but hopefully it's more clear now.

Basically what we found was that the presence of the uppercase FAILED: drew
the eye so much that it was sometimes not noted that it was a key: following
the driver: item, which itself because it did not list explicitly loaded:
was not as clear as it could have been. By making failed: the same as the
other key names visually, hopefully it will be less easy to think that the
loaded: driver failed:

In a sense, this is a legacy issue, because the original use of FAILED: was for
non free video drivers, to see when xorg had failed to load them, but over
more recent years, the most frequent thing I have been seeing is odd things
like failed: ati, when xorg tries to load the legacy ati driver when amdgpu
is being used.

2. Likewise, for RAID mdraid and zfs changed FAILED: to Failed:, again, to make it
more consistent with the other types.

3. In help menu and man page, removed legacy 'card(s)' in -A, -G, -N, and replaced
that with 'device(s)', which is the more accurate term, since the days when these
things were only addon cards are long behind us. I had not noticed that, but it
caught me eye and I realized it was a very deprecated and obsolete syntax, which
did not match the way inxi describes devices today.

4. It was pointed out how incoherent the naming of the item for setting wrap width,
--indent-min and config item INDENT_MIN were super confusing, since it was neither
indent or minimum, it was in fact wrap maximum, so the new options and config items
are --wrap-max and WRAP_MAX. Note that the legacy values will keep working, but
it was almost impossible in words to explain this option because the option text
was almost the exact opposite of what the option actually does. Redid the man
and help explanations to make the function of this option/config item more clear.

5. Made -J/--usb Hub-xx: to fit with other repeating device types in inxi output,
before Hub: was not numbered, but it struck me, it should be, like all the other
auto-incremented counter line starters, like ID-xx:, Device-x:, and so on.

6. Reorganized the main help menu to hopefully be more logical, now it shows the
primary output triggers, then after, the extra data items, -a, -x, -xx, -xxx,
separated by white space per type to make it easier to read. This also moved
the stuff that had been under the -x items back to where they should be, together
with the main output control options. For readability and usability, I think this
will help, the help menu is really long, so the more visual cues it has to make it
clear what each section is, the better I think. Previously -a was the first items,
then way further down was -x, -xx, and -xxx, then under those was -z, -Z, -y.
2021-01-10 19:20:21 -08:00
Harald Hope df45e6d4ae Bug Fixes!!! Continuing internal refactor!!
This bug report came in right after 3.2.00 went out live, but I would never have
found it myself in testing so better found than not found!

Bugs:

1. A bug was introduced to dmidecode data handlers in 3.2.00 resulted in the
dmidecode data array basically eating itself up until errors appear. Quite difficult
to trigger, but babydr from Slackware forums figured it out, using -F --dmidecode
to force dmidecode use for all features that support it triggered thee bug always.
This was a result of the refactor, previously inxi had worked on copies of referenced
arrays, but in this case, it was working on the original array of arrays, subtle,
but obvious. This method was only used on dmidecode arrays.

2. A second bug was exposed almost by accident, for -M --dmidecode data, there was
a missing field and also a missing is set test on that field that led to an error
of using undefined value in string comparison. This was strictly speaking 2 bugs,
both very old, from 2.9 first rewrite, one failing to set/get the value, and the
other failing to test if the value was set before using it.

Fixes:

1. There were a few glitches in help menu and man page related to -L option, those
are corrected.

INTERNAL CODE CHANGES:
1. removed bug inducing splice use in some cases, and added parens to splice to make
it fit the new way of with perl builtins, when taking 2 or more arguments, use parens.

2. Found many more instances to add -> dereferencing operator. I have to say, not
doing that consistently made the code much harder to read, and created situations
where it's somewhat ambiguous what item belongs to what, with everything consistently
-> operator run, the code is more clear and obvious, and some of the hacks I'd added
because of the lack of clarity were also removed.

3. Removed explicit setting of hash references with null value, that was done out
of failure to use -> operators which clearly indicate to Perl and coder what is
happening, so those crutches were removed. Also got rid of unnecessary array
priming like: my @array = (); Some of these habits came from other languages,
but in Perl, declaring my @array means it's an array that is null, and you don't
need to do a further (). @array = () is obviously fine for resetting arrays in
loops or whatever, but not in the initial declaration.
2020-12-17 14:51:11 -08:00