Renaming libifc to libifconfig in response to feedback on initial commit of

this library. Sticking to 'libifconfig' (and 'ifconfig_' as function prefix)
should reduce chances of namespace collisions, make it more clear what the
library does, and be more in line with existing libraries.

Submitted by: Marie Helene Kvello-Aune <marieheleneka@gmail.com>
Differential Revision:	https://reviews.freebsd.org/D7742
Reviewed by:	cem, kp

5 files changed, 373 insertions, 0 deletions

diff --git a/share/examples/libifconfig/Makefile b/share/examples/libifconfig/Makefile
new file mode 100644
index 000000000000..6926f65b1afa
--- /dev/null
+++ b/share/examples/libifconfig/Makefile
@@ -0,0 +1,8 @@
+# $FreeBSD$
+default:
+	$(CC) -Wall -fPIC -lifconfig -g -o example_setdescription setdescription.c
+	$(CC) -Wall -fPIC -lifconfig -g -o example_setmtu setmtu.c
+	$(CC) -Wall -fPIC -lifconfig -g -o example_ifdestroy ifdestroy.c
+	$(CC) -Wall -fPIC -lifconfig -g -o example_ifcreate ifcreate.c
+clean:
+	rm -f example_*
diff --git a/share/examples/libifconfig/ifcreate.c b/share/examples/libifconfig/ifcreate.c
new file mode 100644
index 000000000000..8f5dde506d2e
--- /dev/null
+++ b/share/examples/libifconfig/ifcreate.c
@@ -0,0 +1,93 @@
+/*
+ * Copyright (c) 2016, Marie Helene Kvello-Aune
+ * All rights reserved.
+ *
+ * Redistribution and use in source and binary forms, with or without modification,
+ * are permitted provided that the following conditions are met:
+ *
+ * 1. Redistributions of source code must retain the above copyright notice,
+ * thislist of conditions and the following disclaimer.
+ *
+ * 2. Redistributions in binary form must reproduce the above copyright notice,
+ * this list of conditions and the following disclaimer in the documentation and/or
+ * other materials provided with the distribution.
+ *
+ * 3. Neither the name of the copyright holder nor the names of its contributors
+ * may be used to endorse or promote products derived from this software without
+ * specific prior written permission.
+ *
+ * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+ * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
+ * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+ * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+ * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+ * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+ * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+ * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+ * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+ * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+ *
+ * $FreeBSD$
+ */
+
+#include <err.h>
+#include <errno.h>
+#include <net/if.h>
+#include <sys/ioctl.h>
+#include <stdio.h>
+#include <stdlib.h>
+#include <string.h>
+#include <libifconfig.h>
+
+
+int main(int argc, char *argv[])
+{
+	if (argc != 2) {
+		errx(EINVAL, "Invalid number of arguments."
+		    " Only one argument is accepted, and it should be the name"
+		    " of the interface to be created.");
+	}
+
+	char *ifname, *ifactualname;
+
+	/* We have a static number of arguments. Therefore we can do it simple. */
+	ifname = strdup(argv[1]);
+
+	printf("Requested interface name: %s\n", ifname);
+
+	ifconfig_handle_t *lifh = ifconfig_open();
+	if (ifconfig_create_interface(lifh, ifname, &ifactualname) == 0) {
+		printf("Successfully created interface '%s'\n", ifactualname);
+		ifconfig_close(lifh);
+		lifh = NULL;
+		free(ifname);
+		free(ifactualname);
+		return (0);
+	} else {
+		switch (ifconfig_err_errtype(lifh)) {
+		case SOCKET:
+			warnx("couldn't create socket. This shouldn't happen.\n");
+			break;
+		case IOCTL:
+			if (ifconfig_err_ioctlreq(lifh) == SIOCIFCREATE2) {
+				warnx(
+					"Failed to create interface (SIOCIFCREATE2)\n");
+			}
+			break;
+		default:
+			warnx(
+				"This is a thorough example accommodating for temporary"
+				" 'not implemented yet' errors. That's likely what happened"
+				" now. If not, your guess is as good as mine. ;)"
+				" Error code: %d\n", ifconfig_err_errno(
+					lifh));
+			break;
+		}
+
+		ifconfig_close(lifh);
+		lifh = NULL;
+		free(ifname);
+		free(ifactualname);
+		return (-1);
+	}
+}
diff --git a/share/examples/libifconfig/ifdestroy.c b/share/examples/libifconfig/ifdestroy.c
new file mode 100644
index 000000000000..029e70a8d9b0
--- /dev/null
+++ b/share/examples/libifconfig/ifdestroy.c
@@ -0,0 +1,87 @@
+/*
+ * Copyright (c) 2016, Marie Helene Kvello-Aune
+ * All rights reserved.
+ *
+ * Redistribution and use in source and binary forms, with or without modification,
+ * are permitted provided that the following conditions are met:
+ *
+ * 1. Redistributions of source code must retain the above copyright notice,
+ * thislist of conditions and the following disclaimer.
+ *
+ * 2. Redistributions in binary form must reproduce the above copyright notice,
+ * this list of conditions and the following disclaimer in the documentation and/or
+ * other materials provided with the distribution.
+ *
+ * 3. Neither the name of the copyright holder nor the names of its contributors
+ * may be used to endorse or promote products derived from this software without
+ * specific prior written permission.
+ *
+ * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+ * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
+ * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+ * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+ * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+ * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+ * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+ * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+ * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+ * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+ *
+ * $FreeBSD$
+ */
+
+#include <err.h>
+#include <errno.h>
+#include <net/if.h>
+#include <sys/ioctl.h>
+#include <stdio.h>
+#include <stdlib.h>
+#include <string.h>
+#include <libifconfig.h>
+
+
+int main(int argc, char *argv[])
+{
+	if (argc != 2) {
+		errx(EINVAL, "Invalid number of arguments."
+		    " Only one argument is accepted, and it should be the name"
+		    " of the interface to be destroyed.");
+	}
+
+	char *ifname;
+
+	/* We have a static number of arguments. Therefore we can do it simple. */
+	ifname = strdup(argv[1]);
+
+	printf("Interface name: %s\n", ifname);
+
+	ifconfig_handle_t *lifh = ifconfig_open();
+	if (ifconfig_destroy_interface(lifh, ifname) == 0) {
+		printf("Successfully destroyed interface '%s'.", ifname);
+		ifconfig_close(lifh);
+		lifh = NULL;
+		free(ifname);
+		return (0);
+	} else {
+		switch (ifconfig_err_errtype(lifh)) {
+		case SOCKET:
+			warnx("couldn't create socket. This shouldn't happen.\n");
+			break;
+		case IOCTL:
+			if (ifconfig_err_ioctlreq(lifh) == SIOCIFDESTROY) {
+				warnx(
+					"Failed to destroy interface (SIOCIFDESTROY)\n");
+			}
+			break;
+		default:
+			warnx(
+				"Should basically never end up here in this example.\n");
+			break;
+		}
+
+		ifconfig_close(lifh);
+		lifh = NULL;
+		free(ifname);
+		return (-1);
+	}
+}
diff --git a/share/examples/libifconfig/setdescription.c b/share/examples/libifconfig/setdescription.c
new file mode 100644
index 000000000000..656aba75976f
--- /dev/null
+++ b/share/examples/libifconfig/setdescription.c
@@ -0,0 +1,91 @@
+/*
+ * Copyright (c) 2016, Marie Helene Kvello-Aune
+ * All rights reserved.
+ *
+ * Redistribution and use in source and binary forms, with or without modification,
+ * are permitted provided that the following conditions are met:
+ *
+ * 1. Redistributions of source code must retain the above copyright notice,
+ * thislist of conditions and the following disclaimer.
+ *
+ * 2. Redistributions in binary form must reproduce the above copyright notice,
+ * this list of conditions and the following disclaimer in the documentation and/or
+ * other materials provided with the distribution.
+ *
+ * 3. Neither the name of the copyright holder nor the names of its contributors
+ * may be used to endorse or promote products derived from this software without
+ * specific prior written permission.
+ *
+ * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+ * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
+ * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+ * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+ * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+ * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+ * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+ * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+ * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+ * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+ *
+ * $FreeBSD$
+ */
+
+#include <err.h>
+#include <errno.h>
+#include <stdio.h>
+#include <stdlib.h>
+#include <string.h>
+#include <libifconfig.h>
+
+
+int main(int argc, char *argv[])
+{
+	if (argc != 3) {
+		errx(EINVAL, "Invalid number of arguments."
+		    " First argument should be interface name, second argument"
+		    " should be the description to set.");
+	}
+
+	char *ifname, *ifdescr, *curdescr;
+	/* We have a static number of arguments. Therefore we can do it simple. */
+	ifname = strdup(argv[1]);
+	ifdescr = strdup(argv[2]);
+	curdescr = NULL;
+
+	printf("Interface name: %s\n", ifname);
+
+	ifconfig_handle_t *lifh = ifconfig_open();
+	if (ifconfig_get_description(lifh, ifname, &curdescr) == 0) {
+		printf("Old description: %s\n", curdescr);
+	}
+
+	printf("New description: %s\n\n", ifdescr);
+
+	if (ifconfig_set_description(lifh, ifname, ifdescr) == 0) {
+		printf("New description successfully set.\n");
+	} else {
+		switch (ifconfig_err_errtype(lifh)) {
+		case SOCKET:
+			err(ifconfig_err_errno(lifh), "Socket error");
+			break;
+		case IOCTL:
+			err(ifconfig_err_errno(
+				    lifh), "IOCTL(%lu) error",
+			    ifconfig_err_ioctlreq(lifh));
+			break;
+		case OTHER:
+			err(ifconfig_err_errno(lifh), "Other error");
+			break;
+		}
+	}
+
+	free(ifname);
+	free(ifdescr);
+	free(curdescr);
+	ifname = NULL;
+	ifdescr = NULL;
+	curdescr = NULL;
+
+	ifconfig_close(lifh);
+	return (0);
+}
diff --git a/share/examples/libifconfig/setmtu.c b/share/examples/libifconfig/setmtu.c
new file mode 100644
index 000000000000..4d5a0f8d5f92
--- /dev/null
+++ b/share/examples/libifconfig/setmtu.c
@@ -0,0 +1,94 @@
+/*
+ * Copyright (c) 2016, Marie Helene Kvello-Aune
+ * All rights reserved.
+ *
+ * Redistribution and use in source and binary forms, with or without modification,
+ * are permitted provided that the following conditions are met:
+ *
+ * 1. Redistributions of source code must retain the above copyright notice,
+ * thislist of conditions and the following disclaimer.
+ *
+ * 2. Redistributions in binary form must reproduce the above copyright notice,
+ * this list of conditions and the following disclaimer in the documentation and/or
+ * other materials provided with the distribution.
+ *
+ * 3. Neither the name of the copyright holder nor the names of its contributors
+ * may be used to endorse or promote products derived from this software without
+ * specific prior written permission.
+ *
+ * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+ * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
+ * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+ * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+ * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+ * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+ * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+ * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+ * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+ * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+ *
+ * $FreeBSD$
+ */
+
+#include <err.h>
+#include <errno.h>
+#include <net/if.h>
+#include <sys/ioctl.h>
+#include <stdio.h>
+#include <stdlib.h>
+#include <string.h>
+#include <libifconfig.h>
+
+
+int main(int argc, char *argv[])
+{
+	if (argc != 3) {
+		errx(EINVAL, "Invalid number of arguments."
+		    " First argument should be interface name, second argument"
+		    " should be the MTU to set.");
+	}
+
+	char *ifname, *ptr;
+	int mtu;
+
+	/* We have a static number of arguments. Therefore we can do it simple. */
+	ifname = strdup(argv[1]);
+	mtu = (int)strtol(argv[2], &ptr, 10);
+
+	printf("Interface name: %s\n", ifname);
+	printf("New MTU: %d", mtu);
+
+	ifconfig_handle_t *lifh = ifconfig_open();
+	if (ifconfig_set_mtu(lifh, ifname, mtu) == 0) {
+		printf("Successfully changed MTU of %s to %d\n", ifname, mtu);
+		ifconfig_close(lifh);
+		lifh = NULL;
+		free(ifname);
+		return (0);
+	} else {
+		switch (ifconfig_err_errtype(lifh)) {
+		case SOCKET:
+			warnx("couldn't create socket. This shouldn't happen.\n");
+			break;
+		case IOCTL:
+			if (ifconfig_err_ioctlreq(lifh) == SIOCSIFMTU) {
+				warnx("Failed to set MTU (SIOCSIFMTU)\n");
+			} else {
+				warnx(
+					"Failed to set MTU due to error in unexpected ioctl() call %lu. Error code: %i.\n",
+					ifconfig_err_ioctlreq(lifh),
+					ifconfig_err_errno(lifh));
+			}
+			break;
+		default:
+			warnx(
+				"Should basically never end up here in this example.\n");
+			break;
+		}
+
+		ifconfig_close(lifh);
+		lifh = NULL;
+		free(ifname);
+		return (-1);
+	}
+}