include/atalk/cnid.h

   1 /*
   2  * $Id: cnid.h,v 1.15 2010-03-31 09:47:32 franklahm Exp $
   3  *
   4  * Copyright (c) 2003 the Netatalk Team
   5  * Copyright (c) 2003 Rafal Lewczuk <rlewczuk@pronet.pl>
   6  *
   7  * This program is free software; you can redistribute and/or modify
   8  * it under the terms of the GNU General Public License as published
   9  * by the Free Software Foundation version 2 of the License or later
  10  * version if explicitly stated by any of above copyright holders.
  11  *
  12  */
  13
  14 /*
  15  * This file contains all generic CNID related stuff
  16  * declarations. Included:
  17  * - CNID factory, which retrieves (eventually instantiates)
  18  *   CNID objects on demand
  19  * - selection of CNID backends (default, detected by volume)
  20  * - full set of CNID operations needed by server core.
  21  */
  22
  23 #ifndef _ATALK_CNID__H
  24 #define _ATALK_CNID__H 1
  25
  26 #include <atalk/adouble.h>
  27 #include <atalk/list.h>
  28
  29 /* CNID object flags */
  30 #define CNID_FLAG_PERSISTENT   0x01      /* This backend implements DID persistence */
  31 #define CNID_FLAG_MANGLING     0x02      /* This backend has name mangling feature. */
  32 #define CNID_FLAG_SETUID       0x04      /* Set db owner to parent folder owner. */
  33 #define CNID_FLAG_BLOCK        0x08      /* block signals in update. */
  34 #define CNID_FLAG_NODEV        0x10      /* don't use device number only inode */
  35 #define CNID_FLAG_LAZY_INIT    0x20      /* */
  36 #define CNID_FLAG_MEMORY       0x40      /* this is a memory only db */
  37 #define CNID_FLAG_INODE        0x80      /* in cnid_add the inode is authoritative */
  38
  39 #define CNID_INVALID   0
  40 /* first valid ID */
  41 #define CNID_START     17
  42
  43 #define CNID_ERR_PARAM 0x80000001
  44 #define CNID_ERR_PATH  0x80000002
  45 #define CNID_ERR_DB    0x80000003
  46 #define CNID_ERR_CLOSE 0x80000004   /* the db was not open */
  47 #define CNID_ERR_MAX   0x80000005
  48
  49 /*
  50  * This is instance of CNID database object.
  51  */
  52 struct _cnid_db {
  53
  54         u_int32_t flags;             /* Flags describing some CNID backend aspects. */
  55         char *volpath;               /* Volume path this particular CNID db refers to. */
  56         void *_private;              /* back-end speficic data */
  57
  58         cnid_t (*cnid_add)(struct _cnid_db *cdb, const struct stat *st, const cnid_t did,
  59                         char *name, const size_t, cnid_t hint);
  60         int (*cnid_delete)(struct _cnid_db *cdb, cnid_t id);
  61         cnid_t (*cnid_get)(struct _cnid_db *cdb, const cnid_t did, char *name, const  size_t);
  62         cnid_t (*cnid_lookup)(struct _cnid_db *cdb, const struct stat *st, const cnid_t did,
  63                         char *name, const size_t);
  64         cnid_t (*cnid_nextid)(struct _cnid_db *cdb);
  65         char *(*cnid_resolve)(struct _cnid_db *cdb, cnid_t *id, void *buffer, size_t len);
  66         int (*cnid_update)(struct _cnid_db *cdb, const cnid_t id, const struct stat *st,
  67                         const cnid_t did, char *name, const size_t len);
  68         void (*cnid_close)(struct _cnid_db *cdb);
  69         int  (*cnid_getstamp)(struct _cnid_db *cdb, void *buffer, const size_t len);
  70         cnid_t (*cnid_rebuild_add)(struct _cnid_db *, const struct stat *, const cnid_t,
  71                         char *, const size_t, cnid_t);
  72 };
  73 typedef struct _cnid_db cnid_db;
  74
  75 /*
  76  * Consolidation of args passedn from main cnid_open to modules cnid_XXX_open, so
  77  * that it's easier to add aditional args as required.
  78  */
  79 struct cnid_open_args {
  80     const char *dir;
  81     mode_t mask;
  82     uint32_t flags;
  83     const char *cnidserver;      /* for dbd */
  84     const char *cnidport;        /* for dbd */
  85 };
  86
  87 /*
  88  * CNID module - represents particular CNID implementation
  89  */
  90 struct _cnid_module {
  91         char *name;
  92         struct list_head db_list;   /* CNID modules are also stored on a bidirectional list. */
  93         struct _cnid_db *(*cnid_open)(struct cnid_open_args *args);
  94         u_int32_t flags;            /* Flags describing some CNID backend aspects. */
  95
  96 };
  97 typedef struct _cnid_module cnid_module;
  98
  99 /* Inititalize the CNID backends */
 100 void cnid_init();
 101
 102 /* Registers new CNID backend module */
 103 void cnid_register(struct _cnid_module *module);
 104
 105 /* This function opens a CNID database for selected volume. */
 106 struct _cnid_db *cnid_open(const char *volpath,
 107                            mode_t mask,
 108                            char *type,
 109                            int flags,
 110                            const char *cnidsrv, /* Only for dbd */
 111                            const char *cnidport); /* Only for dbd */
 112
 113 cnid_t cnid_add(struct _cnid_db *cdb, const struct stat *st, const cnid_t did,
 114                         char *name, const size_t len, cnid_t hint);
 115
 116 int    cnid_delete(struct _cnid_db *cdb, cnid_t id);
 117
 118 cnid_t cnid_get   (struct _cnid_db *cdb, const cnid_t did, char *name,const size_t len);
 119
 120 int    cnid_getstamp(struct _cnid_db *cdb, void *buffer, const size_t len);
 121
 122 cnid_t cnid_lookup(struct _cnid_db *cdb, const struct stat *st, const cnid_t did,
 123                         char *name, const size_t len);
 124
 125 char *cnid_resolve(struct _cnid_db *cdb, cnid_t *id, void *buffer, size_t len);
 126
 127 int cnid_update   (struct _cnid_db *cdb, const cnid_t id, const struct stat *st,
 128                         const cnid_t did, char *name, const size_t len);
 129
 130 cnid_t cnid_rebuild_add(struct _cnid_db *cdb, const struct stat *st, const cnid_t did,
 131                         char *name, const size_t len, cnid_t hint);
 132
 133
 134 /* This function closes a CNID database and frees all resources assigned to it. */
 135 void cnid_close(struct _cnid_db *db);
 136
 137 #endif
 138
 139 /*
 140  * $Log: cnid.h,v $
 141  * Revision 1.15  2010-03-31 09:47:32  franklahm
 142  * clustering support: new per volume option cnidserver
 143  *
 144  * Revision 1.14  2009/11/28 13:09:25  didg
 145  * guard against confused DB returning junk values
 146  *
 147  * Revision 1.13  2009/11/24 12:18:19  didg
 148  * add a flag parameter to cnid open functions
 149  *
 150  * Revision 1.12  2005/09/07 15:23:21  didg
 151  *
 152  * lazy init dbd database, help with pre tiger OS and a lot of volumes.
 153  *
 154  * Revision 1.11  2005/05/03 14:55:12  didg
 155  *
 156  * remove gcc warning
 157  *
 158  * Revision 1.10  2005/04/28 20:49:51  bfernhomberg
 159  *
 160  * - merge branch-netatalk-afp-3x-dev, HEAD was tagged before
 161  *
 162  * Revision 1.9.6.8  2005/04/25 22:33:24  lenneis
 163  * Add a new interface to the cdb and dbd backends: cnid_rebuild_add. It
 164  * takes dev, ino, did, name and cnid and writes these values unconditionally
 165  * into the cnid database. To be used in a recovery tool that writes cnids
 166  * cached in AppleDouble files back into the database. Not used yet by
 167  * any daemons or command line utilities.
 168  *
 169  * Revision 1.9.6.7  2005/02/08 11:46:59  didg
 170  *
 171  * warnings fixes from 2.0 branch
 172  *
 173  * Revision 1.9.6.6  2004/02/22 18:36:37  didg
 174  *
 175  * small clean up
 176  *
 177  * Revision 1.9.6.5  2004/01/14 23:15:19  lenneis
 178  * Check if we can get a DB stamp sucessfully in afs_openvol and fail
 179  * the open if not.
 180  *
 181  * Revision 1.9.6.4  2004/01/10 07:19:31  bfernhomberg
 182  * add cnid_init prototype
 183  *
 184  * Revision 1.9.6.3  2004/01/03 22:42:55  didg
 185  *
 186  * better errors handling in afpd for dbd cnid.
 187  *
 188  * Revision 1.9.6.2  2004/01/03 22:21:09  didg
 189  *
 190  * add nodev volume option (always use 0 for device number).
 191  *
 192  * Revision 1.9.6.1  2003/09/09 16:42:20  didg
 193  *
 194  * big merge for db frontend and unicode.
 195  *
 196  * Revision 1.9.4.2  2003/06/11 15:29:11  rlewczuk
 197  * Removed obsolete parameter from cnid_add. Spotted by Didier.
 198  *
 199  * Revision 1.9.4.1  2003/05/29 07:53:19  rlewczuk
 200  * Selectable CNIDs. Some refactoring. Propably needs more of refactoring, mainly
 201  * a well designed API (current API is just an old cnid_* API enclosed in VMT).
 202  *
 203  */
 204