Merge pull request #74 from insa-unyte/development

v0.5.0

Author: ahuangfeng

.gitignore

@@ -5,13 +5,16 @@ sender_sample
 test_seg
 test_queue
 test_malloc
+test_segmentation
 test_version
 sender_json
 libunyte-udp-notif.so
 scripts/resources
+examples/resources
 sender_continuous
 client_continuous
 client_monitoring
+client_socket
 
 docker/tmp
 
@@ -23,3 +26,57 @@ vgcore.*
 unyte-udp-notif.pc
 scripts/graph.eps
 .editorconfig
+
+Makefile.in
+/ar-lib
+/mdate-sh
+/py-compile
+/test-driver
+/ylwrap
+.deps/
+.libs/
+.dirstamp
+build-aux/
+build/
+libtool
+config.h
+
+# http://www.gnu.org/software/autoconf
+
+autom4te.cache
+/autoscan.log
+/autoscan-*.log
+/aclocal.m4
+/compile
+/config.cache
+/config.guess
+/config.h.in
+/config.log
+/config.status
+/config.sub
+/configure
+/configure.scan
+/depcomp
+/install-sh
+/missing
+/stamp-h1
+
+# https://www.gnu.org/software/libtool/
+
+/ltmain.sh
+
+# http://www.gnu.org/software/texinfo
+
+/texinfo.tex
+
+# http://www.gnu.org/software/m4/
+
+m4/libtool.m4
+m4/ltoptions.m4
+m4/ltsugar.m4
+m4/ltversion.m4
+m4/lt~obsolete.m4
+
+*.lo
+Makefile
+libunyte-udp-notif.la

CONTRIBUTING

@@ -0,0 +1,90 @@
+# Contributing
+
+When contributing to this repository, please first discuss the change you wish to make via issue,
+email, or any other method with the owners of this repository before making a change. 
+
+Please note we have a code of conduct, please follow it in all your interactions with the project.
+
+## Pull Request Process
+
+1. Ensure any install or build dependencies are removed before the end of the layer when doing a 
+   build.
+2. Update the README.md with details of changes to the interface, this includes new environment 
+   variables, exposed ports, useful file locations and container parameters.
+3. Increase the version numbers in any examples files and the README.md to the new version that this
+   Pull Request would represent if a bump version is required.
+
+## Code of Conduct
+
+### Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+### Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+### Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+### Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+### Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at alex.huang-feng@insa-lyon.fr. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+### Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

INSTALL.md

@@ -0,0 +1,51 @@
+# Compiling and installing UDP-notif collector
+
+## Dependencies
+This project uses autotools and gcc to compile and package the library.
+
+On Ubuntu:
+```shell
+$ sudo apt-get install autoconf libtool make automake gcc pkg-config
+```
+
+On Centos (tested on `Centos 8`):
+```shell
+$ sudo yum install autoconf libtool make automake pkgconf
+```
+
+### Optional Dependencies
+#### Using tcmalloc (Optional)
+This project can use tcmalloc for memory management allowing better performance.
+
+On Ubuntu:
+```shell
+$ sudo apt-get install libgoogle-perftools-dev
+```
+
+On Centos (tested on `Centos 8`):
+```shell
+$ sudo yum install gperftools gperftools-devel
+```
+
+## Installing
+To install the library on a linux machine.
+```shell
+$ ./bootstrap
+$ ./configure       # See ./configure --help for options
+$ make
+$ make install      # Usually needs sudo permissions
+$ ./export.sh       # Optional: export LD_LIBRARY_PATH with /usr/local/lib in global variable to allow linking process
+```
+
+### Configure options
+There are some custom `./configure` options : 
+- `--with-examples`: compile examples directory. Not compiled by default.
+- `--with-test`: compile testdirectory. Not compiled by default.
+- `--with-pkgconfigdir=[/own_path/pkgconfig]`: overwrite pkgconfig directory to install .pc file [default: ${PREFIX}/lib/pkgconfig]
+- `--enable-tcmalloc`: enable compilation with tcmalloc instead of native malloc. tcmalloc should be installed first.
+
+## Uninstalling
+```shell
+$ make uninstall    # Usually need sudo permissions
+```
+You should remove the export of the lib in your bashrc manually yourself to fully remove the lib.

Makefile.am

@@ -0,0 +1,19 @@
+AM_LDFLAGS = $(EXTRA_LDFLAGS)
+
+SUBDIRS = src
+
+if EXAMPLES
+SUBDIRS += examples
+endif
+
+if TEST_FILES
+SUBDIRS += test
+endif
+
+ACLOCAL_AMFLAGS = -I m4
+
+# PKGCONFIG_USER comes from configure.ac
+pkgconfigdir = $(PKGCONFIG_USER)
+pkgconfig_DATA = \
+	unyte-udp-notif.pc \
+	$(NULL)

README.md

@@ -1,34 +1,21 @@
 # C-Collector for UDP-notif
-Library for collecting UDP-notif protocol messages defined in the IETF draft [draft-ietf-netconf-udp-notif-01](https://tools.ietf.org/html/draft-ietf-netconf-udp-notif-01).
+Library for collecting UDP-notif protocol messages defined in the IETF draft [draft-ietf-netconf-udp-notif-03](https://datatracker.ietf.org/doc/html/draft-ietf-netconf-udp-notif-03).
 
-## Build & install
-To build the project and test example clients, just `make` on root folder. Il will compile with gcc all dependencies and the clients.
-
-### Installing
-To install the library on a machine, run `make install` with sudo and `export.sh` without sudo. Export script will export the LD_LIBRARY_PATH on user space.
-```
-$ make
-$ sudo make install
-$ ./export.sh
-```
-
-### Uninstalling
-```
-$ sudo make uninstall
-```
-You should remove the export of the lib in your bashrc manually yourself to fully remove the lib.
+## Compiling and installing project
+See [INSTALL](INSTALL.md)
 
 ## Usage
 ### Usage of the UDP-notif collector
 The collector allows to read and parse UDP-notif protocol messages from a ip/port specified on the parameters. It allows to get directly the buffer and the metadata of the message in a struct.
 
-The api is in `unyte_udp_collector.h` :
+The api is in `unyte_udp_collector.h`:
 - `unyte_udp_collector_t *unyte_udp_start_collector(unyte_udp_options_t *options)` from `unyte_udp_collector.h`: Initialize the UDP-notif messages collector. It accepts a struct with different options: address (the IP address to listen to), port (port to listen to), recvmmsg_vlen (vlen used on recvmmsg syscall meaning how many messages to receive on every syscall, by default 10)
+- `unyte_udp_collector_t *unyte_udp_start_collector_sk(unyte_udp_sk_options_t *options)` from `unyte_udp_collector.h`: Initialize the UDP-notif messages collector binded to a socket. It accepts a struct with different options: socket file descriptor to listen on, recvmmsg_vlen (vlen used on recvmmsg syscall meaning how many messages to receive on every syscall, by default 10)
 - `void *unyte_udp_queue_read(unyte_udp_queue_t *queue)` from `unyte_udp_queue.h` : read from a queue a struct with all the message buffer and metadata.
 - `int unyte_udp_free_all(unyte_seg_met_t *seg)` from `unyte_udp_collector.h`: free all struct used on a message received.
 
 Simple example of usage :
-```
+```c
 #include <stdio.h>
 #include <stdlib.h>
 #include <pthread.h>
@@ -42,7 +29,7 @@ Simple example of usage :
 #include <unyte-udp-notif/unyte_udp_utils.h>
 #include <unyte-udp-notif/unyte_udp_queue.h>
 
-#define PORT 10001
+#define PORT "10001"
 #define ADDR "192.168.0.17"
 
 int main()
@@ -75,9 +62,8 @@ int main()
     printf("unyte_udp_get_message_length: %u\n", unyte_udp_get_message_length(seg));
     printf("unyte_udp_get_generator_id: %u\n", unyte_udp_get_generator_id(seg));
     printf("unyte_udp_get_message_id: %u\n", unyte_udp_get_message_id(seg));
-    printf("unyte_udp_get_src_port: %u\n", unyte_udp_get_src_port(seg));
-    printf("unyte_udp_get_src_addr: %u\n", unyte_udp_get_src_addr(seg));
-    printf("unyte_udp_get_dest_addr: %u\n", unyte_udp_get_dest_addr(seg));
+    printf("unyte_udp_get_src[family]: %u\n", unyte_udp_get_src(seg)->ss_family);               // AF_INET for IPv4 or AF_INET6 for IPv6
+    printf("unyte_udp_get_dest_addr[family]: %u\n", unyte_udp_get_dest_addr(seg)->ss_family);   // AF_INET for IPv4 or AF_INET6 for IPv6
     printf("unyte_udp_get_payload: %s\n", unyte_udp_get_payload(seg));
     printf("unyte_udp_get_payload_length: %u\n", unyte_udp_get_payload_length(seg));
 
@@ -100,7 +86,7 @@ int main()
 
 #### Segments data
 To process the message data, all the headers, meta-data and payload are found on the struct unyte_seg_met_t defined on unyte_udp_utils.h:
-```
+```c
 typedef struct unyte_segment_with_metadata
 {
   unyte_metadata_t *metadata; // source/port
@@ -116,20 +102,19 @@ typedef struct unyte_segment_with_metadata
 - `uint16_t unyte_udp_get_message_length(unyte_seg_met_t *message);` : total length of the message within one UDP datagram, measured in octets, including the message header
 - `uint32_t unyte_udp_get_generator_id(unyte_seg_met_t *message);` : observation domain id of the message
 - `uint32_t unyte_udp_get_message_id(unyte_seg_met_t *message);` : message id of the message
-- `uint16_t unyte_udp_get_src_port(unyte_seg_met_t *message);` : source port of the message
-- `uint32_t unyte_udp_get_src_addr(unyte_seg_met_t *message);` : source address of the message
-- `uint32_t unyte_udp_get_dest_addr(unyte_seg_met_t *message);` : collector address
+- `struct sockaddr_storage * unyte_udp_get_src(unyte_seg_met_t *message);` : source IP and port of the message. Could be IPv4 or IPv6.
+- `struct sockaddr_storage * unyte_udp_get_dest_addr(unyte_seg_met_t *message);` : collector address. Could be IPv4 or IPv6.
 - `char *unyte_udp_get_payload(unyte_seg_met_t *message);` : payload buffer
 - `uint16_t unyte_udp_get_payload_length(unyte_seg_met_t *message);` : payload length
 
 #### Monitoring of the lib
 There is a monitoring thread that could be started to monitor packets loss and packets received in bad order.
 To activate this thread, you must initiate the monitoring thread queue size (`monitoring_queue_size`):
-```
+```c
 typedef struct
 {
   char *address;
-  uint16_t port;
+  char *port;
   ...
   uint monitoring_queue_size;   // monitoring queue size if wanted to activate the monitoring thread. Default: 0. Recommended: 500.
   uint monitoring_delay;        // monitoring queue frequence in seconds. Default: 5 seconds
@@ -152,7 +137,7 @@ The sender allows the user to send UDP-notif protocol to a IP/port specified. It
 
 The api is in `unyte_sender.h`.
 The message to send have the following structure:
-```
+```c
 typedef struct unyte_message
 {
   uint used_mtu;              // MTU to use for cutting the message to segments
@@ -169,15 +154,15 @@ typedef struct unyte_message
 ```
 
 Simple usage of the sender :
-```
+```c
 #include <pthread.h>
 #include <stdio.h>
 #include <stdlib.h>
 
 #include <unyte-udp-notif/unyte_sender.h>
 #include <unyte-udp-notif/unyte_udp_utils.h>
 
-#define PORT 10001
+#define PORT "10001"
 #define ADDR "192.168.0.17"
 #define MTU 1500
 
@@ -218,8 +203,10 @@ int main()
 ```
 
 ### Examples
-There are some samples implemented during the development of the project [here](samples).
+There are some samples implemented during the development of the project [here](examples).
 - `client_sample.c` : simple example for minimal usage of the collector library.
+- `client_monitoring.c` : sample implementing the monitoring thread to read packets statistics.
+- `client_socket.c` : example using a custom socket instead of creating a new one from the library.
 - `sender_sample.c` : simple example for minimal usage of the sender library.
 - `sender_json.c` : sample reading a json file and sending the bytes by the library.
 

VERSION

@@ -0,0 +1 @@
+0.5.0-git

bootstrap

@@ -0,0 +1,20 @@
+#!/bin/sh
+
+# create m4 directory if does not exist
+[ -d m4 ] || mkdir m4
+
+AUTORECONF=${AUTORECONF:-autoreconf}
+
+# Check we have all tools installed
+check_command() {
+    command -v "${1}" > /dev/null 2>&1 || {
+        >&2 echo "./bootstrap: could not find \`$1'. \`$1' is required to run bootstrap."
+        exit 1
+    }
+}
+
+check_command "$AUTORECONF"
+
+autoreconf --install
+
+exit 0