mirror of
https://github.com/openvswitch/ovs
synced 2025-10-13 14:07:02 +00:00
1636c76112
I started working on a new command line utility that used this shared code. I wanted the ability to pass some data from common initialization code to all of the commands. You can find a similar pattern in ovs-vsctl. This patch updates the command handler to take a new struct, ovs_cmdl_context, instead of argc and argv directly. It includes argc and argv, but also includes an opaque type (void *), where the user of this API can attach its custom data it wants passed along to command handlers. This patch affected the ovstest sub-programs, as well. The patch includes a bit of an odd hack to OVSTEST_REGISTER() to avoid making the main() function of the sub-programs take a ovs_cmdl_context. The test main() functions still receive argc and argv directly, as that seems more natural. The test-subprograms themselves are able to make use of a context internally, though. Signed-off-by: Russell Bryant <rbryant@redhat.com> Signed-off-by: Ben Pfaff <blp@nicira.com>
88 lines
2.5 KiB
C
88 lines
2.5 KiB
C
/*
|
|
* Copyright (c) 2014 Nicira, Inc.
|
|
*
|
|
* Licensed under the Apache License, Version 2.0 (the "License");
|
|
* you may not use this file except in compliance with the License.
|
|
* You may obtain a copy of the License at:
|
|
*
|
|
* http://www.apache.org/licenses/LICENSE-2.0
|
|
*
|
|
* Unless required by applicable law or agreed to in writing, software
|
|
* distributed under the License is distributed on an "AS IS" BASIS,
|
|
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
* See the License for the specific language governing permissions and
|
|
* limitations under the License.
|
|
*/
|
|
|
|
#ifndef OVSTEST_H
|
|
#define OVSTEST_H
|
|
|
|
#include "compiler.h"
|
|
|
|
#include "command-line.h"
|
|
|
|
/* Overview
|
|
* ========
|
|
*
|
|
* OVS tests directory contains many small test programs. One down side
|
|
* of building them as individual programs is that they all have to be
|
|
* linked whenever a library function is modified.
|
|
*
|
|
* ovstest is an attempt to improve the overall build time by linking
|
|
* all test programs into a single program, ovs-test. Regardless of
|
|
* the number of test programs, linking will be done only once to produce
|
|
* ovstest.
|
|
*
|
|
* With ovstest, each test programs now becomes a sub program of ovstest.
|
|
* For example, 'mytest' program, can now be invoked as 'ovstest mytest'.
|
|
*
|
|
* 'ovstest --help' will list all test programs can be invoked.
|
|
*
|
|
* The 'Usage' section below documents how to add a new sub program
|
|
* to ovstest using OVSTEST_REIGSTER macros.
|
|
*/
|
|
|
|
typedef void (*ovstest_func)(int argc, char *argv[]);
|
|
|
|
void ovstest_register(const char *test_name, ovs_cmdl_handler f);
|
|
|
|
/* Usage
|
|
* =====
|
|
*
|
|
* For each sub test program, its 'main' program should be named as
|
|
* '<test_name>_main()'.
|
|
*
|
|
* The 'main' programs should be registered with ovstest as a sub program.
|
|
* OVSTEST_REGISTER(name, function)
|
|
*
|
|
* 'name' will be name of the test program. It is expected as argv[1] when
|
|
* invoking with ovstest.
|
|
*
|
|
* 'function' is the 'main' program mentioned above.
|
|
*
|
|
* Example:
|
|
* ----------
|
|
*
|
|
* Suppose the test program is called my-test.c
|
|
* ...
|
|
*
|
|
* static void
|
|
* my_test_main(int argc, char *argv[])
|
|
* {
|
|
* ....
|
|
* }
|
|
*
|
|
* OVSTEST_REGISTER("my-test", my_test_main);
|
|
*/
|
|
#define OVSTEST_REGISTER(name, function) \
|
|
static void \
|
|
ovstest_wrapper_##function##__(struct ovs_cmdl_context *ctx) \
|
|
{ \
|
|
function(ctx->argc, ctx->argv); \
|
|
} \
|
|
OVS_CONSTRUCTOR(register_##function) { \
|
|
ovstest_register(name, ovstest_wrapper_##function##__); \
|
|
}
|
|
|
|
#endif
|