summaryrefslogtreecommitdiff
path: root/libstore/module.c
blob: 1fcdf544a2ef37232ba887b4e7551f4c8bef82b4 (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
171
172
173
174
175
176
177
178
179
180
181
/* Dynamic loading of store class modules
   Copyright (C) 2002 Free Software Foundation, Inc.

   This file is part of the GNU Hurd.

   The GNU Hurd 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, or (at
   your option) any later version.

   The GNU Hurd 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., 59 Temple Place - Suite 330, Boston, MA 02111, USA. */

#include "store.h"
#include <dlfcn.h>
#include <stdio.h>
#include <stdlib.h>
#include <string.h>
#include <error.h>		/* XXX */

static error_t
open_class (int need_open,
	    const char *name, const char *clname_end,
	    const struct store_class **classp)
{
  char *modname, *clsym;
  void *mod;

  /* Construct the name of the shared object for this module.  */
  if (asprintf (&modname,
		"libstore_%.*s%s", (int) (clname_end - name), name,
		STORE_SONAME_SUFFIX) < 0)
    return ENOMEM;

  /* Now try to load the module.

     Note we never dlclose the module, and add a ref every time we open it
     anew.  We can't dlclose it until no stores of this class exist, so
     we'd need a creation/deletion hook for that.  */

  errno = 0;
  mod = dlopen (modname, RTLD_LAZY);
  if (mod == NULL)
    {
      const char *errstring = dlerror (); /* Must always call or it leaks! */
      if (errno != ENOENT)
	/* XXX not good, but how else to report the error? */
	error (0, 0, "cannot load %s: %s", modname, errstring);
    }
  free (modname);
  if (mod == NULL)
    return errno ?: ENOENT;

  if (asprintf (&clsym, "store_%.*s_class",
		(int) (clname_end - name), name) < 0)
    {
      dlclose (mod);
      return ENOMEM;
    }

  *classp = dlsym (mod, clsym);
  free (clsym);
  if (*classp == NULL)
    {
      error (0, 0, "invalid store module %.*s: %s",
	     (int) (clname_end - name), name, dlerror ());
      dlclose (mod);
      return EGRATUITOUS;
    }

  if (need_open && ! (*classp)->open)
    {
      /* This class cannot be opened as needed.  */
      dlclose (mod);
      return EOPNOTSUPP;
    }

  return 0;
}

error_t
store_module_find_class (const char *name, const char *clname_end,
			 const struct store_class **classp)
{
  return open_class (0, name, clname_end, classp);
}

error_t
store_module_open (const char *name, int flags,
		   const struct store_class *const *classes,
		   struct store **store)
{
  const struct store_class *cl;
  const char *clname_end = strchr (name, ':');
  error_t err;

  if (! clname_end)
    return EINVAL;

  err = open_class (1, name, clname_end, &cl);
  if (err)
    return err;

  if (*clname_end)
    /* Skip the ':' separating the class-name from the device name.  */
    clname_end++;

  if (! *clname_end)
    /* The class-specific portion of the name is empty, so make it *really*
       empty.  */
    clname_end = 0;

  return (*cl->open) (clname_end, flags, classes, store);
}

const struct store_class store_module_open_class =
{ -1, "module", open: store_module_open };
STORE_STD_CLASS (module_open);

error_t
store_module_decode (struct store_enc *enc,
		     const struct store_class *const *classes,
		     struct store **store)
{
  char *modname;
  void *mod;
  const struct store_class *const *cl, *const *clend;
  enum file_storage_class id;

  if (enc->cur_int >= enc->num_ints)
    /* The first int should always be the type.  */
    return EINVAL;

  id = enc->ints[enc->cur_int];

  /* Construct the name of the shared object for this module.  */
  if (asprintf (&modname, "libstore_type-%d%s", id, STORE_SONAME_SUFFIX) < 0)
    return ENOMEM;

  /* Try to open the module.  */
  mod = dlopen (modname, RTLD_LAZY);
  free (modname);
  if (mod == NULL)
    {
      (void) dlerror ();	/* otherwise it leaks */
      return ENOENT;
    }

  /* Now find its "store_std_classes" section, which points to each
     `struct store_class' defined in this module.  */
  cl = dlsym (mod, "__start_store_std_classes");
  if (cl == NULL)
    {
      error (0, 0, "invalid store module type-%d: %s", id, dlerror ());
      dlclose (mod);
      return EGRATUITOUS;
    }
  clend = dlsym (mod, "__stop_store_std_classes");
  if (clend == NULL)
    {
      error (0, 0, "invalid store module type-%d: %s", id, dlerror ());
      dlclose (mod);
      return EGRATUITOUS;
    }

  while (cl < clend)
    if ((*cl)->decode && (*cl)->id == id)
      return (*(*cl)->decode) (enc, classes, store);
    else
      ++cl;

  /* This class cannot be opened via store_decode.  */
  dlclose (mod);
  return EOPNOTSUPP;
}