include/atalk/cnid.h

   1 /*
   2  * $Id: cnid.h,v 1.14 2009-11-28 13:09:25 didg 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  * CNID module - represents particular CNID implementation
  77  */
  78 struct _cnid_module {
  79         char *name;
  80         struct list_head db_list;   /* CNID modules are also stored on a bidirectional list. */
  81         struct _cnid_db *(*cnid_open)(const char *dir, mode_t mask, u_int32_t flags);
  82         u_int32_t flags;            /* Flags describing some CNID backend aspects. */
  83
  84 };
  85 typedef struct _cnid_module cnid_module;
  86
  87 /* Inititalize the CNID backends */
  88 void cnid_init();
  89
  90 /* Registers new CNID backend module */
  91 void cnid_register(struct _cnid_module *module);
  92
  93 /* This function opens a CNID database for selected volume. */
  94 struct _cnid_db *cnid_open(const char *volpath, mode_t mask, char *type, int flags);
  95
  96 cnid_t cnid_add(struct _cnid_db *cdb, const struct stat *st, const cnid_t did,
  97                         char *name, const size_t len, cnid_t hint);
  98
  99 int    cnid_delete(struct _cnid_db *cdb, cnid_t id);
 100
 101 cnid_t cnid_get   (struct _cnid_db *cdb, const cnid_t did, char *name,const size_t len);
 102
 103 int    cnid_getstamp(struct _cnid_db *cdb, void *buffer, const size_t len);
 104
 105 cnid_t cnid_lookup(struct _cnid_db *cdb, const struct stat *st, const cnid_t did,
 106                         char *name, const size_t len);
 107
 108 char *cnid_resolve(struct _cnid_db *cdb, cnid_t *id, void *buffer, size_t len);
 109
 110 int cnid_update   (struct _cnid_db *cdb, const cnid_t id, const struct stat *st,
 111                         const cnid_t did, char *name, const size_t len);
 112
 113 cnid_t cnid_rebuild_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
 117 /* This function closes a CNID database and frees all resources assigned to it. */
 118 void cnid_close(struct _cnid_db *db);
 119
 120 #endif
 121
 122 /*
 123  * $Log: cnid.h,v $
 124  * Revision 1.14  2009-11-28 13:09:25  didg
 125  * guard against confused DB returning junk values
 126  *
 127  * Revision 1.13  2009/11/24 12:18:19  didg
 128  * add a flag parameter to cnid open functions
 129  *
 130  * Revision 1.12  2005/09/07 15:23:21  didg
 131  *
 132  * lazy init dbd database, help with pre tiger OS and a lot of volumes.
 133  *
 134  * Revision 1.11  2005/05/03 14:55:12  didg
 135  *
 136  * remove gcc warning
 137  *
 138  * Revision 1.10  2005/04/28 20:49:51  bfernhomberg
 139  *
 140  * - merge branch-netatalk-afp-3x-dev, HEAD was tagged before
 141  *
 142  * Revision 1.9.6.8  2005/04/25 22:33:24  lenneis
 143  * Add a new interface to the cdb and dbd backends: cnid_rebuild_add. It
 144  * takes dev, ino, did, name and cnid and writes these values unconditionally
 145  * into the cnid database. To be used in a recovery tool that writes cnids
 146  * cached in AppleDouble files back into the database. Not used yet by
 147  * any daemons or command line utilities.
 148  *
 149  * Revision 1.9.6.7  2005/02/08 11:46:59  didg
 150  *
 151  * warnings fixes from 2.0 branch
 152  *
 153  * Revision 1.9.6.6  2004/02/22 18:36:37  didg
 154  *
 155  * small clean up
 156  *
 157  * Revision 1.9.6.5  2004/01/14 23:15:19  lenneis
 158  * Check if we can get a DB stamp sucessfully in afs_openvol and fail
 159  * the open if not.
 160  *
 161  * Revision 1.9.6.4  2004/01/10 07:19:31  bfernhomberg
 162  * add cnid_init prototype
 163  *
 164  * Revision 1.9.6.3  2004/01/03 22:42:55  didg
 165  *
 166  * better errors handling in afpd for dbd cnid.
 167  *
 168  * Revision 1.9.6.2  2004/01/03 22:21:09  didg
 169  *
 170  * add nodev volume option (always use 0 for device number).
 171  *
 172  * Revision 1.9.6.1  2003/09/09 16:42:20  didg
 173  *
 174  * big merge for db frontend and unicode.
 175  *
 176  * Revision 1.9.4.2  2003/06/11 15:29:11  rlewczuk
 177  * Removed obsolete parameter from cnid_add. Spotted by Didier.
 178  *
 179  * Revision 1.9.4.1  2003/05/29 07:53:19  rlewczuk
 180  * Selectable CNIDs. Some refactoring. Propably needs more of refactoring, mainly
 181  * a well designed API (current API is just an old cnid_* API enclosed in VMT).
 182  *
 183  */
 184