Changeset 732:4a0b61061a6d in freeDiameter

Timestamp:

Feb 25, 2011, 3:46:40 PM (13 years ago)

Author:

Sebastien Decugis <sdecugis@nict.go.jp>

Branch:

default

Phase:

public

Message:

Added simple mechanism to declare dependencies between extensions

Files:

• extensions/app_diameap/diameap.c (modified) (1 diff)
• extensions/app_sip/app_sip.c (modified) (1 diff)
• extensions/dict_eap/dict_eap.c (modified) (1 diff)
• extensions/test_sip/test_sip.c (modified) (1 diff)
• include/freeDiameter/extension.h (modified) (1 diff)
• libfdcore/extensions.c (modified) (6 diffs)

extensions/app_diameap/diameap.c

@@ -84 +84 @@
 
 /* Define the entry point */
-EXTENSION_ENTRY("DiamEAP", diameap_main)
+EXTENSION_ENTRY("DiamEAP", diameap_main, "dict_eap")
 ;

extensions/app_sip/app_sip.c

@@ -250 +250 @@
 }
 
-EXTENSION_ENTRY("app_sip", as_entry);
+EXTENSION_ENTRY("app_sip", as_entry, "dict_sip");

extensions/dict_eap/dict_eap.c

@@ -528 +528 @@
 }
 
-EXTENSION_ENTRY("dict_eap", deap_entry);
+EXTENSION_ENTRY("dict_eap", deap_entry, "dict_nasreq");

extensions/test_sip/test_sip.c

@@ -240 +240 @@
 }
 
-EXTENSION_ENTRY("test_sip", ts_entry);
-
+EXTENSION_ENTRY("test_sip", ts_entry, "dict_sip");
+

include/freeDiameter/extension.h

@@ -42 +42 @@
 
 /* Macro that define the entry point of the extension */
-#define EXTENSION_ENTRY(_name, _function)                                               \
+#define EXTENSION_ENTRY(_name, _function, _depends...)                                  \
+const char *fd_ext_depends[] = { _name , ## _depends , NULL };                          \
 static int extension_loaded = 0;                                                        \
 int fd_ext_init(int major, int minor, char * conffile) {                                \

libfdcore/extensions.c

@@ -46 +46 @@
         char            *conffile;      /* optional configuration file name for the extension */
         void            *handler;       /* object returned by dlopen() */
+        const char      **depends;      /* names of the other extensions this one depends on (if provided) */
+        char            *ext_name;      /* points to the extension name, either inside depends, or basename(filename) */
+        int             free_ext_name;  /* must be freed if it was malloc'd */
         void            (*fini)(void);  /* optional address of the fd_ext_fini callback */
 };
@@ -85 +88 @@
                 fd_log_debug(" - '%s'[%s] is %sloaded\n", ext->filename, ext->conffile?:"no conf", ext->handler ? "" : "not ");
         }
+}
+
+/* Check the dependencies. The object must have been dlopened already. */
+static int check_dependencies(struct fd_ext_info * ext) 
+{
+        int i = 1;
+        TRACE_ENTRY( "%p", ext );
+        
+        /* Attempt to resolve the dependency array */
+        ext->depends = dlsym( ext->handler, "fd_ext_depends" );
+        if (!ext->depends) {
+                /* Duplicate the filename */
+                char * tmp = strdup(ext->filename);
+                ext->ext_name = strdup(basename(tmp));
+                free(tmp);
+                ext->free_ext_name = 1;
+                TRACE_DEBUG(FULL, "Old extension's [%s] API: missing dependencies (ignored)", ext->ext_name);
+                return 0;
+        }
+        
+        ext->ext_name = (char *)ext->depends[0];
+        
+        TRACE_DEBUG(FULL, "Checking dependencies for '%s'...", ext->ext_name);
+        
+        while (ext->depends[i]) {
+                struct fd_list * li;
+                for (li = ext_list.next; li != &ext->chain; li = li->next)
+                {
+                        struct fd_ext_info * e = (struct fd_ext_info *)li;
+                        if (!strcasecmp(e->ext_name, ext->depends[i])) {
+                                /* the dependency was already loaded */
+                                break;
+                        }
+                }
+                
+                if (li == &ext->chain) {
+                        /* the dependency was not found */
+                        TRACE_DEBUG(NONE, "Error: extension [%s] depends on [%s] which was not loaded first.\nPlease fix your configuration file.",
+                                ext->ext_name, ext->depends[i]);
+                        return ESRCH;
+                }
+                
+                i++;
+        }
+
+        /* All dependencies resolved successfully */
+        return 0;
 }
 
@@ -111 +161 @@
                 if (ext->handler == NULL) {
                         /* An error occured */
-                        TRACE_DEBUG( NONE, "Loading of extension %s failed:\n %s\n", ext->filename, dlerror());
+                        TRACE_DEBUG( NONE, "Loading of extension %s failed:\n %s", ext->filename, dlerror());
+                        #ifdef DEBUG
+                        ext->handler = dlopen(ext->filename, RTLD_LAZY | RTLD_GLOBAL);
+                        if (ext->handler) {
+                                if (!check_dependencies(ext)) {
+                                        TRACE_DEBUG( NONE, "In addition, all declared dependencies are satisfied (Internal Error!)\n");
+                                }
+                        }
+                        #endif /* DEBUG */
                         return EINVAL;
                 }
+                
+                /* Check if declared dependencies are satisfied. */
+                CHECK_FCT( check_dependencies(ext) );
                 
                 /* Resolve the entry point of the extension */
@@ -168 +229 @@
                 /* Call the exit point of the extension, if it was resolved */
                 if (ext->fini != NULL) {
-                        TRACE_DEBUG (FULL, "Calling [%s]->fd_ext_fini function.", ext->filename);
+                        TRACE_DEBUG (FULL, "Calling [%s]->fd_ext_fini function.", ext->ext_name ?: ext->filename);
                         (*ext->fini)();
                 }
@@ -175 +236 @@
                 /* Now unload the extension */
                 if (ext->handler) {
-                        TRACE_DEBUG (FULL, "Unloading %s", ext->filename);
+                        TRACE_DEBUG (FULL, "Unloading %s", ext->ext_name ?: ext->filename);
                         if ( dlclose(ext->handler) != 0 ) {
-                                TRACE_DEBUG (INFO, "Unloading [%s] failed : %s\n", ext->filename, dlerror());
+                                TRACE_DEBUG (INFO, "Unloading [%s] failed : %s\n", ext->ext_name ?: ext->filename, dlerror());
                         }
                 }
@@ -183 +244 @@
                 
                 /* Free the object and continue */
+                if (ext->free_ext_name)
+                        free(ext->ext_name);
                 free(ext->filename);
                 free(ext->conffile);