feedc0de/gcfuse
1
0
Fork 0
forked from multimediamike/gcfuse
Code Pull Requests Activity

initial import of 0.9.1 source code, plus an autogen.sh script

Browse Source
This commit is contained in:
Mike Melanson
2012-02-11 18:10:20 -08:00
commit 6f33d34715
16 changed files with 1785 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
AUTHORS Normal file
View File

@ -0,0 +1,4 @@
Mike Melanson <mike at multimedia.cx>
based on Fusepak by:
Janusz Dziemidowicz <rraptorr@nails.eu.org>

340
COPYING Normal file
View File

@ -0,0 +1,340 @@
GNU GENERAL PUBLIC LICENSE
Version 2, June 1991
Copyright (C) 1989, 1991 Free Software Foundation, Inc.
59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
Everyone is permitted to copy and distribute verbatim copies
of this license document, but changing it is not allowed.
Preamble
The licenses for most software are designed to take away your
freedom to share and change it. By contrast, the GNU General Public
License is intended to guarantee your freedom to share and change free
software--to make sure the software is free for all its users. This
General Public License applies to most of the Free Software
Foundation's software and to any other program whose authors commit to
using it. (Some other Free Software Foundation software is covered by
the GNU Library General Public License instead.) You can apply it to
your programs, too.
When we speak of free software, we are referring to freedom, not
price. Our General Public Licenses are designed to make sure that you
have the freedom to distribute copies of free software (and charge for
this service if you wish), that you receive source code or can get it
if you want it, that you can change the software or use pieces of it
in new free programs; and that you know you can do these things.
To protect your rights, we need to make restrictions that forbid
anyone to deny you these rights or to ask you to surrender the rights.
These restrictions translate to certain responsibilities for you if you
distribute copies of the software, or if you modify it.
For example, if you distribute copies of such a program, whether
gratis or for a fee, you must give the recipients all the rights that
you have. You must make sure that they, too, receive or can get the
source code. And you must show them these terms so they know their
rights.
We protect your rights with two steps: (1) copyright the software, and
(2) offer you this license which gives you legal permission to copy,
distribute and/or modify the software.
Also, for each author's protection and ours, we want to make certain
that everyone understands that there is no warranty for this free
software. If the software is modified by someone else and passed on, we
want its recipients to know that what they have is not the original, so
that any problems introduced by others will not reflect on the original
authors' reputations.
Finally, any free program is threatened constantly by software
patents. We wish to avoid the danger that redistributors of a free
program will individually obtain patent licenses, in effect making the
program proprietary. To prevent this, we have made it clear that any
patent must be licensed for everyone's free use or not licensed at all.
The precise terms and conditions for copying, distribution and
modification follow.
GNU GENERAL PUBLIC LICENSE
TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION
0. This License applies to any program or other work which contains
a notice placed by the copyright holder saying it may be distributed
under the terms of this General Public License. The "Program", below,
refers to any such program or work, and a "work based on the Program"
means either the Program or any derivative work under copyright law:
that is to say, a work containing the Program or a portion of it,
either verbatim or with modifications and/or translated into another
language. (Hereinafter, translation is included without limitation in
the term "modification".) Each licensee is addressed as "you".
Activities other than copying, distribution and modification are not
covered by this License; they are outside its scope. The act of
running the Program is not restricted, and the output from the Program
is covered only if its contents constitute a work based on the
Program (independent of having been made by running the Program).
Whether that is true depends on what the Program does.
1. You may copy and distribute verbatim copies of the Program's
source code as you receive it, in any medium, provided that you
conspicuously and appropriately publish on each copy an appropriate
copyright notice and disclaimer of warranty; keep intact all the
notices that refer to this License and to the absence of any warranty;
and give any other recipients of the Program a copy of this License
along with the Program.
You may charge a fee for the physical act of transferring a copy, and
you may at your option offer warranty protection in exchange for a fee.
2. You may modify your copy or copies of the Program or any portion
of it, thus forming a work based on the Program, and copy and
distribute such modifications or work under the terms of Section 1
above, provided that you also meet all of these conditions:
a) You must cause the modified files to carry prominent notices
stating that you changed the files and the date of any change.
b) You must cause any work that you distribute or publish, that in
whole or in part contains or is derived from the Program or any
part thereof, to be licensed as a whole at no charge to all third
parties under the terms of this License.
c) If the modified program normally reads commands interactively
when run, you must cause it, when started running for such
interactive use in the most ordinary way, to print or display an
announcement including an appropriate copyright notice and a
notice that there is no warranty (or else, saying that you provide
a warranty) and that users may redistribute the program under
these conditions, and telling the user how to view a copy of this
License. (Exception: if the Program itself is interactive but
does not normally print such an announcement, your work based on
the Program is not required to print an announcement.)
These requirements apply to the modified work as a whole. If
identifiable sections of that work are not derived from the Program,
and can be reasonably considered independent and separate works in
themselves, then this License, and its terms, do not apply to those
sections when you distribute them as separate works. But when you
distribute the same sections as part of a whole which is a work based
on the Program, the distribution of the whole must be on the terms of
this License, whose permissions for other licensees extend to the
entire whole, and thus to each and every part regardless of who wrote it.
Thus, it is not the intent of this section to claim rights or contest
your rights to work written entirely by you; rather, the intent is to
exercise the right to control the distribution of derivative or
collective works based on the Program.
In addition, mere aggregation of another work not based on the Program
with the Program (or with a work based on the Program) on a volume of
a storage or distribution medium does not bring the other work under
the scope of this License.
3. You may copy and distribute the Program (or a work based on it,
under Section 2) in object code or executable form under the terms of
Sections 1 and 2 above provided that you also do one of the following:
a) Accompany it with the complete corresponding machine-readable
source code, which must be distributed under the terms of Sections
1 and 2 above on a medium customarily used for software interchange; or,
b) Accompany it with a written offer, valid for at least three
years, to give any third party, for a charge no more than your
cost of physically performing source distribution, a complete
machine-readable copy of the corresponding source code, to be
distributed under the terms of Sections 1 and 2 above on a medium
customarily used for software interchange; or,
c) Accompany it with the information you received as to the offer
to distribute corresponding source code. (This alternative is
allowed only for noncommercial distribution and only if you
received the program in object code or executable form with such
an offer, in accord with Subsection b above.)
The source code for a work means the preferred form of the work for
making modifications to it. For an executable work, complete source
code means all the source code for all modules it contains, plus any
associated interface definition files, plus the scripts used to
control compilation and installation of the executable. However, as a
special exception, the source code distributed need not include
anything that is normally distributed (in either source or binary
form) with the major components (compiler, kernel, and so on) of the
operating system on which the executable runs, unless that component
itself accompanies the executable.
If distribution of executable or object code is made by offering
access to copy from a designated place, then offering equivalent
access to copy the source code from the same place counts as
distribution of the source code, even though third parties are not
compelled to copy the source along with the object code.
4. You may not copy, modify, sublicense, or distribute the Program
except as expressly provided under this License. Any attempt
otherwise to copy, modify, sublicense or distribute the Program is
void, and will automatically terminate your rights under this License.
However, parties who have received copies, or rights, from you under
this License will not have their licenses terminated so long as such
parties remain in full compliance.
5. You are not required to accept this License, since you have not
signed it. However, nothing else grants you permission to modify or
distribute the Program or its derivative works. These actions are
prohibited by law if you do not accept this License. Therefore, by
modifying or distributing the Program (or any work based on the
Program), you indicate your acceptance of this License to do so, and
all its terms and conditions for copying, distributing or modifying
the Program or works based on it.
6. Each time you redistribute the Program (or any work based on the
Program), the recipient automatically receives a license from the
original licensor to copy, distribute or modify the Program subject to
these terms and conditions. You may not impose any further
restrictions on the recipients' exercise of the rights granted herein.
You are not responsible for enforcing compliance by third parties to
this License.
7. If, as a consequence of a court judgment or allegation of patent
infringement or for any other reason (not limited to patent issues),
conditions are imposed on you (whether by court order, agreement or
otherwise) that contradict the conditions of this License, they do not
excuse you from the conditions of this License. If you cannot
distribute so as to satisfy simultaneously your obligations under this
License and any other pertinent obligations, then as a consequence you
may not distribute the Program at all. For example, if a patent
license would not permit royalty-free redistribution of the Program by
all those who receive copies directly or indirectly through you, then
the only way you could satisfy both it and this License would be to
refrain entirely from distribution of the Program.
If any portion of this section is held invalid or unenforceable under
any particular circumstance, the balance of the section is intended to
apply and the section as a whole is intended to apply in other
circumstances.
It is not the purpose of this section to induce you to infringe any
patents or other property right claims or to contest validity of any
such claims; this section has the sole purpose of protecting the
integrity of the free software distribution system, which is
implemented by public license practices. Many people have made
generous contributions to the wide range of software distributed
through that system in reliance on consistent application of that
system; it is up to the author/donor to decide if he or she is willing
to distribute software through any other system and a licensee cannot
impose that choice.
This section is intended to make thoroughly clear what is believed to
be a consequence of the rest of this License.
8. If the distribution and/or use of the Program is restricted in
certain countries either by patents or by copyrighted interfaces, the
original copyright holder who places the Program under this License
may add an explicit geographical distribution limitation excluding
those countries, so that distribution is permitted only in or among
countries not thus excluded. In such case, this License incorporates
the limitation as if written in the body of this License.
9. The Free Software Foundation may publish revised and/or new versions
of the General Public License from time to time. Such new versions will
be similar in spirit to the present version, but may differ in detail to
address new problems or concerns.
Each version is given a distinguishing version number. If the Program
specifies a version number of this License which applies to it and "any
later version", you have the option of following the terms and conditions
either of that version or of any later version published by the Free
Software Foundation. If the Program does not specify a version number of
this License, you may choose any version ever published by the Free Software
Foundation.
10. If you wish to incorporate parts of the Program into other free
programs whose distribution conditions are different, write to the author
to ask for permission. For software which is copyrighted by the Free
Software Foundation, write to the Free Software Foundation; we sometimes
make exceptions for this. Our decision will be guided by the two goals
of preserving the free status of all derivatives of our free software and
of promoting the sharing and reuse of software generally.
NO WARRANTY
11. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY
FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN
OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES
PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED
OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS
TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE
PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING,
REPAIR OR CORRECTION.
12. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR
REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES,
INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING
OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED
TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY
YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER
PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE
POSSIBILITY OF SUCH DAMAGES.
END OF TERMS AND CONDITIONS
How to Apply These Terms to Your New Programs
If you develop a new program, and you want it to be of the greatest
possible use to the public, the best way to achieve this is to make it
free software which everyone can redistribute and change under these terms.
To do so, attach the following notices to the program. It is safest
to attach them to the start of each source file to most effectively
convey the exclusion of warranty; and each file should have at least
the "copyright" line and a pointer to where the full notice is found.
<one line to give the program's name and a brief idea of what it does.>
Copyright (C) <year> <name of author>
This program is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation; either version 2 of the License, or
(at your option) any later version.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License
along with this program; if not, write to the Free Software
Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
Also add information on how to contact you by electronic and paper mail.
If the program is interactive, make it output a short notice like this
when it starts in an interactive mode:
Gnomovision version 69, Copyright (C) year name of author
Gnomovision comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
This is free software, and you are welcome to redistribute it
under certain conditions; type `show c' for details.
The hypothetical commands `show w' and `show c' should show the appropriate
parts of the General Public License. Of course, the commands you use may
be called something other than `show w' and `show c'; they could even be
mouse-clicks or menu items--whatever suits your program.
You should also get your employer (if you work as a programmer) or your
school, if any, to sign a "copyright disclaimer" for the program, if
necessary. Here is a sample; alter the names:
Yoyodyne, Inc., hereby disclaims all copyright interest in the program
`Gnomovision' (which makes passes at compilers) written by James Hacker.
<signature of Ty Coon>, 1 April 1989
Ty Coon, President of Vice
This General Public License does not permit incorporating your program into
proprietary programs. If your program is a subroutine library, you may
consider it more useful to permit linking proprietary applications with the
library. If this is what you want to do, use the GNU Library General
Public License instead of this License.

6
ChangeLog Normal file
View File

@ -0,0 +1,6 @@
0.9.1:
* copy whole title into .metadata (only 32 characters made it before)
* make main .DOL executable available to browse in the root directory
0.9:
* initial release

236
INSTALL Normal file
View File

@ -0,0 +1,236 @@
Installation Instructions
*************************
Copyright (C) 1994, 1995, 1996, 1999, 2000, 2001, 2002, 2004, 2005 Free
Software Foundation, Inc.
This file is free documentation; the Free Software Foundation gives
unlimited permission to copy, distribute and modify it.
Basic Installation
==================
These are generic installation instructions.
The `configure' shell script attempts to guess correct values for
various system-dependent variables used during compilation. It uses
those values to create a `Makefile' in each directory of the package.
It may also create one or more `.h' files containing system-dependent
definitions. Finally, it creates a shell script `config.status' that
you can run in the future to recreate the current configuration, and a
file `config.log' containing compiler output (useful mainly for
debugging `configure').
It can also use an optional file (typically called `config.cache'
and enabled with `--cache-file=config.cache' or simply `-C') that saves
the results of its tests to speed up reconfiguring. (Caching is
disabled by default to prevent problems with accidental use of stale
cache files.)
If you need to do unusual things to compile the package, please try
to figure out how `configure' could check whether to do them, and mail
diffs or instructions to the address given in the `README' so they can
be considered for the next release. If you are using the cache, and at
some point `config.cache' contains results you don't want to keep, you
may remove or edit it.
The file `configure.ac' (or `configure.in') is used to create
`configure' by a program called `autoconf'. You only need
`configure.ac' if you want to change it or regenerate `configure' using
a newer version of `autoconf'.
The simplest way to compile this package is:
1. `cd' to the directory containing the package's source code and type
`./configure' to configure the package for your system. If you're
using `csh' on an old version of System V, you might need to type
`sh ./configure' instead to prevent `csh' from trying to execute
`configure' itself.
Running `configure' takes awhile. While running, it prints some
messages telling which features it is checking for.
2. Type `make' to compile the package.
3. Optionally, type `make check' to run any self-tests that come with
the package.
4. Type `make install' to install the programs and any data files and
documentation.
5. You can remove the program binaries and object files from the
source code directory by typing `make clean'. To also remove the
files that `configure' created (so you can compile the package for
a different kind of computer), type `make distclean'. There is
also a `make maintainer-clean' target, but that is intended mainly
for the package's developers. If you use it, you may have to get
all sorts of other programs in order to regenerate files that came
with the distribution.
Compilers and Options
=====================
Some systems require unusual options for compilation or linking that the
`configure' script does not know about. Run `./configure --help' for
details on some of the pertinent environment variables.
You can give `configure' initial values for configuration parameters
by setting variables in the command line or in the environment. Here
is an example:
./configure CC=c89 CFLAGS=-O2 LIBS=-lposix
*Note Defining Variables::, for more details.
Compiling For Multiple Architectures
====================================
You can compile the package for more than one kind of computer at the
same time, by placing the object files for each architecture in their
own directory. To do this, you must use a version of `make' that
supports the `VPATH' variable, such as GNU `make'. `cd' to the
directory where you want the object files and executables to go and run
the `configure' script. `configure' automatically checks for the
source code in the directory that `configure' is in and in `..'.
If you have to use a `make' that does not support the `VPATH'
variable, you have to compile the package for one architecture at a
time in the source code directory. After you have installed the
package for one architecture, use `make distclean' before reconfiguring
for another architecture.
Installation Names
==================
By default, `make install' will install the package's files in
`/usr/local/bin', `/usr/local/man', etc. You can specify an
installation prefix other than `/usr/local' by giving `configure' the
option `--prefix=PREFIX'.
You can specify separate installation prefixes for
architecture-specific files and architecture-independent files. If you
give `configure' the option `--exec-prefix=PREFIX', the package will
use PREFIX as the prefix for installing programs and libraries.
Documentation and other data files will still use the regular prefix.
In addition, if you use an unusual directory layout you can give
options like `--bindir=DIR' to specify different values for particular
kinds of files. Run `configure --help' for a list of the directories
you can set and what kinds of files go in them.
If the package supports it, you can cause programs to be installed
with an extra prefix or suffix on their names by giving `configure' the
option `--program-prefix=PREFIX' or `--program-suffix=SUFFIX'.
Optional Features
=================
Some packages pay attention to `--enable-FEATURE' options to
`configure', where FEATURE indicates an optional part of the package.
They may also pay attention to `--with-PACKAGE' options, where PACKAGE
is something like `gnu-as' or `x' (for the X Window System). The
`README' should mention any `--enable-' and `--with-' options that the
package recognizes.
For packages that use the X Window System, `configure' can usually
find the X include and library files automatically, but if it doesn't,
you can use the `configure' options `--x-includes=DIR' and
`--x-libraries=DIR' to specify their locations.
Specifying the System Type
==========================
There may be some features `configure' cannot figure out automatically,
but needs to determine by the type of machine the package will run on.
Usually, assuming the package is built to be run on the _same_
architectures, `configure' can figure that out, but if it prints a
message saying it cannot guess the machine type, give it the
`--build=TYPE' option. TYPE can either be a short name for the system
type, such as `sun4', or a canonical name which has the form:
CPU-COMPANY-SYSTEM
where SYSTEM can have one of these forms:
OS KERNEL-OS
See the file `config.sub' for the possible values of each field. If
`config.sub' isn't included in this package, then this package doesn't
need to know the machine type.
If you are _building_ compiler tools for cross-compiling, you should
use the `--target=TYPE' option to select the type of system they will
produce code for.
If you want to _use_ a cross compiler, that generates code for a
platform different from the build platform, you should specify the
"host" platform (i.e., that on which the generated programs will
eventually be run) with `--host=TYPE'.
Sharing Defaults
================
If you want to set default values for `configure' scripts to share, you
can create a site shell script called `config.site' that gives default
values for variables like `CC', `cache_file', and `prefix'.
`configure' looks for `PREFIX/share/config.site' if it exists, then
`PREFIX/etc/config.site' if it exists. Or, you can set the
`CONFIG_SITE' environment variable to the location of the site script.
A warning: not all `configure' scripts look for a site script.
Defining Variables
==================
Variables not defined in a site shell script can be set in the
environment passed to `configure'. However, some packages may run
configure again during the build, and the customized values of these
variables may be lost. In order to avoid this problem, you should set
them in the `configure' command line, using `VAR=value'. For example:
./configure CC=/usr/local2/bin/gcc
causes the specified `gcc' to be used as the C compiler (unless it is
overridden in the site shell script). Here is a another example:
/bin/bash ./configure CONFIG_SHELL=/bin/bash
Here the `CONFIG_SHELL=/bin/bash' operand causes subsequent
configuration-related scripts to be executed by `/bin/bash'.
`configure' Invocation
======================
`configure' recognizes the following options to control how it operates.
`--help'
`-h'
Print a summary of the options to `configure', and exit.
`--version'
`-V'
Print the version of Autoconf used to generate the `configure'
script, and exit.
`--cache-file=FILE'
Enable the cache: use and save the results of the tests in FILE,
traditionally `config.cache'. FILE defaults to `/dev/null' to
disable caching.
`--config-cache'
`-C'
Alias for `--cache-file=config.cache'.
`--quiet'
`--silent'
`-q'
Do not print messages saying which checks are being made. To
suppress all normal output, redirect it to `/dev/null' (any error
messages will still be shown).
`--srcdir=DIR'
Look for the package's source code in directory DIR. Usually
`configure' can determine that directory automatically.
`configure' also accepts some other, not widely useful, options. Run
`configure --help' for more details.

1
Makefile.am Normal file
View File

@ -0,0 +1 @@
SUBDIRS = src

2
NEWS Normal file
View File

@ -0,0 +1,2 @@
release 1.0
* initial release

33
README Normal file
View File

@ -0,0 +1,33 @@
gcfuse is a program that allows you to mount a Nintendo GameCube DVD
disk image as a read-only part of the Linux filesystem. This allows the
user to browse the directory structure and read the files within.
Further, gcfuse provides access to the main program .dol and also
creates a special file called .metadata in the root directory of
the mounted filesystem.
gcfuse accomplishes all this using Filesystem in Userspace (FUSE),
available at:
http://fuse.sourceforge.net/
Note that there are likely to be bugs and perhaps even security
problems. It is currently meant as primarily an experimental research
tool for studying GameCube discs.
Requirements:
- Linux 2.4.x or 2.6.x (as of 2.6.14 FUSE is part of the
kernel, but you still need user libraries)
- FUSE (http://fuse.sourceforge.net) 2.5.x or higher
Build:
./configure && make
Install:
make install
Usage:
gcfuse <image_file.gcm> <mount_point>
To unmount previously mounted file, use:
fusermount -u <mount_point>

2
TODO Normal file
View File

@ -0,0 +1,2 @@
- more metadata
- make the program more solid and secure

1
autogen.sh Executable file
View File

@ -0,0 +1 @@
aclocal && autoheader && autoconf && automake --add-missing

26
configure.ac Normal file
View File

@ -0,0 +1,26 @@
AC_INIT([gcfuse], [0.9.1], [mike@multimedia.cx])
AM_INIT_AUTOMAKE([gcfuse], [0.9.1])
AC_CONFIG_HEADER([src/config.h])
AC_PROG_CC
AC_PROG_LIBTOOL
CPPFLAGS="$CPPFLAGS -Wall `getconf LFS_CFLAGS`"
LDFLAGS="$LDFLAGS `getconf LFS_LDFLAGS`"
AC_CHECK_LIB([fuse], [fuse_main], , AC_MSG_ERROR([Unable to find libfuse]))
AC_HEADER_STDC
AC_CHECK_HEADER([fuse/fuse.h], , AC_MSG_ERROR([Unable to find fuse.h]))
AC_PREPROC_IFELSE(
[#define FUSE_USE_VERSION 25
#include <fuse.h>]
, , AC_MSG_ERROR([You need FUSE version 2.5.x]))
AC_C_CONST
AC_FUNC_MALLOC
AC_FUNC_STAT
AC_CONFIG_FILES([Makefile src/Makefile])
AC_OUTPUT

3
src/Makefile.am Normal file
View File

@ -0,0 +1,3 @@
bin_PROGRAMS = gcfuse
gcfuse_SOURCES = tree.c gcfs.c main.c
noinst_HEADERS = tree.h gcfs.h

436
src/gcfs.c Executable file
View File

@ -0,0 +1,436 @@
/*
* Copyright (C) 2006 Mike Melanson (mike at multimedia.cx)
*
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation; either version 2 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program; if not, write to the Free Software
* Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
*/
/*!
* \file gcfs.c
* \author Mike Melanson
* \brief Interpret the Nintendo GameCube filesystem
*/
#include <ctype.h>
#include "tree.h"
#include "gcfs.h"
#define NAME_MAX_SIZE 1024
#define METADATA_FILE_NAME ".metadata"
#define CRLF "\x0D\x0A"
// the filename is a slight variation of game name with "-exe.dol" tacked
// on the end; the game name can be at most 0x3E0, with 9 bytes for the
// extended string + NULL; round out to 0x400
#define MAX_MAIN_DOL_FILENAME_SIZE 0x400
// global file description since main program needs to access it
int gcfs_fd;
//! Extract \c gcfsfile structure from FUSE context.
static inline struct gcfsfile *get_gcfsfile_from_context(void)
{
return (struct gcfsfile *)fuse_get_context()->private_data;
}
// **********************************************************************
// gcfs operations
// **********************************************************************
// **********************************************************************
// FUSE operations
// Here comes FUSE operations, please consult fuse.h for description of
// each operation.
// **********************************************************************
/*!
* \brief Get file attributes.
*/
static int gcfs_getattr(const char *path, struct stat *stbuf)
{
struct stat st;
// special handling for the metadata file
if (strcmp(path + 1, METADATA_FILE_NAME) == 0) {
memset(stbuf, 0, sizeof(struct stat));
// Set UID and GID to current user
stbuf->st_uid = getuid();
stbuf->st_gid = getgid();
stbuf->st_mode = S_IFREG | S_IRUSR | S_IRGRP | S_IROTH;
stbuf->st_nlink = 1;
stbuf->st_size = get_gcfsfile_from_context()->metadata_size;
// Set all times to the values from PACK file.
fstat(get_gcfsfile_from_context()->fd, &st);
stbuf->st_atime = st.st_atime;
stbuf->st_mtime = st.st_mtime;
stbuf->st_ctime = st.st_ctime;
return 0;
} else
return tree_getattr(path, stbuf, get_gcfsfile_from_context()->tree,
get_gcfsfile_from_context()->fd);
}
/*!
* \brief File open operation.
*/
static int gcfs_open(const char *path, struct fuse_file_info *fi)
{
// special handling for the metadata file
if (strcmp(path + 1, METADATA_FILE_NAME) == 0)
return 0;
else
return tree_open(path, fi, get_gcfsfile_from_context()->tree);
}
/*!
* \brief Read data from an open file.
*/
static int gcfs_read(const char *path, char *buf, size_t size,
off_t offset, struct fuse_file_info *fi)
{
// special handling for the metadata file
if (strcmp(path + 1, METADATA_FILE_NAME) == 0) {
if (offset >= get_gcfsfile_from_context()->metadata_size)
return 0;
if (offset + size >= get_gcfsfile_from_context()->metadata_size)
size = get_gcfsfile_from_context()->metadata_size - offset;
pthread_mutex_lock(&get_gcfsfile_from_context()->mutex);
memcpy(buf, get_gcfsfile_from_context()->metadata, size);
pthread_mutex_unlock(&get_gcfsfile_from_context()->mutex);
return size;
} else
return tree_read(path, buf, size, offset, fi,
get_gcfsfile_from_context()->tree,
get_gcfsfile_from_context()->fd,
&get_gcfsfile_from_context()->mutex);
}
/*!
* Open directory.
*/
static int gcfs_opendir(const char *path, struct fuse_file_info *fi)
{
return tree_opendir(path, fi, get_gcfsfile_from_context()->tree);
}
/*!
* \brief Read directory.
*/
static int gcfs_readdir(const char *path, void *buf,
fuse_fill_dir_t filler, off_t offset,
struct fuse_file_info *fi)
{
return tree_readdir(path, buf, filler, offset, fi,
get_gcfsfile_from_context()->tree);
}
/*!
* \brief Recurse through a directory structure.
*/
static int gcfs_recurse_directory(
unsigned char *buffer,
int starting_index,
int ending_index,
char *name_buffer,
int starting_name_index,
int fd,
off_t filename_base_offset,
struct tree *root)
{
int i;
unsigned int filename_offset;
unsigned int file_offset;
unsigned int file_size;
int is_dir;
int name_index;
char name_buffer_copy[NAME_MAX_SIZE];
fprintf (stderr, "*** recursing directory %s @ %d, recurse from %d -> %d\n",
name_buffer, starting_index - 1, starting_index, ending_index);
for (i = starting_index; i <= ending_index; i++) {
filename_offset = BE_32(&buffer[(i-1) * 12 + 0]);
file_offset = BE_32(&buffer[(i-1) * 12 + 4]);
file_size = BE_32(&buffer[(i-1) * 12 + 8]);
is_dir = filename_offset & 0x01000000;
filename_offset &= ~0x01000000;
filename_offset += filename_base_offset;
// get the filename
lseek(fd, filename_offset, SEEK_SET);
name_index = starting_name_index;
do {
read(fd, name_buffer + name_index, 1);
} while (isprint(name_buffer[name_index]) &&
(name_index++ < NAME_MAX_SIZE - 1));
// make sure the string is NULL-terminated
name_buffer[name_index] = 0;
if (is_dir) {
name_buffer[name_index++] = '/';
name_buffer[name_index] = 0;
i += gcfs_recurse_directory(buffer, i + 1, file_size,
name_buffer, name_index, fd, filename_base_offset,
root);
} else {
fprintf(stderr, "entry %d: %s; %d bytes, starts @ 0x%X\n",
i, name_buffer, file_size, file_offset);
memcpy(name_buffer_copy, name_buffer, NAME_MAX_SIZE);
tree_insert(root, name_buffer_copy, strlen(name_buffer_copy),
file_offset, file_size);
}
}
return ending_index - starting_index + 1;
}
/*!
* \brief Support function that returns a publisher's name.
*/
static char *gamecube_publisher_name(char c1, char c2)
{
if ((c1 == '0') && (c2 == '1'))
return "Nintendo";
else if ((c1 == '0') && (c2 == '8'))
return "Capcom";
else if ((c1 == '4') && (c2 == '1'))
return "Ubisoft";
else if ((c1 == '4') && (c2 == 'F'))
return "Eidos";
else if ((c1 == '5') && (c2 == '1'))
return "Acclaim";
else if ((c1 == '5') && (c2 == '2'))
return "Activision";
else if ((c1 == '5') && (c2 == 'D'))
return "Midway";
else if ((c1 == '5') && (c2 == 'G'))
return "Hudson";
else if ((c1 == '6') && (c2 == '4'))
return "LucasArts";
else if ((c1 == '6') && (c2 == '9'))
return "Electronic Arts";
else if ((c1 == '6') && (c2 == 'S'))
return "TDK Mediactive";
else if ((c1 == '8') && (c2 == 'P'))
return "Sega";
else if ((c1 == 'A') && (c2 == '4'))
return "Mirage Studios";
else if ((c1 == 'A') && (c2 == 'F'))
return "Namco";
else if ((c1 == 'B') && (c2 == '2'))
return "Bandai";
else if ((c1 == 'D') && (c2 == 'A'))
return "Tomy";
else if ((c1 == 'E') && (c2 == 'M'))
return "Konami";
else
return "unknown publisher";
}
/*!
* \brief Initialize filesystem.
*/
static void *gcfs_init(void)
{
int i, j;
char c;
unsigned char workspace[0x440];
unsigned int fst_chunk;
int file_record_count;
int file_records_size;
unsigned char *file_records;
off_t filename_base_offset;
char name_buffer[NAME_MAX_SIZE];
char main_dol_filename[MAX_MAIN_DOL_FILENAME_SIZE];
unsigned int main_dol_offset;
unsigned char dol_header[256];
unsigned int max_dol_section_offset;
unsigned int section_offset;
unsigned int section_size;
struct gcfsfile *gcfs = (struct gcfsfile *)malloc(sizeof(struct gcfsfile));
if (!gcfs) {
fprintf(stderr,"not enough memory\n");
close(gcfs_fd);
fuse_exit(fuse_get_context()->fuse);
return NULL;
}
gcfs->fd = gcfs_fd;
// Read 64 ID bytes from the front of the resource
if (read(gcfs->fd, workspace, 0x440) != 0x440) {
fprintf(stderr, "file too small to be a GCFS file\n");
close(gcfs->fd);
free(gcfs);
fuse_exit(fuse_get_context()->fuse);
return NULL;
}
gcfs->size = lseek(gcfs->fd, 0, SEEK_END);
pthread_mutex_init(&gcfs->mutex, NULL);
gcfs->tree = tree_empty();
// load the metadata
gcfs->metadata[0] = 0;
strcat(gcfs->metadata, "Game code: ");
gcfs->metadata_size = strlen(gcfs->metadata);
for (i = 0; i < 4; i++)
gcfs->metadata[gcfs->metadata_size++] =
isprint(workspace[i]) ? workspace[i] : '?';
strncat(gcfs->metadata, CRLF, strlen(CRLF));
strcat(gcfs->metadata, "Publisher code: ");
gcfs->metadata_size = strlen(gcfs->metadata);
for (i = 4; i < 6; i++)
gcfs->metadata[gcfs->metadata_size++] =
isprint(workspace[i]) ? workspace[i] : '?';
strcat(gcfs->metadata, " (");
strcat(gcfs->metadata, gamecube_publisher_name(workspace[4], workspace[5]));
strcat(gcfs->metadata, ")");
strncat(gcfs->metadata, CRLF, strlen(CRLF));
strcat(gcfs->metadata, "Title: ");
strncat(gcfs->metadata, &workspace[32], 0x3E0);
strncat(gcfs->metadata, CRLF, strlen(CRLF));
gcfs->metadata[METADATA_FILE_MAX_SIZE - 1] = 0;
gcfs->metadata_size = strlen(gcfs->metadata);
tree_insert(gcfs->tree, METADATA_FILE_NAME, sizeof(METADATA_FILE_NAME),
0, gcfs->metadata_size);
// decide on a filename for the main executable-- lowercase
// all characters; replace spaces with dashes; discard non-alphanumeric
// characters
j = 0;
for (i = 0; i < 0x3E0; i++) {
c = workspace[32 + i];
if (c == ' ')
main_dol_filename[j++] = '-';
else if (isalnum(c)) {
if (isupper(c))
main_dol_filename[j++] = tolower(c);
else
main_dol_filename[j++] = c;
}
}
main_dol_filename[j] = 0;
strcat(main_dol_filename, "-exe.dol");
// find the main executable file-- this involves seeking to the location
// of the DOL, reading the first 256 bytes, and deciding which section of
// text or data section extends the farthest
main_dol_offset = BE_32(&workspace[0x420]);
lseek(gcfs->fd, main_dol_offset, SEEK_SET);
if (read(gcfs->fd, dol_header, 256) != 256) {
fprintf(stderr, "no main executable file found\n");
close(gcfs->fd);
free(gcfs);
fuse_exit(fuse_get_context()->fuse);
return NULL;
}
max_dol_section_offset = 0;
// iterate through the 7 code segments
for (i = 0; i < 7; i++) {
section_offset = BE_32(&dol_header[i * 4]);
section_size = BE_32(&dol_header[0x90 + i * 4]);
if (section_offset + section_size > max_dol_section_offset)
max_dol_section_offset = section_offset + section_size;
}
// iterate through the 10 code segments
for (i = 0; i < 10; i++) {
section_offset = BE_32(&dol_header[0x1C + i * 4]);
section_size = BE_32(&dol_header[0xAC + i * 4]);
if (section_offset + section_size > max_dol_section_offset)
max_dol_section_offset = section_offset + section_size;
}
tree_insert(gcfs->tree, main_dol_filename, strlen(main_dol_filename),
main_dol_offset, max_dol_section_offset);
// find the filesystem pointer at 0x424
fst_chunk = BE_32(&workspace[0x424]);
lseek(gcfs->fd, fst_chunk, SEEK_SET);
// read the first file record
if (read(gcfs->fd, workspace, 12) != 12) {
fprintf(stderr, "file too small to be a GCFS file\n");
close(gcfs->fd);
free(gcfs);
fuse_exit(fuse_get_context()->fuse);
return NULL;
}
file_record_count = BE_32(&workspace[8]);
file_records_size = file_record_count * 12;
file_records = (unsigned char *)malloc(file_records_size);
if (!file_records) {
fprintf(stderr,"not enough memory\n");
close(gcfs->fd);
fuse_exit(fuse_get_context()->fuse);
return NULL;
}
// copy the first record over
memcpy(file_records, workspace, 12);
// load the remaining records
if (read(gcfs->fd, file_records + 12, file_records_size - 12) !=
file_records_size - 12) {
fprintf(stderr, "file too small to be a GCFS file\n");
close(gcfs->fd);
free(gcfs);
fuse_exit(fuse_get_context()->fuse);
return NULL;
}
filename_base_offset = lseek(gcfs->fd, 0, SEEK_CUR);
name_buffer[0] = 0;
// build the tree
gcfs_recurse_directory(file_records, 2, file_record_count,
name_buffer, 0, gcfs->fd, filename_base_offset,
gcfs->tree);
return (void *)gcfs;
}
/*!
* \brief Clean up filesystem.
*/
static void gcfs_destroy(void *context)
{
struct gcfsfile *gcfs = (struct gcfsfile *)context;
if (gcfs) {
close(gcfs->fd);
tree_free(gcfs->tree);
free(gcfs);
}
}
/*!
* \brief The FUSE file system operations.
*/
struct fuse_operations gcfs_operations = {
.getattr = gcfs_getattr,
.open = gcfs_open,
.read = gcfs_read,
.opendir = gcfs_opendir,
.readdir = gcfs_readdir,
.init = gcfs_init,
.destroy = gcfs_destroy,
};

113
src/gcfs.h Normal file
View File

@ -0,0 +1,113 @@
/*
* Copyright (C) 2006 Mike Melanson (mike at multimedia.cx)
*
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation; either version 2 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program; if not, write to the Free Software
* Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
*/
/*!
* \file gcfs.h
* \author Mike Melanson
* \brief GCFS file support header file.
*/
#ifndef _GCFS_H_
#define _GCFS_H_
#define _GNU_SOURCE
#include <string.h>
#include <unistd.h>
#include <stdlib.h>
#include <stdio.h>
#include <errno.h>
#include <pthread.h>
#include <sys/types.h>
#include <sys/stat.h>
#include <fcntl.h>
#define METADATA_FILE_MAX_SIZE 2048
/*!
* \brief Basic information about one GCFS file.
* This structure contains basic information about one GCFS file,
* including information needed by FUSE system. It is stored as \c
* private_data of FUSE context.
*/
struct gcfsfile {
/*!
* \brief GCFS file descriptor.
*/
int fd;
/*!
* \brief Disk operations mutex.
*
* This mutex is used to synchronize disk operations on GCFS
* file. Whenever one need to read/write/lseek GCFS file, this
* mutex should be locked with \c pthread_mutex_lock(). After
* operation has finished (also after an error), this mutex
* should be unlocked with \c pthread_mutex_unlock().
*/
pthread_mutex_t mutex;
/*!
* \brief Size of the GCFS file.
*/
off_t size;
/*!
* \brief Directory tree of the GCFS file.
*
* This field contains directory tree of the GCFS file (which
* doesn't constain any directories, only files). This is
* filled by \c gcfs_init().
*/
struct tree *tree;
/*!
* \brief GameCube filesystem metadata.
*
* This array acts as a container for metadata about the
* the mounted filesystem (title, publisher, etc.).
*/
char metadata[METADATA_FILE_MAX_SIZE];
int metadata_size;
};
extern struct fuse_operations gcfs_operations;
extern int gcfs_fd;
//! Treat given memory address as a 16-bit big-endian integer.
#define BE_16(x) ((((uint8_t*)(x))[0] << 8) | ((uint8_t*)(x))[1])
//! Treat given memory address as a 32-bit big-endian integer.
#define BE_32(x) ((((uint8_t*)(x))[0] << 24) | \
(((uint8_t*)(x))[1] << 16) | \
(((uint8_t*)(x))[2] << 8) | \
((uint8_t*)(x))[3])
//! Treat given memory address as a 16-bit little-endian integer.
#define LE_16(x) ((((uint8_t*)(x))[1] << 8) | ((uint8_t*)(x))[0])
//! Treat given memory address as a 32-bit little-endian integer.
#define LE_32(x) ((((uint8_t*)(x))[3] << 24) | \
(((uint8_t*)(x))[2] << 16) | \
(((uint8_t*)(x))[1] << 8) | \
((uint8_t*)(x))[0])
#endif // _GCFS_H_

88
src/main.c Normal file
View File

@ -0,0 +1,88 @@
/*
* Copyright (C) 2006 Mike Melanson (mike at multimedia.cx)
* based on code by:
* Copyright (C) 2005 Janusz Dziemidowicz (rraptorr@nails.eu.org)
*
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation; either version 2 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program; if not, write to the Free Software
* Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
*/
/*!
* \file main.c
* \author Mike Melanson
* \brief Main program function.
*/
#include <stdlib.h>
#include <stdio.h>
#include <string.h>
//! FUSE library compliance level.
#define FUSE_USE_VERSION 25
#include <fuse.h>
#include "gcfs.h"
/*!
* \brief Flag indicating wheter we should run in quiet mode (0 - no,
* all other values - yes).
*/
int quiet;
/*!
* \brief Main function.
*/
int main(int argc, char *argv[])
{
char **nargv;
int nargc, i, j;
if (argc < 3) {
fprintf
(stderr,
"Usage: %s <archive_file> <mount_point> [<options>] [<FUSE library options>]\n\n",
argv[0]);
fprintf(stderr, "Available options:\n");
fprintf(stderr,
"\t-q - quiet mode (print only error messages)\n");
exit(EXIT_FAILURE);
}
for (i = 1; i < argc; i++) {
if (!strcmp(argv[i], "-q")) {
quiet = 1;
for (j = i; j < argc - 1; j++)
argv[j] = argv[j + 1];
argc--;
break;
}
}
nargc = argc - 1;
nargv = (char **)malloc(nargc * sizeof(char *));
// skip the resource filename
nargv[0] = argv[0];
for (i = 1; i < nargc; i++)
nargv[i] = argv[i + 1];
// try to open the file
gcfs_fd = open(argv[1], O_RDONLY);
if (gcfs_fd < 0) {
perror(argv[1]);
exit(EXIT_FAILURE);
}
return fuse_main(nargc, nargv, &gcfs_operations);
}

268
src/tree.c Normal file
View File

@ -0,0 +1,268 @@
/*
* Copyright (C) 2005 Janusz Dziemidowicz (rraptorr@nails.eu.org)
*
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation; either version 2 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program; if not, write to the Free Software
* Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
*/
/*!
* \file tree.c
* \author Janusz Dziemidowicz
* \brief Directory hierarchy abstraction file.
*/
#include "tree.h"
void tree_insert(struct tree *root, const char *path, int length,
long offset, long size)
{
char *pos;
struct tree *node;
if (!path || !*path)
return;
if ((pos = memchr(path, '/', length))) {
// Path contains directory.
*pos = '\0';
node = root->sub;
// Check if this directory was already inserted by earlier calls.
while (node) {
if (!strcmp(node->name, path)) {
tree_insert(node, pos + 1,
length - (pos + 1 - path),
offset, size);
return;
}
node = node->next;
}
// Create new directory.
node = (struct tree *)malloc(sizeof(struct tree));
node->name = strdup(path);
node->is_dir = 1;
node->offset = 0;
node->size = 0;
node->nsubdirs = 0;
node->sub = NULL;
node->next = root->sub;
// Connect new directory under current directory.
root->sub = node;
root->nsubdirs++;
// Insert remaining parts of path in new directory.
tree_insert(node, pos + 1, length - (pos + 1 - path),
offset, size);
} else {
// No more directories in path. Just create new file
// under current directory.
node = (struct tree *)malloc(sizeof(struct tree));
node->name = strndup(path, length);
node->is_dir = 0;
node->offset = offset;
node->size = size;
node->nsubdirs = 0;
node->sub = NULL;
node->next = root->sub;
root->sub = node;
}
}
struct tree *tree_find_entry(struct tree *root, const char *path)
{
struct tree *node, *ret;
const char *next;
if (!root)
return NULL;
if (!strcmp(path, root->name))
return root;
if (strncmp(path, root->name, strlen(root->name)))
return NULL;
next = path + strlen(root->name);
if (*next != '/')
return NULL;
next++;
if (!*next)
return root;
node = root->sub;
while (node) {
ret = tree_find_entry(node, next);
if (ret)
return ret;
node = node->next;
}
return NULL;
}
void tree_free(struct tree *root)
{
struct tree *node, *next;
node = root->sub;
while (node) {
next = node->next;
tree_free(node);
node = next;
}
free(root->name);
free(root);
}
struct tree *tree_empty(void)
{
struct tree *ret;
ret = (struct tree *)malloc(sizeof(struct tree));
ret->name = strdup("");
ret->is_dir = 1;
ret->offset = 0;
ret->size = 0;
ret->nsubdirs = 0;
ret->sub = NULL;
ret->next = NULL;
return ret;
}
int tree_getattr(const char *path, struct stat *stbuf, struct tree *root,
int fd)
{
struct tree *node;
struct stat st;
node = tree_find_entry(root, path);
if (node) {
memset(stbuf, 0, sizeof(struct stat));
// Set UID and GID to current user
stbuf->st_uid = getuid();
stbuf->st_gid = getgid();
if (node->is_dir) {
stbuf->st_mode =
S_IFDIR | S_IRUSR | S_IRGRP | S_IROTH | S_IXUSR
| S_IXGRP | S_IXOTH;
// Directory should have number of links set
// to 2 + number of subdirectories (not
// files), this makes find work.
stbuf->st_nlink = 2 + node->nsubdirs;
} else {
stbuf->st_mode = S_IFREG | S_IRUSR | S_IRGRP | S_IROTH;
stbuf->st_nlink = 1;
stbuf->st_size = node->size;
}
// Set all times to the values from PACK file.
fstat(fd, &st);
stbuf->st_atime = st.st_atime;
stbuf->st_mtime = st.st_mtime;
stbuf->st_ctime = st.st_ctime;
return 0;
} else
return -ENOENT;
}
int tree_open(const char *path, struct fuse_file_info *fi, struct tree *root)
{
struct tree *node;
if (fi->flags & O_WRONLY)
return -EROFS;
node = tree_find_entry(root, path);
if (!node)
return -ENOENT;
return 0;
}
int tree_read(const char *path, char *buf, size_t size,
off_t offset, struct fuse_file_info *fi, struct tree *root,
int fd, pthread_mutex_t * mutex)
{
struct tree *node;
int ret;
node = tree_find_entry(root, path);
if (!node)
return -ENOENT;
if (node->is_dir)
return -EISDIR;
if (offset >= node->size)
return 0;
if (offset + size > node->size)
size = node->size - offset;
// This is needed to ensure, that no other thread will change
// seek point before we call read().
pthread_mutex_lock(mutex);
lseek(fd, node->offset + offset, SEEK_SET);
ret = read(fd, buf, size);
pthread_mutex_unlock(mutex);
return ret;
}
int tree_opendir(const char *path, struct fuse_file_info *fi, struct tree *root)
{
struct tree *node = tree_find_entry(root, path);
if (!node)
return -ENOENT;
if (!node->is_dir)
return -ENOTDIR;
return 0;
}
int tree_readdir(const char *path, void *buf,
fuse_fill_dir_t filler, off_t offset,
struct fuse_file_info *fi, struct tree *root)
{
struct tree *node;
node = tree_find_entry(root, path);
if (!node)
return -ENOENT;
if (!node->is_dir)
return -ENOTDIR;
filler(buf, ".", NULL, 0);
filler(buf, "..", NULL, 0);
node = node->sub;
while (node) {
filler(buf, node->name, NULL, 0);
node = node->next;
}
return 0;
}

226
src/tree.h Normal file
View File

@ -0,0 +1,226 @@
/*
* Copyright (C) 2005 Janusz Dziemidowicz (rraptorr@nails.eu.org)
*
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation; either version 2 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program; if not, write to the Free Software
* Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
*/
/*!
* \file tree.h
* \author Janusz Dziemidowicz
* \brief Directory hierarchy abstraction header file.
*/
#ifndef _TREE_H_
#define _TREE_H_
//! This is needed for strndup.
#define _GNU_SOURCE
#include <stdlib.h>
#include <sys/types.h>
#include <sys/stat.h>
#include <unistd.h>
#include <errno.h>
#include <fcntl.h>
#include <string.h>
#include <pthread.h>
//! FUSE library compliance level.
#define FUSE_USE_VERSION 25
#include <fuse.h>
/*!
* \brief GRAF directory hierarchy structure.
*
* This structure represents directory structure from GRAF. You should
* insert files into this structure (filenames can contain '/',
* corresponding directories will be made automatically). There are
* also FUSE operations on this structure provided, which can be used
* to quickly implement FUSE filesystem.
*/
struct tree {
/*!
* \brief Filename.
*
* Should be empty string in the root of the tree. Otherwise
* searching function won't work.
*/
char *name;
/*!
* \brief Flag indicating that this a directory.
*/
char is_dir;
/*!
* \brief Offset of the file inside of GRAF.
*/
off_t offset;
/*!
* \brief Size of the file inside of GRAF.
*/
off_t size;
/*!
* \brief Number of subdirectories.
*
* This is used to calculate correct number of hard links,
* which for directories should be 2 + number of
* subdirectories. This is especially needed to make find
* work. It will be incremented when inserting directories.
*/
int nsubdirs;
/*!
* \brief Subdirectories.
*
* If the current file is a regular file this field is NULL. Otherwise
* it is a pointer to first element of directory.
*/
struct tree *sub;
/*!
* \brief Next file.
*
* This is a pointer to the next file on the same directory
* level.
*/
struct tree *next;
};
/*!
* \brief Insert path into representation of GRAF firectory tree.
*
* This function inserts given pathname into the \c tree structure,
* which describes directory structure inside of GRAF. Every needed
* subdirectories will be created by this function.
*
* \param root \c tree root, at which \c path should be inserted.
* \param path path that should be inserted. This should be relative
* name (no '/' in the beginning). Please note that it will be
* destroyed.
* \param length length of \c path (as sometimes it is not zero
* terminated).
* \param offset offset (from \c packentry) that should be stored in
* the tree node corresponding to given \c path.
* \param size size (from \c packentry) that should be stored in the
* tree node correspoding to given \c path.
*/
void tree_insert(struct tree *root, const char *path, int length,
long offset, long size);
/*!
* \brief Find given path in GRAF directory structure.
*
* \param root \c tree root, at which searching should be started.
* \param path path to find, it should be exactly as provided by FUSE
* (so it should start with '/').
* \return pointer to node containing information about given \c path
* or NULL if not found.
*/
struct tree *tree_find_entry(struct tree *root, const char *path);
/*!
* \brief Free entire GRAF directory hierarchy structure.
*
* \param root root of the directory \c tree to be freed.
*/
void tree_free(struct tree *root);
/*!
* \brief Create empty directory structure.
*
* This functions creates empty directory structures with all fields
* set as needed.
*/
struct tree *tree_empty(void);
/*!
* \brief FUSE getattr operation.
*
* This is FUSE compatible getattr operation which gets file
* information from \c tree structure.
* \param path file path.
* \param stbuf stats will be stored here.
* \param root tree root.
* \param fd data file descriptor.
* \return 0 on success, -errno otherwise.
*/
int tree_getattr(const char *path, struct stat *stbuf, struct tree *root,
int fd);
/*!
* \brief FUSE open operation.
*
* This is FUSE compatible open operation which gets file
* information from \c tree structure.
* \param path file path.
* \param fi FUSE file information.
* \param root tree root.
* \return 0 on success, -errno otherwise.
*/
int tree_open(const char *path, struct fuse_file_info *fi, struct tree *root);
/*!
* \brief FUSE read operation.
*
* This is FUSE compatible read operation which gets file
* information from \c tree structure.
* \param path file path.
* \param buf read buffer.
* \param size size of \c buf.
* \param offset read offset.
* \param fi FUSE file information.
* \param root tree root.
* \param fd data file descriptor.
* \param mutex file operations mutex related to \c fd.
* \return number of bytes read on success, -errno otherwise.
*/
int tree_read(const char *path, char *buf, size_t size,
off_t offset, struct fuse_file_info *fi, struct tree *root,
int fd, pthread_mutex_t * mutex);
/*!
* \brief FUSE opendir operation.
*
* This is FUSE compatible opendir operation which gets file
* information from \c tree structure.
* \param path directory path.
* \param fi FUSE file information.
* \param root tree root.
* \return 0 on success, -errno otherwise.
*/
int tree_opendir(const char *path, struct fuse_file_info *fi,
struct tree *root);
/*!
* \brief FUSE readdir operation.
*
* This is FUSE compatible readdir operation which gets file
* information from \c tree structure.
* \param path directory path.
* \param buf output buffer.
* \param filler filler function.
* \param offset output offset.
* \param fi FUSE file information.
* \param root tree root.
* \return 0 on success, -errno otherwise.
*/
int tree_readdir(const char *path, void *buf,
fuse_fill_dir_t filler, off_t offset,
struct fuse_file_info *fi, struct tree *root);
#endif // _TREE_H_