[multipathd] don't care interpreting "\n" as a cli command

CR epileptics like me are happier now.

multipathd>
multipathd>
multipathd>
multipathd>
multipathd>
multipathd>
multipathd>

[multipathd] small fixes

There was a spot where multipathd's reply length forgot to count the NULL,
and I noticed that the way domap go rewritten, the dry-run option doesn't
print out the maps.

This patch fixes both.

Benjamin Marzinski, Redhat

[multipathd] improved daemon setup

If you log into a machine and start the multipathd daemon, you will hang on
logout, because multipathd doesn't fully detach itself from the calling
processes. Also, occasionally the device mapper library functions will
print
error messages to stdout.  These appear in the terminal that was used to
start multipathd, if it was started by hand (not by init scripts).  To fix
these
I added some code to fully daemonize multipathd, and redirect stdout and
stderr to /dev/console.

Benjamin Marzinski, Redhat

[multipathd] stop switch to best PG when no PG is active

To do that I added struct multipath:bestpg to store
switchgroup:select_path_group() result.

struct multipath:nextpg now only store current DM setting.

So the test is now (bestpg != nextpg) to trigger a switchgroup.

[libmultipath] move the async logger in libmultipath, part2

Remove old files

[libmultipath] move the async logger in libmultipath

Brian Wong, Pillardata, suggested and implemented this to avoid
cross dependencies.

[multipathd] fix failback

Refresh mpp->hwe before select_failback() in setup_multipath().
Proposed by Lan Tran, IBM, and Edward Goggin, EMC.

[multipathd] link to ncurses instead of curses

Brian Wong, Pillardata, reports SLES does not package libcurses.
He suggested linking to ncurses instead. Done and verified on
Debian Sarge and RHEL4u0.

[multipathd] "add map" cli command to accept map names as param

[multipathd] "del map" cli command to acces map names as param

[libmultipath] embed a struct dm_info pointer in struct multipath

- replace dm_get_state() by a generic dm_get_info()
- move mpp->minor users to mpp->dmi->minor
- move mpp->dmstate users to mpp->dmi->suspended
- cli handlers for resume/suspend map now trigger dm_get_info()
  instead of playing directly with mpp->dmstate : more reliable

[libmultipath] rename dm_reinstate() to dm_reinstate_path()

More explicit, and in line with dm_fail_path()

[libmultipath] devmapper.c messaging functions consolidation

Add dm_message(), and use it at a backend for adhoc messaging fns.

[libmultipath] rename find_mp() to find_mp_by_alias()

More coherent with find_mp_by_wwid() and find_mp_by_minor()

[multipathd] add "reinstate/fail path $path" CLI commands

[libmultipath] add vector_del_slot() checks

Verify that the slot number we where asked to delete is not "< 0" nor
"> VECTOR_SIZE()".

[multipathd] handle map dmstate reporting through "show maps" CLI cmd

- fetch dmstate a startup
- keep map state in sync in suspend/resume cli handlers
- add the print.[ch] bits

[multipathd] add "suspend/resume map" cli commands

Suggested by Narasimha Doraswamy, HP and others

[multipath] fix early exit for blacklisted scope-limiting-device

we tried to compare conf->dev to the blacklist entries, but entries are
usually of the {sda,sdb,...} form and conf->dev of the /dev/sda form.
No chance of succes !

This was noticed following a related behaviour reported by Maxim Kozover

xa-s05:~/scm/multipath-tools-0.4.6# multipath/multipath /dev/ram0 -v3
ram0 blacklisted

... now that early enough.

[multipath] empty path uid is not a valid response from get_refwwid()

Maxim Kozover noted that 'multipath /dev/fd0' does not limit the scope
as expected. One of the reason is that get_refwwid happily returns blank
refwwid. Make it clear that it's not a valid scope.

[multipath] path list printing tweaks

Don't print headers when the list is empty

[multipathd] don't print headers when there is nothing to list

[multipathd] fix braino in e9e67ad4fe0837f5946b1c29c9c7b8da259955d5

[multipathd] more useful error message in setup_multipath() error path

[multipathd] fix stop_waiter_thread() segv

This happened when asked to shut a waiter for a map with NULL mpp->waiter.
A code path from dm_get_maps -> setup_multipath (fails) can trigger that.

[multipathd] remove pthread_cancel logic to stop waiter a thread

Rely only on the ioctl interruption through a signal, proposed by
Ben. Note we never actually used this code before, my bad.

[multipathd] dmt leak in waitevent() error path

... and nullify some pointers after free.

[libmultipath] fix regfree fix in config.c:find_hwe()

[libmultipath] fix leak in regexp usage

Valgrind learned me the existence of regfree() :/

[libmultipath] plug leaks with libsysfs usage in discovery.c

- forgot to sysfs_close_device() in "bus" fetching
- leaked a sysfs_dir on error path

[libmultipath] remove exit() 1 : discovery.c

[libmultipath] remove exit() 1 : pgpolicies.c

[libmultipath] remove exit() 1 : uevent.c

[libmultipath] User friendly names enhancements

- add a '-b' flag to multipath(8) to let user specify the bindings file
  location
- move from "non blocking lock plus retrys" to "blocking lock plus timeout"

Benjamin Marzinski, Redhat

[libmultipath] maps printing tweaking++

Add two new wildcards :

* %Q : queueing policy changer countdown (no_path_retry)
* %n : number of active paths

Output is like that :

xa-s05:~/scm/multipath-tools-0.4.6# multipathd -k"show maps"
name   sysfs failback         queueing paths
mpath0 dm-0  XXXXXXXX.. 17/20 5 chk    2
mpath1 dm-1  XXXXXXX... 7/10  5 chk    2

[multipathd] fix no_path_retry keyword handling in multipathd

The no_path_retry keyword can be set in a "device configlet", but
libmultipath/propsel.c:select_no_path_retry(mpp) uses mpp->hwe to get at
it. But we didn't care setting mpp->hwe. Do that now.

[multipath] scope limiting fixes

- move get_refwwid after load_cache
- fix broken wwid matching in filter_pathvec

[multipath] devt2devname() mis-ordered parameters

This error caused scope limiting to major:minor not to work as expected.

[multipath] get_refwwid() tweaking

- don't recode strdup() everywhere
- get_user_friendly_wwid() does allocate, not need to strdup() again.
  This was a leak proper

[multipath] allow scope limiting to a "user_friendly name"

Uses the new lookup in libmultipath/alias.[ch]
Also move the get_refwwid upper in the code.

[libmultipath] add a alias to wwid lookup to the binding subsystem

Useful for multipath(8) scope limiting to an alias.

[multipath] don't reload map if features differs and no_path_retry is set

Indeed, setting no_path_retry delegate the "features" handling to the
daemon. multipath(8) loses the privilege to play with this field after
the map is initially loaded.

[libmultipath] add mpath[0..n] feature forgoten files

/libmultipath/alias.[ch] were forgoten when the patch was commited.

[multipathd] add 'show maps' header

[libmultipath] print tweaks++

Introduce a PRINT_PROGRESS macro.
Factorize use in snprint_{path,map}

[libmultipath] printing tweaking

- unchecked prio reported as '#'
- unchecked dm path state reported as '[undef]'
- priority heading is know called 'pri' instead of 'prio'
  (coherent with tools like ps, top, etc ...)

[all] User friendly names patch

This is a patch to add the option of more user friendly names for the
multipath maps, in the form of mpath<n>.  It adds a configuration option
"user_friendly_names". If set, it will cause multipath to check a bindings
file for the names. The bindings file (/var/lib/multipath/bindings) has
alias to wwid mappings. If multipath finds its wwid in the file, it uses
the associated alias. If not, it creates a new alias, and adds the binding
to the bindings file. If the config option is not set, multipath defaults
to it's regular behavior. Specific aliases in /etc/multipath.conf override
this behavior.

Benjamin Marzinski, Redhat

[libmultipath] printing enhancements and fixes

- [enh] align path uuid
- [fix] PAD() macro could overflow
- [enh] add line header for paths (print.c:snprint_path_header)
- [enh] align pathvec dumps in 'multipath -v3' and print header
- [enh] remove heading and trailing white line in multipathd cli output
- [enh] print header in cli's 'show paths' mode

[libmultipath] handle no_path_retry keyword in hardware entries

Now this keyword can be set in the default, multipath and device
config blocks.

[multipath] claimed path handling overall

Detecting path claims during the discovery, and all paths, exposes
us to open(..., O_EXCL) collisions. Paths could appear as claimed when
they are not actually.

Visible effect is, during a udev add storm (driver loading), rarely,
a map would not appear when it should have. This was reported by
Maxim Kozover.

This patch remove all pp->claimed usage and allows DM_DEVICE_CREATE to
fail when loading a map with claimed paths (with libdevmapper logging
shut). But cleanup the mess on error.

[libmultipath] message when a map can't be flush because in use

[multipath] Fix -F appearing twice in the multipath -h output

multipath -h shows 2 options using "-F", where only one of them should be using
-F and another -f. Redhat Bugzilla #171366.

B. Nocera, Redhat

[libmultipath] some more snprint_path() beautifying

- align priority values (too bad log10 needs -lm build flag)
- remove a redundant trailing whitespace after #:#:#:#
- pad states
- scale completion bar to 10 chars

[kpartx] partition type check was flawed

Lars Soltau, IBM

[config] rr_min_io typo fix

Should closes RH Bugzilla #171286

[multipath] proper execution serializing

Multiple multipath(8) execs can race with udev storm.

We can simulate this with the following :
"multipath -F; /sbin/multipath 8:16 & /sbin/multipath 8:32"

Problem arise when two runs are about to create the same map.
One will fail, leaving us with a choice : abord or retry.

This patch implements the retry policy, as we have no way to tell
if the race winner was the one with outdated info or not.

Also :
- beautifies main.c:select_action() messages.
- isolate a nice configure_multipath() entry point fonction out of main()

[multipath] drop a notice upon wwid change causing a map remove/create

[multipath] fix a double free error

"multipath $FLAGS $ALIAS" code path lead to a double free :
1) get_refwwid did a lookup in mptable and returned mpe->alias as the
   refwwid
2) in the exit path, we freed refwwid
3) then free_config()->free_mptable()->free_mpe() freed mpe->alias at the
   same address

So return strdup(mpe->alias) instead.

[multipathd] diff friendly / cosmetic cli command defines

[priority] remove pp_random shellism

[build] strip at install time, not build time anymore

So that we can 'gdb $BUILD_DIR/.../$EXEC'

[multipathd] multipathd segfault fix in main.c:update_queue_mode_del_path()

Dereferencing mpp->pg->pp->mpp is not that smart.
Use mpp directly here.

May be main.c:update_queue_mode_del_path() should check mpp rather than
faulting ... Kiyoshi Ueda ?

[libmultipath] mostly cosmetic

1) harden discovery.c:path_discovery() sysfs loop
2) remove redundant check in discovery.c:apply_format()

[multipathd] braino fixes

1) revoke more info upon path orphaning
2) dump_pathvec() to return negative value when reply is empty
3) ux_trigger() not to append a "ok" when handler return value is < 0

1) fixes an occasional daemon segfault when cycling add/remove paths
2+3) makes for multipath not receiving "ok" as a cached pathvec :)

[multipath] fix segfault upon '-ll' with empty map present

Noted by Maxim Kozover, regression testing squad

[libmultipath] fix empty map flushing

devmapper.c:dm_flush_map() should flush empty map, whatever the type the
caller asked it to limit to.

Noted by Maxim Kozover

[multipath] '-l' should not print empty maps

Noted by Maxim "QA" Kozover :)

[multipathd] invalidate path dmstate when orphaning

[multipathd] close orphan path file descriptors

Maxim Kozover rightly reported :

"multipathd keeps the file /dev/sdx open, regardless if there's a
multipath-related map having that sdx device as a path or not.
It drops /dev/sdx only if the sdx device is removed.
What's bad is that this drop is not always successful and I think it's
not a right way to cope with the situation. Killing multipathd always
releases the descriptors.

Now when I (...) remove maps with multipath -f, the number of
multipathd threads changes accordingly. But it doesn't release
/dev/sdx devices. That means even after I did multipath -f for all
iSCSI devices and multipath -l output is empty, multipathd still has
those /dev/sdx files open and I can't unload iSCSI driver, cause it
has a non-zero usage count."

[multipathd] retry_tick initialization/update fixes

Fix some bugs of missing retry_tick initialization/update in multipathd.
o Initialization by wrong value in update_queue_mode_del_path.
o Missing status update in update_multipath for events from kernel.
o Missing re-initialization in reconfigure.

Kiyoshi Ueda, NEC

[multipath] Extension of the "no_path_retry" scope to the multipath

Kiyoshi Ueda, NEC

[multipathd] fix off-by-1sec path check interval

Current path check interval is 1 second longer than polling_interval
setting in multipath.conf.

This bug affects the "no_path_retry" option.
For example, if no_path_retry is set in 1, retry (== path check) will
not be launched in no-path situation.

[mutipathd] fix off-by-1sec defered failback

Current delay time of defered failback is 1 second shorter than
"failback" setting in multipath.conf, because defered_failback_tick()
is called before sleep(1) in checkerloop().

Kiyoshi Ueda, NEC

[multipath] "skip out of scope map" fix

The logic was accidentaly inverted in the last patch.
And now we drop the map from mpvec when "out of scope".

[multipath] overzealous deadmap detection fix

[multipath] consider the presence of conflicting empty maps

Drop the conflicting map, then create the new one.
The daemon catchs up through its uevent handlers.

[config] undocument the feature keyword

Replaced by no_path_retry.

[libmultipath] deprecate the default_foo config file options

These are in the default{} configlet; the prefix was clearly redundant.
Keep the old keyword around for a smooth transition, but undocument them.

[multipathd] switch on/off the queueing feature when oportune

The following patch adds time-based retry feature in no-path situation
to multipathd.  Any comments are welcome.

This patch adds 'no_path_retry' option to multipathd.

o no_path_retry = "fail" is equal to 'fail_if_no_path'.
  (i.e. I/O to the no-path map will immediately fail.)

o no_path_retry = "queue" is equal to 'queue_if_no_path'.
  (i.e. I/O to the no-path map will be queued until any path comes up.)

o If no_path_retry = <n> where n is positive number,
  then multipathd will set queue_if_no_path to the map,
  and if the all paths are down, multipathd will turn the feature
  off to fail_if_no_path after the checker tries <n> times for each
  paths in the map.

Multipathd re-writes queue_if_no_path feature parameter in the map,
if this option is specified.  But by default, this patch doesn't
change current multipathd behaviour.
So this patch don't break any existing configuration.

Kiyoshi Ueda, NEC

[multipath] remove uneeded map resume upon reload

This sliped in recently.

[libmultipath] specify vendor/product as regular expressions

[multipath] remove dead maps

A map is considered dead, and thus removed from DM, when all its
constituent paths have disappeared from the system (ie sysfs).

When all paths fail, we keep the map, hoping some path can come back
up.

Flush will fail if the map is claimed (mount, ...), notify that.

This policy is rather safe, because :
- multipath is exec'ed only upon "add path events", so maps can magically
  disappear
- claimed maps cannot disappear

This map purge is clearly an interactive maintenance operation.

[libmultipath] print a '-' as a placeholder for devname we can't resolve

iet_lun0 (149455400000000000000000000000000d00600000b000000)
[size=67 GB][features="0"][hwhandler="0"]
\_ round-robin 0 [enabled]
 \_ 15:0:0:1 sdb 8:16  [active]
 \_ 16:0:0:1 sdd 8:48  [active]
 \_ 17:0:0:1 sdh 8:112 [active]
 \_ #:#:#:#  -   8:144 [active]
             ^
     here ---+

[multipath] nice clean up possible now that we store wwids as map uuids

Thanks again, Patrick.

[libmultipath] fix segfault on empty maps in dm_type()

Reported by Maxim Kozover

[libmultipath] devmap status parser fix

The status information from path selectors that apply to paths are
repeated for each path. Current code assumed this info appears
only once per path group.

Stefan Bader, IBM

[multipath] *bad bad nasty* map reload code path

* the uuid needs not be set for DM_DEVICE_RELOAD
* remove map upon map load/reload failure is *wrong* *wrong*
* "int op" superfluous

[libmultipath] forgoten fd init in struct.c:alloc_path()

[libmultipath] get_claimed() could try to close a negative file descriptor

When open() failed for another reason than EBUSY.

[libmultipath] 0 _is_ a valid file descriptor

Stefan Bader, IBM

[multipath] rules fix

/sbin doesn't seem to be in the PATH when udev execs dmsetup.
Use absolute paths then.

[multipath] workaround for a dmsetup bug in multipath.rules

dmsetup -n flag does not suppress the heading, as the manual suggests
it should. Though --noheadings works, so use that instead.

[multipath] don't exit if pathvec is empty after discovery

When all path fail or are removed by operator, but the maps are still
present, expected behaviour is for "multipath -l" to work.

IOW outs something like :

xa-s05:~/scm/multipath-tools-0.4.6# multipath/multipath -l
149455400000000000000000002000000d00600000b000000 ()
[size=67 GB][features="0"][hwhandler="0"]
\_ round-robin 0 [enabled]
 \_ 10:0:0:1 sdd 8:48 [active]

149455400000000000000000002000000d20600000b000000 ()
[size=33 GB][features="0"][hwhandler="0"]
\_ round-robin 0 [enabled]
 \_ 10:0:0:2 sde 8:64 [active]

xa-s05:~/scm/multipath-tools-0.4.6# iscsiadm -m node --logout --record=0203b2
xa-s05:~/scm/multipath-tools-0.4.6# multipath/multipath -l
149455400000000000000000002000000d00600000b000000 ()
[size=67 GB][features="0"][hwhandler="0"]
\_ round-robin 0 [enabled]
 \_ #:#:#:#   8:48 [active]

149455400000000000000000002000000d20600000b000000 ()
[size=33 GB][features="0"][hwhandler="0"]
\_ round-robin 0 [enabled]
 \_ #:#:#:#   8:64 [active]

[multipath] set devmap UUID to multipath WWID

If you use aliases to rename the multipath devices to something sensible you
lose the WWIDs, this patch stores them as the device-mapper UUID and retrieves
them so they can be displayed using multipath -l.

Patrick Caulfield, Redhat.

Only use one loop to read all data.

Don' use unalligned pointers, this is undefined behaviour.

Use endian.h and byteswap.h.

[libmultipath] generic discovery.c:wait_for_file()

clearly state the wait for file (sysfs or device node) logic is needed
only for multipathd, because it races udev upon uevent broadcast.

for multipath(8), which is ran by udev *after* devnode creation,
wait_for_file() just returns "ok".

[multipath] the multipath udev rule voids the blacklist logic

"%M:%m" moved to "%r/%k"
with the assumption already used that these nodes exist.

[multipath] yet another unchecked devt2devname() return value

This one caused a multipath -ll with no cache loaded to wait for a
pathinfo(nul) to complete for a path discovered in the map but not
present anymore in sysfs.