fs/adfs/dir_f.c

   1 /*
   2  *  linux/fs/adfs/dir_f.c
   3  *
   4  * Copyright (C) 1997-1999 Russell King
   5  *
   6  * This program is free software; you can redistribute it and/or modify
   7  * it under the terms of the GNU General Public License version 2 as
   8  * published by the Free Software Foundation.
   9  *
  10  *  E and F format directory handling
  11  */
  12 #include <linux/errno.h>
  13 #include <linux/fs.h>
  14 #include <linux/adfs_fs.h>
  15 #include <linux/time.h>
  16 #include <linux/stat.h>
  17 #include <linux/spinlock.h>
  18 #include <linux/buffer_head.h>
  19 #include <linux/string.h>
  20
  21 #include "adfs.h"
  22 #include "dir_f.h"
  23
  24 static void adfs_f_free(struct adfs_dir *dir);
  25
  26 /*
  27  * Read an (unaligned) value of length 1..4 bytes
  28  */
  29 static inline unsigned int adfs_readval(unsigned char *p, int len)
  30 {
  31         unsigned int val = 0;
  32
  33         switch (len) {
  34         case 4:         val |= p[3] << 24;
  35         case 3:         val |= p[2] << 16;
  36         case 2:         val |= p[1] << 8;
  37         default:        val |= p[0];
  38         }
  39         return val;
  40 }
  41
  42 static inline void adfs_writeval(unsigned char *p, int len, unsigned int val)
  43 {
  44         switch (len) {
  45         case 4:         p[3] = val >> 24;
  46         case 3:         p[2] = val >> 16;
  47         case 2:         p[1] = val >> 8;
  48         default:        p[0] = val;
  49         }
  50 }
  51
  52 static inline int adfs_readname(char *buf, char *ptr, int maxlen)
  53 {
  54         char *old_buf = buf;
  55
  56         while (*ptr >= ' ' && maxlen--) {
  57                 if (*ptr == '/')
  58                         *buf++ = '.';
  59                 else
  60                         *buf++ = *ptr;
  61                 ptr++;
  62         }
  63         *buf = '\0';
  64
  65         return buf - old_buf;
  66 }
  67
  68 static inline void adfs_writename(char *to, char *from, int maxlen)
  69 {
  70         int i;
  71
  72         for (i = 0; i < maxlen; i++) {
  73                 if (from[i] == '\0')
  74                         break;
  75                 if (from[i] == '.')
  76                         to[i] = '/';
  77                 else
  78                         to[i] = from[i];
  79         }
  80
  81         for (; i < maxlen; i++)
  82                 to[i] = '\0';
  83 }
  84
  85 #define ror13(v) ((v >> 13) | (v << 19))
  86
  87 #define dir_u8(idx)                             \
  88         ({ int _buf = idx >> blocksize_bits;    \
  89            int _off = idx - (_buf << blocksize_bits);\
  90           *(u8 *)(bh[_buf]->b_data + _off);     \
  91         })
  92
  93 #define dir_u32(idx)                            \
  94         ({ int _buf = idx >> blocksize_bits;    \
  95            int _off = idx - (_buf << blocksize_bits);\
  96           *(u32 *)(bh[_buf]->b_data + _off);    \
  97         })
  98
  99 #define bufoff(_bh,_idx)                        \
 100         ({ int _buf = _idx >> blocksize_bits;   \
 101            int _off = _idx - (_buf << blocksize_bits);\
 102           (u8 *)(_bh[_buf]->b_data + _off);     \
 103         })
 104
 105 /*
 106  * There are some algorithms that are nice in
 107  * assembler, but a bitch in C...  This is one
 108  * of them.
 109  */
 110 static u8
 111 adfs_dir_checkbyte(const struct adfs_dir *dir)
 112 {
 113         struct buffer_head * const *bh = dir->bh;
 114         const int blocksize_bits = dir->sb->s_blocksize_bits;
 115         union { u32 *ptr32; u8 *ptr8; } ptr, end;
 116         u32 dircheck = 0;
 117         int last = 5 - 26;
 118         int i = 0;
 119
 120         /*
 121          * Accumulate each word up to the last whole
 122          * word of the last directory entry.  This
 123          * can spread across several buffer heads.
 124          */
 125         do {
 126                 last += 26;
 127                 do {
 128                         dircheck = cpu_to_le32(dir_u32(i)) ^ ror13(dircheck);
 129
 130                         i += sizeof(u32);
 131                 } while (i < (last & ~3));
 132         } while (dir_u8(last) != 0);
 133
 134         /*
 135          * Accumulate the last few bytes.  These
 136          * bytes will be within the same bh.
 137          */
 138         if (i != last) {
 139                 ptr.ptr8 = bufoff(bh, i);
 140                 end.ptr8 = ptr.ptr8 + last - i;
 141
 142                 do
 143                         dircheck = *ptr.ptr8++ ^ ror13(dircheck);
 144                 while (ptr.ptr8 < end.ptr8);
 145         }
 146
 147         /*
 148          * The directory tail is in the final bh
 149          * Note that contary to the RISC OS PRMs,
 150          * the first few bytes are NOT included
 151          * in the check.  All bytes are in the
 152          * same bh.
 153          */
 154         ptr.ptr8 = bufoff(bh, 2008);
 155         end.ptr8 = ptr.ptr8 + 36;
 156
 157         do {
 158                 unsigned int v = *ptr.ptr32++;
 159                 dircheck = cpu_to_le32(v) ^ ror13(dircheck);
 160         } while (ptr.ptr32 < end.ptr32);
 161
 162         return (dircheck ^ (dircheck >> 8) ^ (dircheck >> 16) ^ (dircheck >> 24)) & 0xff;
 163 }
 164
 165 /*
 166  * Read and check that a directory is valid
 167  */
 168 int
 169 adfs_dir_read(struct super_block *sb, unsigned long object_id,
 170               unsigned int size, struct adfs_dir *dir)
 171 {
 172         const unsigned int blocksize_bits = sb->s_blocksize_bits;
 173         int blk = 0;
 174
 175         /*
 176          * Directories which are not a multiple of 2048 bytes
 177          * are considered bad v2 [3.6]
 178          */
 179         if (size & 2047)
 180                 goto bad_dir;
 181
 182         size >>= blocksize_bits;
 183
 184         dir->nr_buffers = 0;
 185         dir->sb = sb;
 186
 187         for (blk = 0; blk < size; blk++) {
 188                 int phys;
 189
 190                 phys = __adfs_block_map(sb, object_id, blk);
 191                 if (!phys) {
 192                         adfs_error(sb, "dir object %lX has a hole at offset %d",
 193                                    object_id, blk);
 194                         goto release_buffers;
 195                 }
 196
 197                 dir->bh[blk] = sb_bread(sb, phys);
 198                 if (!dir->bh[blk])
 199                         goto release_buffers;
 200         }
 201
 202         memcpy(&dir->dirhead, bufoff(dir->bh, 0), sizeof(dir->dirhead));
 203         memcpy(&dir->dirtail, bufoff(dir->bh, 2007), sizeof(dir->dirtail));
 204
 205         if (dir->dirhead.startmasseq != dir->dirtail.new.endmasseq ||
 206             memcmp(&dir->dirhead.startname, &dir->dirtail.new.endname, 4))
 207                 goto bad_dir;
 208
 209         if (memcmp(&dir->dirhead.startname, "Nick", 4) &&
 210             memcmp(&dir->dirhead.startname, "Hugo", 4))
 211                 goto bad_dir;
 212
 213         if (adfs_dir_checkbyte(dir) != dir->dirtail.new.dircheckbyte)
 214                 goto bad_dir;
 215
 216         dir->nr_buffers = blk;
 217
 218         return 0;
 219
 220 bad_dir:
 221         adfs_error(sb, "corrupted directory fragment %lX",
 222                    object_id);
 223 release_buffers:
 224         for (blk -= 1; blk >= 0; blk -= 1)
 225                 brelse(dir->bh[blk]);
 226
 227         dir->sb = NULL;
 228
 229         return -EIO;
 230 }
 231
 232 /*
 233  * convert a disk-based directory entry to a Linux ADFS directory entry
 234  */
 235 static inline void
 236 adfs_dir2obj(struct object_info *obj, struct adfs_direntry *de)
 237 {
 238         obj->name_len = adfs_readname(obj->name, de->dirobname, ADFS_F_NAME_LEN);
 239         obj->file_id  = adfs_readval(de->dirinddiscadd, 3);
 240         obj->loadaddr = adfs_readval(de->dirload, 4);
 241         obj->execaddr = adfs_readval(de->direxec, 4);
 242         obj->size     = adfs_readval(de->dirlen,  4);
 243         obj->attr     = de->newdiratts;
 244 }
 245
 246 /*
 247  * convert a Linux ADFS directory entry to a disk-based directory entry
 248  */
 249 static inline void
 250 adfs_obj2dir(struct adfs_direntry *de, struct object_info *obj)
 251 {
 252         adfs_writeval(de->dirinddiscadd, 3, obj->file_id);
 253         adfs_writeval(de->dirload, 4, obj->loadaddr);
 254         adfs_writeval(de->direxec, 4, obj->execaddr);
 255         adfs_writeval(de->dirlen,  4, obj->size);
 256         de->newdiratts = obj->attr;
 257 }
 258
 259 /*
 260  * get a directory entry.  Note that the caller is responsible
 261  * for holding the relevant locks.
 262  */
 263 int
 264 __adfs_dir_get(struct adfs_dir *dir, int pos, struct object_info *obj)
 265 {
 266         struct super_block *sb = dir->sb;
 267         struct adfs_direntry de;
 268         int thissize, buffer, offset;
 269
 270         buffer = pos >> sb->s_blocksize_bits;
 271
 272         if (buffer > dir->nr_buffers)
 273                 return -EINVAL;
 274
 275         offset = pos & (sb->s_blocksize - 1);
 276         thissize = sb->s_blocksize - offset;
 277         if (thissize > 26)
 278                 thissize = 26;
 279
 280         memcpy(&de, dir->bh[buffer]->b_data + offset, thissize);
 281         if (thissize != 26)
 282                 memcpy(((char *)&de) + thissize, dir->bh[buffer + 1]->b_data,
 283                        26 - thissize);
 284
 285         if (!de.dirobname[0])
 286                 return -ENOENT;
 287
 288         adfs_dir2obj(obj, &de);
 289
 290         return 0;
 291 }
 292
 293 int
 294 __adfs_dir_put(struct adfs_dir *dir, int pos, struct object_info *obj)
 295 {
 296         struct super_block *sb = dir->sb;
 297         struct adfs_direntry de;
 298         int thissize, buffer, offset;
 299
 300         buffer = pos >> sb->s_blocksize_bits;
 301
 302         if (buffer > dir->nr_buffers)
 303                 return -EINVAL;
 304
 305         offset = pos & (sb->s_blocksize - 1);
 306         thissize = sb->s_blocksize - offset;
 307         if (thissize > 26)
 308                 thissize = 26;
 309
 310         /*
 311          * Get the entry in total
 312          */
 313         memcpy(&de, dir->bh[buffer]->b_data + offset, thissize);
 314         if (thissize != 26)
 315                 memcpy(((char *)&de) + thissize, dir->bh[buffer + 1]->b_data,
 316                        26 - thissize);
 317
 318         /*
 319          * update it
 320          */
 321         adfs_obj2dir(&de, obj);
 322
 323         /*
 324          * Put the new entry back
 325          */
 326         memcpy(dir->bh[buffer]->b_data + offset, &de, thissize);
 327         if (thissize != 26)
 328                 memcpy(dir->bh[buffer + 1]->b_data, ((char *)&de) + thissize,
 329                        26 - thissize);
 330
 331         return 0;
 332 }
 333
 334 /*
 335  * the caller is responsible for holding the necessary
 336  * locks.
 337  */
 338 static int
 339 adfs_dir_find_entry(struct adfs_dir *dir, unsigned long object_id)
 340 {
 341         int pos, ret;
 342
 343         ret = -ENOENT;
 344
 345         for (pos = 5; pos < ADFS_NUM_DIR_ENTRIES * 26 + 5; pos += 26) {
 346                 struct object_info obj;
 347
 348                 if (!__adfs_dir_get(dir, pos, &obj))
 349                         break;
 350
 351                 if (obj.file_id == object_id) {
 352                         ret = pos;
 353                         break;
 354                 }
 355         }
 356
 357         return ret;
 358 }
 359
 360 static int
 361 adfs_f_read(struct super_block *sb, unsigned int id, unsigned int sz, struct adfs_dir *dir)
 362 {
 363         int ret;
 364
 365         if (sz != ADFS_NEWDIR_SIZE)
 366                 return -EIO;
 367
 368         ret = adfs_dir_read(sb, id, sz, dir);
 369         if (ret)
 370                 adfs_error(sb, "unable to read directory");
 371         else
 372                 dir->parent_id = adfs_readval(dir->dirtail.new.dirparent, 3);
 373
 374         return ret;
 375 }
 376
 377 static int
 378 adfs_f_setpos(struct adfs_dir *dir, unsigned int fpos)
 379 {
 380         if (fpos >= ADFS_NUM_DIR_ENTRIES)
 381                 return -ENOENT;
 382
 383         dir->pos = 5 + fpos * 26;
 384         return 0;
 385 }
 386
 387 static int
 388 adfs_f_getnext(struct adfs_dir *dir, struct object_info *obj)
 389 {
 390         unsigned int ret;
 391
 392         ret = __adfs_dir_get(dir, dir->pos, obj);
 393         if (ret == 0)
 394                 dir->pos += 26;
 395
 396         return ret;
 397 }
 398
 399 static int
 400 adfs_f_update(struct adfs_dir *dir, struct object_info *obj)
 401 {
 402         struct super_block *sb = dir->sb;
 403         int ret, i;
 404
 405         ret = adfs_dir_find_entry(dir, obj->file_id);
 406         if (ret < 0) {
 407                 adfs_error(dir->sb, "unable to locate entry to update");
 408                 goto out;
 409         }
 410
 411         __adfs_dir_put(dir, ret, obj);
 412
 413         /*
 414          * Increment directory sequence number
 415          */
 416         dir->bh[0]->b_data[0] += 1;
 417         dir->bh[dir->nr_buffers - 1]->b_data[sb->s_blocksize - 6] += 1;
 418
 419         ret = adfs_dir_checkbyte(dir);
 420         /*
 421          * Update directory check byte
 422          */
 423         dir->bh[dir->nr_buffers - 1]->b_data[sb->s_blocksize - 1] = ret;
 424
 425 #if 1
 426         {
 427         const unsigned int blocksize_bits = sb->s_blocksize_bits;
 428
 429         memcpy(&dir->dirhead, bufoff(dir->bh, 0), sizeof(dir->dirhead));
 430         memcpy(&dir->dirtail, bufoff(dir->bh, 2007), sizeof(dir->dirtail));
 431
 432         if (dir->dirhead.startmasseq != dir->dirtail.new.endmasseq ||
 433             memcmp(&dir->dirhead.startname, &dir->dirtail.new.endname, 4))
 434                 goto bad_dir;
 435
 436         if (memcmp(&dir->dirhead.startname, "Nick", 4) &&
 437             memcmp(&dir->dirhead.startname, "Hugo", 4))
 438                 goto bad_dir;
 439
 440         if (adfs_dir_checkbyte(dir) != dir->dirtail.new.dircheckbyte)
 441                 goto bad_dir;
 442         }
 443 #endif
 444         for (i = dir->nr_buffers - 1; i >= 0; i--)
 445                 mark_buffer_dirty(dir->bh[i]);
 446
 447         ret = 0;
 448 out:
 449         return ret;
 450 #if 1
 451 bad_dir:
 452         adfs_error(dir->sb, "whoops!  I broke a directory!");
 453         return -EIO;
 454 #endif
 455 }
 456
 457 static void
 458 adfs_f_free(struct adfs_dir *dir)
 459 {
 460         int i;
 461
 462         for (i = dir->nr_buffers - 1; i >= 0; i--) {
 463                 brelse(dir->bh[i]);
 464                 dir->bh[i] = NULL;
 465         }
 466
 467         dir->nr_buffers = 0;
 468         dir->sb = NULL;
 469 }
 470
 471 struct adfs_dir_ops adfs_f_dir_ops = {
 472         .read           = adfs_f_read,
 473         .setpos         = adfs_f_setpos,
 474         .getnext        = adfs_f_getnext,
 475         .update         = adfs_f_update,
 476         .free           = adfs_f_free
 477 };