Merge lp:~stefan.goetz-deactivatedaccount/hipl/hidb-lsidb into lp:hipl

[Stefan Götz]

Clean up internal implementation of HIDB: introduce a dedicated container for local-scope identifiers (LSIs) and use it in the HIDB.

Reviewing the individual commits provides additional context.

Changes since the last merge proposal:

2012-01-16: rebased on trunk; no functional changes; confirmed that LSI functionality is still working as expected when accessing the local interfaces and the HIPL test servers; please comment.

2012-01-18: addressed Diego's review comments (fixed style issues and bogus UNUSED macro)

[René Hummen (rene-hummen)]

review needs-fixing

On 20.05.2011, at 23:27, Stefan Götz wrote:
> Stefan Götz has proposed merging lp:~stefan.goetz/hipl/hidb-lsidb into lp:hipl.
>
> Requested reviews:
> HIPL core team (hipl-core)
>
> For more details, see:
> https://code.launchpad.net/~stefan.goetz/hipl/hidb-lsidb/+merge/61833
>
> Clean up internal implementation of HIDB: introduce a dedicated container for local-scope identifiers (LSIs) and use it in the HIDB.
>
> Reviewing the individual commits provides additional context.
> --
> https://code.launchpad.net/~stefan.goetz/hipl/hidb-lsidb/+merge/61833
> Your team HIPL core team is requested to review the proposed merge of lp:~stefan.goetz/hipl/hidb-lsidb into lp:hipl.

> /* assign a free lsi address */
> - HIP_IFEL(hip_hidb_add_lsi(db, id_entry) < 0, -EEXIST, "No LSI free\n");
> + HIP_IFEL(lsidb_allocate_lsi(&id_entry->lsi) == false, -EEXIST,
> + "Unable to allocate an LSI from the LSIDB for a local host ID\n");

What happened to the hip_ prefix for functions?

Otherwise, this proposal is fine.

Ciao,
René

--
Dipl.-Inform. Rene Hummen, Ph.D. Student
Chair of Communication and Distributed Systems
RWTH Aachen University, Germany
tel: [phone]
web: http://www.comsys.rwth-aachen.de/team/rene-hummen/

[Stefan Götz (stefan.goetz-deactivatedaccount)]

Hi Rene!

Thanks for reviewing!

> What happened to the hip_ prefix for functions?

I did not use them because 1) they seem useless to me (or is there a
reason why they are necessary?) 2) there is no official policy about
using them (at least not in doc/HACKING) and 3) they are not used
consistently throughout the code anyway.

> Otherwise, this proposal is fine.

Thanks! :)

I'll work on the bugs first though

Stefan

[René Hummen (rene-hummen)]

> Hi Rene!
>
> Thanks for reviewing!
>
> > What happened to the hip_ prefix for functions?
>
> I did not use them because 1) they seem useless to me (or is there a
> reason why they are necessary?)

You are right. They are not necessary in the daemons, but they must be included in the library functions.

> 2) there is no official policy about
> using them (at least not in doc/HACKING)

I will add this to the policies, once we agree that my answer to (1) is the way to go.

> and 3) they are not used
> consistently throughout the code anyway.

True, but that doesn't mean we cannot improve the code as we go on ;-)

This proposal is good to be merged.

review: Approve

[René Hummen (rene-hummen)]

Oh one more thing, can you please always state in the merge proposal if and how the code has been tested. Here, a comment in the lines of "Tested BEX in VM testbed with 2 HIP hosts using HIP LSIs as end-point identifiers." would be great.

Thanks,
René

[Stefan Götz (stefan.goetz-deactivatedaccount)]

Hi Rene!

[The hip_ prefix]

>> I did not use them because 1) they seem useless to me (or is there a
>> reason why they are necessary?)
>
> You are right. They are not necessary in the daemons, but they must be included in the library functions.
>
>> 2) there is no official policy about
>> using them (at least not in doc/HACKING)
>
> I will add this to the policies, once we agree that my answer to (1) is the way to go.

Hm. I'd prefer a consistent rule for the complete code base because
code tends to move between daemons and the library. Personally, I
don't think that name clashes between HIPL code and other code will
ever be a big problem which is why I'm not a big fan of hip_ (which
should be hipl_, anyway) but then that's just my gut feeling. But this
is nothing too important - I'm fine with any rule, including the one
you suggest above.

As soon as HACKING is updated, I'll update the code in my branches, too.

Stefan

[Christof Mroz (christof-mroz)]

On Mon, 06 Jun 2011 09:16:25 +0200, Stefan Götz
<email address hidden> wrote:

> Hm. I'd prefer a consistent rule for the complete code base because
> code tends to move between daemons and the library. Personally, I
> don't think that name clashes between HIPL code and other code will
> ever be a big problem which is why I'm not a big fan of hip_ (which
> should be hipl_, anyway) but then that's just my gut feeling. But this
> is nothing too important - I'm fine with any rule, including the one
> you suggest above.

I ran into this issue when working on midauth in the firewall:
There's code speicific to hipd, specific to hipfw and also shared between
those (in modules/). Applying the least amount of creativity possible,
this resulted in names like (don't remember exactly)
hipfw_check_challenge_response(...) and hip_check_challenge_response(...),
for example, the former calling the latter.
Without prefixes, I could have come up with
"process_challenge_response(...)" or similar purely to avoid a name clash
of course, but I'd have to remember which verb belongs to hipfw or hipd
then every time.
Another example: main(argc,argv) parsing parameters and delegating control
to hipd_main() (or hipfw_main()), rather than "run_daemon()" or something.

That's just an annoyance of course (and you could argue that adding a
prefix every time is even more annoying). And this applies to cross-module
functions only... prefixes pose no benefit to static functions IMHO.

[Diego Biurrun (diego-biurrun)]

On Fri, May 20, 2011 at 09:27:34PM +0000, Stefan Götz wrote:
> Stefan Götz has proposed merging lp:~stefan.goetz/hipl/hidb-lsidb into lp:hipl.
>
> For more details, see:
> https://code.launchpad.net/~stefan.goetz/hipl/hidb-lsidb/+merge/61833
>
> Clean up internal implementation of HIDB: introduce a dedicated
> container for local-scope identifiers (LSIs) and use it in the HIDB.

What's the status of this merge proposal?

Diego

[Stefan Götz (stefan.goetz-deactivatedaccount)]

Before merging this proposal, I would like to
- add an LSI-related test to the regression test framework
- run this branch against that test and verify that it does not break things

I occasionally work on these steps and I hope to have this proposal ready by the end of the month.

[Diego Biurrun (diego-biurrun)]

 review needs-fixing

On Tue, Jan 17, 2012 at 12:56:51PM +0000, Stefan Götz wrote:
> Stefan Götz has proposed merging lp:~stefan.goetz/hipl/hidb-lsidb into lp:hipl.

Looks mostly good, some minor issues I noticed below ...

> --- Makefile.am 2012-01-05 15:20:15 +0000
> +++ Makefile.am 2012-01-17 12:55:31 +0000
> @@ -69,10 +69,12 @@
> ### tests ###
> if HIP_UNITTESTS
> TESTS = test/check_hipfw \
> + test/check_hipd \
> test/check_lib_core \
> check_PROGRAMS = test/check_hipfw \
> + test/check_hipd \
> test/check_lib_core \
> @@ -219,6 +222,9 @@
> test/hipfw/rewrite.c \
> $(hipfw_hipfw_sources)
>
> +test_check_hipd_SOURCES = test/check_hipd.c \
> + test/hipd/lsidb.c
> +
> test_check_lib_core_SOURCES = test/check_lib_core.c \
> test/lib/core/crypto.c \
> @@ -242,6 +248,7 @@
> test_auth_performance_LDADD = lib/core/libhipcore.la
> test_check_hipfw_LDADD = lib/core/libhipcore.la
> +test_check_hipd_LDADD = lib/core/libhipcore.la
> test_check_lib_core_LDADD = lib/core/libhipcore.la

All of this in proper alphabetical order please.

> --- hipd/hidb.c 2011-12-30 23:20:44 +0000
> +++ hipd/hidb.c 2012-01-17 12:55:31 +0000
> --- hipd/lsidb.c 1970-01-01 00:00:00 +0000
> +++ hipd/lsidb.c 2012-01-17 12:55:31 +0000
> @@ -0,0 +1,106 @@
> +/*
> + * Copyright (c) 2011-2012 Aalto University and RWTH Aachen University.

Just 2012 should be enough.

> +bool lsidb_free_lsi(UNUSED const hip_lsi_t lsi)
> +{
> + /* is this a valid LSI? */
> + if ((ntohl(lsi.s_addr) & ~HIP_LSI_TYPE_MASK_CLEAR) == HIP_LSI_PREFIX) {
> + /* we currently do not support freeing the LSI */
> + return true;
> + }
> +
> + return false;
> +}

The UNUSED seems wrong ...

> --- hipd/lsidb.h 1970-01-01 00:00:00 +0000
> +++ hipd/lsidb.h 2012-01-17 12:55:31 +0000
> @@ -0,0 +1,43 @@
> +/*
> + * Copyright (c) 2011-2012 Aalto University and RWTH Aachen University.

see above

> +#ifndef HIP_HIPD_LSIDB_H
> +#define HIP_HIPD_LSIDB_H
> +
> +#endif /* HIP_HIPD_LSIDB_H */

HIPL_

> --- test/check_hipd.c 1970-01-01 00:00:00 +0000
> +++ test/check_hipd.c 2012-01-17 12:55:31 +0000
> @@ -0,0 +1,40 @@
> +/*
> + * Copyright (c) 2011-2012 Aalto University and RWTH Aachen University.

see above

> + * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
> + * OTHER DEALINGS IN THE SOFTWARE.
> + */
> +#include <check.h>
> +#include <stdlib.h>

nit: leave an empty line

> --- test/hipd/lsidb.c 1970-01-01 00:00:00 +0000
> +++ test/hipd/lsidb.c 2012-01-17 12:55:31 +0000
> @@ -0,0 +1,91 @@
> +/*
> + * Copyright (c) 2011-2012 Aalto University and RWTH Aachen University.

again

> + * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
> + * OTHER DEALINGS IN THE SOFTWARE.
> + */
> +#include <check.h>
> +#include <stdlib.h>

empty line

> --- test/hipd/test_suites.h 1970-01-01 00:00:00 +0000
> +++ test/hipd/test_suites.h 2012-01-17 12:55:31 +0000
> @@ -0,...

review: Needs Fixing

[Diego Biurrun (diego-biurrun)]

 review approve

On Wed, Jan 18, 2012 at 09:18:28PM +0000, Stefan Götz wrote:
> Stefan Götz has proposed merging lp:~stefan.goetz/hipl/hidb-lsidb into lp:hipl.
>
> --- Makefile.am 2012-01-05 15:20:15 +0000
> +++ Makefile.am 2012-01-18 21:17:27 +0000
> @@ -1,4 +1,4 @@
> -# Copyright (c) 2010-2011 Aalto University and RWTH Aachen University.
> +# Copyright (c) 2012 Aalto University and RWTH Aachen University.

2010-2012 :)

Diego

review: Approve

[lp:~stefan.goetz-deactivatedaccount/hipl/hidb-lsidb]

6250. By Stefan Götz on 2012-01-19

Restore copyright year range

[Miika Komu (miika-iki)]

Works for me. Good work!

review: Approve

=== modified file 'Makefile.am'
--- Makefile.am	2012-01-05 15:20:15 +0000
+++ Makefile.am	2012-01-19 09:28:24 +0000
@@ -1,4 +1,4 @@
-# Copyright (c) 2010-2011 Aalto University and RWTH Aachen University.
+# Copyright (c) 2010-2012 Aalto University and RWTH Aachen University.
 #
 # Permission is hereby granted, free of charge, to any person
 # obtaining a copy of this software and associated documentation
@@ -68,11 +68,13 @@
 
 ### tests ###
 if HIP_UNITTESTS
-TESTS           = test/check_hipfw    \
+TESTS           = test/check_hipd     \
+                  test/check_hipfw    \
                   test/check_lib_core \
                   test/check_lib_tool \
                   test/check_modules_midauth
-check_PROGRAMS  = test/check_hipfw    \
+check_PROGRAMS  = test/check_hipd     \
+                  test/check_hipfw    \
                   test/check_lib_core \
                   test/check_lib_tool \
                   test/check_modules_midauth
@@ -111,6 +113,7 @@
                     hipd/init.c                  \
                     hipd/input.c                 \
                     hipd/keymat.c                \
+                    hipd/lsidb.c                 \
                     hipd/maintenance.c           \
                     hipd/nat.c                   \
                     hipd/netdev.c                \
@@ -208,6 +211,9 @@
 endif
 
 
+test_check_hipd_SOURCES     = test/check_hipd.c              \
+                              test/hipd/lsidb.c
+
 test_check_hipfw_SOURCES = test/check_hipfw.c          \
                            test/mocks.c                \
                            test/hipfw/conntrack.c      \
@@ -241,6 +247,7 @@
 hipd_hipd_LDADD                          = lib/core/libhipcore.la
 hipfw_hipfw_LDADD                        = lib/core/libhipcore.la
 test_auth_performance_LDADD              = lib/core/libhipcore.la
+test_check_hipd_LDADD                    = lib/core/libhipcore.la
 test_check_hipfw_LDADD                   = lib/core/libhipcore.la
 test_check_lib_core_LDADD                = lib/core/libhipcore.la
 test_check_lib_tool_LDADD                = lib/core/libhipcore.la

=== modified file 'hipd/hidb.c'
--- hipd/hidb.c	2011-12-30 23:20:44 +0000
+++ hipd/hidb.c	2012-01-19 09:28:24 +0000
@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2010-2011 Aalto University and RWTH Aachen University.
+ * Copyright (c) 2010-2012 Aalto University and RWTH Aachen University.
  *
  * Permission is hereby granted, free of charge, to any person
  * obtaining a copy of this software and associated documentation
@@ -54,6 +54,7 @@
 #include "config.h"
 #include "cookie.h"
 #include "hipd.h"
+#include "lsidb.h"
 #include "netdev.h"
 #include "hidb.h"
 
@@ -61,8 +62,6 @@
 HIP_HASHTABLE *hip_local_hostid_db = NULL;
 #define HIP_MAX_HOST_ID_LEN 1600
 
-static const char *lsi_addresses[] = { "1.0.0.1", "1.0.0.2", "1.0.0.3", "1.0.0.4" };
-
 #ifdef HAVE_EC_CRYPTO
 /**
  * Strips the private key component from an ECDSA-based host id.
@@ -406,41 +405,6 @@
     return 1;
 }
 
-/**
- * Assign a free LSI to a host id entry
- *
- * @param db database structure
- * @param id_entry contains an entry to the db, will contain an unsigned lsi
- * @return zero on success, or negative error value on failure.
- */
-static int hidb_add_lsi(HIP_HASHTABLE *db, struct local_host_id *id_entry)
-{
-    struct local_host_id *id_entry_aux;
-    LHASH_NODE           *item;
-    hip_lsi_t             lsi_aux;
-    int                   used_lsi, c, i;
-    int                   len = sizeof(lsi_addresses) / sizeof(*lsi_addresses);
-
-    for (i = 0; i < len; i++) {
-        inet_aton(lsi_addresses[i], &lsi_aux);
-        used_lsi = 0;
-
-        list_for_each(item, db, c) {
-            id_entry_aux = list_entry(item);
-            if (hip_lsi_are_equal(&lsi_aux, &id_entry_aux->lsi)) {
-                used_lsi = 1;
-                c        = -1;
-            }
-        }
-
-        if (!used_lsi) {
-            memcpy(&id_entry->lsi, &lsi_aux, sizeof(hip_lsi_t));
-            break;
-        }
-    }
-    return 0;
-}
-
 /*
  * Interface functions to access databases.
  *
@@ -507,7 +471,8 @@
     }
 
     /* assign a free lsi address */
-    HIP_IFEL(hidb_add_lsi(db, id_entry) < 0, -EEXIST, "No LSI free\n");
+    HIP_IFEL(lsidb_allocate_lsi(&id_entry->lsi) == false, -EEXIST,
+             "Unable to allocate an LSI from the LSIDB for a local host ID\n");
 
     memcpy(lsi, &id_entry->lsi, sizeof(hip_lsi_t));
     id_entry->insert = add;

=== added file 'hipd/lsidb.c'
--- hipd/lsidb.c	1970-01-01 00:00:00 +0000
+++ hipd/lsidb.c	2012-01-19 09:28:24 +0000
@@ -0,0 +1,106 @@
+/*
+ * Copyright (c) 2012 Aalto University and RWTH Aachen University.
+ *
+ * Permission is hereby granted, free of charge, to any person
+ * obtaining a copy of this software and associated documentation
+ * files (the "Software"), to deal in the Software without
+ * restriction, including without limitation the rights to use,
+ * copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the
+ * Software is furnished to do so, subject to the following
+ * conditions:
+ *
+ * The above copyright notice and this permission notice shall be
+ * included in all copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+ * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
+ * OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+ * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
+ * HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
+ * WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
+ * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
+ * OTHER DEALINGS IN THE SOFTWARE.
+ */
+
+/**
+ * @file
+ * Implementation of the local scope identifier (LSI) database.
+ * The LSIDB manages which LSIs are assigned to network interfaces on the local
+ * host and which LSIs are still available.
+ */
+
+#include <netinet/in.h>
+#include <stdbool.h>
+
+#include "lib/core/common.h"
+#include "lib/core/debug.h"
+#include "lib/core/protodefs.h"
+#include "lsidb.h"
+
+static unsigned lsi_index = 1;
+
+/**
+ * Allocate an unused LSI that is still available to be used on the local host.
+ * This function merely keeps track of LSIs allocated through this interface.
+ * It does no check the actual network interfaces or other data structures in
+ * the HIP daemon to determine whether LSIs are in use or not.
+ *
+ * @param lsi   Points to an LSI object that receives the LSI if this function
+ *              returns successfully.
+ *              The result of calling this function with @a lsi == @c NULL or
+ *              @a lsi not pointing to a valid LSI object is undefined.
+ * @return      This function returns true if an available LSI was successfully
+ *              allocated and stored in @a lsi.
+ *              This function returns false if no more LSIs are available on
+ *              the local host.
+ *
+ * @internal
+ * The current implementation is extremely primitive and returns successively
+ * incremented LSIs.
+ * Freeing an LSI has no effect.
+ * This is currently acceptable because LSIs are allocated together with host
+ * identities when HIPD starts up and LSIs are only freed when HIPD exits.
+ * This interface is intended to hide potentially more complex allocation
+ * schemes, too.
+ */
+bool lsidb_allocate_lsi(hip_lsi_t *const lsi)
+{
+    HIP_ASSERT(lsi);
+    /* the index may not be 0 because that does not lead to a valid network
+     * address */
+    HIP_ASSERT(lsi_index != 0);
+
+    /* does the index still fit into the allowed address prefix length of
+     * LSIs (-1 because the highest address is the broadcast address) */
+    if (lsi_index < HIP_LSI_TYPE_MASK_CLEAR) {
+        *lsi = (hip_lsi_t) { htonl(HIP_LSI_PREFIX | lsi_index) };
+        lsi_index++;
+        return true;
+    }
+
+    return false;
+}
+
+/**
+ * Free a previously allocated LSI so it is available to allocation again.
+ * This function should be called only after the LSI has been de-registered
+ * from the system is no longer in active use.
+ *
+ * @param lsi   The LSI object to free.
+ * @return      This function returns true if @a lsi is an LSI that was
+ *              previously allocated via lsidb_allocate_lsi() and if it was
+ *              freed successfully.
+ *              This function returns false if @a lsi could not be freed and
+ *              made available through allocation again.
+ */
+bool lsidb_free_lsi(const hip_lsi_t lsi)
+{
+    /* is this a valid LSI? */
+    if ((ntohl(lsi.s_addr) & ~HIP_LSI_TYPE_MASK_CLEAR) == HIP_LSI_PREFIX) {
+        /* we currently do not support freeing the LSI */
+        return true;
+    }
+
+    return false;
+}

=== added file 'hipd/lsidb.h'
--- hipd/lsidb.h	1970-01-01 00:00:00 +0000
+++ hipd/lsidb.h	2012-01-19 09:28:24 +0000
@@ -0,0 +1,43 @@
+/*
+ * Copyright (c) 2012 Aalto University and RWTH Aachen University.
+ *
+ * Permission is hereby granted, free of charge, to any person
+ * obtaining a copy of this software and associated documentation
+ * files (the "Software"), to deal in the Software without
+ * restriction, including without limitation the rights to use,
+ * copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the
+ * Software is furnished to do so, subject to the following
+ * conditions:
+ *
+ * The above copyright notice and this permission notice shall be
+ * included in all copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+ * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
+ * OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+ * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
+ * HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
+ * WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
+ * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
+ * OTHER DEALINGS IN THE SOFTWARE.
+ */
+
+/**
+ * @file
+ * Public interface of the local scope identifier (LSI) database.
+ * The LSIDB manages which LSIs are assigned to network interfaces on the local
+ * host and which LSIs are still available.
+ */
+
+#ifndef HIPL_HIPD_LSIDB_H
+#define HIPL_HIPD_LSIDB_H
+
+#include <stdbool.h>
+
+#include "lib/core/protodefs.h"
+
+bool lsidb_allocate_lsi(hip_lsi_t *const lsi);
+bool lsidb_free_lsi(const hip_lsi_t const lsi);
+
+#endif /* HIPL_HIPD_LSIDB_H */

=== added file 'test/check_hipd.c'
--- test/check_hipd.c	1970-01-01 00:00:00 +0000
+++ test/check_hipd.c	2012-01-19 09:28:24 +0000
@@ -0,0 +1,41 @@
+/*
+ * Copyright (c) 2012 Aalto University and RWTH Aachen University.
+ *
+ * Permission is hereby granted, free of charge, to any person
+ * obtaining a copy of this software and associated documentation
+ * files (the "Software"), to deal in the Software without
+ * restriction, including without limitation the rights to use,
+ * copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the
+ * Software is furnished to do so, subject to the following
+ * conditions:
+ *
+ * The above copyright notice and this permission notice shall be
+ * included in all copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+ * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
+ * OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+ * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
+ * HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
+ * WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
+ * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
+ * OTHER DEALINGS IN THE SOFTWARE.
+ */
+
+#include <check.h>
+#include <stdlib.h>
+
+#include "test/hipd/test_suites.h"
+
+int main(void)
+{
+    int      number_failed;
+    SRunner *sr = srunner_create(NULL);
+    srunner_add_suite(sr, hipd_lsidb());
+
+    srunner_run_all(sr, CK_NORMAL);
+    number_failed = srunner_ntests_failed(sr);
+    srunner_free(sr);
+    return (number_failed == 0) ? EXIT_SUCCESS : EXIT_FAILURE;
+}

=== added directory 'test/hipd'
=== added file 'test/hipd/lsidb.c'
--- test/hipd/lsidb.c	1970-01-01 00:00:00 +0000
+++ test/hipd/lsidb.c	2012-01-19 09:28:24 +0000
@@ -0,0 +1,92 @@
+/*
+ * Copyright (c) 2012 Aalto University and RWTH Aachen University.
+ *
+ * Permission is hereby granted, free of charge, to any person
+ * obtaining a copy of this software and associated documentation
+ * files (the "Software"), to deal in the Software without
+ * restriction, including without limitation the rights to use,
+ * copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the
+ * Software is furnished to do so, subject to the following
+ * conditions:
+ *
+ * The above copyright notice and this permission notice shall be
+ * included in all copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+ * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
+ * OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+ * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
+ * HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
+ * WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
+ * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
+ * OTHER DEALINGS IN THE SOFTWARE.
+ */
+
+#include <check.h>
+#include <stdlib.h>
+
+#include "hipd/lsidb.c"
+#include "test_suites.h"
+
+START_TEST(test_lsidb_allocate_lsi_valid)
+{
+    hip_lsi_t lsi;
+
+    /* exhaust all available LSIs */
+    for (unsigned i = 1; i < HIP_LSI_TYPE_MASK_CLEAR; i++) {
+        fail_unless(lsidb_allocate_lsi(&lsi) == true, NULL);
+        /* does the returned LSI have the correct LSI head? */
+        fail_unless((lsi.s_addr & ntohl(HIP_LSI_TYPE_MASK_1)) != 0, NULL);
+        /* does the returned LSI have the correct prefix? */
+        fail_unless((lsi.s_addr & ntohl(~HIP_LSI_TYPE_MASK_CLEAR)) == ntohl(HIP_LSI_TYPE_MASK_1), NULL);
+    }
+
+    /* now the allocator should return an error because there should be no
+     * LSIs left. */
+    fail_unless(lsidb_allocate_lsi(&lsi) == false, NULL);
+}
+END_TEST
+
+START_TEST(test_lsidb_free_lsi_valid)
+{
+    hip_lsi_t lsi;
+
+    fail_unless(lsidb_allocate_lsi(&lsi) == true, NULL);
+    fail_unless(lsidb_free_lsi(lsi) == true, NULL);
+}
+END_TEST
+
+START_TEST(test_lsidb_free_lsi_invalid)
+{
+    hip_lsi_t lsi = { 0xFFFFFFFF };
+
+    fail_unless(lsidb_free_lsi(lsi) == false, NULL);
+}
+END_TEST
+
+#ifdef HAVE_TCASE_ADD_EXIT_TEST
+START_TEST(test_lsidb_allocate_lsi_null)
+{
+    lsidb_allocate_lsi(NULL);
+}
+END_TEST
+#endif /* HAVE_TCASE_ADD_EXIT_TEST */
+
+Suite *hipd_lsidb(void)
+{
+    Suite *s = suite_create("hipd/lsidb");
+
+    TCase *tc_core = tcase_create("Core");
+    tcase_add_test(tc_core, test_lsidb_allocate_lsi_valid);
+    tcase_add_test(tc_core, test_lsidb_free_lsi_valid);
+    tcase_add_test(tc_core, test_lsidb_free_lsi_invalid);
+    // the tcase_add_exit_test macro is only available in check 0.9.8 or later but
+    // scratchbox uses an older version of checkc so we try to avoid this macro
+#ifdef HAVE_TCASE_ADD_EXIT_TEST
+    tcase_add_exit_test(tc_core, test_lsidb_allocate_lsi_null, 1);
+#endif
+    suite_add_tcase(s, tc_core);
+
+    return s;
+}

=== added file 'test/hipd/test_suites.h'
--- test/hipd/test_suites.h	1970-01-01 00:00:00 +0000
+++ test/hipd/test_suites.h	2012-01-19 09:28:24 +0000
@@ -0,0 +1,33 @@
+/*
+ * Copyright (c) 2012 Aalto University and RWTH Aachen University.
+ *
+ * Permission is hereby granted, free of charge, to any person
+ * obtaining a copy of this software and associated documentation
+ * files (the "Software"), to deal in the Software without
+ * restriction, including without limitation the rights to use,
+ * copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the
+ * Software is furnished to do so, subject to the following
+ * conditions:
+ *
+ * The above copyright notice and this permission notice shall be
+ * included in all copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+ * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
+ * OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+ * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
+ * HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
+ * WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
+ * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
+ * OTHER DEALINGS IN THE SOFTWARE.
+ */
+
+#ifndef HIPL_TEST_HIPD_TEST_SUITES_H
+#define HIPL_TEST_HIPD_TEST_SUITES_H
+
+#include <check.h>
+
+Suite *hipd_lsidb(void);
+
+#endif /* HIPL_TEST_HIPD_TEST_SUITES_H */