bsd/sys/loadable_fs.h

   1 /*
   2  * Copyright (c) 2000-2002 Apple Computer, Inc. All rights reserved.
   3  *
   4  * @APPLE_OSREFERENCE_LICENSE_HEADER_START@
   5  *
   6  * This file contains Original Code and/or Modifications of Original Code
   7  * as defined in and that are subject to the Apple Public Source License
   8  * Version 2.0 (the 'License'). You may not use this file except in
   9  * compliance with the License. The rights granted to you under the License
  10  * may not be used to create, or enable the creation or redistribution of,
  11  * unlawful or unlicensed copies of an Apple operating system, or to
  12  * circumvent, violate, or enable the circumvention or violation of, any
  13  * terms of an Apple operating system software license agreement.
  14  *
  15  * Please obtain a copy of the License at
  16  * http://www.opensource.apple.com/apsl/ and read it before using this file.
  17  *
  18  * The Original Code and all software distributed under the License are
  19  * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
  20  * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
  21  * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
  22  * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
  23  * Please see the License for the specific language governing rights and
  24  * limitations under the License.
  25  *
  26  * @APPLE_OSREFERENCE_LICENSE_HEADER_END@
  27  */
  28 /*      @(#)loadable_fs.h       2.0     26/06/90        (c) 1990 NeXT   */
  29
  30 /* XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
  31  *
  32  * W I L L    D R A S T I C A L L Y   C H A N G E   S O O N
  33  * U S E   A T  Y O U R   O W N  R I S K
  34  *
  35  * XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX */
  36
  37
  38 /*
  39  * loadable_fs.h - message struct for loading and initializing loadable
  40  *                 file systems.
  41  */
  42
  43 #ifndef _SYS_LOADABLE_FS_
  44 #define _SYS_LOADABLE_FS_
  45
  46
  47 /*
  48  * Constants for Loadable FS Utilities (in "/System/Library/Filesystems")
  49  *
  50  * Example of a /usr/filesystems directory
  51  *
  52  * /usr/filesystems/dos.fs/dos.util             utility with which WSM
  53  *                                                      communicates
  54  * /usr/filesystems/dos.fs/dos.name             "DOS Floppy"
  55  * /usr/filesystems/dos.fs/dos_reloc            actual loadable filesystem
  56  * /usr/filesystems/dos.fs/dos.openfs.tiff      "open folder" icon
  57  * /usr/filesystems/dos.fs/dos.fs.tiff          "closed folder" icon
  58  */
  59 #define FS_DIR_LOCATION         "/System/Library/Filesystems"
  60 #define FS_DIR_SUFFIX           ".fs"
  61 #define FS_UTIL_SUFFIX          ".util"
  62 #define FS_OPEN_SUFFIX          ".openfs.tiff"
  63 #define FS_CLOSED_SUFFIX        ".fs.tiff"
  64 #define FS_NAME_SUFFIX          ".name"
  65 #define FS_LABEL_SUFFIX         ".label"
  66
  67 /*
  68  * .util program commands - all sent in the form "-p" or "-m" ... as argv[1].
  69  */
  70 #define FSUC_PROBE              'p'     /* probe FS for mount or init */
  71         /* example usage: foo.util -p fd0 removable writable */
  72
  73 #define FSUC_PROBEFORINIT       'P'     /* probe FS for init only */
  74         /* example usage: foo.util -P fd0 removable */
  75
  76 #define FSUC_MOUNT              'm'     /* mount FS */
  77         /* example usage: foo.util -m fd0 /bar removable writable */
  78
  79 #define FSUC_REPAIR             'r'     /* repair ('fsck') FS */
  80         /* example usage: foo.util -r fd0 removable */
  81
  82 #define FSUC_INITIALIZE         'i'     /* initialize FS */
  83         /* example usage: foo.util -i fd0 removable */
  84
  85 #define FSUC_UNMOUNT            'u'     /* unmount FS */
  86         /* example usage: foo.util -u fd0 /bar */
  87
  88 /* The following is not used by Workspace Manager */
  89 #define FSUC_MOUNT_FORCE        'M'     /* like FSUC_MOUNT, but proceed even on
  90                                          * error. */
  91 /*
  92  * Return codes from .util program
  93  */
  94 #define FSUR_RECOGNIZED         (-1)    /* response to FSUC_PROBE; implies that
  95                                          * a mount is possible */
  96 #define FSUR_UNRECOGNIZED       (-2)    /* negative response to FSUC_PROBE */
  97 #define FSUR_IO_SUCCESS         (-3)    /* mount, unmount, repair succeeded */
  98 #define FSUR_IO_FAIL            (-4)    /* unrecoverable I/O error */
  99 #define FSUR_IO_UNCLEAN         (-5)    /* mount failed, file system not clean
 100                                          */
 101 #define FSUR_INVAL              (-6)    /* invalid argument */
 102 #define FSUR_LOADERR            (-7)    /* kern_loader error */
 103 #define FSUR_INITRECOGNIZED     (-8)    /* response to FSUC_PROBE or
 104                                          * FSUC_PROBEFORINIT, implies that
 105                                          * initialization is possible */
 106
 107 /*
 108  *      mount parameters passed from WSM to the .util program.
 109  */
 110 #define DEVICE_READONLY         "readonly"
 111 #define DEVICE_WRITABLE         "writable"
 112
 113 #define DEVICE_REMOVABLE        "removable"
 114 #define DEVICE_FIXED            "fixed"
 115
 116 /*
 117  *      Additional parameters to the mount command - used by WSM when they
 118  *      appear in the /etc/mtab file.
 119  */
 120 #define MNTOPT_FS               "filesystem=" /* e.g. "filesystem=DOS" */
 121 #define MNTOPT_REMOVABLE        "removable"
 122
 123 #endif  /* _SYS_LOADABLE_FS_ */