summaryrefslogtreecommitdiff
path: root/source4/lib/module.c
blob: 58764683d52b93fcffa5b2dfc372ede2c4ee3440 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
/* 
   Unix SMB/CIFS implementation.
   module loading system

   Copyright (C) Jelmer Vernooij 2002-2004
   
   This program is free software; you can redistribute it and/or modify
   it under the terms of the GNU General Public License as published by
   the Free Software Foundation; either version 2 of the License, or
   (at your option) any later version.
   
   This program is distributed in the hope that it will be useful,
   but WITHOUT ANY WARRANTY; without even the implied warranty of
   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
   GNU General Public License for more details.
   
   You should have received a copy of the GNU General Public License
   along with this program; if not, write to the Free Software
   Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
*/

#include "includes.h"
#include "system/dir.h"

#ifdef HAVE_DLOPEN

/* Load module (or directory with modules) recursively. 
 * Includes running the init_module() function */
NTSTATUS smb_load_module(const char *module_name)
{
	void *handle;
	init_module_function init;
	NTSTATUS status;
	const char *error;
	struct stat st;
	DIR *dir;
	struct dirent *dirent;

	if(stat(module_name, &st) < 0) {
		DEBUG(0, ("Can't stat module '%s'\n", module_name));
		return NT_STATUS_UNSUCCESSFUL;
	}

	/* If the argument is a directory, recursively load all files / 
	 * directories in it */

	/* How about symlinks pointing to themselves - wouldn't we rather 
	 * want to use wildcards here? */
	if(S_ISDIR(st.st_mode)) {
		dir = opendir(module_name);
		while ((dirent = readdir(dir))) {
			smb_load_module(dirent->d_name);
		}
	}

	/* Always try to use LAZY symbol resolving; if the plugin has 
	 * backwards compatibility, there might be symbols in the 
	 * plugin referencing to old (removed) functions
	 */
	handle = sys_dlopen(module_name, RTLD_LAZY);

	if(!handle) {
		DEBUG(0, ("Error loading module '%s': %s\n", module_name, sys_dlerror()));
		return NT_STATUS_UNSUCCESSFUL;
	}

	init = (init_module_function)sys_dlsym(handle, "init_module");

	/* we must check sys_dlerror() to determine if it worked, because
           sys_dlsym() can validly return NULL */
	error = sys_dlerror();
	if (error) {
		DEBUG(0, ("Error trying to resolve symbol 'init_module' in %s: %s\n", module_name, error));
		return NT_STATUS_UNSUCCESSFUL;
	}

	status = init();

	DEBUG(2, ("Module '%s' loaded\n", module_name));

	return status;
}

/* Load all modules in list and return number of 
 * modules that has been successfully loaded */
int smb_load_modules(const char **modules)
{
	int i;
	int success = 0;

	for(i = 0; modules[i]; i++){
		if(NT_STATUS_IS_OK(smb_load_module(modules[i]))) {
			success++;
		}
	}

	DEBUG(2, ("%d modules successfully loaded\n", success));

	return success;
}

#else /* HAVE_DLOPEN */

NTSTATUS smb_load_module(const char *module_name)
{
	DEBUG(0,("This samba executable has not been built with plugin support\n"));
	return NT_STATUS_NOT_SUPPORTED;
}

int smb_load_modules(const char **modules)
{
	DEBUG(0,("This samba executable has not been built with plugin support\n"));
	return -1;
}

#endif /* HAVE_DLOPEN */

void init_modules(void)
{
	if(lp_preload_modules()) 
		smb_load_modules(lp_preload_modules());
}

struct subsystem {
	char *name;
	register_backend_function callback;
	struct subsystem *prev, *next;
};

static struct subsystem *subsystems = NULL;

NTSTATUS register_subsystem(const char *name, register_backend_function callback) 
{
	struct subsystem *s;
	struct subsystem *t = subsystems;

	while(t) {
		if(!strcmp(name, t->name)) {
			/* its already registered! */
			DEBUG(0,("Subsystem '%s' already registered\n", name));
			return NT_STATUS_OBJECT_NAME_COLLISION;
		}
		t = t->next;
	}

	s = smb_xmalloc(sizeof(struct subsystem));

	s->name = smb_xstrdup(name);
	s->callback = callback;
	s->prev = s->next = NULL;

	DLIST_ADD(subsystems, s);

	return NT_STATUS_OK;
}

NTSTATUS register_backend(const char *subsystem, const void *args)
{
	/* Find the specified subsystem */
	struct subsystem *s = subsystems;

	while(s) {
		if(!strcmp(subsystem, s->name)) return s->callback(args);
		s = s->next;
	}
	
	DEBUG(0, ("Unable to register backend for subsystem '%s'\n", subsystem));

	return NT_STATUS_NOT_IMPLEMENTED;
}