make: generate

WHATS_NEW: updates

man: indent with command

Avoid spaces showing as the 1st. character on the man page line.
Also start with actual text and move .IP sequence to the line end.

makefile: rebuild man when see_also changes

Missed rebuild dependency, when see_also file changes.

makefile: cleanup tab

tests: don't restart lvmdbusd

Since lvmdbusd execution of lvm2 command was fixed
stop retrying to restart lvmdbuds and abort testig
when it fails.

lvm: option description only for man generator

There is no need to include option description text
within command binary itself.

It's only used only for man generating.

man: fixes in argument description

Describe missed --segments opt for lvdisplay (matches lvs).

Describe lvm-fullreport --all option - show text for lvs,vgs,pvs.

Missed '.' for --separator.

lvmdbusd: ensure readout on exit

cache: ensure UUID ends with \0

Initialization of union is somewhat tricky as it initialize only
the first member + padding, but in our case this does not clear
the whole size of union so explicitly set \0 after 2 'struct id'
and make sure DM uuid is not using random characters from stack.

Also add explicit .id designators (c99).

metadata: replace pv status WRONG_VG with pv bit field

Avoid any special meaning associated with the status field.

lvmcache: unpair wrong PV devs and improve duplicate name warnings

After detecting that a VG has wrongly claimed a PV, unpair
the pv->dev setting.  This will cause the usual "missing PV"
message to appear for that VG.  Make this message, and some
others, clearer by using the VGID rather than the VG name
when there are multiple VGs with the same name.

lvmcache: fix check for no pvid

lvmcache: add WRONG_VG PV status flag

_vg_read() calls lvmcache_update_vg_from_read() which detects
that the VG metadata is incorrectly claiming the PV.  Flag this
condition in the PV status as WRONG_VG.  Later, vg_read() can
simply check the WRONG_VG flag rather than repeating the same
PV/VG checks that were already done in lvmcache_update_vg_from_read.

lvmcache: ignore incorrect PV claim from old metadata

Outdated VG metadata that appears when an old device is attached
to the system can result in PVs appearing to belong to the
old/wrong VG, and commands are allowed to use (corrupt) the PVs.

- vgcreate old /dev/sda /dev/sdb /dev/sdc
- offline /dev/sda
- vgreduce --removemissing old
- vgremove old
- vgcreate new /dev/sdb /dev/sdc
- online /dev/sda

When sda is reattached, sdb and sdc will appear to be
in VG old again.  An attempt to correct the problem,
e.g. with vgremove old or vgreduce old, would modify
sdb and sdc, removing them from the new VG.

To fix this, check that sdb and sdc contain metadata for
VG old before allowing VG old to claim ownership of them.
With the fix, sdb and sdc are not displayed as part of
VG old, and commands to change VG old will fail as long
as it references incorrect PVs.

To fix VG old (sda), remove the incorrect PVs from VG old
while limiting the command to see only the correct PVs:
vgreduce --removemissing --devices /dev/sda old

integrity: round meta size up to minimum one extent

If VG extents are larger than the required integrity metadata size,
use one extent as the size.

lvmlockd: add helpful error message for vgremove

Print a helpful error message when the lockspace is not started.

pvresize: accept autobackup option

doc: Update metadata on 2.03.31 release notes

post-release

pre-release 2.03.31

doc: WHATS_NEW and release note update

doc: Apply markdown formatting

misc: Typo fix s/loose/lose/

Signed-off-by: Eric Blake <eblake@redhat.com>

misc: Typo fix s/more then/more than/

Also a few instances of s/less then/less than/.

Signed-off-by: Eric Blake <eblake@redhat.com>

WHATS_NEW: update

make: generate

test: check LVM_SUPPRESS_FD_WARNINGS

Add test for suppression messages about leaked descriptors.

lvmlockd: drop return from void function

man: update generator code

Generate pages more complaint with 'mandoc -T lint'
Remove some generated space on EOL.
Replace .ad l with .na  macro.
Remove some .br duplicates.

man: reformat args.h to fit in 80 lines

Compliance to mandoc -T lint to fit lines into 80 chars
in generated man pages.

man: updates

Updates for 'mandot -T lint'
Fit lines into 80 characters.
Use  .na .ad   instead of  .ad l  .ad b
Remove some misplaced  .P  & .br
Trim spaces for EOL.

libdaemon: fix suppressing stray fd warnings

Restore support for LVM_SUPPRESS_FD_WARNINGS as
this was seemingly lost with refactoring to
use daemon_close_stray_fds().

uncache and splitcache should restore inactive state

If an inactive LV is being cached in writeback mode, then
removing the cache does a temporary activation to flush
the cache back to the main LV.  However, it forgot to
deactivate the LV again, so the temporary activation
was left in place.

lvmlockd: add debug line

lvmlockd: expand lockopt skip options

The lockopt options for skipping locks were not being used
in many places, making it impossible to override locking to
forcibly run some commands.

test: result is some for lvmpolld

Drop 'TEST WARNING' from this case - the code works the same
were for 'pvmove -b' polling as for lvmpolld.

Just keep there 'TODO' notice we want to eventually reduce amount
of 'worked' pvmove monitoring process - ATM there will be 1 per LV.

man: clarify --stripes number of device

The current manpage is unclear in the example of a raid10 type LV RAID
with --mirrors 1 --stripes 4. The number of devices in each raid1 mirror
is NumberStripes/(NumberMirrors+1). Thus the example should read:

e.g. mirrors 1 and stripes 4 will stripe data across two raid1
mirrors, where each mirror contains two devices.

Fixes: https://gitlab.com/lvmteam/lvm2/-/issues/26
Signed-off-by: Salvatore Bonaccorso <carnil@debian.org>

man: fix grammar in lvmlockd.8_main

Remove redundant 'the' in 'When the another VG'.

Signed-off-by: Dion Bosschieter <dionbosschieter@gmail.com>

man: removing duplicate words in man pages.

This patch removes some sequentially duplicated words in a few man pages.

clang: match prototype

cov: some missed arg_is_set changes

lvconvert: validate mirror image counting

Since _failed_mirrors_count() may eventually return -1,
add extra validation before using returned count.

thin: fix checking monitor mode

Previous commit 874a8ab4d02a59c5 missed 'IGNORE' mode.
Fix it by adding rather 'explicit' test for this value,
so the code is better readable.

Also unlock memory earlier and drop unneeded <backtrace>
from return since we already logged error in this function.

lvmlockd: fix missing lvremove free_lv

Fix missing lockd_free_lv in commit
e3f0af8f1fd7 lvmlockd: fixes for lvremove

tests: reduce Exa test size

Since kernel patch 3d9a9e9a77c5ebecda43b514f2b9659644b904d0  (6.14)
it seem device size is no limitted to <8Exa bytes (so LLONG loff_t
works across whole device).

So reduce our tested size to 8191 Peta  ~ <8 Exa.

test: wait for polling finish

Increase the used mirror size for longer processing.

Add more -vvvv traces to pvmove to better chase test error.

Add extra code to wait for finish of polling pvmove after it's
been aborted - so it doesn't break 'next' test.

WHATS_NEW: updates

cov: add value check

cov: use arg_count for unchecked usage

Reserve usage of  'arg_is_set()' to tested use case and use
arg_count() for unchecked one.

cov: explicitly ignore value

man: remarks and editorial changes for dmstats

Use "groff -e ' $' -e '\\~$' <file>" to find obvious trailing spaces.
Use "mandoc -T lint  dmstats.8"
Use "test-groff -mandoc -t -ww -z dmstats.8"

-.-.

Lines containing '\c' (' \c' does not make sense):

503:.B \-\-units \c

-.-

Change '-' (\-) to '\(en' (en-dash) for a (numeric) range.
GNU gnulib has recently (2023-06-18) updated its
"build_aux/update-copyright" to recognize "\(en" in man pages.

dmstats.8:470:expressed as a hyphen separated range, for example: '1\-10'.

-.-.

Add a (no-break, "\ " or "\~") space between a number and a unit,
as these are not one entity.

1114:Create a 32M region 1G into device d0

-.-.

Add a "\&" after "e.g." and "i.e.", or use English words
(man-pages(7)).
Abbreviation points should be protected against being interpreted as
an end of sentence, if they are not, and that independent of the
current place on the line.

511:Can also specify custom units e.g. \fB\-\-units\ 3M\fP.

-.-.

Wrong distance between sentences in the input file.

  Separate the sentences and subordinate clauses; each begins on a new
line.  See man-pages(7) ("Conventions for source file layout") and
"info groff" ("Input Conventions").

  The best procedure is to always start a new sentence on a new line,
at least, if you are typing on a computer.

Remember coding: Only one command ("sentence") on each (logical) line.

-.-.

The name of a man page is typeset in bold and the section in roman
(see man-pages(7)).

798:extents). This currently includes \fBxfs(5)\fP and \fBext4(5)\fP.
801:group, and the group alias is set to the \fBbasename(3)\fP of the

-.-.

Use thousand markers to make large numbers easy to read

560:is equivalent to 10000000. Latency values with a precision of less than

-.-.

Remove quotes when there is a printable
but no space character between them
and the quotes are not for emphasis (markup),
for example as an argument to a macro.

1:.TH DMSTATS 8 "Jun 23 2016" "Linux" "MAINTENANCE COMMANDS"

-.-.

Output from "test-groff  -mandoc -t -K utf8 -rF0 -rHY=0 -rCHECKSTYLE=10 -ww -z ":

.-.

Additionally:

  Fix some arguments for '.TP'.  A single-font macro does not work with
'\c', so use a two-font macro.

-.-

  Use the pair ".na / .ad" to set no-adjustment (same result as '.ad l')
and '.ad' to restore previous adjustment.
[Replacing ".ad l" ... ".ad b"]

  Set singular '.ad b' to '.ad \*(AD' as the user should have the choice to
control the adjustment from the command line.

  Add an empty string to string 'AD' with '.as AD "\"' to avoid a warning
about an undefined string.

-.-

Generally:

Split (sometimes) lines after a punctuation mark; before a conjunction.

Updated-by: zkabelac@redhat.com

man: remarks and editorial changes for dmsetup

Checking for defects with a new version

Use test-[g|n]roff -mandoc -t -K utf8 -rF0 -rHY=0 -rCHECKSTYLE=10 -ww -z < "man page"
Use "groff -e ' $' -e '\\~$' <file>" to find obvious trailing spaces.
Use "mandoc -T lint  dmsetup.8":
Use "test-groff -mandoc -t -ww -z dmsetup.8":

-.-.

Add a (no-break, "\ " or "\~") space between a number and a unit,
as these are not one entity.

-.-.

Use "\e" to print the escape character instead of "\\" (which gets
interpreted in copy mode).

487:with its hex value (two digits) prefixed by \\x.

-.-.

Strings longer than 3/4 of a standard line length (80)
Use "\:" to split the string at the end of an output line, for example a
long URL (web address)

1030 <name>,<uuid>,\:<minor>,<flags>,\:<table>\:[,<table>+]\:[;<name>,<uuid>,\:<minor>,<flags>,<table>\:[,<table>+]]

-.-.

Add a "\&" after "e.g." and "i.e.", or use English words
(man-pages(7)).
Abbreviation points should be protected against being interpreted as
an end of sentence, if they are not, and that independent of the
current place on the line.

581:Note: Same cookie should be used for same type of operations i.e. creation of
767:Attempts to remove all device definitions i.e. reset the driver.  This also runs
946:e.g. striped 2 32 /dev/hda1 0 /dev/hdb1 0

-.-.

Wrong distance between sentences in the input file.

  Separate the sentences and subordinate clauses; each begins on a new
line.  See man-pages(7) ("Conventions for source file layout") and
"info groff" ("Input Conventions").

  The best procedure is to always start a new sentence on a new line,
at least, if you are typing on a computer.

Remember coding: Only one command ("sentence") on each (logical) line.

Mark a final abbreviation point as such by suffixing it with "\&".

Some sentences (etc.) do not begin on a new line.

Split (sometimes) lines after a punctuation mark; before a conjunction.

-.-.

Use \(en (en-dash) for a dash at the beginning (en) of a line,
or between space characters,
not a minus (\-) or a hyphen (-), except in the NAME section.

-.-.

Remove quotes when there is a printable
but no space character between them
and the quotes are not for emphasis (markup),
for example as an argument to a macro.

1:.TH DMSETUP 8 "Apr 06 2006" "Linux" "MAINTENANCE COMMANDS"

-.-.

Output from "test-groff  -mandoc -t -K utf8 -rF0 -rHY=0 -rCHECKSTYLE=10 -ww -z ":

Updated-by: <zkabelac@redhat.com>

polldaemon: handle sigint from nanosleep

Handle interruption caught in sleep between polling and
abort() tool execution in such case.
(Although ATM we are not normally signalling the tool this way).

polldaemon: enhance error tracking

Improve error handling in polling functions where errors
were previously ignored. These errors result from serious
failures (e.g., allocation errors) and should lead to a full
command exit, as the tool cannot function in such a state.

FIXME:

However, there is a fundamental design issue worth considering:
when a command like pvmove --abort cancels an ongoing operation,
the existing polling command continues running and only terminates
once it detects that there is nothing left to poll.

Next issue is perment reopening of a VG when 'monitoring' progress.

And the last is big trouble with '--interval 0' which is able to
wait in DM ioctl() and hold the VG lock, and there is not good way
to about such operation (other then sending a signal to such process).

lvmpolld: easier alloc code

Share _free_lvmpolld_lv() function.

test: skip retry only for lvconvert

Mirror creation is creating log volumes and needs occasionally
retry loop for deactivation.

makefile: remove old lcov files

Remove any older lcov generated files ('*.gcda|gcno') then the currently
generated 'make.file' before creating a new lcov report.

Otherwise we may hit the problem of using some older generated files
possibly with different format.

libdm: restore missing symbols

Restore missing symbols to the libdevmapper.so library.

These symbols:

dm_bitset_parse_list@@DM_1_02_138
and dm_tree_node_size_changed@Base

become 'lost' with commit: 40b277ae1799fc7a2e3f38b0abebd81a8e3d1995
which supposedly cleaned local 'symbols' from visibility,
however these missing symbols were impproperly exported.

Signed-off-by: Jianqi Zeng <zengjianqi@kylinos.cn>

lvmlockd: recognize error ELMERR

lvmlockd: disallow shared activation of LV with cow snapshot

The check for disallowing shared activation was missing
a check for this type.

test: repeatedly restart lvmdbusd

It looks like occasionally supports_json() in cmdhandler.py
for some reason does not find  'fullreport' in err output
of lvm help...  let's see more traces...

revert "test: aux gives more time for lvmdbusd start"

This reverts commit 8425c1b468af0caf2e1e36d1eb1c1b399ee22489.

Seems we have different problem with lvmdbusd test start.

test: improve holding device open

Use 'exec' to open device and then just pass descriptor to sleep.

lvmlockd: fixes for lvremove

The simple common case of locking the LV to remove with a
persistent lock would usually be fine, but there are a number
of special cases that were not addressed:
- no locking was done for removing cow snapshot
- direct locking to vdo pool
- dm-cache uncache using lvremove was not handled

lvmlockd: use lockd_lvcreate_lock for multiple LV types

Use the same lockd_lvcreate_lock() for all cases in which
creating a new LV first requires locking another associated
LV, e.g. locking the pool or origin for the new LV.

test: add check for no such file

cov: refactor code for warning

Refactor resizing loop, so Coverity no longer sees
the loop as 'infinite' and the code is also readable.

cov: refactor code

Refactor code, so Coverity doesn't complain about over-running
an array with char*.
(IMHO this seemed like a problem in Coverity code evaluation)

cov: initialize arrays values

clang: refactor code for easier alloc tracking

Refactor _get_split_name(). code to simplify detection of memory leak
in _destroy_split_name(). Now there are always just 2 pointers
instead of conditional pointer free() which is hard to follow.

clang: call alloca with non-zero size

Make sure that some non 0 size is also for (mirrors == 0).

clang: pointer protection

clang: validate command before exec

Add extra check for command existence in argv before fork().

clang: use better readable code

Here we make sure, that we always free fopen() fp.
As theoretically we may have had opened 'stdout'.

clang: validation

tools: using proper header order

ARG_COUNT is generated by processing command_enums and
then it can be used by command.h.

So correct include order and later use command.h.

cleanup: headers self compilable

In most cases header should be self-compilable, so the
do not expect other 'header' files to be used upfront
so the header would be compilable.

No functional change.

cleanup: match function prototype with definition

Match variable name in function definition with
its prototype. Pick the name which better fits
the usage.

No functional change.

cleanup: project headers in front

Include project headers before system header files.

clang: silence warning

Make the code pass through Coverity/clang.
As it didn't like theoretical access beyond
_yes[] & _no[] array elements.

clang: correcting imprecise prototype

These internal header were using misleading variable names
in function prototypes, but correct names were used in
function definition. Noticed with:

clang-tidy --checks=readability-inconsistent-declaration-parameter-name

No functional change.

clang: make pointer defined

clang: add known mask value

Bit flags likely should never have been 'enum' but since
we have this in a public header - it might be hard to
replace this. So at least add missing 'enum' element
we use.

clang: check pointers

clang: pointer validation

clang: better visibility of non-null lock_type

clang can't see transient result, however
it would be still better to check for type string just once.

clang: ensure defined value

Although this radix_tree_simple code is not being unused ATM...

clang: validate allocated buffer size

Validate for not using 0 size arg for allocation,
however this can never heapen for running code...

clang: trace rewind errno

Although rewind() return void, it's API suggest
to check for 'errno' value.

clang: reduce padding in struct cfg_def_item

Reorder struct members to minimize padding.

clang: reduce padding in struct command_name

Reorder struct members to minimize padding.

clang: refactor code to always run inner loop

Make it more clear to analyzer the inner loop always runs.
Otherwise it may complain about *c being NULL.

clang: valid area is required

Do not try to check references when verifying
LV segments with missing area.

clang: ensure extents is usable

Although the code was exiting only for  (update == 0),
the later code actually used requires 'extents' to exist
also for  (update != 0).

TODO: The logic here is not very clear, more testing needed.

clang: fix double free in error path

When prefix insertion to radix_tree would fail, the error
path might try to possible double free allocated memory.

raid: set warn print level

Since there conversion messages are not causing direct
command error, switch message level to log_warn().

man lvm: add tag info

Restore basic info about tags that was dropped years ago
during the reworking for man page generation.
Also some other minor random updates.

lvcreate: accept lockopt option

The redundant lvcreate.c implementation of accepted options needs
to be removed.

test: improve for use with older systems

Improve test, so it's also working on systems without delay_dev
and test is actually more 'race' resistant.