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     u_int32_t flags;             /* Flags describing some CNID backend aspects. */
  54     char *volpath;               /* Volume path this particular CNID db refers to. */
  55     void *_private;              /* back-end speficic data */
  56
  57     cnid_t (*cnid_add)         (struct _cnid_db *cdb, const struct stat *st, const cnid_t did,
  58                                 char *name, const size_t, cnid_t hint);
  59     int    (*cnid_delete)      (struct _cnid_db *cdb, cnid_t id);
  60     cnid_t (*cnid_get)         (struct _cnid_db *cdb, const cnid_t did, char *name, const  size_t);
  61     cnid_t (*cnid_lookup)      (struct _cnid_db *cdb, const struct stat *st, const cnid_t did,
  62                                 char *name, const size_t);
  63     cnid_t (*cnid_nextid)      (struct _cnid_db *cdb);
  64     char * (*cnid_resolve)     (struct _cnid_db *cdb, cnid_t *id, void *buffer, size_t len);
  65     int    (*cnid_update)      (struct _cnid_db *cdb, const cnid_t id, const struct stat *st,
  66                                 const cnid_t did, char *name, const size_t len);
  67     void   (*cnid_close)       (struct _cnid_db *cdb);
  68     int    (*cnid_getstamp)    (struct _cnid_db *cdb, void *buffer, const size_t len);
  69     cnid_t (*cnid_rebuild_add) (struct _cnid_db *, const struct stat *, const cnid_t,
  70                                 char *, const size_t, cnid_t);
  71     int    (*cnid_find)        (struct _cnid_db *cdb, const char *name, size_t len);
  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,
 111                            const char *cnidport);
 112 cnid_t cnid_add        (struct _cnid_db *cdb, const struct stat *st, const cnid_t did,
 113                         const char *name, const size_t len, cnid_t hint);
 114 int    cnid_delete     (struct _cnid_db *cdb, cnid_t id);
 115 cnid_t cnid_get        (struct _cnid_db *cdb, const cnid_t did, char *name,const size_t len);
 116 int    cnid_getstamp   (struct _cnid_db *cdb, void *buffer, const size_t len);
 117 cnid_t cnid_lookup     (struct _cnid_db *cdb, const struct stat *st, const cnid_t did,
 118                         char *name, const size_t len);
 119 char  *cnid_resolve    (struct _cnid_db *cdb, cnid_t *id, void *buffer, size_t len);
 120 int    cnid_update     (struct _cnid_db *cdb, const cnid_t id, const struct stat *st,
 121                         const cnid_t did, char *name, const size_t len);
 122 cnid_t cnid_rebuild_add(struct _cnid_db *cdb, const struct stat *st, const cnid_t did,
 123                         char *name, const size_t len, cnid_t hint);
 124 int    cnid_find       (struct _cnid_db *cdb, const char *name, size_t len);
 125 void   cnid_close      (struct _cnid_db *db);
 126
 127 #endif