1

#ifndef MODULE_H

     2

#define MODULE_H

     3

     4

/**

     5

 * @file

     6

 *

     7

 * Dynamically loadable modules for use with nexus.

     8

 *

     9

 * The modules are loaded using dlopen(), and hence should be standard dynamic libraries. Module initialization happens

    10

 * using a module_init_func_t named "<name>_init", which should return some kind of context pointer, which can later be

    11

 * used to perform other operations on the module.

    12

 */

    13

#include "nexus.h"

    14

#include "error.h"

    15

    16

#include <sys/queue.h>

    17

    18

/**

    19

 * Information required to load/identify a module.

    20

 */

    21

struct module_info {

    22

    /** Human-readable name */

    23

    const char *name;

    24

    25

    /** Filesystem path to the .so */

    26

    const char *path;

    27

};

    28

    29

/**

    60

 * A loaded module.

    61

 */

    62

struct module {

    63

    /** The identifying info for the module */

    64

    struct module_info info;

    65

    66

    /** The dlopen handle */

    67

    void *handle;

    68

    72

    /** The module context object */

    73

    void *ctx;

    74

    75

    /** Our entry in the list of modules */

    76

    TAILQ_ENTRY(module) modules_list;

    77

};

    78

    79

/**

    80

 * A set of loaded modules, and functionality to load more

    81

 */

    82

struct modules {

    83

    /** The nexus in use */

    84

    struct nexus *nexus;

    85

    86

    /** List of loaded modules */

    87

    TAILQ_HEAD(module_ctx_modules, module) list;

    88

};

    89

    90

/**

    91

 * Possible error codes

    92

 */

    93

enum module_error_code {

    94

    _ERR_MODULE_BEGIN = _ERR_MODULE,

    95

    96

    ERR_MODULE_OPEN,        ///< dlopen() failed

    97

    ERR_MODULE_NAME,        ///< invalid module_info.name

    98

    ERR_MODULE_SYM,         ///< invalid symbol

    99

    ERR_MODULE_INIT_FUNC,   ///< invalid module_init_func_t

   100

    ERR_MODULE_CONF,        ///< value error in configuration data

   101

};

   102

   103

   104

/**

   105

 * Maximum length of a module name

   106

 */

   107

#define MODULE_NAME_MAX 24

   108

   109

/**

   110

 * Maximum length of module symbol suffix

   111

 */

   112

#define MODULE_SUFFIX_MAX 16

   113

   114

/**

   115

 * Maximum length of symbol name name, including terminating NUL

   116

 */

   117

#define MODULE_SYMBOL_MAX (MODULE_NAME_MAX + 1 + MODULE_SUFFIX_MAX + 1)

   118

   119

/**

   120

 * Create a new modules state

   121

 */

   122

err_t modules_create (struct modules **modules_ptr, struct nexus *nexus);

   123

   124

/**

   125

 * Load a new module

   126

 */

   127

err_t module_load (struct modules *modules, struct module **module_ptr, const struct module_info *info, struct error_info *err);

   128

   129

/**

   130

 * Set a module configuration option

   131

 */

   132

err_t module_conf (struct module *module, const char *name, char *value, struct error_info *err);

   133

   134

/**

   135

 * Unload a module

   136

 *

   137

 * XXX: not implemented

   138

 */

   139

err_t module_unload (struct module *module);

   140

   141

#endif