svn commit: r193583 - in head/tools/tools: . vimage
Marko Zec
zec at FreeBSD.org
Sat Jun 6 12:50:11 UTC 2009
Author: zec
Date: Sat Jun 6 12:50:10 2009
New Revision: 193583
URL: http://svn.freebsd.org/changeset/base/193583
Log:
Add an interim userland utility for managing vimages / virtualized
network stack infrastructure.
Requested by: julian (mentor)
Approved by: julian (mentor)
Added:
head/tools/tools/vimage/
head/tools/tools/vimage/Makefile (contents, props changed)
head/tools/tools/vimage/vimage.8 (contents, props changed)
head/tools/tools/vimage/vimage.c (contents, props changed)
Modified:
head/tools/tools/README
Modified: head/tools/tools/README
==============================================================================
--- head/tools/tools/README Sat Jun 6 12:43:13 2009 (r193582)
+++ head/tools/tools/README Sat Jun 6 12:50:10 2009 (r193583)
@@ -61,6 +61,8 @@ sysdoc Build a manual page with availab
kernel configuration.
tinybsd Script to build FreeBSD embedded systems.
track Track the progress of a world / kernel build
+vimage An interim utility for managing the virtualized network
+ stack infrastructure.
vop_table Generates a HTML document that shows all the VOP's in
the kernel.
whereintheworld Summarizes "make world" output.
Added: head/tools/tools/vimage/Makefile
==============================================================================
--- /dev/null 00:00:00 1970 (empty, because file is newly added)
+++ head/tools/tools/vimage/Makefile Sat Jun 6 12:50:10 2009 (r193583)
@@ -0,0 +1,13 @@
+# $FreeBSD$
+
+PROG= vimage
+
+WARNS?= 2
+CFLAGS+= -I../../../sys
+
+MAN= vimage.8
+
+BINDIR?= /usr/sbin
+NO_SHARED?= YES
+
+.include <bsd.prog.mk>
Added: head/tools/tools/vimage/vimage.8
==============================================================================
--- /dev/null 00:00:00 1970 (empty, because file is newly added)
+++ head/tools/tools/vimage/vimage.8 Sat Jun 6 12:50:10 2009 (r193583)
@@ -0,0 +1,164 @@
+.\" Copyright (c) 2002, 2003 Marko Zec <zec at tel.fer.hr>
+.\" Copyright (c) 2009 University of Zagreb
+.\" Copyright (c) 2009 FreeBSD Foundation
+.\"
+.\" 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, this list 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.
+.\"
+.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR 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 AUTHOR 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$
+.\"
+.Dd June 6, 2009
+.Dt VIMAGE 8
+.Os
+.Sh NAME
+.Nm vimage
+.Nd manage virtual network stacks
+.Sh SYNOPSIS
+.Nm
+.Ar vi_name
+.Op command
+.Nm
+.Fl c
+.Ar vi_name
+.Nm
+.Fl d
+.Ar vi_name
+.Nm
+.Fl l
+.Op Ar vi_name
+.Nm
+.Fl i
+.Ar vi_name interface
+.Sh DESCRIPTION
+.Nm
+command is an interm user interface for controlling the virtual network
+stacks in FreeBSD.
+.Ss Overview
+A virtual image reprepresents an isolated operating environment with its
+own independent network stack instance. Every process, socket and network
+interface present in the system is always attached to one, and only one,
+virtual image i.e. virtual network stack instance.
+During the system bootup sequence default virtual image is created to
+which all the configured interfaces and user processes are initially
+assigned.
+Assuming that enough system resources and per virtual image privileges
+are provided, the super-user can create and manage a hierarchy of
+subordinated virtual images. The
+.Nm
+command allows for creation, deletion and monitoring of virtual images,
+as well as for execution of arbitrary processes in a targeted virtual
+image.
+.Ss Invocation
+If invoked with no modifiers, the
+.Nm
+command spawns a new shell process in virtual image
+.Ar vi_name .
+If provided, the optional arguments following the virtual image name
+.Ar vi_name
+are interpreted as a standard command line issued at a shell,
+otherwise an interactive shell is started in the target virtual image.
+.Pp
+The following parameters are available:
+.Bl -tag -width indent
+.It Fl c
+Create a new virtual image named
+.So
+.Ar vi_name
+.Sc .
+.It Fl d
+Delete the virtual image
+.Ar vi_name .
+No processes and/or sockets should exist in the target virtual image
+in order for the delete request to succeed. Non-loopback interfaces
+residing in the target virtual image will be reassigned to the virtual
+image's parent.
+.It Fl l
+List the properties and statistics for virtual images one level
+below the current one in the hierarchy. If an optional argument
+.Ar vi_name
+is provided, only the information regarding the target virtual image
+.Ar vi_name
+is displayed.
+.It Fl lr
+List the properties and statistics for all virtual images in
+the hierarchy of subordinated vimages. If an optional argument
+.Ar vi_name
+is provided, the hierarchy will be traversed at and below the
+.Ar vi_name
+level.
+.It Fl i
+Move the interface
+.Ar interface
+to the target virtual image
+.Ar vi_name .
+If the value of
+.Ar vi_name
+argument is
+.So ..
+.Sc ,
+the interface is returned to the parent of the current virtual image.
+.El
+.Sh EXAMPLES
+Create a new virtual image named
+.So v1
+.Sc :
+.Pp
+.Dl vimage -c v1
+.Pp
+Execute the
+.So ifconfig
+.Sc command in the virtual image
+.So v1
+.Sc :
+.Pp
+.Dl vimage v1 ifconfig
+.Pp
+Move the interface
+.So vlan0
+.Sc to the virtual image
+.So v1
+.Sc :
+.Pp
+.Dl vimage -i v1 vlan0
+.Pp
+Show the status information for virtual image
+.So v1
+.Sc :
+.Pp
+.Dl vimage -l v1
+.Sh DIAGNOSTICS
+The
+.Nm
+command exits 0 on success, and >0 if an error occurs.
+.Sh SEE ALSO
+.Xr jail 8
+.Sh BUGS
+If memory allocation failure occurs during the vimage creation, it will remain
+undetected/ignored in the current implementation, thus latently scheduling
+an almost imminent system crash in the future.
+.Sh AUTHOR
+.An "Marko Zec" Aq zec at fer.hr
+.Sh HISTORY
+The
+.Nm
+facility first appeared as a patch against FreeBSD 4.7-RELEASE in 2002.
Added: head/tools/tools/vimage/vimage.c
==============================================================================
--- /dev/null 00:00:00 1970 (empty, because file is newly added)
+++ head/tools/tools/vimage/vimage.c Sat Jun 6 12:50:10 2009 (r193583)
@@ -0,0 +1,168 @@
+/*
+ * Copyright (c) 2002-2004 Marko Zec <zec at fer.hr>
+ * Copyright (c) 2009 University of Zagreb
+ * Copyright (c) 2009 FreeBSD Foundation
+ *
+ * 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, this list 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.
+ *
+ * THIS SOFTWARE IS PROVIDED BY THE AUTHOR 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 AUTHOR 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 <sys/types.h>
+#include <sys/ioctl.h>
+#include <sys/socket.h>
+#include <sys/vimage.h>
+
+#include <errno.h>
+#include <stdio.h>
+#include <stdlib.h>
+#include <string.h>
+#include <unistd.h>
+
+void
+vi_print(struct vi_req *vi_req)
+{
+
+ printf("\"%s\":\n", vi_req->vi_name);
+ printf(" %d sockets, %d ifnets, %d processes\n",
+ vi_req->vi_sock_count, vi_req->vi_if_count, vi_req->vi_proc_count);
+}
+
+int
+main(int argc, char **argv)
+{
+ int s;
+ char *shell;
+ int cmd = VI_SWITCHTO;
+ struct vi_req vi_req;
+
+ s = socket(AF_INET, SOCK_DGRAM, 0);
+ if (s == -1)
+ goto abort;
+
+ bzero(&vi_req, sizeof(vi_req));
+ strcpy(vi_req.vi_name, "."); /* . = this vimage. */
+
+ if (argc == 1)
+ cmd = VI_GET;
+
+ if (argc == 2 && strcmp(argv[1], "-l") == 0)
+ cmd = VI_GETNEXT;
+
+ if (argc == 2 && strcmp(argv[1], "-lr") == 0)
+ cmd = VI_GETNEXT_RECURSE;
+
+ if (argc == 3) {
+ strcpy(vi_req.vi_name, argv[2]);
+ if (strcmp(argv[1], "-l") == 0)
+ cmd = VI_GET;
+ if (strcmp(argv[1], "-c") == 0)
+ cmd = VI_CREATE;
+ if (strcmp(argv[1], "-d") == 0)
+ cmd = VI_DESTROY;
+ }
+
+ if (argc >= 3) {
+ strcpy(vi_req.vi_name, argv[2]);
+ if (strcmp(argv[1], "-c") == 0)
+ cmd = VI_CREATE;
+ if (strcmp(argv[1], "-i") == 0)
+ cmd = VI_IFACE;
+ }
+
+ vi_req.vi_api_cookie = VI_API_COOKIE;
+ vi_req.vi_req_action = cmd;
+ switch (cmd) {
+
+ case VI_GET:
+ if (ioctl(s, SIOCGPVIMAGE, (caddr_t)&vi_req) < 0)
+ goto abort;
+ if (argc == 1)
+ printf("%s\n", vi_req.vi_name);
+ else
+ vi_print(&vi_req);
+ exit(0);
+
+ case VI_GETNEXT:
+ case VI_GETNEXT_RECURSE:
+ vi_req.vi_req_action = VI_GET;
+ if (ioctl(s, SIOCGPVIMAGE, (caddr_t)&vi_req) < 0)
+ goto abort;
+ vi_print(&vi_req);
+ vi_req.vi_req_action = VI_GETNEXT_RECURSE;
+ while (ioctl(s, SIOCGPVIMAGE, (caddr_t)&vi_req) == 0) {
+ vi_print(&vi_req);
+ vi_req.vi_req_action = cmd;
+ }
+ exit(0);
+
+ case VI_IFACE:
+ strncpy(vi_req.vi_if_xname, argv[3],
+ sizeof(vi_req.vi_if_xname));
+ if (ioctl(s, SIOCSIFVIMAGE, (caddr_t)&vi_req) < 0)
+ goto abort;
+ printf("%s@%s\n", vi_req.vi_if_xname, vi_req.vi_name);
+ exit(0);
+
+ case VI_CREATE:
+ if (ioctl(s, SIOCSPVIMAGE, (caddr_t)&vi_req) < 0)
+ goto abort;
+ exit(0);
+
+ case VI_SWITCHTO:
+ strcpy(vi_req.vi_name, argv[1]);
+ if (ioctl(s, SIOCSPVIMAGE, (caddr_t)&vi_req) < 0)
+ goto abort;
+
+ vi_req.vi_req_action = VI_GET;
+ strcpy(vi_req.vi_name, ".");
+ if (ioctl(s, SIOCGPVIMAGE, (caddr_t)&vi_req) < 0) {
+ printf("XXX this should have not happened!\n");
+ goto abort;
+ }
+ close(s);
+
+ if (argc == 2) {
+ printf("Switched to vimage %s\n", argv[1]);
+ if ((shell = getenv("SHELL")) == NULL)
+ execlp("/bin/sh", argv[0], NULL);
+ else
+ execlp(shell, argv[0], NULL);
+ } else
+ execvp(argv[2], &argv[2]);
+ break;
+
+ case VI_DESTROY:
+ if (ioctl(s, SIOCSPVIMAGE, (caddr_t)&vi_req) < 0)
+ goto abort;
+ exit(0);
+
+ default:
+ fprintf(stderr, "usage: %s [-cdilr] vi_name [args]\n",
+ argv[0]);
+ exit(1);
+ }
+
+abort:
+ perror("Error");
+ exit(1);
+}
More information about the svn-src-all
mailing list