arlad/state.h

   1 /*
   2  * Copyright (c) 2001 - 2002 Kungliga Tekniska Högskolan
   3  * (Royal Institute of Technology, Stockholm, Sweden).
   4  * All rights reserved.
   5  *
   6  * Redistribution and use in source and binary forms, with or without
   7  * modification, are permitted provided that the following conditions
   8  * are met:
   9  *
  10  * 1. Redistributions of source code must retain the above copyright
  11  *    notice, this list of conditions and the following disclaimer.
  12  *
  13  * 2. Redistributions in binary form must reproduce the above copyright
  14  *    notice, this list of conditions and the following disclaimer in the
  15  *    documentation and/or other materials provided with the distribution.
  16  *
  17  * 3. Neither the name of the Institute nor the names of its contributors
  18  *    may be used to endorse or promote products derived from this software
  19  *    without specific prior written permission.
  20  *
  21  * THIS SOFTWARE IS PROVIDED BY THE INSTITUTE AND CONTRIBUTORS ``AS IS'' AND
  22  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  23  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  24  * ARE DISCLAIMED.  IN NO EVENT SHALL THE INSTITUTE OR CONTRIBUTORS BE LIABLE
  25  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  26  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  27  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  28  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  29  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  30  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  31  * SUCH DAMAGE.
  32  */
  33
  34 /*
  35  * The interface for the on disk storage of data when arla is down
  36  */
  37
  38 /* $Id$ */
  39
  40 #ifndef _STORE_H_
  41 #define _STORE_H_
  42
  43 /*
  44  *
  45  */
  46 #define STORE_CELLNAMELENGTH    256
  47
  48 /*
  49  * This is magic cookie for the dump of the fcache.
  50  * It's supposed not to be able to be confused with an old-style
  51  * dump (with no header)
  52  */
  53 #define FCACHE_MAGIC_COOKIE     0xff1201ff
  54
  55 /*
  56  * current version number of the dump file
  57  */
  58 #define FCACHE_VERSION          0x5
  59
  60 struct fcache_store {
  61     char cell[STORE_CELLNAMELENGTH];
  62     AFSFid fid;
  63     unsigned refcount;
  64     size_t length;
  65     size_t fetched_length;
  66     AFSVolSync volsync;
  67     AFSFetchStatus status;
  68     uint32_t anonaccess;
  69     uint32_t index;
  70     struct {
  71         unsigned attrp : 1;
  72         unsigned datap : 1;
  73         unsigned extradirp : 1;
  74         unsigned mountp : 1;
  75         unsigned fake_mp : 1;
  76         unsigned vol_root : 1;
  77     } flags;
  78     u_int tokens;
  79     char parentcell[STORE_CELLNAMELENGTH];
  80     AFSFid parent;
  81     Bool priority;
  82 };
  83
  84 /*
  85  * This is magic cookie for the dump of the volcache.
  86  * It's supposed not to be able to be confused with an old-style
  87  * dump (with no header)
  88  */
  89
  90 #define VOLCACHE_MAGIC_COOKIE   0x00120100
  91
  92 /*
  93  * current version number of the dump file
  94  */
  95
  96 #define VOLCACHE_VERSION        0x4
  97
  98 struct volcache_store {
  99     char cell[STORE_CELLNAMELENGTH];
 100     nvldbentry entry;
 101     AFSVolSync volsync;
 102     unsigned refcount;
 103 };
 104
 105 enum { STORE_NEXT = 0, STORE_DONE = 1, STORE_SKIP = 2 };
 106
 107 typedef int (*store_fcache_fn)(struct fcache_store *, void *);
 108 typedef int (*store_volcache_fn)(struct volcache_store *, void *);
 109
 110 int
 111 state_recover_volcache(const char *file, store_volcache_fn func, void *ptr);
 112
 113 int
 114 state_store_volcache(const char *fn, store_volcache_fn func, void *ptr);
 115
 116 int
 117 state_recover_fcache(const char *file, store_fcache_fn func, void *ptr);
 118
 119 int
 120 state_store_fcache(const char *fn, store_fcache_fn func, void *ptr);
 121
 122 #endif /* _STORE_H */