1 /* $NetBSD: hfs_subr.c,v 1.11 2008/11/16 19:34:30 pooka Exp $ */ 2 3 /*- 4 * Copyright (c) 2005, 2007 The NetBSD Foundation, Inc. 5 * All rights reserved. 6 * 7 * This code is derived from software contributed to The NetBSD Foundation 8 * by Yevgeny Binder and Dieter Baron. 9 * 10 * Redistribution and use in source and binary forms, with or without 11 * modification, are permitted provided that the following conditions 12 * are met: 13 * 1. Redistributions of source code must retain the above copyright 14 * notice, this list of conditions and the following disclaimer. 15 * 2. Redistributions in binary form must reproduce the above copyright 16 * notice, this list of conditions and the following disclaimer in the 17 * documentation and/or other materials provided with the distribution. 18 * 19 * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS 20 * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED 21 * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 22 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS 23 * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR 24 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF 25 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS 26 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN 27 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) 28 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE 29 * POSSIBILITY OF SUCH DAMAGE. 30 */ 31 32 #include <sys/cdefs.h> 33 __KERNEL_RCSID(0, "$NetBSD: hfs_subr.c,v 1.11 2008/11/16 19:34:30 pooka Exp $"); 34 35 #include <sys/param.h> 36 #include <sys/systm.h> 37 #include <sys/time.h> 38 #include <sys/kernel.h> 39 #include <sys/proc.h> 40 #include <sys/vnode.h> 41 #include <sys/malloc.h> 42 #include <sys/stat.h> 43 #include <sys/file.h> 44 #include <sys/filedesc.h> 45 #include <sys/mount.h> 46 #include <sys/disklabel.h> 47 #include <sys/conf.h> 48 #include <sys/kauth.h> 49 #include <sys/buf.h> 50 51 #include <fs/hfs/hfs.h> 52 53 #include <miscfs/specfs/specdev.h> 54 55 /* 56 * Initialize the vnode associated with a new hfsnode. 57 */ 58 void 59 hfs_vinit(struct mount *mp, int (**specops)(void *), int (**fifoops)(void *), 60 struct vnode **vpp) 61 { 62 struct hfsnode *hp; 63 struct vnode *vp; 64 65 vp = *vpp; 66 hp = VTOH(vp); 67 68 vp->v_type = hfs_catalog_keyed_record_vtype( 69 (hfs_catalog_keyed_record_t *)&hp->h_rec); 70 71 switch(vp->v_type) { 72 case VCHR: 73 case VBLK: 74 vp->v_op = specops; 75 spec_node_init(vp, 76 HFS_CONVERT_RDEV(hp->h_rec.file.bsd.special.raw_device)); 77 break; 78 case VFIFO: 79 vp->v_op = fifoops; 80 break; 81 82 case VNON: 83 case VBAD: 84 case VSOCK: 85 case VDIR: 86 case VREG: 87 case VLNK: 88 break; 89 } 90 91 if (hp->h_rec.u.cnid == HFS_CNID_ROOT_FOLDER) 92 vp->v_vflag |= VV_ROOT; 93 94 *vpp = vp; 95 } 96 97 /* 98 * Callbacks for libhfs 99 */ 100 101 void 102 hfs_libcb_error( 103 const char* format, 104 const char* file, 105 int line, 106 va_list args) 107 { 108 #ifdef HFS_DEBUG 109 if (file != NULL) 110 printf("%s:%i: ", file, line); 111 else 112 printf("hfs: "); 113 #else 114 printf("hfs: "); 115 #endif 116 117 /* XXX Should we really display this if debugging is off? */ 118 vprintf(format, args); 119 printf("\n"); 120 } 121 122 /* XXX change malloc/realloc/free to use pools */ 123 124 void* 125 hfs_libcb_malloc(size_t size, hfs_callback_args* cbargs) 126 { 127 return malloc(size, /*M_HFSMNT*/ M_TEMP, M_WAITOK); 128 } 129 130 void* 131 hfs_libcb_realloc(void* ptr, size_t size, hfs_callback_args* cbargs) 132 { 133 return realloc(ptr, size, /*M_HFSMNT*/ M_TEMP, M_WAITOK); 134 } 135 136 void 137 hfs_libcb_free(void* ptr, hfs_callback_args* cbargs) 138 { 139 free(ptr, /*M_HFSMNT*/ M_TEMP); 140 } 141 142 /* 143 * hfs_libcb_opendev() 144 * 145 * hfslib uses this callback to open a volume's device node by name. However, 146 * by the time this is called here, the device node has already been opened by 147 * VFS. So we are passed the vnode to this volume's block device and use that 148 * instead of the device's name. 149 */ 150 int 151 hfs_libcb_opendev( 152 hfs_volume* vol, 153 const char* devname, 154 hfs_callback_args* cbargs) 155 { 156 hfs_libcb_data* cbdata = NULL; 157 hfs_libcb_argsopen* args; 158 struct partinfo dpart; 159 int result; 160 161 result = 0; 162 args = (hfs_libcb_argsopen*)(cbargs->openvol); 163 164 if (vol == NULL || devname == NULL) { 165 result = EINVAL; 166 goto error; 167 } 168 169 cbdata = malloc(sizeof(hfs_libcb_data), M_HFSMNT, M_WAITOK); 170 if (cbdata == NULL) { 171 result = ENOMEM; 172 goto error; 173 } 174 vol->cbdata = cbdata; 175 176 cbdata->devvp = NULL; 177 178 /* Open the device node. */ 179 if ((result = VOP_OPEN(args->devvp, vol->readonly? FREAD : FREAD|FWRITE, 180 FSCRED)) != 0) 181 goto error; 182 183 /* Flush out any old buffers remaining from a previous use. */ 184 vn_lock(args->devvp, LK_EXCLUSIVE | LK_RETRY); 185 result = vinvalbuf(args->devvp, V_SAVE, args->cred, args->l, 0, 0); 186 VOP_UNLOCK(args->devvp, 0); 187 if (result != 0) 188 goto error; 189 190 cbdata->devvp = args->devvp; 191 192 /* Determine the device's block size. Default to DEV_BSIZE if unavailable.*/ 193 if (VOP_IOCTL(args->devvp, DIOCGPART, &dpart, FREAD, args->cred) 194 != 0) 195 cbdata->devblksz = DEV_BSIZE; 196 else 197 cbdata->devblksz = dpart.disklab->d_secsize; 198 199 return 0; 200 201 error: 202 if (cbdata != NULL) { 203 if (cbdata->devvp != NULL) { 204 vn_lock(cbdata->devvp, LK_EXCLUSIVE | LK_RETRY); 205 (void)VOP_CLOSE(cbdata->devvp, vol->readonly ? FREAD : 206 FREAD | FWRITE, NOCRED); 207 VOP_UNLOCK(cbdata->devvp, 0); 208 } 209 free(cbdata, M_HFSMNT); 210 vol->cbdata = NULL; 211 } 212 213 return result; 214 } 215 216 void 217 hfs_libcb_closedev(hfs_volume* in_vol, hfs_callback_args* cbargs) 218 { 219 struct vnode *devvp; 220 221 if (in_vol == NULL) 222 return; 223 224 if (in_vol->cbdata != NULL) { 225 devvp = ((hfs_libcb_data*)in_vol->cbdata)->devvp; 226 if (devvp != NULL) { 227 vn_lock(devvp, LK_EXCLUSIVE | LK_RETRY); 228 (void)VOP_CLOSE(devvp, 229 in_vol->readonly ? FREAD : FREAD | FWRITE, NOCRED); 230 /* XXX do we need a VOP_UNLOCK() here? */ 231 } 232 233 free(in_vol->cbdata, M_HFSMNT); 234 in_vol->cbdata = NULL; 235 } 236 } 237 238 int 239 hfs_libcb_read( 240 hfs_volume* vol, 241 void* outbytes, 242 uint64_t length, 243 uint64_t offset, 244 hfs_callback_args* cbargs) 245 { 246 hfs_libcb_data *cbdata; 247 hfs_libcb_argsread* argsread; 248 kauth_cred_t cred; 249 uint64_t physoffset; /* physical offset from start of device(?) */ 250 251 if (vol == NULL || outbytes == NULL) 252 return -1; 253 254 cbdata = (hfs_libcb_data*)vol->cbdata; 255 256 if (cbargs != NULL 257 && (argsread = (hfs_libcb_argsread*)cbargs->read) != NULL 258 && argsread->cred != NULL) 259 cred = argsread->cred; 260 else 261 cred = NOCRED; 262 263 /* 264 * Since bread() only reads data in terms of integral blocks, it may have 265 * read some data before and/or after our desired offset & length. So when 266 * copying that data into the outgoing buffer, start at the actual desired 267 * offset and only copy the desired length. 268 */ 269 physoffset = offset + vol->offset; 270 271 return hfs_pread(cbdata->devvp, outbytes, cbdata->devblksz, physoffset, 272 length, cred); 273 } 274 275 /* 276 * So it turns out that bread() is pretty shoddy. It not only requires the size 277 * parameter to be an integral multiple of the device's block size, but also 278 * requires the block number to be on a boundary of that same block size -- and 279 * yet be given as an integral multiple of DEV_BSIZE! So after much toil and 280 * bloodshed, hfs_pread() was written as a convenience (and a model of how sane 281 * people take their bread()). Returns 0 on success. 282 */ 283 int 284 hfs_pread(struct vnode *vp, void *buf, size_t secsz, uint64_t off, 285 uint64_t len, kauth_cred_t cred) 286 { 287 struct buf *bp; 288 uint64_t curoff; /* relative to 'start' variable */ 289 uint64_t start; 290 int error; 291 292 if (vp == NULL || buf == NULL) 293 return EINVAL; 294 295 if (len == 0) 296 return 0; 297 298 curoff = 0; 299 error = 0; 300 301 /* align offset to highest preceding sector boundary */ 302 #define ABSZ(x, bsz) (((x)/(bsz))*(bsz)) 303 304 /* round size up to integral # of block sizes */ 305 #define RBSZ(x, bsz) (((x) + (bsz) - 1) & ~((bsz) - 1)) 306 307 start = ABSZ(off, secsz); 308 while (start + curoff < off + len) 309 { 310 bp = NULL; 311 312 /* XXX Does the algorithm always do what's intended here when 313 * XXX start != off? Need to test this. */ 314 315 error = bread(vp, (start + curoff) / DEV_BSIZE,/* no rounding involved*/ 316 RBSZ(min(len - curoff + (off - start), MAXBSIZE), secsz), 317 cred, 0, &bp); 318 319 if (error == 0) 320 memcpy((uint8_t*)buf + curoff, (uint8_t*)bp->b_data + 321 (off - start), min(len - curoff, MAXBSIZE - (off - start))); 322 323 if (bp != NULL) 324 brelse(bp, 0); 325 if (error != 0) 326 return error; 327 328 curoff += MAXBSIZE; 329 } 330 #undef ABSZ 331 #undef RBSZ 332 333 return 0; 334 } 335 336 /* XXX Provide a routine to take a catalog record and return its proper BSD file 337 * XXX or directory mode value */ 338 339 340 /* Convert from HFS+ time representation to UNIX time since epoch. */ 341 void 342 hfs_time_to_timespec(uint32_t hfstime, struct timespec *unixtime) 343 { 344 /* 345 * HFS+ time is calculated in seconds since midnight, Jan 1st, 1904. 346 * struct timespec counts from midnight, Jan 1st, 1970. Thus, there is 347 * precisely a 66 year difference between them, which is equal to 348 * 2,082,844,800 seconds. No, I didn't count them by hand. 349 */ 350 351 if (hfstime < 2082844800) 352 unixtime->tv_sec = 0; /* dates before 1970 are bs anyway, so use epoch*/ 353 else 354 unixtime->tv_sec = hfstime - 2082844800; 355 356 unixtime->tv_nsec = 0; /* we don't have nanosecond resolution */ 357 } 358 359 /* 360 * Endian conversion with automatic pointer incrementation. 361 */ 362 363 uint16_t be16tohp(void** inout_ptr) 364 { 365 uint16_t result; 366 uint16_t *ptr; 367 368 if(inout_ptr==NULL) 369 return 0; 370 371 ptr = *inout_ptr; 372 373 result = be16toh(*ptr); 374 375 ptr++; 376 *inout_ptr = ptr; 377 378 return result; 379 } 380 381 uint32_t be32tohp(void** inout_ptr) 382 { 383 uint32_t result; 384 uint32_t *ptr; 385 386 if(inout_ptr==NULL) 387 return 0; 388 389 ptr = *inout_ptr; 390 391 result = be32toh(*ptr); 392 393 ptr++; 394 *inout_ptr = ptr; 395 396 return result; 397 } 398 399 uint64_t be64tohp(void** inout_ptr) 400 { 401 uint64_t result; 402 uint64_t *ptr; 403 404 if(inout_ptr==NULL) 405 return 0; 406 407 ptr = *inout_ptr; 408 409 result = be64toh(*ptr); 410 411 ptr++; 412 *inout_ptr = ptr; 413 414 return result; 415 } 416 417 enum vtype 418 hfs_catalog_keyed_record_vtype(const hfs_catalog_keyed_record_t *rec) 419 { 420 if (rec->type == HFS_REC_FILE) { 421 uint32_t mode; 422 423 mode = ((const hfs_file_record_t *)rec)->bsd.file_mode; 424 if (mode != 0) 425 return IFTOVT(mode); 426 else 427 return VREG; 428 } 429 else 430 return VDIR; 431 } 432