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
  28
  29 /* the list of currently registered NTVFS backends, note that there
  30  * can be more than one backend with the same name, as long as they
  31  * have different typesx */
  32 static struct {
  33         struct ntvfs_ops *ops;
  34 } *backends = NULL;
  35 static int num_backends;
  36
  37 /*
  38   register a NTVFS backend.
  39
  40   The 'name' can be later used by other backends to find the operations
  41   structure for this backend.
  42
  43   The 'type' is used to specify whether this is for a disk, printer or IPC$ share
  44 */
  45 static NTSTATUS ntvfs_register(void *_ops)
  46 {
  47         struct ntvfs_ops *ops = _ops;
  48
  49         if (ntvfs_backend_byname(ops->name, ops->type) != NULL) {
  50                 /* its already registered! */
  51                 DEBUG(0,("NTVFS backend '%s' for type %d already registered\n",
  52                          ops->name, (int)ops->type));
  53                 return NT_STATUS_OBJECT_NAME_COLLISION;
  54         }
  55
  56         backends = Realloc(backends, sizeof(backends[0]) * (num_backends+1));
  57         if (!backends) {
  58                 smb_panic("out of memory in ntvfs_register");
  59         }
  60
  61         backends[num_backends].ops = smb_xmemdup(ops, sizeof(*ops));
  62         backends[num_backends].ops->name = smb_xstrdup(ops->name);
  63
  64         num_backends++;
  65
  66         DEBUG(3,("NTVFS backend '%s' for type %d registered\n",
  67                  ops->name,ops->type));
  68
  69         return NT_STATUS_OK;
  70 }
  71
  72
  73 /*
  74   return the operations structure for a named backend of the specified type
  75 */
  76 struct ntvfs_ops *ntvfs_backend_byname(const char *name, enum ntvfs_type type)
  77 {
  78         int i;
  79
  80         for (i=0;i<num_backends;i++) {
  81                 if (backends[i].ops->type == type &&
  82                     strcmp(backends[i].ops->name, name) == 0) {
  83                         return backends[i].ops;
  84                 }
  85         }
  86
  87         return NULL;
  88 }
  89
  90
  91 /*
  92   return the NTVFS interface version, and the size of some critical types
  93   This can be used by backends to either detect compilation errors, or provide
  94   multiple implementations for different smbd compilation options in one module
  95 */
  96 const struct ntvfs_critical_sizes *ntvfs_interface_version(void)
  97 {
  98         static const struct ntvfs_critical_sizes critical_sizes = {
  99                 NTVFS_INTERFACE_VERSION,
 100                 sizeof(struct ntvfs_ops),
 101                 sizeof(SMB_OFF_T),
 102                 sizeof(struct tcon_context),
 103                 sizeof(struct request_context),
 104         };
 105
 106         return &critical_sizes;
 107 }
 108
 109
 110 /*
 111   initialise the NTVFS subsystem
 112 */
 113 BOOL ntvfs_init(void)
 114 {
 115         NTSTATUS status;
 116
 117         status = register_subsystem("ntvfs", ntvfs_register);
 118         if (!NT_STATUS_IS_OK(status)) {
 119                 return False;
 120         }
 121
 122         /* FIXME: Perhaps panic if a basic backend, such as IPC, fails to initialise? */
 123         static_init_ntvfs;
 124
 125         DEBUG(3,("NTVFS subsystem version %d initialised\n", NTVFS_INTERFACE_VERSION));
 126         return True;
 127 }
 128
 129
 130 /*
 131   initialise a connection structure to point at a NTVFS backend
 132 */
 133 NTSTATUS ntvfs_init_connection(struct request_context *req)
 134 {
 135         const char *handler = lp_ntvfs_handler(req->conn->service);
 136
 137         req->conn->ntvfs_ops = ntvfs_backend_byname(handler, req->conn->type);
 138
 139         if (!req->conn->ntvfs_ops) {
 140                 DEBUG(1,("ntvfs_init_connection: failed to find backend=%s, type=%d\n", handler, req->conn->type));
 141                 return NT_STATUS_UNSUCCESSFUL;
 142         }
 143
 144         return NT_STATUS_OK;
 145 }