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_v2(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_v2");
  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         temp = htonl( EID_DISK(eid) );
  84         memcpy(buf, &temp, sizeof( temp ));
  85         buf += sizeof( temp );
  86
  87         temp = htonl( ad->ad_eid[ eid ].ade_off );
  88         memcpy(buf, &temp, sizeof( temp ));
  89         buf += sizeof( temp );
  90
  91         temp = htonl( ad->ad_eid[ eid ].ade_len );
  92         memcpy(buf, &temp, sizeof( temp ));
  93         buf += sizeof( temp );
  94         nent++;
  95     }
  96     nent = htons( nent );
  97     memcpy(nentp, &nent, sizeof( nent ));
  98
  99     return ad_getentryoff(ad, ADEID_RFORK);
 100 }
 101
 102 int ad_rebuild_adouble_header_ea(struct adouble *ad)
 103 {
 104     uint32_t       eid;
 105     uint32_t       temp;
 106     uint16_t       nent;
 107     char        *buf, *nentp;
 108     int             len;
 109
 110     LOG(log_debug, logtype_default, "ad_rebuild_adouble_header_ea");
 111
 112     buf = ad->ad_data;
 113
 114     temp = htonl( ad->ad_magic );
 115     memcpy(buf, &temp, sizeof( temp ));
 116     buf += sizeof( temp );
 117
 118     temp = htonl( ad->ad_version );
 119     memcpy(buf, &temp, sizeof( temp ));
 120     buf += sizeof( temp );
 121
 122     buf += sizeof( ad->ad_filler );
 123
 124     nentp = buf;
 125     buf += sizeof( nent );
 126     for ( eid = 0, nent = 0; eid < ADEID_MAX; eid++ ) {
 127         if ((ad->ad_eid[ eid ].ade_off == 0) || (eid == ADEID_RFORK))
 128             continue;
 129         temp = htonl( EID_DISK(eid) );
 130         memcpy(buf, &temp, sizeof( temp ));
 131         buf += sizeof( temp );
 132
 133         temp = htonl( ad->ad_eid[ eid ].ade_off );
 134         memcpy(buf, &temp, sizeof( temp ));
 135         buf += sizeof( temp );
 136
 137         temp = htonl( ad->ad_eid[ eid ].ade_len );
 138         memcpy(buf, &temp, sizeof( temp ));
 139         buf += sizeof( temp );
 140         nent++;
 141     }
 142     nent = htons( nent );
 143     memcpy(nentp, &nent, sizeof( nent ));
 144
 145     return AD_DATASZ_EA;
 146 }
 147
 148 /*!
 149  * Prepare adbuf buffer from struct adouble for writing on disk
 150  */
 151 static int ad_rebuild_adouble_header_osx(struct adouble *ad, char *adbuf)
 152 {
 153     uint32_t       temp;
 154     uint16_t       nent;
 155     char           *buf;
 156     int            len;
 157
 158     LOG(log_debug, logtype_default, "ad_rebuild_adouble_header_osx");
 159
 160     buf = &adbuf[0];
 161
 162     temp = htonl( ad->ad_magic );
 163     memcpy(buf, &temp, sizeof( temp ));
 164     buf += sizeof( temp );
 165
 166     temp = htonl( ad->ad_version );
 167     memcpy(buf, &temp, sizeof( temp ));
 168     buf += sizeof( temp );
 169
 170     buf += sizeof( ad->ad_filler );
 171
 172     nent = htons(ADEID_NUM_OSX);
 173     memcpy(buf, &nent, sizeof( nent ));
 174     buf += sizeof( nent );
 175
 176     /* FinderInfo */
 177     temp = htonl(EID_DISK(ADEID_FINDERI));
 178     memcpy(buf, &temp, sizeof( temp ));
 179     buf += sizeof( temp );
 180
 181     temp = htonl(ADEDOFF_FINDERI_OSX);
 182     memcpy(buf, &temp, sizeof( temp ));
 183     buf += sizeof( temp );
 184
 185     temp = htonl(ADEDLEN_FINDERI);
 186     memcpy(buf, &temp, sizeof( temp ));
 187     buf += sizeof( temp );
 188
 189     memcpy(adbuf + ADEDOFF_FINDERI_OSX, ad_entry(ad, ADEID_FINDERI), ADEDLEN_FINDERI);
 190
 191     /* rfork */
 192     temp = htonl( EID_DISK(ADEID_RFORK) );
 193     memcpy(buf, &temp, sizeof( temp ));
 194     buf += sizeof( temp );
 195
 196     temp = htonl(ADEDOFF_RFORK_OSX);
 197     memcpy(buf, &temp, sizeof( temp ));
 198     buf += sizeof( temp );
 199
 200     temp = htonl( ad->ad_rlen);
 201     memcpy(buf, &temp, sizeof( temp ));
 202     buf += sizeof( temp );
 203
 204     return AD_DATASZ_OSX;
 205 }
 206
 207 /* -------------------
 208  * XXX copy only header with same size or comment
 209  * doesn't work well for adouble with different version.
 210  *
 211  */
 212 int ad_copy_header(struct adouble *add, struct adouble *ads)
 213 {
 214     uint32_t       eid;
 215     uint32_t       len;
 216
 217     for ( eid = 0; eid < ADEID_MAX; eid++ ) {
 218         if ( ads->ad_eid[ eid ].ade_off == 0 || add->ad_eid[ eid ].ade_off == 0 )
 219             continue;
 220
 221         len = ads->ad_eid[ eid ].ade_len;
 222         if (!len || len != add->ad_eid[ eid ].ade_len)
 223             continue;
 224
 225         switch (eid) {
 226         case ADEID_COMMENT:
 227         case ADEID_PRIVDEV:
 228         case ADEID_PRIVINO:
 229         case ADEID_PRIVSYN:
 230         case ADEID_PRIVID:
 231             continue;
 232         default:
 233             ad_setentrylen( add, eid, len );
 234             memcpy( ad_entry( add, eid ), ad_entry( ads, eid ), len );
 235         }
 236     }
 237     add->ad_rlen = ads->ad_rlen;
 238
 239     if ((ads->ad_vers == AD_VERSION2) && (add->ad_vers = AD_VERSION_EA)
 240         || (ads->ad_vers == AD_VERSION_EA) && (add->ad_vers = AD_VERSION2)) {
 241         cnid_t id;
 242         memcpy(&id, ad_entry(add, ADEID_PRIVID), sizeof(cnid_t));
 243         id = htonl(id);
 244         memcpy(ad_entry(add, ADEID_PRIVID), &id, sizeof(cnid_t));
 245     }
 246     return 0;
 247 }
 248
 249 static int ad_flush_hf(struct adouble *ad)
 250 {
 251     EC_INIT;
 252     int len;
 253     int cwd = -1;
 254
 255     LOG(log_debug, logtype_default, "ad_flush_hf(%s)", adflags2logstr(ad->ad_adflags));
 256
 257     struct ad_fd *adf;
 258
 259     switch (ad->ad_vers) {
 260     case AD_VERSION2:
 261         adf = ad->ad_mdp;
 262         break;
 263     case AD_VERSION_EA:
 264         adf = &ad->ad_data_fork;
 265         break;
 266     default:
 267         LOG(log_error, logtype_afpd, "ad_flush: unexpected adouble version");
 268         return -1;
 269     }
 270
 271     if ((adf->adf_flags & O_RDWR)
 272         || ((ad->ad_adflags & ADFLAGS_DIR) && (ad->ad_adflags & ADFLAGS_RDWR))) {
 273         if (ad_getentryoff(ad, ADEID_RFORK)) {
 274             if (ad->ad_rlen > 0xffffffff)
 275                 ad_setentrylen(ad, ADEID_RFORK, 0xffffffff);
 276             else
 277                 ad_setentrylen(ad, ADEID_RFORK, ad->ad_rlen);
 278         }
 279         len = ad->ad_ops->ad_rebuild_header(ad);
 280
 281         switch (ad->ad_vers) {
 282         case AD_VERSION2:
 283             if (adf_pwrite(ad->ad_mdp, ad->ad_data, len, 0) != len) {
 284                 if (errno == 0)
 285                     errno = EIO;
 286                 return( -1 );
 287             }
 288             break;
 289         case AD_VERSION_EA:
 290             if (AD_META_OPEN(ad)) {
 291                 if (ad->ad_adflags & ADFLAGS_DIR) {
 292                     EC_NEG1_LOG( cwd = open(".", O_RDONLY) );
 293                     EC_NEG1_LOG( fchdir(ad_data_fileno(ad)) );
 294                     EC_ZERO_LOG( sys_lsetxattr(".", AD_EA_META, ad->ad_data, AD_DATASZ_EA, 0) );
 295                     EC_NEG1_LOG( fchdir(cwd) );
 296                     EC_NEG1_LOG( close(cwd) );
 297                     cwd = -1;
 298                 } else {
 299                     EC_ZERO_LOG( sys_fsetxattr(ad_data_fileno(ad), AD_EA_META, ad->ad_data, AD_DATASZ_EA, 0) );
 300                 }
 301             }
 302             break;
 303         default:
 304             LOG(log_error, logtype_afpd, "ad_flush: unexpected adouble version");
 305             return -1;
 306         }
 307     }
 308
 309 EC_CLEANUP:
 310     if (cwd != -1) {
 311         if (fchdir(cwd) != 0) {
 312             AFP_PANIC("ad_flush: cant fchdir");
 313         }
 314         close(cwd);
 315     }
 316     EC_EXIT;
 317 }
 318
 319 /* Flush resofork adouble file if any (currently adouble:ea and #ifndef HAVE_EAFD eg Linux) */
 320 static int ad_flush_rf(struct adouble *ad)
 321 {
 322     ssize_t len;
 323     char    adbuf[AD_DATASZ_OSX];
 324
 325 #ifdef HAVE_EAFD
 326     return 0;
 327 #endif
 328     if (ad->ad_vers != AD_VERSION_EA)
 329         return 0;
 330
 331     LOG(log_debug, logtype_default, "ad_flush_rf(%s)", adflags2logstr(ad->ad_adflags));
 332
 333     if ((ad->ad_rfp->adf_flags & O_RDWR)) {
 334         if (ad_getentryoff(ad, ADEID_RFORK)) {
 335             if (ad->ad_rlen > 0xffffffff)
 336                 ad_setentrylen(ad, ADEID_RFORK, 0xffffffff);
 337             else
 338                 ad_setentrylen(ad, ADEID_RFORK, ad->ad_rlen);
 339         }
 340         len = ad_rebuild_adouble_header_osx(ad, &adbuf[0]);
 341
 342         if (adf_pwrite(ad->ad_rfp, adbuf, len, 0) != len) {
 343             if (errno == 0)
 344                 errno = EIO;
 345             return -1;
 346         }
 347     }
 348     return 0;
 349 }
 350
 351 int ad_flush(struct adouble *ad)
 352 {
 353     EC_INIT;
 354
 355     LOG(log_debug, logtype_default, "ad_flush(%s)", adflags2logstr(ad->ad_adflags));
 356
 357     if (AD_META_OPEN(ad)) {
 358         EC_ZERO( ad_flush_hf(ad) );
 359     }
 360
 361     if (AD_RSRC_OPEN(ad)) {
 362         EC_ZERO( ad_flush_rf(ad) );
 363     }
 364
 365 EC_CLEANUP:
 366     EC_EXIT;
 367 }
 368
 369 static int ad_data_closefd(struct adouble *ad)
 370 {
 371     int ret = 0;
 372
 373     if (ad_data_fileno(ad) == -2) {
 374         free(ad->ad_data_fork.adf_syml);
 375         ad->ad_data_fork.adf_syml = NULL;
 376     } else {
 377         if (close(ad_data_fileno(ad)) < 0)
 378             ret = -1;
 379     }
 380     ad_data_fileno(ad) = -1;
 381     return ret;
 382 }
 383
 384 /*!
 385  * Close a struct adouble freeing all resources
 386  */
 387 int ad_close(struct adouble *ad, int adflags)
 388 {
 389     int err = 0;
 390
 391     if (ad == NULL)
 392         return err;
 393
 394     LOG(log_debug, logtype_default,
 395         "ad_close(%s): BEGIN [dfd: %d (ref: %d), mfd: %d (ref: %d), rfd: %d (ref: %d)]",
 396         adflags2logstr(adflags),
 397         ad_data_fileno(ad), ad->ad_data_fork.adf_refcount,
 398         ad_meta_fileno(ad), ad->ad_mdp->adf_refcount,
 399         ad_reso_fileno(ad), ad->ad_rfp->adf_refcount);
 400
 401     if (adflags & (ADFLAGS_SETSHRMD | ADFLAGS_CHECK_OF)) {
 402         /* sharemode locks are stored in the data fork, adouble:v2 needs this extra handling */
 403         adflags |= ADFLAGS_DF;
 404     }
 405
 406     if ((ad->ad_vers == AD_VERSION2) && (adflags & ADFLAGS_RF))
 407         adflags |= ADFLAGS_HF;
 408
 409     if ((adflags & ADFLAGS_DF)
 410         && (ad_data_fileno(ad) >= 0 || ad_data_fileno(ad) == -2) /* -2 means symlink */
 411         && --ad->ad_data_fork.adf_refcount == 0) {
 412         if (ad_data_closefd(ad) < 0)
 413             err = -1;
 414         adf_lock_free(&ad->ad_data_fork);
 415     }
 416
 417     if ((adflags & ADFLAGS_HF)
 418         && (ad_meta_fileno(ad) != -1) && !(--ad->ad_mdp->adf_refcount)) {
 419         if (close( ad_meta_fileno(ad)) < 0)
 420             err = -1;
 421         ad_meta_fileno(ad) = -1;
 422         if (ad->ad_vers == AD_VERSION2)
 423             adf_lock_free(ad->ad_mdp);
 424     }
 425
 426     if ((adflags & ADFLAGS_RF) && (ad->ad_vers == AD_VERSION_EA)) {
 427         if ((ad_reso_fileno(ad) != -1)
 428             && !(--ad->ad_rfp->adf_refcount)) {
 429             if (close(ad->ad_rfp->adf_fd) < 0)
 430                 err = -1;
 431             ad->ad_rlen = 0;
 432             ad_reso_fileno(ad) = -1;
 433             adf_lock_free(ad->ad_rfp);
 434         }
 435     }
 436
 437     LOG(log_debug, logtype_default,
 438         "ad_close(%s): END: %d [dfd: %d (ref: %d), mfd: %d (ref: %d), rfd: %d (ref: %d)]",
 439         adflags2logstr(adflags), err,
 440         ad_data_fileno(ad), ad->ad_data_fork.adf_refcount,
 441         ad_meta_fileno(ad), ad->ad_mdp->adf_refcount,
 442         ad_reso_fileno(ad), ad->ad_rfp->adf_refcount);
 443
 444     return err;
 445 }