libatalk/adouble/ad_flush.c

   1 /*
   2  * Copyright (c) 1990,1991 Regents of The University of Michigan.
   3  * Copyright (c) 2010      Frank Lahm
   4  * All Rights Reserved.
   5  *
   6  * Permission to use, copy, modify, and distribute this software and
   7  * its documentation for any purpose and without fee is hereby granted,
   8  * provided that the above copyright notice appears in all copies and
   9  * that both that copyright notice and this permission notice appear
  10  * in supporting documentation, and that the name of The University
  11  * of Michigan not be used in advertising or publicity pertaining to
  12  * distribution of the software without specific, written prior
  13  * permission. This software is supplied as is without expressed or
  14  * implied warranties of any kind.
  15  *
  16  *  Research Systems Unix Group
  17  *  The University of Michigan
  18  *  c/o Mike Clark
  19  *  535 W. William Street
  20  *  Ann Arbor, Michigan
  21  *  +1-313-763-0525
  22  *  netatalk@itd.umich.edu
  23  */
  24
  25 #ifdef HAVE_CONFIG_H
  26 #include <config.h>
  27 #endif /* HAVE_CONFIG_H */
  28
  29 #include <string.h>
  30 #include <stdio.h>
  31 #include <stdlib.h>
  32 #include <errno.h>
  33 #include <arpa/inet.h>
  34
  35 #include <atalk/adouble.h>
  36 #include <atalk/ea.h>
  37 #include <atalk/logger.h>
  38 #include <atalk/bstrlib.h>
  39 #include <atalk/bstradd.h>
  40 #include <atalk/errchk.h>
  41 #include <atalk/util.h>
  42
  43 #include "ad_lock.h"
  44
  45 static const uint32_t set_eid[] = {
  46     0,1,2,3,4,5,6,7,8,
  47     9,10,11,12,13,14,15,
  48     AD_DEV, AD_INO, AD_SYN, AD_ID
  49 };
  50
  51 #define EID_DISK(a) (set_eid[a])
  52
  53 /*
  54  * Prepare ad->ad_data buffer from struct adouble for writing on disk
  55  */
  56 int ad_rebuild_adouble_header(struct adouble *ad)
  57 {
  58     uint32_t       eid;
  59     uint32_t       temp;
  60     uint16_t       nent;
  61     char        *buf, *nentp;
  62     int             len;
  63
  64     LOG(log_debug, logtype_default, "ad_rebuild_adouble_header");
  65
  66     buf = ad->ad_data;
  67
  68     temp = htonl( ad->ad_magic );
  69     memcpy(buf, &temp, sizeof( temp ));
  70     buf += sizeof( temp );
  71
  72     temp = htonl( ad->ad_version );
  73     memcpy(buf, &temp, sizeof( temp ));
  74     buf += sizeof( temp );
  75
  76     buf += sizeof( ad->ad_filler );
  77
  78     nentp = buf;
  79     buf += sizeof( nent );
  80     for ( eid = 0, nent = 0; eid < ADEID_MAX; eid++ ) {
  81         if ( ad->ad_eid[ eid ].ade_off == 0 ) {
  82             continue;
  83         }
  84         temp = htonl( EID_DISK(eid) );
  85         memcpy(buf, &temp, sizeof( temp ));
  86         buf += sizeof( temp );
  87
  88         temp = htonl( ad->ad_eid[ eid ].ade_off );
  89         memcpy(buf, &temp, sizeof( temp ));
  90         buf += sizeof( temp );
  91
  92         temp = htonl( ad->ad_eid[ eid ].ade_len );
  93         memcpy(buf, &temp, sizeof( temp ));
  94         buf += sizeof( temp );
  95         nent++;
  96     }
  97     nent = htons( nent );
  98     memcpy(nentp, &nent, sizeof( nent ));
  99
 100     switch (ad->ad_vers) {
 101     case AD_VERSION2:
 102         len = ad_getentryoff(ad, ADEID_RFORK);
 103         break;
 104     case AD_VERSION_EA:
 105         len = AD_DATASZ_EA;
 106         break;
 107     default:
 108         LOG(log_error, logtype_afpd, "Unexpected adouble version");
 109         len = 0;
 110         break;
 111     }
 112
 113     return len;
 114 }
 115
 116 /*!
 117  * Prepare adbuf buffer from struct adouble for writing on disk
 118  */
 119 static int ad_rebuild_adouble_header_osx(struct adouble *ad, char *adbuf)
 120 {
 121     uint32_t       temp;
 122     uint16_t       nent;
 123     char           *buf;
 124     int            len;
 125
 126     LOG(log_debug, logtype_default, "ad_rebuild_adouble_header_osx");
 127
 128     buf = &adbuf[0];
 129
 130     temp = htonl( ad->ad_magic );
 131     memcpy(buf, &temp, sizeof( temp ));
 132     buf += sizeof( temp );
 133
 134     temp = htonl( ad->ad_version );
 135     memcpy(buf, &temp, sizeof( temp ));
 136     buf += sizeof( temp );
 137
 138     buf += sizeof( ad->ad_filler );
 139
 140     nent = htons(ADEID_NUM_OSX);
 141     memcpy(buf, &nent, sizeof( nent ));
 142     buf += sizeof( nent );
 143
 144     /* FinderInfo */
 145     temp = htonl(EID_DISK(ADEID_FINDERI));
 146     memcpy(buf, &temp, sizeof( temp ));
 147     buf += sizeof( temp );
 148
 149     temp = htonl(ADEDOFF_FINDERI_OSX);
 150     memcpy(buf, &temp, sizeof( temp ));
 151     buf += sizeof( temp );
 152
 153     temp = htonl(ADEDLEN_FINDERI);
 154     memcpy(buf, &temp, sizeof( temp ));
 155     buf += sizeof( temp );
 156
 157     memcpy(adbuf + ADEDOFF_FINDERI_OSX, ad_entry(ad, ADEID_FINDERI), ADEDLEN_FINDERI);
 158
 159     /* rfork */
 160     temp = htonl( EID_DISK(ADEID_RFORK) );
 161     memcpy(buf, &temp, sizeof( temp ));
 162     buf += sizeof( temp );
 163
 164     temp = htonl(ADEDOFF_RFORK_OSX);
 165     memcpy(buf, &temp, sizeof( temp ));
 166     buf += sizeof( temp );
 167
 168     temp = htonl( ad->ad_rlen);
 169     memcpy(buf, &temp, sizeof( temp ));
 170     buf += sizeof( temp );
 171
 172     return AD_DATASZ_OSX;
 173 }
 174
 175 /* -------------------
 176  * XXX copy only header with same size or comment
 177  * doesn't work well for adouble with different version.
 178  *
 179  */
 180 int ad_copy_header(struct adouble *add, struct adouble *ads)
 181 {
 182     uint32_t       eid;
 183     uint32_t       len;
 184
 185     for ( eid = 0; eid < ADEID_MAX; eid++ ) {
 186         if ( ads->ad_eid[ eid ].ade_off == 0 || add->ad_eid[ eid ].ade_off == 0 )
 187             continue;
 188
 189         len = ads->ad_eid[ eid ].ade_len;
 190         if (!len || len != add->ad_eid[ eid ].ade_len)
 191             continue;
 192
 193         switch (eid) {
 194         case ADEID_COMMENT:
 195         case ADEID_PRIVDEV:
 196         case ADEID_PRIVINO:
 197         case ADEID_PRIVSYN:
 198         case ADEID_PRIVID:
 199             continue;
 200         default:
 201             ad_setentrylen( add, eid, len );
 202             memcpy( ad_entry( add, eid ), ad_entry( ads, eid ), len );
 203         }
 204     }
 205     add->ad_rlen = ads->ad_rlen;
 206
 207     if ((ads->ad_vers == AD_VERSION2) && (add->ad_vers = AD_VERSION_EA)
 208         || (ads->ad_vers == AD_VERSION_EA) && (add->ad_vers = AD_VERSION2)) {
 209         cnid_t id;
 210         memcpy(&id, ad_entry(add, ADEID_PRIVID), sizeof(cnid_t));
 211         id = htonl(id);
 212         memcpy(ad_entry(add, ADEID_PRIVID), &id, sizeof(cnid_t));
 213     }
 214     return 0;
 215 }
 216
 217 static int ad_flush_hf(struct adouble *ad)
 218 {
 219     EC_INIT;
 220     int len;
 221     int cwd = -1;
 222
 223     LOG(log_debug, logtype_default, "ad_flush_hf(%s)", adflags2logstr(ad->ad_adflags));
 224
 225     struct ad_fd *adf;
 226
 227     switch (ad->ad_vers) {
 228     case AD_VERSION2:
 229         adf = ad->ad_mdp;
 230         break;
 231     case AD_VERSION_EA:
 232         adf = &ad->ad_data_fork;
 233         break;
 234     default:
 235         LOG(log_error, logtype_afpd, "ad_flush: unexpected adouble version");
 236         return -1;
 237     }
 238
 239     if ((adf->adf_flags & O_RDWR)
 240         || ((ad->ad_adflags & ADFLAGS_DIR) && (ad->ad_adflags & ADFLAGS_RDWR))) {
 241         if (ad_getentryoff(ad, ADEID_RFORK)) {
 242             if (ad->ad_rlen > 0xffffffff)
 243                 ad_setentrylen(ad, ADEID_RFORK, 0xffffffff);
 244             else
 245                 ad_setentrylen(ad, ADEID_RFORK, ad->ad_rlen);
 246         }
 247         len = ad->ad_ops->ad_rebuild_header(ad);
 248
 249         switch (ad->ad_vers) {
 250         case AD_VERSION2:
 251             if (adf_pwrite(ad->ad_mdp, ad->ad_data, len, 0) != len) {
 252                 if (errno == 0)
 253                     errno = EIO;
 254                 return( -1 );
 255             }
 256             break;
 257         case AD_VERSION_EA:
 258             if (AD_META_OPEN(ad)) {
 259                 if (ad->ad_adflags & ADFLAGS_DIR) {
 260                     EC_NEG1_LOG( cwd = open(".", O_RDONLY) );
 261                     EC_NEG1_LOG( fchdir(ad_data_fileno(ad)) );
 262                     EC_ZERO_LOG( sys_lsetxattr(".", AD_EA_META, ad->ad_data, AD_DATASZ_EA, 0) );
 263                     EC_NEG1_LOG( fchdir(cwd) );
 264                     EC_NEG1_LOG( close(cwd) );
 265                     cwd = -1;
 266                 } else {
 267                     EC_ZERO_LOG( sys_fsetxattr(ad_data_fileno(ad), AD_EA_META, ad->ad_data, AD_DATASZ_EA, 0) );
 268                 }
 269             }
 270             break;
 271         default:
 272             LOG(log_error, logtype_afpd, "ad_flush: unexpected adouble version");
 273             return -1;
 274         }
 275     }
 276
 277 EC_CLEANUP:
 278     if (cwd != -1) {
 279         if (fchdir(cwd) != 0) {
 280             AFP_PANIC("ad_flush: cant fchdir");
 281         }
 282         close(cwd);
 283     }
 284     EC_EXIT;
 285 }
 286
 287 /* Flush resofork adouble file if any (currently adouble:ea and #ifndef HAVE_EAFD eg Linux) */
 288 static int ad_flush_rf(struct adouble *ad)
 289 {
 290     ssize_t len;
 291     char    adbuf[AD_DATASZ_OSX];
 292
 293 #ifdef HAVE_EAFD
 294     return 0;
 295 #endif
 296     if (ad->ad_vers != AD_VERSION_EA)
 297         return 0;
 298
 299     LOG(log_debug, logtype_default, "ad_flush_rf(%s)", adflags2logstr(ad->ad_adflags));
 300
 301     if ((ad->ad_rfp->adf_flags & O_RDWR)) {
 302         if (ad_getentryoff(ad, ADEID_RFORK)) {
 303             if (ad->ad_rlen > 0xffffffff)
 304                 ad_setentrylen(ad, ADEID_RFORK, 0xffffffff);
 305             else
 306                 ad_setentrylen(ad, ADEID_RFORK, ad->ad_rlen);
 307         }
 308         len = ad_rebuild_adouble_header_osx(ad, &adbuf[0]);
 309
 310         if (adf_pwrite(ad->ad_rfp, adbuf, len, 0) != len) {
 311             if (errno == 0)
 312                 errno = EIO;
 313             return -1;
 314         }
 315     }
 316     return 0;
 317 }
 318
 319 int ad_flush(struct adouble *ad)
 320 {
 321     EC_INIT;
 322
 323     LOG(log_debug, logtype_default, "ad_flush(%s)", adflags2logstr(ad->ad_adflags));
 324
 325     if (AD_META_OPEN(ad)) {
 326         EC_ZERO( ad_flush_hf(ad) );
 327     }
 328
 329     if (AD_RSRC_OPEN(ad)) {
 330         EC_ZERO( ad_flush_rf(ad) );
 331     }
 332
 333 EC_CLEANUP:
 334     EC_EXIT;
 335 }
 336
 337 static int ad_data_closefd(struct adouble *ad)
 338 {
 339     int ret = 0;
 340
 341     if (ad_data_fileno(ad) == -2) {
 342         free(ad->ad_data_fork.adf_syml);
 343         ad->ad_data_fork.adf_syml = NULL;
 344     } else {
 345         if (close(ad_data_fileno(ad)) < 0)
 346             ret = -1;
 347     }
 348     ad_data_fileno(ad) = -1;
 349     return ret;
 350 }
 351
 352 /*!
 353  * Close a struct adouble freeing all resources
 354  */
 355 int ad_close(struct adouble *ad, int adflags)
 356 {
 357     int err = 0;
 358
 359     if (ad == NULL)
 360         return err;
 361
 362     LOG(log_debug, logtype_default,
 363         "ad_close(%s): BEGIN [dfd: %d (ref: %d), mfd: %d (ref: %d), rfd: %d (ref: %d)]",
 364         adflags2logstr(adflags),
 365         ad_data_fileno(ad), ad->ad_data_fork.adf_refcount,
 366         ad_meta_fileno(ad), ad->ad_mdp->adf_refcount,
 367         ad_reso_fileno(ad), ad->ad_rfp->adf_refcount);
 368
 369     if (adflags & (ADFLAGS_SETSHRMD | ADFLAGS_CHECK_OF)) {
 370         /* sharemode locks are stored in the data fork, adouble:v2 needs this extra handling */
 371         adflags |= ADFLAGS_DF;
 372     }
 373
 374     if ((ad->ad_vers == AD_VERSION2) && (adflags & ADFLAGS_RF))
 375         adflags |= ADFLAGS_HF;
 376
 377     if ((adflags & ADFLAGS_DF)
 378         && (ad_data_fileno(ad) >= 0 || ad_data_fileno(ad) == -2) /* -2 means symlink */
 379         && --ad->ad_data_fork.adf_refcount == 0) {
 380         if (ad_data_closefd(ad) < 0)
 381             err = -1;
 382         adf_lock_free(&ad->ad_data_fork);
 383     }
 384
 385     if ((adflags & ADFLAGS_HF)
 386         && (ad_meta_fileno(ad) != -1) && !(--ad->ad_mdp->adf_refcount)) {
 387         if (close( ad_meta_fileno(ad)) < 0)
 388             err = -1;
 389         ad_meta_fileno(ad) = -1;
 390         if (ad->ad_vers == AD_VERSION2)
 391             adf_lock_free(ad->ad_mdp);
 392     }
 393
 394     if ((adflags & ADFLAGS_RF) && (ad->ad_vers == AD_VERSION_EA)) {
 395         if ((ad_reso_fileno(ad) != -1)
 396             && !(--ad->ad_rfp->adf_refcount)) {
 397             if (close(ad->ad_rfp->adf_fd) < 0)
 398                 err = -1;
 399             ad->ad_rlen = 0;
 400             ad_reso_fileno(ad) = -1;
 401             adf_lock_free(ad->ad_rfp);
 402         }
 403     }
 404
 405     LOG(log_debug, logtype_default,
 406         "ad_close(%s): END: %d [dfd: %d (ref: %d), mfd: %d (ref: %d), rfd: %d (ref: %d)]",
 407         adflags2logstr(adflags), err,
 408         ad_data_fileno(ad), ad->ad_data_fork.adf_refcount,
 409         ad_meta_fileno(ad), ad->ad_mdp->adf_refcount,
 410         ad_reso_fileno(ad), ad->ad_rfp->adf_refcount);
 411
 412     return err;
 413 }