source4/ntvfs/ntvfs_base.c

   1 /*
   2    Unix SMB/CIFS implementation.
   3    NTVFS base code
   4
   5    Copyright (C) Andrew Tridgell 2003
   6    Copyright (C) Stefan (metze) Metzmacher 2004
   7
   8    This program is free software; you can redistribute it and/or modify
   9    it under the terms of the GNU General Public License as published by
  10    the Free Software Foundation; either version 2 of the License, or
  11    (at your option) any later version.
  12
  13    This program is distributed in the hope that it will be useful,
  14    but WITHOUT ANY WARRANTY; without even the implied warranty of
  15    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  16    GNU General Public License for more details.
  17
  18    You should have received a copy of the GNU General Public License
  19    along with this program; if not, write to the Free Software
  20    Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
  21 */
  22 /*
  23   this implements the core code for all NTVFS modules. Backends register themselves here.
  24 */
  25
  26 #include "includes.h"
  27 #include "dlinklist.h"
  28 #include "smb_server/smb_server.h"
  29 #include "build.h"
  30 #include "ntvfs/ntvfs.h"
  31
  32 /* the list of currently registered NTVFS backends, note that there
  33  * can be more than one backend with the same name, as long as they
  34  * have different typesx */
  35 static struct ntvfs_backend {
  36         const struct ntvfs_ops *ops;
  37 } *backends = NULL;
  38 static int num_backends;
  39
  40 /*
  41   register a NTVFS backend.
  42
  43   The 'name' can be later used by other backends to find the operations
  44   structure for this backend.
  45
  46   The 'type' is used to specify whether this is for a disk, printer or IPC$ share
  47 */
  48 _PUBLIC_ NTSTATUS ntvfs_register(const void *_ops)
  49 {
  50         const struct ntvfs_ops *ops = _ops;
  51         struct ntvfs_ops *new_ops;
  52
  53         if (ntvfs_backend_byname(ops->name, ops->type) != NULL) {
  54                 /* its already registered! */
  55                 DEBUG(0,("NTVFS backend '%s' for type %d already registered\n",
  56                          ops->name, (int)ops->type));
  57                 return NT_STATUS_OBJECT_NAME_COLLISION;
  58         }
  59
  60         backends = realloc_p(backends, struct ntvfs_backend, num_backends+1);
  61         if (!backends) {
  62                 smb_panic("out of memory in ntvfs_register");
  63         }
  64
  65         new_ops = smb_xmemdup(ops, sizeof(*ops));
  66         new_ops->name = smb_xstrdup(ops->name);
  67
  68         backends[num_backends].ops = new_ops;
  69
  70         num_backends++;
  71
  72         DEBUG(3,("NTVFS backend '%s' for type %d registered\n",
  73                  ops->name,ops->type));
  74
  75         return NT_STATUS_OK;
  76 }
  77
  78
  79 /*
  80   return the operations structure for a named backend of the specified type
  81 */
  82 _PUBLIC_ const struct ntvfs_ops *ntvfs_backend_byname(const char *name, enum ntvfs_type type)
  83 {
  84         int i;
  85
  86         for (i=0;i<num_backends;i++) {
  87                 if (backends[i].ops->type == type &&
  88                     strcmp(backends[i].ops->name, name) == 0) {
  89                         return backends[i].ops;
  90                 }
  91         }
  92
  93         return NULL;
  94 }
  95
  96
  97 /*
  98   return the NTVFS interface version, and the size of some critical types
  99   This can be used by backends to either detect compilation errors, or provide
 100   multiple implementations for different smbd compilation options in one module
 101 */
 102 static const struct ntvfs_critical_sizes critical_sizes = {
 103         .interface_version              = NTVFS_INTERFACE_VERSION,
 104         .sizeof_ntvfs_critical_sizes    = sizeof(struct ntvfs_critical_sizes),
 105         .sizeof_ntvfs_context           = sizeof(struct ntvfs_context),
 106         .sizeof_ntvfs_module_context    = sizeof(struct ntvfs_module_context),
 107         .sizeof_ntvfs_ops               = sizeof(struct ntvfs_ops),
 108         .sizeof_ntvfs_async_state       = sizeof(struct ntvfs_async_state),
 109         .sizeof_ntvfs_request           = sizeof(struct ntvfs_request),
 110 };
 111
 112 _PUBLIC_ const struct ntvfs_critical_sizes *ntvfs_interface_version(void)
 113 {
 114         return &critical_sizes;
 115 }
 116
 117
 118 /*
 119   initialise a connection structure to point at a NTVFS backend
 120 */
 121 NTSTATUS ntvfs_init_connection(struct ntvfs_request *req, enum ntvfs_type type)
 122 {
 123         const char **handlers = lp_ntvfs_handler(req->tcon->service);
 124         int i;
 125         struct ntvfs_context *ctx;
 126
 127         if (!handlers) {
 128                 return NT_STATUS_INTERNAL_ERROR;
 129         }
 130
 131         ctx = talloc(req->tcon, struct ntvfs_context);
 132         NT_STATUS_HAVE_NO_MEMORY(ctx);
 133         ctx->type = type;
 134         ctx->modules = NULL;
 135
 136         for (i=0; handlers[i]; i++) {
 137                 struct ntvfs_module_context *ntvfs;
 138
 139                 ntvfs = talloc(ctx, struct ntvfs_module_context);
 140                 NT_STATUS_HAVE_NO_MEMORY(ntvfs);
 141
 142                 ntvfs->private_data = NULL;
 143
 144                 ntvfs->ops = ntvfs_backend_byname(handlers[i], ctx->type);
 145                 if (!ntvfs->ops) {
 146                         DEBUG(1,("ntvfs_init_connection: failed to find backend=%s, type=%d\n",
 147                                 handlers[i], ctx->type));
 148                         return NT_STATUS_INTERNAL_ERROR;
 149                 }
 150                 ntvfs->depth = i;
 151                 DLIST_ADD_END(ctx->modules, ntvfs, struct ntvfs_module_context *);
 152         }
 153
 154         if (!ctx->modules) {
 155                 return NT_STATUS_INTERNAL_ERROR;
 156         }
 157
 158         req->tcon->ntvfs_ctx = ctx;
 159
 160         return NT_STATUS_OK;
 161 }
 162
 163 NTSTATUS ntvfs_init(void)
 164 {
 165         init_module_fn static_init[] = STATIC_ntvfs_MODULES;
 166         init_module_fn *shared_init = load_samba_modules(NULL, "ntvfs");
 167
 168         run_init_functions(static_init);
 169         run_init_functions(shared_init);
 170
 171         talloc_free(shared_init);
 172
 173         return NT_STATUS_OK;
 174 }