include/atalk/volume.h

Go to the documentation of this file.

/*
 * Copyright (c) 1990,1994 Regents of The University of Michigan.
 * All Rights Reserved.  See COPYRIGHT.
 */
 
#ifndef ATALK_VOLUME_H
#define ATALK_VOLUME_H 1
 
#include <stdint.h>
#include <sys/types.h>
 
#include <atalk/cnid.h>
#include <atalk/globals.h>
#include <atalk/hash.h>
#include <atalk/unicode.h>
#include <atalk/vfs.h>
 
#define AFPVOL_U8MNAMELEN   255 
#define AFPVOL_MACNAMELEN    27 
 
typedef uint64_t VolSpace;
 
/* Forward declaration — full definition in atalk/spotlight.h */
struct sl_backend_ops;
 
/* This should belong in a file.h */
struct extmap {
    char        *em_ext;
    char        em_creator[4];
    char        em_type[4];
};
 
struct vol {
    struct vol      *v_next;
    AFPObj          *v_obj;
    uint16_t        v_vid;
    int             v_flags;
    char            *v_path;
    struct dir      *v_root;
    time_t          v_mtime;
 
    charset_t       v_volcharset;
    charset_t       v_maccharset;
    uint16_t        v_mtou_flags;    
    uint16_t        v_utom_flags;
    uint32_t        v_kTextEncoding; 
    size_t          max_filename;
    char            *v_veto;
    int             v_adouble;    
    int             v_ad_options; 
    const char      *(*ad_path)(const char *, int);
    struct _cnid_db *v_cdb;
    char            v_stamp[ADEDLEN_PRIVSYN];
    VolSpace        v_limitsize; 
    mode_t          v_umask;
    mode_t          v_dperm; 
    mode_t          v_fperm; 
    ucs2_t          *v_u8mname;     
    ucs2_t          *v_macname;     
    ucs2_t          *v_name;        
 
    /* get/set volparams */
    time_t          v_ctime;  
    dev_t           v_dev;    
 
    /* adouble VFS indirection */
    struct vfs_ops  *vfs;   
    const struct vfs_ops *vfs_modules[4];
    int             v_vfs_ea;       
 
    /* misc */
    char            *v_gvs;
    void            *v_nfsclient;
    int             v_nfs;
    VolSpace        v_tm_used;  
    time_t          v_tm_cachetime; 
    VolSpace        v_appended; 
 
    /* only when opening/closing volumes or in error */
    int             v_casefold;
    char            *v_configname;   
    char            *v_localname;    
    char            *v_volcodepage;
    char            *v_maccodepage;
    char            *v_password;
    char            *v_cnidscheme;
    char            *v_dbpath;
    char            *v_cnidserver;
    char            *v_cnidport;
    char            *v_legacyicon;    
    unsigned char   *v_icon_rfork;    
    size_t          v_icon_rfork_len; 
#if 0
    int             v_hide;       /* new volume wait until old volume is closed */
    int             v_new;        /* volume deleted but there's a new one
                                   * with the same name */
#endif
    int             v_deleted;    
    char            *v_sl_backend_name; 
    const struct sl_backend_ops *v_sl_backend; 
#if 0
    char            *v_root_preexec;
#endif
    char            *v_preexec;
#if 0
    char            *v_root_postexec;
#endif
    char            *v_postexec;
#if 0
    int             v_root_preexec_close;
#endif
    int             v_preexec_close;
    char            *v_uuid;    
    int             v_qfd;
    uint32_t        v_ignattr;  
};

typedef enum {
    LV_DEFAULT = 0,
    LV_ALL = 1,      
    LV_FORCE = 2     
} lv_flags_t;
 
/* volume flags */
#define AFPVOL_OPEN (1<<0)
 
/* Volume-space backend/state (bits 2–4); value 1 is currently unused. */
#define AFPVOL_GVSMASK   (7 << 2)
#define AFPVOL_NONE      (0 << 2)
#define AFPVOL_USTATFS   (1 << 3)
#define AFPVOL_UQUOTA    (1 << 4)
 
/* Flags that alter per-volume behavior. */
#define AFPVOL_NOV2TOEACONV (1 << 5) 
#define AFPVOL_SPOTLIGHT (1 << 6)    
#define AFPVOL_EA_SAMBA  (1 << 7)    
#define AFPVOL_RO        (1 << 8)    
#define AFPVOL_CHMOD_PRESERVE_ACL (1 << 9) 
#define AFPVOL_CHMOD_IGNORE (1 << 10) 
#define AFPVOL_FORCE_STICKY_XATTR (1 << 11) 
#define AFPVOL_LIMITSIZE (1 << 12)   
#define AFPVOL_A2VOL     (1 << 13)   
#define AFPVOL_MULTIPROTO (1 << 14)  
#define AFPVOL_NOSTAT    (1 << 16)   
#define AFPVOL_UNIX_PRIV (1 << 17)   
#define AFPVOL_NODEV     (1 << 18)   
#define AFPVOL_EILSEQ    (1 << 20)   
#define AFPVOL_INV_DOTS  (1 << 22)   
#define AFPVOL_TM        (1 << 23)   
#define AFPVOL_ACLS      (1 << 24)   
#define AFPVOL_SEARCHDB  (1 << 25)   
#define AFPVOL_NONETIDS  (1 << 26)   
#define AFPVOL_FOLLOWSYM (1 << 27)   
#define AFPVOL_DELVETO   (1 << 28)   
 
/* Extended Attributes vfs indirection */
#define AFPVOL_EA_NONE           0   
#define AFPVOL_EA_AUTO           1   
#define AFPVOL_EA_SYS            2   
#define AFPVOL_EA_AD             3   
 
/* FPGetSrvrParms options */
#define AFPSRVR_CONFIGINFO     (1 << 0)
#define AFPSRVR_PASSWD         (1 << 7)
 
/* handle casefolding */
#define AFPVOL_MTOUUPPER       (1 << 0)
#define AFPVOL_MTOULOWER       (1 << 1)
#define AFPVOL_UTOMUPPER       (1 << 2)
#define AFPVOL_UTOMLOWER       (1 << 3)
#define AFPVOL_UMLOWER         (AFPVOL_MTOULOWER | AFPVOL_UTOMLOWER)
#define AFPVOL_UMUPPER         (AFPVOL_MTOUUPPER | AFPVOL_UTOMUPPER)
#define AFPVOL_UUPPERMLOWER    (AFPVOL_MTOUUPPER | AFPVOL_UTOMLOWER)
#define AFPVOL_ULOWERMUPPER    (AFPVOL_MTOULOWER | AFPVOL_UTOMUPPER)
#define AFPVOL_CASESENS        (1 << 4)
 
#define AFPVOLSIG_FLAT          0x0001 
#define AFPVOLSIG_FIX           0x0002 
#define AFPVOLSIG_VAR           0x0003 
#define AFPVOLSIG_DEFAULT       AFPVOLSIG_FIX
 
/* volume attributes */
#define VOLPBIT_ATTR_RO           (1 << 0)
#define VOLPBIT_ATTR_PASSWD       (1 << 1)
#define VOLPBIT_ATTR_FILEID       (1 << 2)
#define VOLPBIT_ATTR_CATSEARCH    (1 << 3)
#define VOLPBIT_ATTR_BLANKACCESS  (1 << 4)
#define VOLPBIT_ATTR_UNIXPRIV     (1 << 5)
#define VOLPBIT_ATTR_UTF8         (1 << 6)
#define VOLPBIT_ATTR_NONETIDS     (1 << 7)
#define VOLPBIT_ATTR_PRIVPARENT   (1 << 8)
#define VOLPBIT_ATTR_NOTFILEXCHG  (1 << 9)
#define VOLPBIT_ATTR_EXT_ATTRS    (1 << 10)
#define VOLPBIT_ATTR_ACLS         (1 << 11)
#define VOLPBIT_ATTR_CASESENS     (1 << 12)
#define VOLPBIT_ATTR_TM           (1 << 13)
 
#define VOLPBIT_ATTR    0
#define VOLPBIT_SIG 1
#define VOLPBIT_CDATE   2
#define VOLPBIT_MDATE   3
#define VOLPBIT_BDATE   4
#define VOLPBIT_VID 5
#define VOLPBIT_BFREE   6
#define VOLPBIT_BTOTAL  7
#define VOLPBIT_NAME    8
/* handle > 4GB volumes */
#define VOLPBIT_XBFREE  9
#define VOLPBIT_XBTOTAL 10
#define VOLPBIT_BSIZE   11        
 
#define utf8_encoding(obj) ((obj)->afp_version >= 30)
 
#define vol_nodev(vol) (((vol)->v_flags & AFPVOL_NODEV) ? 1 : 0)
#define vol_unix_priv_enabled(vol) (((vol)->v_flags & AFPVOL_UNIX_PRIV) ? 1 : 0)
#define vol_unix_priv(vol) ((vol)->v_obj->afp_version >= 30 && vol_unix_priv_enabled(vol))
#define vol_umask(vol) (vol_unix_priv_enabled(vol) ? (vol)->v_umask : 0)
#define vol_dperm(vol) (vol_unix_priv_enabled(vol) ? (vol)->v_dperm : 0)
#define vol_fperm(vol) (vol_unix_priv_enabled(vol) ? (vol)->v_fperm : 0)
#define vol_inv_dots(vol) (((vol)->v_flags & AFPVOL_INV_DOTS) ? 1 : 0)
#define vol_syml_opt(vol) (((vol)->v_flags & AFPVOL_FOLLOWSYM) ? 0 : O_NOFOLLOW)
#define vol_chmod_opt(vol) (((vol)->v_flags & AFPVOL_CHMOD_PRESERVE_ACL) ? O_NETATALK_ACL : \
                            ((vol)->v_flags & AFPVOL_CHMOD_IGNORE) ? O_IGNORE : 0)
 
#endif