lib: fix notification by reading one byte at a time from Unix socket

Internally, several bytes will be read at once and the notification
should be detected earlier. This fixes a regression introduced in
5aeda65433fd41b7bb67f908d8c4741f045ce508 because we relied on datagram
boundary semantics. This was not important when pulling information
but we still used this semantic when pushing information. Closes: #43.

systemd: ship lldpd.service file if possible

lldpd: fix a segfault when a port disappear

Due to previous recent change, a NULL function could be called when a
port disappear. Fix that.

lldpd: small optimization in the expiration process

Don't check if we have to expire a port if we will remove it anyway.

lldpd: make notifications work when a port goes down

We need to refactor a bit `lldpd_remote_cleanup()` to separate the
expiration process (checking each remote port to check if it is still
current) and the removal of remote port (which triggers the expire
function because we want to be notified when a neighbor disappear this
way).

linux: add support for team devices

rpc: don't check source MAC settings when it is 0

interfaces: mangle source MAC address on bonds for other OS too

interfaces: abstract a bit MAC address mangling for bonding devices

A variable in `struct lldpd_hardware` control the mangling. On the
other end, `hardware->h_ops->send()` should not be called directly
anymore. Instead, `interfaces_helper_send()` should be used instead.

interfaces: move "mangle" function for bond slaves

This will allow it to be used by other OS.

lldpcli: remove unused variable

Also fix a cast.

lib: update version-info to match previous changes

bond: reenable the possibility to use a fixed MAC address

Moreover, this will be the default. The fixed MAC is not configurable.

client: move register of bond-slave-src-mac-type to a separate function

[PATCH| lldpd: use bond slave real mac with locally administered bit set as sour
ce man in lldp frames sent on bond slaves

By default lldpd sent src mac of zero for all lldp frames sent on bond
slaves. See https://tickets.cumulusnetworks.com/browse/CM-1283

This patch provides a few options to select the source address in lldp
trames sent on bonded slaves.

The problem with using the bond slave real mac in lldp frames
is described in https://github.com/vincentbernat/lldpd/issues/26

This patch provides 3 choices to src mac address selection on bond slaves:

# lldpcli help configure system bond-slave-src-mac-type

-- Set LLDP bond slave src mac type
      real  Real mac
      zero  All zero mac
     local  Real Mac with locally administered bit set

Signed-off-by: Roopa Prabhu <roopa@cumulusnetworks.com>
Signed-off-by: Vincent Bernat <bernat@luffy.cx>

linux: mangle MAC address for enslaved devices

With enslaved devices, we may end up with in a situation where we send
a packet with a source MAC address that may confuse switches. For
example:

 1. eth0, MAC X connected to switch A.
 2. eth1, MAC Y connected to switch B.
 3. Active/backup bond is created, MAC X.
 4. eth1 is active, eth0 is backup.

If we use the real MAC, eth0 will send LLDP packets with MAC X to
switch A that will learn this MAC and send packets on backup port eth0
and they will be discarded.

The solution until then was to use a zero MAC address in those
cases. However, it seems that some switches may be confused by such a
move. See #26.

Instead, we set the "local" bit to 1 if not already set. Otherwise, we
just use some arbitrary MAC address that I have on an unused 3Com
"Tornado" card. It is unlikely to be reused (100 MBps and it is in a
basement). If you happen to have an even older MAC address and are
willing to give it for lldpd, feel free to tell me. The later case
does not handle all problems but allievate the problem with switches
discarding or complaining about zero MAC address as a source.

lib: fix parsing of "11542."

The case was correctly handled but clz() does not handle 0 as its
argument.

lib: introduce proper fixed point parsing and representation module

This additional modules isolates the complexity of parsing and
representing fixed point numbers. This is uses for coordinates in
LLDP-MED.

The previous version was using an incorrect precision. When parsing
user input, the precision is now derivated from the number of digits
provided. When displaying a value, the precision is used to add
additional 0 if needed.

Moreover, the previous version was a bit buggy with some values and
with negative numbers. This change contains unittest to tackle most
issues.

It relies on presence of __builtin_clzll() function, available in GCC
and others. Maybe this will become a portability issue.

This closes #41.

lib: correctly set altitude unit without erasing neighbouring data

The way the altitude unit was set in buffer was erasing 4 unrelated
bits with 0. This made the altitude precision wrong.

event: replace `evutil_make_socket_nonblocking()` by an idempotent version

Once a file descriptor is locked with `BIOCLOCK`, it is not possible
to make it non-blocking. Therefore, we need to make it non-blocking
before locking it. Unfortunately, `evutil_make_socket_nonblocking()`
does not check the current value of the flag to see if there is
anything to do and we get a spurious warning. Just provide our version
of this function for this purpose.

lldpd: invoke `setproctitle_init()` when needed

On some systems, we need to invoke `setproctitle_init()` before using
`setproctitle()`.

priv: use `sigaction()` instead of `signal()` to install non-default signals

`signal()` is not portable to install non-default signals.

README: on OSX, /etc is a symlink to /private/etc.

osx: make the path to /Library/LaunchDaemons configurable

This path can also be set to `no` to avoid the installation of such a daemon.

osx: minimize differences with downstream Homebrew formula

osx: fix a syntax error in Homebrew formula

osx: patch the installation of launchd plist file for Homebrew

osx: don't remove the whole /Library/LaunchDaemons directory on uninstall!

configure: check for `res_init()` before trying other forms.

On OSX, `res_init()` is a symbol of `libsystem_info` (a dependency of
`libSystem`). So, AC_SEARCH_LIBS directly finds this symbol without an
additional library. However, once you include `resolv.h`, this becomes
a macro to `res_9_init` which is a symbol of `libresolv`. So you need
to link to `libresolv`. This is why we test first for `res_9_init` and
only after for `res_init`.

See more info about this here:
 http://blog.achernya.com/2013/03/os-x-has-silly-libsystem.html

However, on other systems, this will link to libbind while this is not
needed because `res_9_init` is a symbol of libbind while `res_init` is
correctly defined in `libc` and no odd redefinition.

So, the solution is to force `AC_SEARCH_LIBS` to include `resolv.h`
and only test for `res_init` (as a symbol or a macro, we don't
care). This is done by redefining `AC_LANG_CALL(C)` to include
`resolv.h`.

README: remove inexact paragraph about stacking bonding/vlans/bridges

lldpd now supports any kind of stacking

osx: update SHA1 sum for Homebrew recipe

osx: fix postinstall script

`@PRIVSEP_USER@` and `@PRIVSEP_GROUP@` were not substituted with the
appropriate values because they were not declared as an output
variable.

packaging: change `PreReq` to `Requires(pre)` in lldpd.spec

PreReq is deprecated and makes the build fail on OSC.

packaging: update to 0.7.6

README: show how to use tcpdump for troubleshooting

priv: correctly declare `priv_cmd` type

`enum {} priv_cmd` was the declaration of a variable `priv_cmd` as an
anonymous enum. This is not what was expected. Instead, we want `enum
priv_cmd` to be a declaration of a named enum: `enum priv_cmd {}` (we
could also use `typedef enum {} priv_cmd`, but in lldpd, `typedef` is
seldomly used).

When `priv_cmd` was moved out of `priv.c`, its symbol was defined in
several objects. It seems that recent versions of gcc are able to cope
with that (because `priv_cmd` variable was not used, so it was
optimized out I think, not sure). However, some older versions like
4.2.1 complained about duplicate objects during the link phase.

doc: add a CONTRIBUTE document

linux: define IFALIASZ for old systems

lldpd: fix a fd leak when we cannot write the new alias

lldpd: append "was" to an interface description when a neighbor disappear

This allows a user to know what neighbor was connected to a
server. This should closes #16.

client: add "configure/unconfigure system interface description" command

This allows to enable/disable updating interface description based on
visible neighbors.

lib: `lldpctl_k_config_receiveonly` is a read-only property

Update `lldpctl.h` to reflect this fact.

interfaces: overwrite interface description with neighbor found

If no neighbor is found, interface name is `lldpd: no neighbor
found`. If one neighbor is found, this is `lldpd: connected to XXXXX`
and if several neighbors are found, this is `lldpd: XXX
neighbors`. Smart filter is used to count neighbors.

Currently, this is not possible to disable this. Works with FreeBSD,
OpenBSD and Linux.

priv: avoid to leak generic socket

Due to previous commit, a socket was requested for each operation
needing it but it was not released.

privsep: separate OS specific code to dedicated files

Linux only stuff goes in `priv-linux.c`. This includes interface
handling, ethtool and ability to open files (which is not Linux
specific but only Linux requires this).

BSD stuff goes in `priv-bpf.c` since it only includes interface
handling.

Moreover, `privsep_fdpass.c` is merged into `privsep_io.c`, a new file
for almost everything about IO (read/write and passing FD). The global
`remote` object is put into this file.

This commit is mostly moving stuff around. This will enable the
ability to write interface aliases without putting too much #ifdef.

redhat: require groupadd/useradd

Those are needed on RHEL/CentOS if lldpd is installed early (for
example, in Kickstart). Thanks to Larry Brigman for correcting this.

osx: don't repeat `pkg-ref` several times in `distribution.xml`

osx: don't use `domains` tag in `distribution.xml`

This triggers the use of a new buggy "Destination Select" pane.

osx: add a way to compile for older versions of OS X

osx: `make pkg` can now build universal binaries

Next step: compile for another SDK.

osx: don't try to build universal binaries

The use of multiple arch is not safe with autotools. I believe that
libevent compute some arch-dependent stuff at configure-time. Just say
in README.md that the package will only work for the same version of
OSX and the same architecture.

For the future:

  - real universal binaries can be built by configuring and building
    each arch into a separate directory, then merge the result with
    `lipo`.

  - building a package for an older versions of Max OS X can be done
    by using `-mmacosx-version-min=10.6` and `-isysroot
    /Developer/SDKs/MacOSX10.5.sdk` on both `CFLAGS` and `LDFLAGS`.

configure: remove out-dated instructions to regen autoconf out-of-git

There is no need to hack anything, thanks to the use of
`./get-version` script.

snmp: fix a typo in `agent_priv.c`

configure: ensure that osx/scripts are executable

osx: use HTML files instead of RTF for welcome message

Also add a conclusion file.

osx: simpler instructions in README.md

osx: add a target to build an OSX package

We use pkgbuild and productbuild (which seem to have superseded
PackageMaker). Those tools are shipped from OSX 10.6.6. There are only
a few examples of how to use those tools with daemons. You may also
look at Jenkins or ngircd.

See `README.md` for more information on how to invoke the build of a
package.

configure: fix a typo in the description of `--with-embedded-libevent` option

travis: check that we can build lldpd with embedded libevent

Since we got an option to force the use of embedded libevent, let's
test that.

configure: add a flag to force use of embedded libevent

This will prove useful for OSX when building as a package.

debian: update packaging to match downstream

compat: include config.h in compat.h

Without this inclusion, no `HAVE_*` macro was defined. This was
triggered because with some libc, `strndup()` is defined by a macro
and therefore cannot be redefined as a function.

compat: fix strndup

NEWS: add an entry about the use of `strndup()`

compat: add `strndup()` compatibility function

This function does not exist on OS X 10.6 for example. This was a long
time GNU extension.

compat: remove copyright notice for setproctitle()

It's an empty function!

tests: define ck_assert_ptr_eq if check is too old

osx: use SHA1 instead of MD5 in homebrew formula

check: use `ck_assert_ptr_eq` instead of `ck_assert_int_eq`.

style: use C99 designated initializers instead of memset() when possible

packaging: update to 0.7.5

tokenizer: input buffer was too small

packaging: update packaging

bpf: on OpenBSD, invert the filter direction

From the manual page:

> Sets or gets the status of the `direction filter` flag.  If
> non-zero, packets matching the specified direction (either
> `BPF_DIRECTION_IN` or `BPF_DIRECTION_OUT`) will be ignored.

NEWS: add an entry for the use of `setproctitle()`

compat: declare `setproctitle()` as a printf function

debian: build-depends on libbssd-dev

lldpd: when no `setproctitle()` available, don't count neighbors

lldpd: count number of chassis to get number of neighbors

Also, if only one neighbor, just display its name.

lldpd: don't call `lldpd_count_neighbors()` too many times

build: use libbsd if available, also use `setproctitle()`

The monitor process will be titled "monitor", while the unprivileged
one will have the number of neighbors displayed. We provide an empty
fallback since this function is not essential.

On Linux, we expect `setproctitle()` to be available in `libbsd`. This
makes functions like `strlcpy()` and `fgetln()` also
available. However, the headers are `bsd/string.h`, so we either need
to declare the prototype or include those new headers (or use the
overlay system). A simple thing to do is to detect the usage of libbsd
and include the appropriate headers in this case.

lldpcli: `configure system platform` to override platform description

lldpcli: `configure system description` to override chassis description

lldpcli: split `conf.c` into `conf-system.c` and `conf-lldp.c`.

lldpcli: `configure system interface pattern` instead of `configure lldp iface-pattern`

`configure system` will contain non-LLDP related stuff. Moreover, we
may add `configure system interface alias rewrite` to enable the
rewrite of ifalias (a long awaited feature).

libevent: use GitHub git tree

Sourceforge one is out-of-date

debian: sync packaging with official Debian package

libevent: switch to patches-2.0 branch to get the appropriate automake fix

libevent 2.0.21 is not compatible with automake 2.13. libevent 2.0.22
will be but is not released.

git: ignore test-driver, generated by recent automake versions

Fixed some boundary conditions in code that cleans
remote ports on ttl expiry.

Problem:
- ttl expires, cleanup check fails to detect that ttl has elapsed
and skips cleanup
- After that, The ttl timer set routine again ends up setting the timer to ttl
resulting in 2 * ttl time for the expired rport to get released

(The test I did was with 1 port)

liblldpctl: fix infinite loop when user is reading fixed chunks

ISSUE:

_lldpctl_do_something() has the following loop for receiving a complete
message:

while ((bytes_needed = ctl_msg_recv_unserialized(...)) > 0) {
    _lldpctl_needs(bytes_needed)
}

ctl_msg_recv_unserialized() processes the received message and determines
how many more bytes are needed. First time, it requests "header" worth of
bytes. Once it receives that, it looks at header->len to determine next
set of bytes.

_lldpctl_needs() calls the connection's receive() routine to receive a
chunk of data and copies that over the a buffer in the connection structure,
either by malloc/copy or realloc/memmove. This buffer is called
conn->input_buffer. conn->input_buffer_len stores how many bytes are
currently in conn->input_buffer.

The issue is with the following statement in _lldpctl_needs():

        if (conn->input_buffer_len >= length) return 0;

where length is bytes_needed in the above illustration.

Suppose the message requires 16578 bytes. The connection's receive()
routine provided by the application reads in chunks of 1024 bytes.
With the above logic, the loop will execute successfully for 16 times
with the following resultant state:

conn->input_buffer_len = 16384
bytes_needed = 194

The above conditional statement in the beginning of _lldpctl_needs()
will cause it to return 0. ctl_msg_recv_unserialized() will keep asking
for 194 more bytes. The while() loop goes ad infinitum.

PATCH:

Remove the above statement. It is not needed.

marshal: fix alignment issue when unserializing

On some archs (Sparc and sometimes ARM), unaligned access are
forbidden. Instead of copying unaligned structures with `memcpy()`, we
ensure that `struct marshal_serialized` structures are always
correctly aligned, including when they are serialized. This is done by
adding some padding before appending such a structure to a buffer.

log: fix memory leak when using a log handler

This is quite important for liblldpctl.

marshal: don't declare serialize/unserialize helper for string

When using convenience library, this may lead to multiple definition
of this function. We are better off not defining it and using
`marshal_unserialize()` in `client.c` instead.

lldpd: fix an alignment (non-)issue

lldpcli: don't use an hack to pass the writer to watch callback

Use a proper structure for this purpose.

marshal: provide type-specific serialization/unserialization functions

Those functions should be used in place of `marshal_serialize()` and
`marshal_unserialize()` if possible.

client: fix a memory leak when changing lldpd configuration

lldpd_config_cleanup() does not free the configuration structure.

ctl: fix a memory leak when cleaning control socket

client: trigger interface refresh when updating interface pattern