diff options
author | Dimitri Staessens <dimitri@ouroboros.rocks> | 2020-03-08 13:29:21 +0100 |
---|---|---|
committer | Sander Vrijders <sander@ouroboros.rocks> | 2020-03-15 14:20:38 +0100 |
commit | c80c93f11dbfb1b0c07f9a6f8b8d91024e5db507 (patch) | |
tree | c6ac06aa8841bcb4a403507deda4401594d5cdbe /src/tools/irm | |
parent | 8796a612f0600fc973aa908b84ded837f3470512 (diff) | |
download | ouroboros-c80c93f11dbfb1b0c07f9a6f8b8d91024e5db507.tar.gz ouroboros-c80c93f11dbfb1b0c07f9a6f8b8d91024e5db507.zip |
irm: Revise naming API
This revises the naming API to treat names (or reg_name in the source)
as first-class citizens of the architecture. This is more in line with
the way they are described in the article.
Operations have been added to create/destroy names independently of
registering. This was previously done only as part of register, and
there was no way to delete a name from the IRMd. The create call now
allows specifying a policy for load-balancing incoming flows for a
name. The default is the new round-robin load-balancer, the previous
behaviour is still available as a spillover load-balancer.
The register calls will still create a name if it doesn't exist, with
the default round-robin load-balancer.
The tools now have a "name" section, so the format is now
irm name <operation> <name> ...
Signed-off-by: Dimitri Staessens <dimitri@ouroboros.rocks>
Signed-off-by: Sander Vrijders <sander@ouroboros.rocks>
Diffstat (limited to 'src/tools/irm')
-rw-r--r-- | src/tools/irm/CMakeLists.txt | 8 | ||||
-rw-r--r-- | src/tools/irm/irm.c | 6 | ||||
-rw-r--r-- | src/tools/irm/irm_ipcp_list.c | 4 | ||||
-rw-r--r-- | src/tools/irm/irm_name.c | 98 | ||||
-rw-r--r-- | src/tools/irm/irm_name_create.c | 96 | ||||
-rw-r--r-- | src/tools/irm/irm_name_destroy.c | 72 | ||||
-rw-r--r-- | src/tools/irm/irm_name_list.c | 115 | ||||
-rw-r--r-- | src/tools/irm/irm_name_reg.c (renamed from src/tools/irm/irm_register.c) | 56 | ||||
-rw-r--r-- | src/tools/irm/irm_name_unreg.c (renamed from src/tools/irm/irm_unregister.c) | 17 | ||||
-rw-r--r-- | src/tools/irm/irm_ops.h | 16 |
10 files changed, 454 insertions, 34 deletions
diff --git a/src/tools/irm/CMakeLists.txt b/src/tools/irm/CMakeLists.txt index ca32e9c7..e5e5c466 100644 --- a/src/tools/irm/CMakeLists.txt +++ b/src/tools/irm/CMakeLists.txt @@ -23,8 +23,12 @@ set(SOURCE_FILES irm_unbind.c irm_bind.c irm_ipcp.c - irm_register.c - irm_unregister.c + irm_name.c + irm_name_create.c + irm_name_destroy.c + irm_name_reg.c + irm_name_unreg.c + irm_name_list.c irm_utils.c ) diff --git a/src/tools/irm/irm.c b/src/tools/irm/irm.c index fe382bb3..2388bfd9 100644 --- a/src/tools/irm/irm.c +++ b/src/tools/irm/irm.c @@ -49,8 +49,7 @@ static void usage(void) { printf("Usage: irm [OPERATION]\n\n" - "where OPERATION = {ipcp bind unbind\n" - " register unregister}\n"); + "where OPERATION = {ipcp bind unbind name}\n"); } static int do_help(int argc, @@ -70,8 +69,7 @@ static const struct cmd { { "ipcp", ipcp_cmd }, { "bind", bind_cmd }, { "unbind", unbind_cmd }, - { "register", do_register }, - { "unregister", do_unregister }, + { "name", name_cmd }, { "help", do_help }, { NULL, NULL } }; diff --git a/src/tools/irm/irm_ipcp_list.c b/src/tools/irm/irm_ipcp_list.c index 28a31d4f..3b8612ed 100644 --- a/src/tools/irm/irm_ipcp_list.c +++ b/src/tools/irm/irm_ipcp_list.c @@ -1,7 +1,7 @@ /* * Ouroboros - Copyright (C) 2016 - 2020 * - * Create IPC Processes + * List IPC Processes * * Dimitri Staessens <dimitri.staessens@ugent.be> * Sander Vrijders <sander.vrijders@ugent.be> @@ -46,7 +46,7 @@ #include <stdlib.h> #include <string.h> -#define UNICAST "unicast" +#define UNICAST "unicast" #define UDP "udp" #define ETH_LLC "eth-llc" #define ETH_DIX "eth-dix" diff --git a/src/tools/irm/irm_name.c b/src/tools/irm/irm_name.c new file mode 100644 index 00000000..3a615b00 --- /dev/null +++ b/src/tools/irm/irm_name.c @@ -0,0 +1,98 @@ +/* + * Ouroboros - Copyright (C) 2016 - 2020 + * + * A tool to instruct the IRM daemon + * + * Dimitri Staessens <dimitri.staessens@ugent.be> + * Sander Vrijders <sander.vrijders@ugent.be> + * + * 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. + * + * 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. + */ + +#include <stdio.h> + +#include "irm_ops.h" +#include "irm_utils.h" + +static void usage(void) +{ + printf("Usage: irm name [OPERATION]\n\n" + "where OPERATION = {create destroy\n" + " register unregister\n" + " list help}\n"); +} + +static int do_help(int argc, char **argv) +{ + (void) argc; + (void) argv; + + usage(); + return 0; +} + +static const struct cmd { + const char * cmd; + int (* func)(int argc, char ** argv); +} cmds[] = { + { "create", do_create_name }, + { "destroy", do_destroy_name }, + { "register", do_reg_name }, + { "unregister", do_unreg_name }, + { "list", do_list_name}, + { "help", do_help }, + { NULL, NULL } +}; + +static int do_cmd(const char * argv0, + int argc, + char ** argv) +{ + const struct cmd * c; + + for (c = cmds; c->cmd; ++c) { + if (matches(argv0, c->cmd) == 0) + return c->func(argc - 1, argv + 1); + } + + fprintf(stderr, "\"%s\" is unknown, try \"irm ipcp help\".\n", argv0); + + return -1; +} + +int name_cmd(int argc, char ** argv) +{ + if (argc < 1) { + usage(); + return -1; + } + + return do_cmd(argv[0], argc, argv); +} diff --git a/src/tools/irm/irm_name_create.c b/src/tools/irm/irm_name_create.c new file mode 100644 index 00000000..9b7e6a36 --- /dev/null +++ b/src/tools/irm/irm_name_create.c @@ -0,0 +1,96 @@ +/* + * Ouroboros - Copyright (C) 2016 - 2020 + * + * Create IPC Processes + * + * Dimitri Staessens <dimitri.staessens@ugent.be> + * Sander Vrijders <sander.vrijders@ugent.be> + * + * 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. + * + * 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. + */ + +#include <ouroboros/irm.h> + +#include <stdio.h> +#include <string.h> + +#include "irm_ops.h" +#include "irm_utils.h" + +#define RR "round-robin" +#define SPILL "spillover" + +static void usage(void) +{ + printf("Usage: irm name create\n" + " <name>\n" + " lb [LB_POLICY], default: %s\n\n" + "where LB_POLICY = {" RR " " SPILL "}\n", RR); +} + +int do_create_name(int argc, + char ** argv) +{ + char * name = NULL; + char * lb_pol = RR; + enum pol_balance pol_lb = LB_RR; + + name = *(argv++); + --argc; + + while (argc > 0) { + if (matches(*argv, "lb") == 0) { + lb_pol = *(argv + 1); + } else { + printf("\"%s\" is unknown, try \"irm " + "name create\".\n", *argv); + return -1; + } + + argc -= 2; + argv += 2; + } + + if (name == NULL) { + usage(); + return -1; + } + + if (strcmp(lb_pol, RR) == 0) + pol_lb = LB_RR; + else if (strcmp(lb_pol, SPILL) == 0) + pol_lb = LB_SPILL; + else { + usage(); + return -1; + } + + return irm_create_name(name, pol_lb); +} diff --git a/src/tools/irm/irm_name_destroy.c b/src/tools/irm/irm_name_destroy.c new file mode 100644 index 00000000..70f801b2 --- /dev/null +++ b/src/tools/irm/irm_name_destroy.c @@ -0,0 +1,72 @@ +/* + * Ouroboros - Copyright (C) 2016 - 2020 + * + * Create IPC Processes + * + * Dimitri Staessens <dimitri.staessens@ugent.be> + * Sander Vrijders <sander.vrijders@ugent.be> + * + * 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. + * + * 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. + */ + +#include <ouroboros/irm.h> + +#include <stdio.h> +#include <string.h> + +#include "irm_ops.h" +#include "irm_utils.h" + +static void usage(void) +{ + printf("Usage: irm name destroy <name>\n"); +} + +int do_destroy_name(int argc, + char ** argv) +{ + char * name = NULL; + + name = *(argv++); + --argc; + + if (argc > 0) { + printf("\"%s\" is unknown, try \"irm " + "name destroy\".\n", *argv); + return -1; + } + + if (name == NULL) { + usage(); + return -1; + } + + return irm_destroy_name(name); +} diff --git a/src/tools/irm/irm_name_list.c b/src/tools/irm/irm_name_list.c new file mode 100644 index 00000000..2e4c3194 --- /dev/null +++ b/src/tools/irm/irm_name_list.c @@ -0,0 +1,115 @@ +/* + * Ouroboros - Copyright (C) 2016 - 2020 + * + * List names + * + * Dimitri Staessens <dimitri.staessens@ugent.be> + * Sander Vrijders <sander.vrijders@ugent.be> + * + * 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. + * + * 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. + */ + +#include <ouroboros/irm.h> +#include <ouroboros/errno.h> + +#include "irm_ops.h" +#include "irm_utils.h" + +#include <stdio.h> +#include <stdlib.h> +#include <string.h> + +#define RR "round-robin" +#define SPILL "spillover" + +static char * str_pol(enum pol_balance p) +{ + switch(p) { + case LB_RR: + return RR; + case LB_SPILL: + return SPILL; + default: + return "UNKNOWN"; + } +}; + +int do_list_name(int argc, + char ** argv) +{ + char * name = NULL; + struct name_info * names; + ssize_t len; + ssize_t i; + + while (argc > 0) { + if (matches(*argv, "list") == 0) { + name = *(argv + 1); + } else { + printf("\"%s\" is unknown, try \"irm " + "name list.\n", *argv); + return -1; + } + + argc -= 2; + argv += 2; + } + + len = irm_list_names(&names); + if (len == 0) { + printf("No names in system.\n\n"); + return 0; + } else if (len == -EIRMD) { + printf("Failed to communicate with the " + "Ouroboros IPC Resource Manager daemon.\n"); + return -1; + } else if (len < 0) + return len; + + printf("+----------------------------------------------------" + "+----------------------+\n"); + printf("| %50s | %20s |\n", "name", "load-balance policy"); + printf("+----------------------------------------------------" + "+----------------------+\n"); + + for (i = 0; i < len; i++) { + if (name != NULL && matches(names[i].name, name)) + continue; + printf("| %50s | %20s |\n", + names[i].name, + str_pol(names[i].pol_lb)); + } + printf("+----------------------------------------------------" + "+----------------------+\n"); + + free(names); + + return 0; +} diff --git a/src/tools/irm/irm_register.c b/src/tools/irm/irm_name_reg.c index f7b57b0b..52bf911b 100644 --- a/src/tools/irm/irm_register.c +++ b/src/tools/irm/irm_name_reg.c @@ -1,7 +1,7 @@ /* * Ouroboros - Copyright (C) 2016 - 2020 * - * Register names in IPCPs + * Register names with IPCPs * * Dimitri Staessens <dimitri.staessens@ugent.be> * Sander Vrijders <sander.vrijders@ugent.be> @@ -38,7 +38,6 @@ #include <ouroboros/irm.h> - #include "irm_ops.h" #include "irm_utils.h" @@ -51,8 +50,7 @@ static void usage(void) { - printf("Usage: irm register\n" - " name <name>\n" + printf("Usage: irm name register <name>\n" " ipcp <ipcp to register with>\n" " [ipcp <ipcp to register with>]\n" " [... (maximum %d ipcps)]\n" @@ -63,7 +61,7 @@ static void usage(void) } -int do_register(int argc, +int do_reg_name(int argc, char ** argv) { char * name = NULL; @@ -72,14 +70,17 @@ int do_register(int argc, char * ipcp[MAX_IPCPS]; size_t ipcp_len = 0; struct ipcp_info * ipcps; - ssize_t len; + ssize_t ipcps_len; + struct name_info * names; + ssize_t names_len; + bool name_create = true; ssize_t i; + name = *(argv++); + --argc; while (argc > 0) { - if (matches(*argv, "name") == 0) { - name = *(argv + 1); - } else if (matches(*argv, "layer") == 0) { + if (matches(*argv, "layer") == 0) { layers[layers_len++] = *(argv + 1); if (layers_len > MAX_LAYERS) { printf("Too many layers specified.\n"); @@ -92,7 +93,7 @@ int do_register(int argc, return -1; } } else { - printf("\"%s\" is unknown, try \"irm " + printf("\"%s\" is unknown, try \"irm name " "register\".\n", *argv); return -1; } @@ -106,24 +107,46 @@ int do_register(int argc, return -1; } - len = irm_list_ipcps(&ipcps); - if (len < 0) - return len; + ipcps_len = irm_list_ipcps(&ipcps); + if (ipcps_len < 0) + return ipcps_len; + + names_len = irm_list_names(&names); + if (names_len < 0) { + free(ipcps); + return names_len; + } + + for (i = 0; i < names_len; ++i) { + if (strcmp(names[i].name, name) == 0) { + name_create = false; + break; + } + } + + if (name_create && irm_create_name(name, LB_SPILL)) { + printf("Error creating name."); + free(ipcps); + free(name); + return -1; + } - for (i = 0; i < len; ++i) { + for (i = 0; i < ipcps_len; ++i) { size_t j; for (j = 0; j < layers_len; j++) { if (wildcard_match(layers[j], ipcps[i].layer) == 0) { - if (irm_reg(ipcps[i].pid, name)) { + if (irm_reg_name(name, ipcps[i].pid)) { free(ipcps); + free(names); return -1; } } } for (j = 0; j < ipcp_len; j++) { if (wildcard_match(ipcp[j], ipcps[i].name) == 0) { - if (irm_reg(ipcps[i].pid, name)) { + if (irm_reg_name(name, ipcps[i].pid)) { free(ipcps); + free(names); return -1; } } @@ -131,6 +154,7 @@ int do_register(int argc, } free(ipcps); + free(names); return 0; } diff --git a/src/tools/irm/irm_unregister.c b/src/tools/irm/irm_name_unreg.c index 3ef28700..48253143 100644 --- a/src/tools/irm/irm_unregister.c +++ b/src/tools/irm/irm_name_unreg.c @@ -50,8 +50,7 @@ static void usage(void) { - printf("Usage: irm unregister\n" - " name <name>\n" + printf("Usage: irm name unregister <name>\n" " ipcp <ipcp to register with>\n" " [ipcp <ipcp to register with>]\n" " [... (maximum %d ipcps)]\n" @@ -61,7 +60,8 @@ static void usage(void) , MAX_IPCPS, MAX_LAYERS); } -int do_unregister(int argc, char ** argv) +int do_unreg_name(int argc, + char ** argv) { char * name = NULL; char * layers[MAX_LAYERS]; @@ -72,10 +72,11 @@ int do_unregister(int argc, char ** argv) ssize_t len; size_t i; + name = *(argv++); + --argc; + while (argc > 0) { - if (matches(*argv, "name") == 0) { - name = *(argv + 1); - } else if (matches(*argv, "layer") == 0) { + if (matches(*argv, "layer") == 0) { layers[layers_len++] = *(argv + 1); if (layers_len > MAX_LAYERS) { printf("Too many layers specified.\n"); @@ -110,7 +111,7 @@ int do_unregister(int argc, char ** argv) size_t j; for (j = 0; j < layers_len; j++) { if (wildcard_match(ipcps[i].layer, layers[j]) == 0) { - if (irm_unreg(ipcps[i].pid, name)) { + if (irm_unreg_name(name, ipcps[i].pid)) { free(ipcps); return -1; } @@ -119,7 +120,7 @@ int do_unregister(int argc, char ** argv) } for (j = 0; j < ipcp_len; j++) { if (wildcard_match(ipcps[i].name, ipcp[j]) == 0) { - if (irm_unreg(ipcps[i].pid, name)) { + if (irm_unreg_name(name, ipcps[i].pid)) { free(ipcps); return -1; } diff --git a/src/tools/irm/irm_ops.h b/src/tools/irm/irm_ops.h index a6530f61..7c1b1a8f 100644 --- a/src/tools/irm/irm_ops.h +++ b/src/tools/irm/irm_ops.h @@ -84,8 +84,20 @@ int do_unbind_process(int argc, int do_unbind_ipcp(int argc, char ** argv); -int do_register(int argc, +int name_cmd(int argc, + char ** argv); + +int do_create_name(int argc, + char ** argv); + +int do_destroy_name(int argc, + char ** argv); + +int do_reg_name(int argc, char ** argv); -int do_unregister(int argc, +int do_unreg_name(int argc, char ** argv); + +int do_list_name(int argc, + char ** argv); |