docs: add Sami Kerola to authors

performance: set few variables read-only

cleanup: remove message duplicate

Commit 9a9003a436b19044abf35a73c9fc5bb5a271b7aa missed removing this line.

cleanup: correct display_offset variable usage

Variable display_offset was missed to move from local scope to control
structure in file it had it as local.

cleanup: set variable only if it is used

Variable introduction needs to be same way preprocessor conditional as the
related code.  This is a minor clean up, because modern compilers should
remove these types of variables automatically.

cleanup: remove more/bottom labels header separation from mpls

Commit a932cb2abc85651ca6f33a06d7b64448c1d27f65 added this separation, but
after five years and a bit the printouts has not become different.  It is
time to remove this todo item.

performance: make get_iiwidth() to be const function

Change input argument to be a variable, so that optimizer can kick in and
take short cuts when possible.

Reference; https://gcc.gnu.org/onlinedocs/gcc/Common-Function-Attributes.html#Common-Function-Attributes

cleanup: make unused and const attributes to look the same

Definition CONST was already reserved in net.h to mean 'const' as a variable
attribute, so function attribute got a ATTRIBUTE_ prefix to separate them.
This change unifies unused to look the same.

crash fix: ctl->iiwidth_len was not initialized correctly

It was a mistake to add iiwidth_len to struct mtr_ctl.  First of all the
value needed in that field was never set, and that resulted to crash when
running command with --csv option.

Secondly adding the field was bad idea to begin with.  Number of array
elements is known only within context of asn.c file, so it is better to add
interface to query it rather than try to set value to a structure.  Later
design is prone to cause futher bugs, if/when execution flow is not as one
might assume.

crash fix: never return const string as address

String that comes from #define can cause SIGSEGV.

crash fix: add ctl structure to gtk Pause_clicked() handler

Without this handler net_max() will crash with SIGSEGV at line 1209.  gdb
backtrace gave clear hint what was the problem, and where it needs to be
fixed.

  #0 0x4109db in net_max /home/src/mtr/net.c:1209
  #1 0x42478e in gtk_redraw /home/src/mtr/gtk.c:508
  #2 0x422fc7 in Pause_clicked /home/src/mtr/gtk.c:121

cleanup: merge two trim functions to one

As a minor improvement make the trimmed string to stay at same start
address, so that trims can be safely done to pointers that are allocated and
need to be free'd later on.  There is no such case in this code, but it is
good idea to write functions the way they will not cause memory issues
if/when such use case happens.

performance: use fewer printw() calls to center text

Avoid printing white space one by one when variable length print out of
nothing can do the same thing.

Signed-off-by: Sami Kerola <kerolasa@iki.fi>

bug fix: long option --gracetime is correct, --graceperiod is not

Commit 5dbeb8f1b4084c38103e92dbd028da2762c1f0a9 introduced new long option
--gracetime, that was documented as --graceperiod.  Only one or the other
can be correct, so pick the --gracetime and update documentation to tell
this is, the expected long option.

usability: add bash-completion file

posix: do not use time(2) input argument

Function time(2) argument is obsolescent and should always be NULL in new
code.  When the argument is NULL, the call cannot fail.

Reference: http://man7.org/linux/man-pages/man2/time.2.html

usability: use ISO-8601 timestamp

The ISO timestamp has timezone information, and is easily parsable.

reliability: check writing to stdout and stderr was successful

This is expected behaviour.

$ mtr --help > /dev/full; echo $?
./mtr: write error: No space left on device
1

Earlier write errors returned successful zero.

Reference: https://www.irill.org/events/ghm-gnu-hackers-meeting/videos/jim-meyering-goodbye-world-the-perils-of-relying-on-output-streams-in-c

reliability: always check strdup() return value

Exit if allocation fails.

reliability: always check malloc() return value

Exit if allocation fails.

reliability: further removal of unsave string operation

Replace strcpy() + strcat() with a snprintf().  In same go name a magic
constant to a definition.

reliability: ensure string copy results to a null determined string

Copying strings is much harder than it superficially looks, see reference
for further information,

Reference: http://meyering.net/crusade-to-eliminate-strncpy/

cleanup: move generic utility functions to a separate file

The utils.c is basically an internal general purpose function library.

cleanup: use ICMP definitions from linux/icmp.h when possible

cleanup: avoid duplicating stdint.h

Use exactly defined data types from stdint.h rather than defining own
similar types.

Reference: http://pubs.opengroup.org/onlinepubs/009695399/basedefs/stdint.h.html

cleanup: remove commented out includes in dns.c

Thees have been two years commented out, and if someone really has to fiddle
around with comments that is a failure of autotools usage and needs to be
addressed by getting the autoconf to do the right things.

cleanup: use definition for a magic value appearing twice in code

This improves readability, and makes it almost impossible to get these out
of sync.

usability: print usage() if unknown options are used

It is better to burn and fail than allow recovery from unexpected user
interface usage.

warnings: avoid vla when malloc() is more appropriate

Assuming allocatin failure will happen use of vla will cause very strange
looking error.  In this occasion it is better to use malloc, and check it
was successful.  Found with smatch scan.

warnings: do not use zero as NULL

Found with smatch scan.

warnings: correct function pointer prototype argument

In struct fields the function pointer is getting assignments of functions
that take one int as input argument.

crash fix: make --xml not to dump core

This also makes --report option to print values rather than %5N.  And in
same go remove a floating point exception.

Crash these issues were introduced in caad4c42fb8ef0d830fd37608a96702d6774f93f

data types: move rest of the global variables to control structures

Many of these variables seem to related to printing.  One can reasonably
assume the control structure will need to be split to a library and
none-library parts.

data types: make control structure smaller

Move boolean variables, and other variables that has well known small size,
to a named bit field.

data types: move global data to control structures

This is a big and pretty messy change, but unfortunately there is no nice
way to move variables from global scope to input argument scope.  But that
does not explain why this is needed, so let me try to do that.

Variables in global scope make lousy api.  In order to separate tracing
functionality from various display interfaces making api cleaner is a must.
Further goal of clean api with aim publishing it as libmtr library.  Such
library needs to be fully documented, and it can even provide python
bindings for people and organizations who happen to need such.  Please keep
this plan as a git commit log hush-hush secret.  It might take more than a
moment to get all the necessary changes done to reach fully working, decent,
understandable, documented library similar to libabc.

Reference: https://git.kernel.org/cgit/linux/kernel/git/kay/libabc.git

docs: make manual page versioning automatic

In same go mark the manual page in System Administration selection.

usability: fix --mark documentation

And make the option argument to match with what is expected in kernel space,
that is u32int_t data type.

Reference: https://github.com/torvalds/linux/blob/master/include/net/sock.h#L419

data types: get rid of all globals that are easy to remove

Some variables are unnecessary, others can be moved to a function or a file
scope.

warnings: fix use of uninitialized warning

clang claims: variable 'port' is used uninitialized whenever switch default
is taken.  And that is a lie, but error() is not marked as function that
never returns, because it can also be used when printing warning.  So the
compiler is guessing wrong, but the easiest fix is to initialize the
variable rather than educate compiler.

data types: check with smatch everything is in resonable scope

Now when extern variables, and functions are known one can start thinking
about how get rid of global variables.

data types: move variable declaration from header to .c file

And make the variable shared.

cleanup: remove redundant redeclaration

data types: set static strings to be read-only

Merge pull request #144 from kerolasa/mac

Mac/portability fixes

portability: fix MacOS libresolv usage

MacOS has res_query in libc, but needs libresolv for dn_expand().

portability: MacOS does not have error() function

Add portability fix by using err() function family.  This is a bit cheeky,
but should work relatively well.

portability: fix float max check from values.h

MacOS does not have values.h file.

fixed typo.

Merge pull request #143 from kerolasa/2016-08-21

Cleanups: mark some functions as static. use GNU function "error" instead of perror/exit.

build-sys: tell function locality explicitly

Most of the function prototypes in header files are indeed external, with
few exceptions that can be set to local scope with static key word.
Additionally get rid of net_duplicate() prototype that does not exist
anywhere.

build-sys: use system getopt_long() when it is available

And move the getopt sources to portability support directory.

cleanup: move max port number to be a define in net.h

usage: use error(3) error-reporting function

There are two benefits of using error(3).  First of all this function
unifies error printing nice way, and when done this way a programmer cannot
accidentally mix stderr and stdout error print outs.  Secondly the error(3)
appends program name to errors, making it clear what printed an error.  To
demonstrate this see below for old and new output, in which the old error
could have in theory been reported by sudo(8).

$ sudo mtr -u -T # old
-u , -T and -S are mutually exclusive.

$ sudo ./mtr -u -T # new
./mtr: -u , -T and -S are mutually exclusive

usage: be careful when parsing numeric user input

Functions atoi(3) and atof(3) do not perform any error checking.  Use
strtol(3) function family, with alterations to fail if input is not
expected.

Merge pull request #142 from kerolasa/pkg-config

configuration cleanup, Pkg config.

cleanup: remove preprocessor missing functions go-arounds

Calling empty functions when there is no support is messy, and harder to
read than not calling at all functionality that is not present.

usage: reflect ./configure choices in available command line options

Features that are turned off should not be available to users as an options.
This commit also ensures matching long and short options, and makes the
long-only --displaymode option to be totally unreachable with short options.

cleanup: remove obsolete herror() function

Applications should use getaddrinfo(3), getnameinfo(3), and gai_strerror(3)
instead.  Systems without getaddrinfo() are from now on considered too
broken to be supported.  These include for example platforms: HP-UX 11.11,
IRIX 6.5, OSF/1 5.1, Solaris 7, Cygwin 1.5.x, mingw, MSVC 9, Interix 3.5,
and BeOS.

build-sys: remove unused autoconf check values

Return values from checks are not used anywhere in this project.

build-sys: simplify finding resolver library

cleanup: remove NO_SPLIT preprocessor check

Apparently ./configure --without-split was planned to be added in commit
433bf6c22ce90e25f3ffb0b4852631e5724ac608 but that has not happen in 17
years.  Time has come to get rid of a half implemented idea.

build-sys: get rid of double negative ipinfo autotools settings

build-sys: use pkg-config to find ncurses

The curses function attron() has been part of posix since 1997.  There is no
need to go-around for it.

Reference: http://pubs.opengroup.org/onlinepubs/7908799/xcurses/attron.html

build-sys: use pkg-config to find gtk+-2.0

build-sys: check pkg-config availability

fixed #141 compile without SCTP if not available

fixed #27 and #35 where the fix was tested a long time ago.

Merge pull request #140 from aquerubin/stdev

Fix standard deviation calculation.

Fix standard deviation calculation.

Partial reverse of 6bb5b6b3b.

The bug in automake does not create a vulnerable distirbution. It
allows local attackers that are logged in (or running in the
background) when a distributer types "make distcheck" to possibly gain
root access on the build system. This is NOT creating a vulnerable
distribution. The fact that automake has a vulnerability does not
warrant build failures on older systems.

more cleanup

Merge pull request #138 from kerolasa/2016-08-17

2016 08 17 regression fixes and warnings removal

warnings: fix --disable-ipv6 --without-ipinfo compilation warnings

Add include <strings.h> to avoid implicit declaration of built-in functions,
replace bzero() with memset(), mark function argument unused, and use %zu to
print size_t data type.

Signed-off-by: Sami Kerola <kerolasa@iki.fi>

build-sys: fix ./configure --disable-ipv6

build-sys: fix --without-ipinfo regressions

The commit e2d898cc16398609821f7a786ae86dcbac4884af was far from perfect it
broke all --without features.  Oh dear me.

Looks like I am not the only one breaking configure.  The --disable-ipv6 has
been broken since commit d90dd1fd8f9289fa9e880c006ca6dff0ef7d4918 and
further damaged by 2cf22b240958b72fb8d84f3ee663f84cbad2c65b.  These issues
will be addressed later.

warnigns: add void to functions that do not take any arguments

The use of function declarators with empty parentheses (not prototype-format
parameter type declarators) is an obsolescent feature.

fixed no-gtk build bug introduced with e2d898cc

Merge branch 'master' of github.com:traviscross/mtr

Merge pull request #136 from kerolasa/2016-08-16

2016 08 16 make build system better

cleanup: remove unnecessary function

readability: always use EXIT_* definitions from stdlib.h

warnings: fix unused variable when ./configure --without-gtk is used

Use of preprocessor to enable/disable code blocks makes messy code.  Perhaps
something can be done in future to make this nicer.

build-sys: require automake 1.11.6 or newer

Do not let anyone to create vulnerable dist package.

Reference: https://cve.mitre.org/cgi-bin/cvename.cgi?name=CVE-2012-3386

build-sys: improve configure.am

Unify indentation, use strict quoting, and use appropriate macros.  Add few
comments that can be found from ./configure script so that one has some idea
what macros are generating the lines one is looking.

build-sys: use build version script from gnulib

This makes distribution tar-balls from snapshot to indicate they are
snapshot versions.  Additionally the version markup ends up in config.h
correct way, so earlier code that was specific to this project can be
removed.

Reference: http://git.savannah.gnu.org/cgit/gnulib.git/tree/build-aux/git-version-gen

build-sys: remove old dist Makefile kludge

Autotools dist works, there is no longer need for this.

build-sys: fix make distcheck

New distribution package can, and should, now be built using 'make
distcheck' facility from autotools.  Personally I would run the following.

git clean -xdf && git reset --hard HEAD &&
./bootstrap.sh && ./configure && make distcheck

warnings: remove dead code

These functions are not used, remove them.

cast: do not downgrade to float when double should be used

Regression from commit 78f019aa9d49be5ada89296a462939738c20c181

Requested-by: rewolff <R.E.Wolff@BitWizard.nl>
Reference: https://github.com/traviscross/mtr/pull/135/files#r74889063

comment: add value range note to initialization

Requested-by: rewolff <R.E.Wolff@BitWizard.nl>
Reference: https://github.com/traviscross/mtr/pull/135#discussion_r74889440

warnings: fix some missed unsigned vs signed variable comparisions

Commit 507092a9099a286f86639d9cd38dcdc1f28117ff fixed almost all of them,
this should be the last one.

Merge pull request #135 from kerolasa/warnings

Warnings branch

warnings: multiply timeval seconds only when the value is small

It should be safe to multiply timeval seconds by million after substracting
sequence timestamp from now.  The reason to postpone multiply operation is
to ensure there is smallest possible change for interger overflow to happen.

warnings: fix couple unsigned vs signed variable comparisions

warnings: mark unused function input variables

warnings: do not take abs() when data type is unsigned

Taking the absolute value of unsigned type 'unsigned int' has no effect.

build-sys: default to ,/configure --enable-silent-rules

This makes noticing compiler warnings easier.

man: use url macro to urls and fix reference manual notations

build-sys; do not use subdirectory object

None-recursive builds are quicker, and less problematic from make(1) object
tracking point of view.  See reference for full explanation.

References: http://miller.emu.id.au/pmiller/books/rmch/

cleanup: remove unnecessary null check

The fmt_ipinfo() returns variable from stack.  In order a stack variable to
point to NULL there has to go so much things wrong that the program cannot
run - effectively this can happen when system memory is so low that even
global variables cannot be allocated.