commit 036d45e551ca5405c726f8ccb51f446620cd4af4 Author: Jaegeuk Kim Date: Fri Oct 26 21:56:34 2012 +0900 mkfs: Initial commit for patch v2 series This is same as f2fs-tools-1.1.0.tar.gz, and for patch v2 in kernel. Signed-off-by: Jaegeuk Kim diff --git a/AUTHORS b/AUTHORS new file mode 100644 index 0000000..6ec1861 --- /dev/null +++ b/AUTHORS @@ -0,0 +1 @@ +This package has been developed by Praesto Team at Samsung Electronics Co., Ltd. diff --git a/COPYING b/COPYING new file mode 100644 index 0000000..21cd6db --- /dev/null +++ b/COPYING @@ -0,0 +1,351 @@ +The tools for F2FS are covered by GNU Public License version 2. + +Copyright (c) 2012 Samsung Electronics Co., Ltd. + http://www.samsung.com/ + +This program is free software; you can redistribute it and/or modify +it under the terms of the GNU General Public License version 2 as +published by the Free Software Foundation. + +================================================================================ + GNU GENERAL PUBLIC LICENSE + Version 2, June 1991 + + Copyright (C) 1989, 1991 Free Software Foundation, Inc. + 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 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. + + + Copyright (C) + + 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., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 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. + + , 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. +================================================================================ diff --git a/ChangeLog b/ChangeLog new file mode 100644 index 0000000..bcbd38d --- /dev/null +++ b/ChangeLog @@ -0,0 +1,2 @@ +f2fs-tools-1.0.0 Tue Aug 14, 2012 KST + * The first release of f2fs-tools. diff --git a/INSTALL b/INSTALL new file mode 100644 index 0000000..a1e89e1 --- /dev/null +++ b/INSTALL @@ -0,0 +1,370 @@ +Installation Instructions +************************* + +Copyright (C) 1994-1996, 1999-2002, 2004-2011 Free Software Foundation, +Inc. + + Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. This file is offered as-is, +without warranty of any kind. + +Basic Installation +================== + + Briefly, the shell commands `./configure; make; make install' should +configure, build, and install this package. The following +more-detailed instructions are generic; see the `README' file for +instructions specific to this package. Some packages provide this +`INSTALL' file but do not implement all of the features documented +below. The lack of an optional feature in a given package is not +necessarily a bug. More recommendations for GNU packages can be found +in *note Makefile Conventions: (standards)Makefile Conventions. + + 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 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. + + Running `configure' might take a while. 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, generally using the just-built uninstalled binaries. + + 4. Type `make install' to install the programs and any data files and + documentation. When installing into a prefix owned by root, it is + recommended that the package be configured and built as a regular + user, and only the `make install' phase executed with root + privileges. + + 5. Optionally, type `make installcheck' to repeat any self-tests, but + this time using the binaries in their final installed location. + This target does not install anything. Running this target as a + regular user, particularly if the prior `make install' required + root privileges, verifies that the installation completed + correctly. + + 6. 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. + + 7. Often, you can also type `make uninstall' to remove the installed + files again. In practice, not all packages have tested that + uninstallation works correctly, even though it is required by the + GNU Coding Standards. + + 8. Some packages, particularly those that use Automake, provide `make + distcheck', which can by used by developers to test that all other + targets like `make install' and `make uninstall' work correctly. + This target is generally not run by end users. + +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=c99 CFLAGS=-g 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 can use 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 `..'. This +is known as a "VPATH" build. + + With a non-GNU `make', it is safer 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. + + On MacOS X 10.5 and later systems, you can create libraries and +executables that work on multiple system types--known as "fat" or +"universal" binaries--by specifying multiple `-arch' options to the +compiler but only a single `-arch' option to the preprocessor. Like +this: + + ./configure CC="gcc -arch i386 -arch x86_64 -arch ppc -arch ppc64" \ + CXX="g++ -arch i386 -arch x86_64 -arch ppc -arch ppc64" \ + CPP="gcc -E" CXXCPP="g++ -E" + + This is not guaranteed to produce working output in all cases, you +may have to build one architecture at a time and combine the results +using the `lipo' tool if you have problems. + +Installation Names +================== + + By default, `make install' installs the package's commands under +`/usr/local/bin', include files under `/usr/local/include', etc. You +can specify an installation prefix other than `/usr/local' by giving +`configure' the option `--prefix=PREFIX', where PREFIX must be an +absolute file name. + + You can specify separate installation prefixes for +architecture-specific files and architecture-independent files. If you +pass the option `--exec-prefix=PREFIX' to `configure', the package uses +PREFIX as the prefix for installing programs and libraries. +Documentation and other data files 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. In general, the +default for these options is expressed in terms of `${prefix}', so that +specifying just `--prefix' will affect all of the other directory +specifications that were not explicitly provided. + + The most portable way to affect installation locations is to pass the +correct locations to `configure'; however, many packages provide one or +both of the following shortcuts of passing variable assignments to the +`make install' command line to change installation locations without +having to reconfigure or recompile. + + The first method involves providing an override variable for each +affected directory. For example, `make install +prefix=/alternate/directory' will choose an alternate location for all +directory configuration variables that were expressed in terms of +`${prefix}'. Any directories that were specified during `configure', +but not in terms of `${prefix}', must each be overridden at install +time for the entire installation to be relocated. The approach of +makefile variable overrides for each directory variable is required by +the GNU Coding Standards, and ideally causes no recompilation. +However, some platforms have known limitations with the semantics of +shared libraries that end up requiring recompilation when using this +method, particularly noticeable in packages that use GNU Libtool. + + The second method involves providing the `DESTDIR' variable. For +example, `make install DESTDIR=/alternate/directory' will prepend +`/alternate/directory' before all installation names. The approach of +`DESTDIR' overrides is not required by the GNU Coding Standards, and +does not work on platforms that have drive letters. On the other hand, +it does better at avoiding recompilation issues, and works well even +when some directory options were not specified in terms of `${prefix}' +at `configure' time. + +Optional Features +================= + + 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'. + + 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. + + Some packages offer the ability to configure how verbose the +execution of `make' will be. For these packages, running `./configure +--enable-silent-rules' sets the default to minimal output, which can be +overridden with `make V=1'; while running `./configure +--disable-silent-rules' sets the default to verbose, which can be +overridden with `make V=0'. + +Particular systems +================== + + On HP-UX, the default C compiler is not ANSI C compatible. If GNU +CC is not installed, it is recommended to use the following options in +order to use an ANSI C compiler: + + ./configure CC="cc -Ae -D_XOPEN_SOURCE=500" + +and if that doesn't work, install pre-built binaries of GCC for HP-UX. + + HP-UX `make' updates targets which have the same time stamps as +their prerequisites, which makes it generally unusable when shipped +generated files such as `configure' are involved. Use GNU `make' +instead. + + On OSF/1 a.k.a. Tru64, some versions of the default C compiler cannot +parse its `' header file. The option `-nodtk' can be used as +a workaround. If GNU CC is not installed, it is therefore recommended +to try + + ./configure CC="cc" + +and if that doesn't work, try + + ./configure CC="cc -nodtk" + + On Solaris, don't put `/usr/ucb' early in your `PATH'. This +directory contains several dysfunctional programs; working variants of +these programs are available in `/usr/bin'. So, if you need `/usr/ucb' +in your `PATH', put it _after_ `/usr/bin'. + + On Haiku, software installed for all users goes in `/boot/common', +not `/usr/local'. It is recommended to use the following options: + + ./configure --prefix=/boot/common + +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 option `--target=TYPE' 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). + +Unfortunately, this technique does not work for `CONFIG_SHELL' due to +an Autoconf bug. Until the bug is fixed you can use this workaround: + + CONFIG_SHELL=/bin/bash /bin/bash ./configure CONFIG_SHELL=/bin/bash + +`configure' Invocation +====================== + + `configure' recognizes the following options to control how it +operates. + +`--help' +`-h' + Print a summary of all of the options to `configure', and exit. + +`--help=short' +`--help=recursive' + Print a summary of the options unique to this package's + `configure', and exit. The `short' variant lists options used + only in the top level, while the `recursive' variant lists options + also present in any nested packages. + +`--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. + +`--prefix=DIR' + Use DIR as the installation prefix. *note Installation Names:: + for more details, including other options available for fine-tuning + the installation locations. + +`--no-create' +`-n' + Run the configure checks, but stop before creating any output + files. + +`configure' also accepts some other, not widely useful, options. Run +`configure --help' for more details. + diff --git a/Makefile.am b/Makefile.am new file mode 100644 index 0000000..88f9f6a --- /dev/null +++ b/Makefile.am @@ -0,0 +1,5 @@ +## Makefile.am + +ACLOCAL_AMFLAGS = -I m4 + +SUBDIRS = man mkfs diff --git a/NEWS b/NEWS new file mode 100644 index 0000000..e69de29 diff --git a/README b/README new file mode 100644 index 0000000..c0be658 --- /dev/null +++ b/README @@ -0,0 +1,25 @@ +F2FS format utilility +--------------------- + +To use f2fs filesystem, you should format the storage partition +with this utilility. Otherwise, you cannot mount f2fs. + +Initial compilation +------------------- + +Before compilation initially, autoconf/automake tools should be run. + + # autoreconf --install + +How to compile +-------------- + + # ./configure + # make + +How to run by default +--------------------- + + $ ./mkfs.f2fs -l [LABEL] $DEV + +For more mkfs options, see man page. diff --git a/configure.ac b/configure.ac new file mode 100644 index 0000000..fd7272d --- /dev/null +++ b/configure.ac @@ -0,0 +1,31 @@ +# -*- Autoconf -*- +# Process this file with autoconf to produce a configure script. + +AC_PREREQ([2.68]) +AC_INIT([F2FS tools], [1.0.0], [TBD]) +AM_INIT_AUTOMAKE +AC_CONFIG_SRCDIR([mkfs/f2fs_format.c]) +AC_CONFIG_HEADERS([config.h]) + +# Checks for programs. +AC_PROG_CC + +# Checks for libraries. + +# Checks for header files. +AC_CHECK_HEADERS([fcntl.h mntent.h stdlib.h string.h sys/ioctl.h sys/mount.h unistd.h]) + +# Checks for typedefs, structures, and compiler characteristics. +AC_C_INLINE +AC_TYPE_INT32_T +AC_TYPE_INT8_T +AC_TYPE_SIZE_T + +# Checks for library functions. +AC_FUNC_GETMNTENT +AC_CHECK_FUNCS([getmntent memset]) + +AC_CONFIG_FILES([Makefile + man/Makefile + mkfs/Makefile]) +AC_OUTPUT diff --git a/m4/.gitignore b/m4/.gitignore new file mode 100644 index 0000000..44701f5 --- /dev/null +++ b/m4/.gitignore @@ -0,0 +1,2 @@ + +*.m4 diff --git a/man/Makefile.am b/man/Makefile.am new file mode 100644 index 0000000..477d654 --- /dev/null +++ b/man/Makefile.am @@ -0,0 +1,3 @@ +## Makefile.am + +dist_man_MANS = mkfs.f2fs.8 diff --git a/man/mkfs.f2fs.8 b/man/mkfs.f2fs.8 new file mode 100644 index 0000000..928b7bf --- /dev/null +++ b/man/mkfs.f2fs.8 @@ -0,0 +1,71 @@ +.\" Copyright (C) 2007-2012 Nippon Telegraph and Telephone Corporation. +.\" Written by Ryusuke Konishi +.\" +.TH MKFS.F2FS 8 "August 2012" "f2fs-tools version 1.0" +.SH NAME +mkfs.f2fs \- create an F2FS file system +.SH SYNOPSIS +.B mkfs.f2fs +[ +.B \-a +.I heap-based-allocation +] +[ +.B \-l +.I volume-label +] +[ +.B \-o +.I overprovision-ratio-percentage +] +[ +.B \-s +.I log-based-#-of-segments-per-section +] +[ +.B \-z +.I #-of-sections-per-zone +] +.I device +.SH DESCRIPTION +.B mkfs.f2fs +is used to create a f2fs file system (usually in a disk partition). +\fIdevice\fP is the special file corresponding to the device (e.g. +\fI/dev/sdXX\fP). +.PP +The exit code returned by +.B mkfs.f2fs +is 0 on success and 1 on failure. +.SH OPTIONS +.TP +.BI \-a " heap-based-allocation" +Specify 1 or 0 to enable/disable heap based block allocation policy. +If the value is equal to 1, each of active log areas are initially +assigned separately according to the whole volume size. +The default value is 1. +.TP +.BI \-l " volume-label" +Specify the volume label to the partition mounted as F2FS. +.TP +.BI \-o " overprovision-ratio-percentage" +Specify the percentage over the volume size for overprovision area. This area +is hidden to users, and utilized by F2FS cleaner. The default percentage is 5%. +.TP +.BI \-s " log-based-#-of-segments-per-section" +Specify the log-based number of segments per section. A section consists of +multiple consecutive segments, and is the unit of garbage collection. +The default number is 0, which means one segment is assigned to a section. +.TP +.BI \-z " #-of-sections-per-zone" +Specify the number of sections per zone. A zone consists of multiple sections. +F2FS allocates segments for active logs with separated zones as much as possible. +The default number is 1, which means a zone consists of one section. +.SH AUTHOR +This version of +.B mkfs.f2fs +has been written by Jaegeuk Kim . +.SH AVAILABILITY +.B mkfs.f2fs +is available from http://sourceforge.net/projects/f2fs-tools/. +.SH SEE ALSO +.BR mkfs (8). diff --git a/mkfs/Makefile.am b/mkfs/Makefile.am new file mode 100644 index 0000000..f47c1ec --- /dev/null +++ b/mkfs/Makefile.am @@ -0,0 +1,5 @@ +## Makefile.am + +AM_CFLAGS = -Wall +bin_PROGRAMS = mkfs.f2fs +mkfs_f2fs_SOURCES = f2fs_format.c f2fs_format.h diff --git a/mkfs/f2fs_format.c b/mkfs/f2fs_format.c new file mode 100644 index 0000000..e20ad4e --- /dev/null +++ b/mkfs/f2fs_format.c @@ -0,0 +1,1300 @@ +/** + * f2fs_format.c + * + * Copyright (c) 2012 Samsung Electronics Co., Ltd. + * http://www.samsung.com/ + * + * This program is free software; you can redistribute it and/or modify + * it under the terms of the GNU General Public License version 2 as + * published by the Free Software Foundation. + */ +#define _LARGEFILE64_SOURCE + +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include + +#include "f2fs_format.h" + +struct f2fs_global_parameters f2fs_params; +struct f2fs_super_block super_block; + +/** + * @brief This function will change a given string from ASCII to UNICODE + * @param out_buf Output UNICODE string + * @param in_buf Input ASCII string + * @return None + */ +void ASCIIToUNICODE(u_int16_t *out_buf, u_int8_t *in_buf) +{ + u_int8_t *pchTempPtr = in_buf; + u_int16_t *pwTempPtr = out_buf; + + while (*pchTempPtr != '\0') { + /* Copy the string elements character by character + * to the output string with typecasting the source. + */ + *pwTempPtr = (u_int16_t)*pchTempPtr; + pchTempPtr++; + pwTempPtr++; + } + *pwTempPtr = '\0'; + return; +} + +/** + * @brief This function will ntitlize f2fs global paramenters + * @param None + * @return None + */ +static void f2fs_init_global_parameters(void) +{ + f2fs_params.sector_size = DEFAULT_SECTOR_SIZE; + f2fs_params.sectors_per_blk = DEFAULT_SECTORS_PER_BLOCK; + f2fs_params.blks_per_seg = DEFAULT_BLOCKS_PER_SEGMENT; + f2fs_params.reserved_segments = 20; /* calculated by overprovision ratio */ + f2fs_params.overprovision = 5; + f2fs_params.segs_per_sec = 1; + f2fs_params.secs_per_zone = 1; + f2fs_params.heap = 1; + memset(f2fs_params.vol_label, 0, sizeof(f2fs_params.vol_label)); + + f2fs_params.vol_label[0] = 'F'; + f2fs_params.vol_label[1] = '2'; + f2fs_params.vol_label[2] = 'F'; + f2fs_params.vol_label[3] = 'S'; + f2fs_params.vol_label[4] = '\0'; + f2fs_params.device_name = NULL; +} + +static inline int f2fs_set_bit(unsigned int nr, unsigned char *addr) +{ + int mask; + int ret; + + addr += (nr >> 3); + mask = 1 << (7 - (nr & 0x07)); + ret = mask & *addr; + *addr |= mask; + return ret; +} + +/** + * @brief This function calculates log base 2 of given number + * @param num an integer number + * @return an int log base 2 of given number + */ +static int8_t log_base_2(u_int32_t num) +{ + int8_t ret = 0; + + if (num <= 0 || (num & (num - 1)) != 0) { + return -1; + } + + while (num >>= 1) { + ret++; + } + + return ret; +} + +/** + * @brief This function shows error if user gives wrong parameters + * @param None + * @return None + */ +static void f2fs_usage(void) +{ + fprintf(stderr, "Usage: f2fs_format [options] device\n"); + fprintf(stderr, "[options]\n"); + fprintf(stderr, "-l label\n"); + fprintf(stderr, "-a heap-based allocation [default:1]\n"); + fprintf(stderr, "-o overprovision ratio [default:5]\n"); + fprintf(stderr, "-s # of segments per section [default:1]\n"); + fprintf(stderr, "-z # of sections per zone [default:1]\n"); + fprintf(stderr, "-e [extension list] e.g. \"mp3,gif,mov\"\n"); + exit(1); +} + +/** + * @brief This function calculates log base 2 of given number + * @param argc number of arguments + * @param argv an array of arguments + * @return None + */ +static void f2fs_parse_options(int argc, char *argv[]) +{ + static const char *option_string = "l:o:z:a:s:e:"; + int32_t option=0; + + while ((option = getopt(argc,argv,option_string)) != EOF) { + switch (option) { + case 'l': /*v: volume label */ + if (strlen(optarg) > 512) { + printf("Error: Volume Label should be less than \ + 512 characters\n"); + f2fs_usage(); + } + sprintf((char *)f2fs_params.vol_label, "%s", optarg); + break; + case 'o': + f2fs_params.overprovision = atoi(optarg); + printf("Info: Overprovision ratio = %u%%\n", atoi(optarg)); + break; + case 's': + f2fs_params.segs_per_sec = atoi(optarg); + printf("Info: segments per section = %d\n", atoi(optarg)); + break; + case 'a': + f2fs_params.heap = atoi(optarg); + if (f2fs_params.heap == 0) + printf("Info: Allocate without heap-based policy\n"); + break; + case 'z': + f2fs_params.secs_per_zone = atoi(optarg); + printf("Info: sections per zone = %d\n", atoi(optarg)); + break; + case 'e': + f2fs_params.extension_list = strdup(optarg); + break; + default: + printf("Error: Unknown option %c\n",option); + f2fs_usage(); + break; + } + } + + if ((optind + 1) != argc) { + printf("Error: Device not specified\n"); + f2fs_usage(); + } + + f2fs_params.reserved_segments = + (100 / f2fs_params.overprovision + 5) + * f2fs_params.segs_per_sec; + f2fs_params.device_name = argv[optind]; +} + +/** + * @brief Routine to check if the device is already mounted + * @param None + * @return 0 if device is not mounted + * -1 if already mounted + */ +static int8_t f2fs_is_device_mounted() +{ + FILE *file; + struct mntent *mnt; /* mntent structure to retrieve mount info */ + + if ((file = setmntent(MOUNTED, "r")) == NULL) + return 0; + + while ((mnt = getmntent(file)) != NULL) { + if (!strcmp(f2fs_params.device_name, mnt->mnt_fsname)) { + printf("Error: %s is already mounted\n", + f2fs_params.device_name); + return -1; + } + } + endmntent(file); + return 0; +} + +/** + * @brief Get device info - sector size, number of sectors etc + * @param None + * @return 0 if successfully got device info + */ +static int8_t f2fs_get_device_info() +{ + int32_t fd = 0; + int32_t sector_size; + struct stat stat_buf; + struct hd_geometry geom; + + fd = open(f2fs_params.device_name, O_RDWR); + if (fd < 0) { + printf("\n\tError: Failed to open the device!!!\n"); + return -1; + } + f2fs_params.fd = fd; + + if (fstat(fd, &stat_buf) < 0 ) { + printf("\n\tError: Failed to get the device stat!!!\n"); + return -1; + } + + if (S_ISREG(stat_buf.st_mode)) { + f2fs_params.total_sectors = stat_buf.st_size / + f2fs_params.sector_size; + } + else if (S_ISBLK(stat_buf.st_mode)) { + if (ioctl(fd, BLKSSZGET, §or_size) < 0 ) + printf("\n\tError: Cannot get the sector size!!! \ + Using the default Sector Size\n"); + else { + if (f2fs_params.sector_size < sector_size) { + printf("\n\tError: Cannot set the sector size to: %d" + " as the device does not support" + "\nSetting the sector size to : %d\n", + f2fs_params.sector_size, sector_size); + f2fs_params.sector_size = sector_size; + f2fs_params.sectors_per_blk = PAGE_SIZE / sector_size; + } + } + + if (ioctl(fd, BLKGETSIZE, &f2fs_params.total_sectors) < 0) { + printf("\n\tError: Cannot get the device size\n"); + return -1; + } + + if (ioctl(fd, HDIO_GETGEO, &geom) < 0) { + printf("\n\tError: Cannot get the device geometry\n"); + return -1; + } + f2fs_params.start_sector = geom.start; + } + else { + printf("\n\n\tError: Volume type is not supported!!!\n"); + return -1; + } + + printf("Info: sector size = %u\n", f2fs_params.sector_size); + printf("Info: total sectors = %llu (in 512bytes)\n", f2fs_params.total_sectors); + if (f2fs_params.total_sectors < + (F2FS_MIN_VOLUME_SIZE / DEFAULT_SECTOR_SIZE)) { + printf("Error: Min volume size supported is %d\n", + F2FS_MIN_VOLUME_SIZE); + return -1; + } + + return 0; +} + +const char *media_ext_lists[] = { + "jpg", + "gif", + "png", + "avi", + "divx", + "mp4", + "mp3", + "3gp", + "wmv", + "wma", + "mpeg", + "mkv", + "mov", + "asx", + "asf", + "wmx", + "svi", + "wvx", + "wm", + "mpg", + "mpe", + "rm", + "ogg", + NULL +}; + +static void configure_extension_list(void) +{ + const char **extlist = media_ext_lists; + char *ext_str = f2fs_params.extension_list; + char *ue; + int name_len; + int i = 0; + + super_block.extension_count = 0; + memset(super_block.extension_list, 0, + sizeof(super_block.extension_list)); + + while (*extlist) { + name_len = strlen(*extlist); + memcpy(super_block.extension_list[i++], *extlist, name_len); + extlist++; + } + super_block.extension_count = i - 1; + + if (!ext_str) + return; + + /* add user ext list */ + ue = strtok(ext_str, ","); + while (ue != NULL) { + name_len = strlen(ue); + memcpy(super_block.extension_list[i++], ue, name_len); + ue = strtok(NULL, ","); + if (i > F2FS_MAX_EXTENSION) + break; + } + + super_block.extension_count = i - 1; + + free(f2fs_params.extension_list); +} + + +/** + * @brief It writes buffer to disk or storage meant to be formatted + * with F2FS. + * @param fd File descriptor for device + * @param buf buffer to be written + * @param offset where to bw written on the device + * @param length length of the device + * @return 0 if success + */ +static int writetodisk(int32_t fd, void *buf, u_int64_t offset, size_t length) +{ + if (lseek64(fd, offset, SEEK_SET) < 0) { + printf("\n\tError: While lseek to the derised location!!!\n"); + return -1; + } + + if (write(fd, buf, length) < 0) { + printf("\n\tError: While writing data to the disk!!! Error Num : \ + %d\n", errno); + return -1; + } + + return 0; +} + +/** + * @brief It initialize F2FS super block + * @param None + * @return None + */ +static int f2fs_prepare_super_block(void) +{ + u_int32_t blk_size_bytes; + u_int32_t log_sectorsize, log_sectors_per_block; + u_int32_t log_blocksize, log_blks_per_seg; + u_int32_t segment_size_bytes, zone_size_bytes; + u_int32_t sit_segments; + u_int32_t blocks_for_sit, blocks_for_nat, blocks_for_ssa; + u_int32_t total_valid_blks_available; + u_int64_t zone_align_start_offset, diff, total_meta_segments; + u_int32_t sit_bitmap_size, max_nat_bitmap_size, max_nat_segments; + u_int32_t total_zones; + + super_block.magic = cpu_to_le32(F2FS_SUPER_MAGIC); + super_block.major_ver = cpu_to_le16(F2FS_MAJOR_VERSION); + super_block.minor_ver = cpu_to_le16(F2FS_MINOR_VERSION); + + log_sectorsize = log_base_2(f2fs_params.sector_size); + log_sectors_per_block = log_base_2(f2fs_params.sectors_per_blk); + log_blocksize = log_sectorsize + log_sectors_per_block; + log_blks_per_seg = log_base_2(f2fs_params.blks_per_seg); + + super_block.log_sectorsize = cpu_to_le32(log_sectorsize); + + if (log_sectorsize < 0) { + printf("\n\tError: Failed to get the sector size: %u!\n", + f2fs_params.sector_size); + return -1; + } + + super_block.log_sectors_per_block = cpu_to_le32(log_sectors_per_block); + + if (log_sectors_per_block < 0) { + printf("\n\tError: Failed to get sectors per block: %u!\n", + f2fs_params.sectors_per_blk); + return -1; + } + + super_block.log_blocksize = cpu_to_le32(log_blocksize); + super_block.log_blocks_per_seg = cpu_to_le32(log_blks_per_seg); + + if (log_blks_per_seg < 0) { + printf("\n\tError: Failed to get block per segment: %u!\n", + f2fs_params.blks_per_seg); + return -1; + } + + super_block.segs_per_sec = cpu_to_le32(f2fs_params.segs_per_sec); + super_block.secs_per_zone = cpu_to_le32(f2fs_params.secs_per_zone); + blk_size_bytes = 1 << log_blocksize; + segment_size_bytes = blk_size_bytes * f2fs_params.blks_per_seg; + zone_size_bytes = + blk_size_bytes * f2fs_params.secs_per_zone * + f2fs_params.segs_per_sec * f2fs_params.blks_per_seg; + + super_block.checksum_offset = 0; + + super_block.block_count = cpu_to_le64( + (f2fs_params.total_sectors * DEFAULT_SECTOR_SIZE) / + blk_size_bytes); + + zone_align_start_offset = + (f2fs_params.start_sector * DEFAULT_SECTOR_SIZE + + F2FS_SUPER_OFFSET * F2FS_BLKSIZE + + sizeof(struct f2fs_super_block) * 2 + + zone_size_bytes - 1) / zone_size_bytes * zone_size_bytes - + f2fs_params.start_sector * DEFAULT_SECTOR_SIZE; + + if (f2fs_params.start_sector % DEFAULT_SECTORS_PER_BLOCK) { + printf("WARN: Align start sector number in a unit of pages\n"); + printf("\ti.e., start sector: %d, ofs:%d (sectors per page: %d)\n", + f2fs_params.start_sector, + f2fs_params.start_sector % DEFAULT_SECTORS_PER_BLOCK, + DEFAULT_SECTORS_PER_BLOCK); + } + + super_block.segment_count = cpu_to_le32( + ((f2fs_params.total_sectors * DEFAULT_SECTOR_SIZE) - + zone_align_start_offset) / segment_size_bytes); + + super_block.segment0_blkaddr = + cpu_to_le32(zone_align_start_offset / blk_size_bytes); + + printf("Info: zone aligned segment0 blkaddr: %u\n", + le32_to_cpu(super_block.segment0_blkaddr)); + + super_block.start_segment_checkpoint = super_block.segment0_blkaddr; + super_block.segment_count_ckpt = + cpu_to_le32(F2FS_NUMBER_OF_CHECKPOINT_PACK); + + super_block.sit_blkaddr = cpu_to_le32( + le32_to_cpu(super_block.start_segment_checkpoint) + + (le32_to_cpu(super_block.segment_count_ckpt) * + (1 << log_blks_per_seg))); + + blocks_for_sit = (le32_to_cpu(super_block.segment_count) + + SIT_ENTRY_PER_BLOCK - 1) / SIT_ENTRY_PER_BLOCK; + + sit_segments = (blocks_for_sit + f2fs_params.blks_per_seg - 1) + / f2fs_params.blks_per_seg; + + super_block.segment_count_sit = cpu_to_le32(sit_segments * 2); + + super_block.nat_blkaddr = cpu_to_le32( + le32_to_cpu(super_block.sit_blkaddr) + + (le32_to_cpu(super_block.segment_count_sit) * + f2fs_params.blks_per_seg)); + + total_valid_blks_available = (le32_to_cpu(super_block.segment_count) - + (le32_to_cpu(super_block.segment_count_ckpt) + + le32_to_cpu(super_block.segment_count_sit))) * + f2fs_params.blks_per_seg; + + blocks_for_nat = (total_valid_blks_available + NAT_ENTRY_PER_BLOCK - 1) + / NAT_ENTRY_PER_BLOCK; + + super_block.segment_count_nat = cpu_to_le32( + (blocks_for_nat + f2fs_params.blks_per_seg - 1) / + f2fs_params.blks_per_seg); + /* + * The number of node segments should not be exceeded a "Threshold". + * This number resizes NAT bitmap area in a CP page. + * So the threshold is determined not to overflow one CP page + */ + sit_bitmap_size = ((le32_to_cpu(super_block.segment_count_sit) / 2) << + log_blks_per_seg) / 8; + max_nat_bitmap_size = 4096 - sizeof(struct f2fs_checkpoint) + 1 - + sit_bitmap_size; + max_nat_segments = (max_nat_bitmap_size * 8) >> log_blks_per_seg; + + if (le32_to_cpu(super_block.segment_count_nat) > max_nat_segments) + super_block.segment_count_nat = cpu_to_le32(max_nat_segments); + + super_block.segment_count_nat = cpu_to_le32( + le32_to_cpu(super_block.segment_count_nat) * 2); + + super_block.ssa_blkaddr = cpu_to_le32( + le32_to_cpu(super_block.nat_blkaddr) + + le32_to_cpu(super_block.segment_count_nat) * + f2fs_params.blks_per_seg); + + total_valid_blks_available = (le32_to_cpu(super_block.segment_count) - + (le32_to_cpu(super_block.segment_count_ckpt) + + le32_to_cpu(super_block.segment_count_sit) + + le32_to_cpu(super_block.segment_count_nat))) * + f2fs_params.blks_per_seg; + + blocks_for_ssa = total_valid_blks_available / + f2fs_params.blks_per_seg + 1; + + super_block.segment_count_ssa = cpu_to_le32( + (blocks_for_ssa + f2fs_params.blks_per_seg - 1) / + f2fs_params.blks_per_seg); + + total_meta_segments = le32_to_cpu(super_block.segment_count_ckpt) + + le32_to_cpu(super_block.segment_count_sit) + + le32_to_cpu(super_block.segment_count_nat) + + le32_to_cpu(super_block.segment_count_ssa); + diff = total_meta_segments % (f2fs_params.segs_per_sec * + f2fs_params.secs_per_zone); + if (diff) + super_block.segment_count_ssa = cpu_to_le32( + le32_to_cpu(super_block.segment_count_ssa) + + (f2fs_params.segs_per_sec * f2fs_params.secs_per_zone - + diff)); + + super_block.main_blkaddr = cpu_to_le32( + le32_to_cpu(super_block.ssa_blkaddr) + + (le32_to_cpu(super_block.segment_count_ssa) * + f2fs_params.blks_per_seg)); + + super_block.segment_count_main = cpu_to_le32( + le32_to_cpu(super_block.segment_count) - + (le32_to_cpu(super_block.segment_count_ckpt) + + le32_to_cpu(super_block.segment_count_sit) + + le32_to_cpu(super_block.segment_count_nat) + + le32_to_cpu(super_block.segment_count_ssa))); + + super_block.section_count = cpu_to_le32( + le32_to_cpu(super_block.segment_count_main) + / f2fs_params.segs_per_sec); + + super_block.segment_count_main = cpu_to_le32( + le32_to_cpu(super_block.section_count) * + f2fs_params.segs_per_sec); + + if ((le32_to_cpu(super_block.segment_count_main) - 2) < + f2fs_params.reserved_segments) { + printf("Error: Device size is not sufficient for F2FS volume, \ + more segment needed =%u", + f2fs_params.reserved_segments - + (le32_to_cpu(super_block.segment_count_main) - 2)); + return -1; + } + + super_block.failure_safe_block_distance = 0; + super_block.volume_serial_number = 0; + + ASCIIToUNICODE(super_block.volume_name, f2fs_params.vol_label); + + super_block.node_ino = cpu_to_le32(1); + super_block.meta_ino = cpu_to_le32(2); + super_block.root_ino = cpu_to_le32(3); + + total_zones = ((le32_to_cpu(super_block.segment_count_main) - 1) / + f2fs_params.segs_per_sec) / + f2fs_params.secs_per_zone; + if (total_zones <= 6) { + printf("\n\tError: %d zones: Need more zones \ + by shrinking zone size\n", total_zones); + return -1; + } + + if (f2fs_params.heap) { + f2fs_params.cur_seg[CURSEG_HOT_NODE] = (total_zones - 1) * + f2fs_params.segs_per_sec * + f2fs_params.secs_per_zone + + ((f2fs_params.secs_per_zone - 1) * + f2fs_params.segs_per_sec); + f2fs_params.cur_seg[CURSEG_WARM_NODE] = + f2fs_params.cur_seg[CURSEG_HOT_NODE] - + f2fs_params.segs_per_sec * + f2fs_params.secs_per_zone; + f2fs_params.cur_seg[CURSEG_COLD_NODE] = + f2fs_params.cur_seg[CURSEG_WARM_NODE] - + f2fs_params.segs_per_sec * + f2fs_params.secs_per_zone; + f2fs_params.cur_seg[CURSEG_HOT_DATA] = + f2fs_params.cur_seg[CURSEG_COLD_NODE] - + f2fs_params.segs_per_sec * + f2fs_params.secs_per_zone; + f2fs_params.cur_seg[CURSEG_COLD_DATA] = 0; + f2fs_params.cur_seg[CURSEG_WARM_DATA] = + f2fs_params.cur_seg[CURSEG_COLD_DATA] + + f2fs_params.segs_per_sec * + f2fs_params.secs_per_zone; + } else { + f2fs_params.cur_seg[CURSEG_HOT_NODE] = 0; + f2fs_params.cur_seg[CURSEG_WARM_NODE] = + f2fs_params.cur_seg[CURSEG_HOT_NODE] + + f2fs_params.segs_per_sec * + f2fs_params.secs_per_zone; + f2fs_params.cur_seg[CURSEG_COLD_NODE] = + f2fs_params.cur_seg[CURSEG_WARM_NODE] + + f2fs_params.segs_per_sec * + f2fs_params.secs_per_zone; + f2fs_params.cur_seg[CURSEG_HOT_DATA] = + f2fs_params.cur_seg[CURSEG_COLD_NODE] + + f2fs_params.segs_per_sec * + f2fs_params.secs_per_zone; + f2fs_params.cur_seg[CURSEG_COLD_DATA] = + f2fs_params.cur_seg[CURSEG_HOT_DATA] + + f2fs_params.segs_per_sec * + f2fs_params.secs_per_zone; + f2fs_params.cur_seg[CURSEG_WARM_DATA] = + f2fs_params.cur_seg[CURSEG_COLD_DATA] + + f2fs_params.segs_per_sec * + f2fs_params.secs_per_zone; + } + + configure_extension_list(); + + return 0; +} + +/** + * @brief It initialize SIT Data structure + * @param None + * @return 0 if success + */ +static int8_t f2fs_init_sit_area(void) +{ + u_int32_t blk_size_bytes; + u_int32_t seg_size_bytes; + u_int32_t index = 0; + u_int64_t sit_seg_blk_offset = 0; + u_int8_t *zero_buf = NULL; + + blk_size_bytes = 1 << le32_to_cpu(super_block.log_blocksize); + seg_size_bytes = (1 << le32_to_cpu(super_block.log_blocks_per_seg)) * + blk_size_bytes; + + zero_buf = calloc(sizeof(u_int8_t), seg_size_bytes); + if(zero_buf == NULL) { + printf("\n\tError: Calloc Failed for sit_zero_buf!!!\n"); + return -1; + } + + sit_seg_blk_offset = le32_to_cpu(super_block.sit_blkaddr) * + blk_size_bytes; + + for (index = 0; + index < (le32_to_cpu(super_block.segment_count_sit) / 2); + index++) { + if (writetodisk(f2fs_params.fd, zero_buf, sit_seg_blk_offset, + seg_size_bytes) < 0) { + printf("\n\tError: While zeroing out the sit area \ + on disk!!!\n"); + return -1; + } + sit_seg_blk_offset = sit_seg_blk_offset + seg_size_bytes; + } + + free(zero_buf); + return 0 ; +} + +/** + * @brief It initialize NAT Area + * @param None + * @return 0 if success + */ +static int8_t f2fs_init_nat_area(void) +{ + u_int32_t blk_size_bytes; + u_int32_t seg_size_bytes; + u_int32_t index = 0; + u_int64_t nat_seg_blk_offset = 0; + u_int8_t *nat_buf = NULL; + + blk_size_bytes = 1 << le32_to_cpu(super_block.log_blocksize); + seg_size_bytes = (1 << le32_to_cpu(super_block.log_blocks_per_seg)) * + blk_size_bytes; + + nat_buf = calloc(sizeof(u_int8_t), seg_size_bytes); + if (nat_buf == NULL) { + printf("\n\tError: Calloc Failed for nat_zero_blk!!!\n"); + return -1; + } + + nat_seg_blk_offset = le32_to_cpu(super_block.nat_blkaddr) * + blk_size_bytes; + + for (index = 0; + index < (le32_to_cpu(super_block.segment_count_nat) / 2); + index++) { + if (writetodisk(f2fs_params.fd, nat_buf, nat_seg_blk_offset, + seg_size_bytes) < 0) { + printf("\n\tError: While zeroing out the nat area \ + on disk!!!\n"); + return -1; + } + nat_seg_blk_offset = nat_seg_blk_offset + (2 * seg_size_bytes); + } + + free(nat_buf); + return 0 ; +} + +#define CRCPOLY_LE 0xedb88320 + +unsigned int f2fs_cal_crc32(unsigned int crc, void *buff, unsigned int len) +{ + int i; + unsigned char *p = (unsigned char *)buff; + while (len--) { + crc ^= *p++; + for (i = 0; i < 8; i++) + crc = (crc >> 1) ^ ((crc & 1) ? CRCPOLY_LE : 0); + } + return crc; +} + +/** + * @brief It writes check poiint pack on Check point Area + * @param None + * @return 0 if succes + */ +static int8_t f2fs_write_check_point_pack(void) +{ + struct f2fs_checkpoint *ckp = NULL; + struct f2fs_summary_block *sum = NULL; + u_int32_t blk_size_bytes; + u_int64_t cp_seg_blk_offset = 0; + u_int32_t crc = 0; + int i; + + ckp = calloc(F2FS_CP_BLOCK_SIZE, 1); + if (ckp == NULL) { + printf("\n\tError: Calloc Failed for f2fs_checkpoint!!!\n"); + return -1; + } + + sum = calloc(sizeof(struct f2fs_summary_block), 1); + if (sum == NULL) { + printf("\n\tError: Calloc Failed for summay_node!!!\n"); + return -1; + } + + /* 1. cp page 1 of checkpoint pack 1 */ + ckp->checkpoint_ver = 1; + ckp->cur_node_segno[0] = + cpu_to_le32(f2fs_params.cur_seg[CURSEG_HOT_NODE]); + ckp->cur_node_segno[1] = + cpu_to_le32(f2fs_params.cur_seg[CURSEG_WARM_NODE]); + ckp->cur_node_segno[2] = + cpu_to_le32(f2fs_params.cur_seg[CURSEG_COLD_NODE]); + ckp->cur_data_segno[0] = + cpu_to_le32(f2fs_params.cur_seg[CURSEG_HOT_DATA]); + ckp->cur_data_segno[1] = + cpu_to_le32(f2fs_params.cur_seg[CURSEG_WARM_DATA]); + ckp->cur_data_segno[2] = + cpu_to_le32(f2fs_params.cur_seg[CURSEG_COLD_DATA]); + for (i = 3; i < MAX_ACTIVE_NODE_LOGS; i++) { + ckp->cur_node_segno[i] = 0xffffffff; + ckp->cur_data_segno[i] = 0xffffffff; + } + + ckp->cur_node_blkoff[0] = cpu_to_le16(1); + ckp->nat_upd_blkoff[0] = cpu_to_le16(1); + ckp->cur_data_blkoff[0] = cpu_to_le16(1); + ckp->valid_block_count = cpu_to_le64(2); + ckp->rsvd_segment_count = cpu_to_le32(f2fs_params.reserved_segments); + ckp->overprov_segment_count = cpu_to_le32( + (le32_to_cpu(super_block.segment_count_main) - + le32_to_cpu(ckp->rsvd_segment_count)) * + f2fs_params.overprovision / 100); + ckp->overprov_segment_count = cpu_to_le32( + le32_to_cpu(ckp->overprov_segment_count) + + le32_to_cpu(ckp->rsvd_segment_count)); + + /* main segments - reserved segments - (node + data segments) */ + ckp->free_segment_count = cpu_to_le32( + le32_to_cpu(super_block.segment_count_main) - 6); + ckp->user_block_count = cpu_to_le64( + ((le32_to_cpu(ckp->free_segment_count) + 6 - + le32_to_cpu(ckp->overprov_segment_count)) * + f2fs_params.blks_per_seg)); + ckp->cp_pack_total_block_count = cpu_to_le32(5); + ckp->cp_pack_start_sum = cpu_to_le32(1); + ckp->valid_node_count = cpu_to_le32(1); + ckp->valid_inode_count = cpu_to_le32(1); + ckp->next_free_nid = cpu_to_le32( + le32_to_cpu(super_block.root_ino) + 1); + + ckp->sit_ver_bitmap_bytesize = cpu_to_le32( + ((le32_to_cpu(super_block.segment_count_sit) / 2) << + le32_to_cpu(super_block.log_blocks_per_seg)) / 8); + + ckp->nat_ver_bitmap_bytesize = cpu_to_le32( + ((le32_to_cpu(super_block.segment_count_nat) / 2) << + le32_to_cpu(super_block.log_blocks_per_seg)) / 8); + + ckp->checksum_offset = cpu_to_le32(4092); + + crc = f2fs_cal_crc32(F2FS_SUPER_MAGIC, ckp, + le32_to_cpu(ckp->checksum_offset)); + *((u_int32_t *)((unsigned char *)ckp + + le32_to_cpu(ckp->checksum_offset))) = crc; + + blk_size_bytes = 1 << le32_to_cpu(super_block.log_blocksize); + cp_seg_blk_offset = + le32_to_cpu(super_block.start_segment_checkpoint) * blk_size_bytes; + + if (writetodisk(f2fs_params.fd, ckp, cp_seg_blk_offset, + F2FS_CP_BLOCK_SIZE) < 0) { + printf("\n\tError: While writing the ckp to disk!!!\n"); + return -1; + } + + /* 2. Prepare and write Segment summary for data blocks */ + SET_SUM_TYPE((&sum->footer), SUM_TYPE_DATA); + + sum->entries[0].nid = super_block.root_ino; + sum->entries[0].bidx = 0; + + cp_seg_blk_offset += blk_size_bytes; + if (writetodisk(f2fs_params.fd, sum, cp_seg_blk_offset, + sizeof(struct f2fs_summary_block)) < 0) { + printf("\n\tError: While writing the sum_blk to disk!!!\n"); + return -1; + } + + /* 3. Fill segment summary for data block to zero. */ + memset(sum, 0, sizeof(struct f2fs_summary_block)); + + cp_seg_blk_offset += blk_size_bytes; + if (writetodisk(f2fs_params.fd, sum, cp_seg_blk_offset, + sizeof(struct f2fs_summary_block)) < 0) { + printf("\n\tError: While writing the sum_blk to disk!!!\n"); + return -1; + } + + /* 4. Fill segment summary for data block to zero. */ + memset(sum, 0, sizeof(struct f2fs_summary_block)); + + /* inode sit for root */ + sum->n_sits = cpu_to_le16(6); + sum->sit_j.entries[0].segno = ckp->cur_node_segno[0]; + sum->sit_j.entries[0].se.vblocks = cpu_to_le16((CURSEG_HOT_NODE << 10) | 1); + f2fs_set_bit(0, sum->sit_j.entries[0].se.valid_map); + sum->sit_j.entries[1].segno = ckp->cur_node_segno[1]; + sum->sit_j.entries[1].se.vblocks = cpu_to_le16((CURSEG_WARM_NODE << 10)); + sum->sit_j.entries[2].segno = ckp->cur_node_segno[2]; + sum->sit_j.entries[2].se.vblocks = cpu_to_le16((CURSEG_COLD_NODE << 10)); + + /* data sit for root */ + sum->sit_j.entries[3].segno = ckp->cur_data_segno[0]; + sum->sit_j.entries[3].se.vblocks = cpu_to_le16((CURSEG_HOT_DATA << 10) | 1); + f2fs_set_bit(0, sum->sit_j.entries[3].se.valid_map); + sum->sit_j.entries[4].segno = ckp->cur_data_segno[1]; + sum->sit_j.entries[4].se.vblocks = cpu_to_le16((CURSEG_WARM_DATA << 10)); + sum->sit_j.entries[5].segno = ckp->cur_data_segno[2]; + sum->sit_j.entries[5].se.vblocks = cpu_to_le16((CURSEG_COLD_DATA << 10)); + + cp_seg_blk_offset += blk_size_bytes; + if (writetodisk(f2fs_params.fd, sum, cp_seg_blk_offset, + sizeof(struct f2fs_summary_block)) < 0) { + printf("\n\tError: While writing the sum_blk to disk!!!\n"); + return -1; + } + + /* 5. cp page2 */ + cp_seg_blk_offset += blk_size_bytes; + if (writetodisk(f2fs_params.fd, ckp, cp_seg_blk_offset, + F2FS_CP_BLOCK_SIZE) < 0) { + printf("\n\tError: While writing the ckp to disk!!!\n"); + return -1; + } + + /* 6. cp page 1 of check point pack 2 + * Initiatialize other checkpoint pack with version zero + */ + ckp->checkpoint_ver = 0; + + crc = f2fs_cal_crc32(F2FS_SUPER_MAGIC, ckp, + le32_to_cpu(ckp->checksum_offset)); + *((u_int32_t *)((unsigned char *)ckp + + le32_to_cpu(ckp->checksum_offset))) = crc; + + cp_seg_blk_offset = (le32_to_cpu(super_block.start_segment_checkpoint) + + f2fs_params.blks_per_seg) * + blk_size_bytes; + if (writetodisk(f2fs_params.fd, ckp, + cp_seg_blk_offset, F2FS_CP_BLOCK_SIZE) < 0) { + printf("\n\tError: While writing the ckp to disk!!!\n"); + return -1; + } + + /* 7. */ + memset(sum, 0, sizeof(struct f2fs_summary_block)); + SET_SUM_TYPE((&sum->footer), SUM_TYPE_DATA); + cp_seg_blk_offset += blk_size_bytes; + if (writetodisk(f2fs_params.fd, sum, cp_seg_blk_offset, + sizeof(struct f2fs_summary_block)) < 0) { + printf("\n\tError: While writing the sum_blk to disk!!!\n"); + return -1; + } + + /* 8. */ + memset(sum, 0, sizeof(struct f2fs_summary_block)); + cp_seg_blk_offset += blk_size_bytes; + if (writetodisk(f2fs_params.fd, sum, cp_seg_blk_offset, + sizeof(struct f2fs_summary_block)) < 0) { + printf("\n\tError: While writing the sum_blk to disk!!!\n"); + return -1; + } + + /* 9. */ + memset(sum, 0, sizeof(struct f2fs_summary_block)); + cp_seg_blk_offset += blk_size_bytes; + if (writetodisk(f2fs_params.fd, sum, cp_seg_blk_offset, + sizeof(struct f2fs_summary_block)) < 0) { + printf("\n\tError: While writing the sum_blk to disk!!!\n"); + return -1; + } + + /* 10. cp page 2 of check point pack 2 */ + cp_seg_blk_offset += blk_size_bytes; + if (writetodisk(f2fs_params.fd, ckp, cp_seg_blk_offset, + F2FS_CP_BLOCK_SIZE) < 0) { + printf("\n\tError: While writing the ckp to disk!!!\n"); + return -1; + } + + free(sum) ; + free(ckp) ; + return 0; +} + +/** + * @brief It writes super block on device + * @param None + * @return 0 if success + */ +static int8_t f2fs_write_super_block(void) +{ + u_int32_t index = 0; + u_int64_t super_blk_offset; + u_int8_t *zero_buff; + + zero_buff = calloc(f2fs_params.sector_size, 1); + super_blk_offset = F2FS_SUPER_OFFSET * F2FS_BLKSIZE; + + for (index = 0; index < 2; index++) { + if (writetodisk(f2fs_params.fd, &super_block, super_blk_offset, + sizeof(struct f2fs_super_block)) < 0) { + printf("\n\tError: While while writing supe_blk \ + on disk!!! index : %d\n", index); + return -1; + } + super_blk_offset += F2FS_BLKSIZE; + } + + free(zero_buff); + return 0; +} + +/** + * @brief It initializes and writes root inode on device. + * @param None + * @return 0 if success + */ +static int8_t f2fs_write_root_inode(void) +{ + struct f2fs_node *raw_node = NULL; + u_int32_t blk_size_bytes; + u_int64_t data_blk_nor; + u_int64_t main_area_node_seg_blk_offset = 0; + + raw_node = calloc(sizeof(struct f2fs_node), 1); + if (raw_node == NULL) { + printf("\n\tError: Calloc Failed for raw_node!!!\n"); + return -1; + } + + raw_node->footer.nid = super_block.root_ino; + raw_node->footer.ino = super_block.root_ino; + raw_node->footer.cp_ver = cpu_to_le64(1); + raw_node->footer.next_blkaddr = cpu_to_le32( + le32_to_cpu(super_block.main_blkaddr) + + f2fs_params.cur_seg[CURSEG_HOT_NODE] * + f2fs_params.blks_per_seg + 1); + + raw_node->i.i_mode = cpu_to_le16(0x41ed); + raw_node->i.i_links = cpu_to_le32(2); + raw_node->i.i_uid = cpu_to_le32(getuid()); + raw_node->i.i_gid = cpu_to_le32(getgid()); + + blk_size_bytes = 1 << le32_to_cpu(super_block.log_blocksize); + raw_node->i.i_size = cpu_to_le64(1 * blk_size_bytes); /* dentry */ + raw_node->i.i_blocks = cpu_to_le64(2); + + raw_node->i.i_ctime = cpu_to_le32(time(NULL)); + raw_node->i.i_ctime_nsec = 0; + raw_node->i.i_mtime = cpu_to_le32(time(NULL)); + raw_node->i.i_mtime_nsec = 0; + raw_node->i.i_xattr_nid = 0; + raw_node->i.i_flags = 0; + raw_node->i.current_depth = cpu_to_le32(1); + + data_blk_nor = le32_to_cpu(super_block.main_blkaddr) + + f2fs_params.cur_seg[CURSEG_HOT_DATA] * f2fs_params.blks_per_seg; + raw_node->i.i_addr[0] = cpu_to_le32(data_blk_nor); + + raw_node->i.i_ext.fofs = 0; + raw_node->i.i_ext.blk_addr = cpu_to_le32(data_blk_nor); + raw_node->i.i_ext.len = cpu_to_le32(1); + + main_area_node_seg_blk_offset = le32_to_cpu(super_block.main_blkaddr); + main_area_node_seg_blk_offset += f2fs_params.cur_seg[CURSEG_HOT_NODE] * + f2fs_params.blks_per_seg; + main_area_node_seg_blk_offset *= blk_size_bytes; + + if (writetodisk(f2fs_params.fd, raw_node, main_area_node_seg_blk_offset, + sizeof(struct f2fs_node)) < 0) { + printf("\n\tError: While writing the raw_node to disk!!!\n"); + return -1; + } + + memset(raw_node, 0xff, sizeof(struct f2fs_node)); + + if (writetodisk(f2fs_params.fd, raw_node, + main_area_node_seg_blk_offset + 4096, + sizeof(struct f2fs_node)) < 0) { + printf("\n\tError: While writing the raw_node to disk!!!\n"); + return -1; + } + free(raw_node); + return 0; +} + +/** + * @brief It updates NAT for root Inode + * @param None + * @return 0 if success + */ +static int8_t f2fs_update_nat_root(void) +{ + struct f2fs_nat_block *nat_blk = NULL; + u_int32_t blk_size_bytes; + u_int64_t nat_seg_blk_offset = 0; + + nat_blk = calloc(sizeof(struct f2fs_nat_block), 1); + if(nat_blk == NULL) { + printf("\n\tError: Calloc Failed for nat_blk!!!\n"); + return -1; + } + + /* update root */ + nat_blk->entries[super_block.root_ino].block_addr = cpu_to_le32( + le32_to_cpu(super_block.main_blkaddr) + + f2fs_params.cur_seg[CURSEG_HOT_NODE] * f2fs_params.blks_per_seg); + nat_blk->entries[super_block.root_ino].ino = super_block.root_ino; + + /* update node nat */ + nat_blk->entries[super_block.node_ino].block_addr = cpu_to_le32(1); + nat_blk->entries[super_block.node_ino].ino = super_block.node_ino; + + /* update meta nat */ + nat_blk->entries[super_block.meta_ino].block_addr = cpu_to_le32(1); + nat_blk->entries[super_block.meta_ino].ino = super_block.meta_ino; + + blk_size_bytes = 1 << le32_to_cpu(super_block.log_blocksize); + + nat_seg_blk_offset = le32_to_cpu(super_block.nat_blkaddr) * + blk_size_bytes; + + if (writetodisk(f2fs_params.fd, nat_blk, nat_seg_blk_offset, + sizeof(struct f2fs_nat_block)) < 0) { + printf("\n\tError: While writing the nat_blk set0 to disk!!!\n"); + return -1; + } + + free(nat_blk); + return 0; +} + +/** + * @brief It updates default dentries in Root Inode + * @param None + * @return 0 if success + */ +static int8_t f2fs_add_default_dentry_root(void) +{ + struct f2fs_dentry_block *dent_blk = NULL; + u_int32_t blk_size_bytes; + u_int64_t data_blk_offset = 0; + + dent_blk = calloc(sizeof(struct f2fs_dentry_block), 1); + if(dent_blk == NULL) { + printf("\n\tError: Calloc Failed for dent_blk!!!\n"); + return -1; + } + + dent_blk->dentry[0].hash_code = 0; + dent_blk->dentry[0].ino = super_block.root_ino; + dent_blk->dentry[0].name_len = cpu_to_le16(1); + dent_blk->dentry[0].file_type = F2FS_FT_DIR; + memcpy(dent_blk->filename[0], ".", 1); + + dent_blk->dentry[1].hash_code = 0; + dent_blk->dentry[1].ino = super_block.root_ino; + dent_blk->dentry[1].name_len = cpu_to_le16(2); + dent_blk->dentry[1].file_type = F2FS_FT_DIR; + memcpy(dent_blk->filename[1], "..", 2); + + /* bitmap for . and .. */ + dent_blk->dentry_bitmap[0] = (1 << 1) | (1 << 0); + blk_size_bytes = 1 << le32_to_cpu(super_block.log_blocksize); + data_blk_offset = (le32_to_cpu(super_block.main_blkaddr) + + f2fs_params.cur_seg[CURSEG_HOT_DATA] * + f2fs_params.blks_per_seg) * blk_size_bytes; + + if (writetodisk(f2fs_params.fd, dent_blk, data_blk_offset, + sizeof(struct f2fs_dentry_block)) < 0) { + printf("\n\tError: While writing the dentry_blk to disk!!!\n"); + return -1; + } + + free(dent_blk); + return 0; +} + +/** + * @brief It creates root directory on device. + * @param None + * @return 0 if success + */ +static int8_t f2fs_create_root_dir(void) +{ + int8_t err = 0; + + err = f2fs_write_root_inode(); + if (err < 0) { + printf("\n\tError: Failed to write root inode!!!\n"); + goto exit; + } + + err = f2fs_update_nat_root(); + if (err < 0) { + printf("\n\tError: Failed to update NAT for root!!!\n"); + goto exit; + } + + err = f2fs_add_default_dentry_root(); + if (err < 0) { + printf("\n\tError: Failed to add default dentries for root!!!\n"); + goto exit; + } +exit: + if (err) + printf("\n\tError: Could not create the root directory!!!\n"); + + return err; +} + +int f2fs_trim_device() +{ + unsigned long long range[2]; + struct stat stat_buf; + + range[0] = 0; + range[1] = f2fs_params.total_sectors * DEFAULT_SECTOR_SIZE; + + if (fstat(f2fs_params.fd, &stat_buf) < 0 ) { + printf("\n\tError: Failed to get the device stat!!!\n"); + return -1; + } + + if (S_ISREG(stat_buf.st_mode)) + return 0; + else if (S_ISBLK(stat_buf.st_mode)) { + if (ioctl(f2fs_params.fd, BLKDISCARD, &range) < 0) + printf("Info: This device doesn't support TRIM\n"); + } else + return -1; + return 0; +} + +/** + * @brief It s a routine to fromat device with F2FS on-disk layout + * @param None + * @return 0 if success + */ +static int8_t f2fs_format_device(void) +{ + int8_t err = 0; + + err= f2fs_prepare_super_block(); + if (err < 0) + goto exit; + + err = f2fs_trim_device(); + if (err < 0) { + printf("\n\tError: Failed to trim whole device!!!\n"); + goto exit; + } + + err = f2fs_init_sit_area(); + if (err < 0) { + printf("\n\tError: Failed to Initialise the SIT AREA!!!\n"); + goto exit; + } + + err = f2fs_init_nat_area(); + if (err < 0) { + printf("\n\tError: Failed to Initialise the NAT AREA!!!\n"); + goto exit; + } + + err = f2fs_create_root_dir(); + if (err < 0) { + printf("\n\tError: Failed to create the root directory!!!\n"); + goto exit; + } + + err = f2fs_write_check_point_pack(); + if (err < 0) { + printf("\n\tError: Failed to write the check point pack!!!\n"); + goto exit; + } + + err = f2fs_write_super_block(); + if (err < 0) { + printf("\n\tError: Failed to write the Super Block!!!\n"); + goto exit; + } +exit: + if (err) + printf("\n\tError: Could not format the device!!!\n"); + + /* + * We should call fsync() to flush out all the dirty pages + * in the block device page cache. + */ + if (fsync(f2fs_params.fd) < 0) + printf("\n\tError: Could not conduct fsync!!!\n"); + + if (close(f2fs_params.fd) < 0) + printf("\n\tError: Failed to close device file!!!\n"); + + return err; +} + +/** + * @brief main function of F2Fs utility + * @param argc count of argument + * @param argv array of arguments + * @return 0 if success + */ +int main(int argc, char *argv[]) +{ + f2fs_init_global_parameters(); + + f2fs_parse_options(argc, argv); + + if (f2fs_is_device_mounted() < 0) + return -1; + + if (f2fs_get_device_info() < 0) + return -1; + + if (f2fs_format_device() < 0) + return -1; + + printf("Info: format successful\n"); + + return 0; +} diff --git a/mkfs/f2fs_format.h b/mkfs/f2fs_format.h new file mode 100644 index 0000000..ed3c525 --- /dev/null +++ b/mkfs/f2fs_format.h @@ -0,0 +1,398 @@ +/** + * f2fs_format.h + * + * Copyright (c) 2012 Samsung Electronics Co., Ltd. + * http://www.samsung.com/ + * + * This program is free software; you can redistribute it and/or modify + * it under the terms of the GNU General Public License version 2 as + * published by the Free Software Foundation. + */ +#ifndef __F2FS_FORMAT_H__ +#define __F2FS_FORMAT_H__ + +#include +#include +#include + +#if __BYTE_ORDER == __LITTLE_ENDIAN +#define le16_to_cpu(x) ((__u16)(x)) +#define le32_to_cpu(x) ((__u32)(x)) +#define le64_to_cpu(x) ((__u64)(x)) +#define cpu_to_le16(x) ((__u16)(x)) +#define cpu_to_le32(x) ((__u32)(x)) +#define cpu_to_le64(x) ((__u64)(x)) +#elif __BYTE_ORDER == __BIG_ENDIAN +#define le16_to_cpu(x) bswap_16(x) +#define le32_to_cpu(x) bswap_32(x) +#define le64_to_cpu(x) bswap_64(x) +#define cpu_to_le16(x) bswap_16(x) +#define cpu_to_le32(x) bswap_32(x) +#define cpu_to_le64(x) bswap_64(x) +#endif + +/* these are defined in kernel */ +#define PAGE_SIZE 4096 +#define PAGE_CACHE_SIZE 4096 +#define BITS_PER_BYTE 8 + +/* for mkfs */ +#define F2FS_MIN_VOLUME_SIZE 104857600 + +#define F2FS_MAJOR_VERSION 1 +#define F2FS_MINOR_VERSION 0 + +#define F2FS_O_DIRECTORY 0x00004000 +#define F2FS_O_EONLY 0x00000040 +#define F2FS_O_WRONLY 0x00000080 +#define F2FS_O_RDONLY 0x00000100 + +#define F2FS_NUMBER_OF_CHECKPOINT_PACK 2 + +#define DEFAULT_SECTOR_SIZE 512 +#define DEFAULT_SECTORS_PER_BLOCK 8 +#define DEFAULT_BLOCKS_PER_SEGMENT 512 +#define DEFAULT_SEGMENTS_PER_SECTION 1 +#define F2FS_CP_BLOCK_SIZE (DEFAULT_SECTOR_SIZE * \ + DEFAULT_SECTORS_PER_BLOCK) + +#define MAX_ACTIVE_LOGS 16 +#define MAX_ACTIVE_NODE_LOGS 8 +#define MAX_ACTIVE_DATA_LOGS 8 + +struct f2fs_global_parameters { + u_int32_t sector_size; + u_int32_t reserved_segments; + u_int32_t overprovision; + u_int32_t cur_seg[6]; + u_int32_t segs_per_sec; + u_int32_t secs_per_zone; + u_int32_t start_sector; + u_int64_t total_sectors; + u_int32_t sectors_per_blk; + u_int32_t blks_per_seg; + u_int8_t vol_label[16]; + int heap; + int32_t fd; + char *device_name; + char *extension_list; +} __attribute__((packed)); + +#ifdef CONFIG_64BIT +#define BITS_PER_LONG 64 +#else +#define BITS_PER_LONG 32 +#endif + +#define BIT_MASK(nr) (1 << (nr % BITS_PER_LONG)) +#define BIT_WORD(nr) (nr / BITS_PER_LONG) + +/* + * For superblock + */ +#define F2FS_SUPER_MAGIC 0xF2F52010 /* F2FS Magic Number */ +#define F2FS_SUPER_OFFSET 0 /* start sector # for sb */ +#define F2FS_BLKSIZE 4096 +#define F2FS_MAX_EXTENSION 64 + +struct f2fs_super_block { + __le32 magic; /* Magic Number */ + __le16 major_ver; /* Major Version */ + __le16 minor_ver; /* Minor Version */ + __le32 log_sectorsize; /* log2 (Sector size in bytes) */ + __le32 log_sectors_per_block; /* log2 (Number of sectors per block */ + __le32 log_blocksize; /* log2 (Block size in bytes) */ + __le32 log_blocks_per_seg; /* log2 (Number of blocks per segment) */ + __le32 segs_per_sec; /* log2 (Number of segments per section) */ + __le32 secs_per_zone; /* Number of sections per zone) */ + __le32 checksum_offset; /* Checksum position in this super block */ + __le64 block_count; /* Total number of blocks */ + __le32 section_count; /* Total number of sections */ + __le32 segment_count; /* Total number of segments */ + __le32 segment_count_ckpt; /* Total number of segments + in Checkpoint area */ + __le32 segment_count_sit; /* Total number of segments + in Segment information table */ + __le32 segment_count_nat; /* Total number of segments + in Node address table */ + /*Total number of segments in Segment summary area */ + __le32 segment_count_ssa; + /* Total number of segments in Main area */ + __le32 segment_count_main; + __le32 failure_safe_block_distance; + __le32 segment0_blkaddr; /* Start block address of Segment 0 */ + __le32 start_segment_checkpoint; /* Start block address of ckpt */ + __le32 sit_blkaddr; /* Start block address of SIT */ + __le32 nat_blkaddr; /* Start block address of NAT */ + __le32 ssa_blkaddr; /* Start block address of SSA */ + __le32 main_blkaddr; /* Start block address of Main area */ + __le32 root_ino; /* Root directory inode number */ + __le32 node_ino; /* node inode number */ + __le32 meta_ino; /* meta inode number */ + __le32 volume_serial_number; /* VSN is optional field */ + __le16 volume_name[512]; /* Volume Name */ + __le32 extension_count; + __u8 extension_list[F2FS_MAX_EXTENSION][8]; /* extension array */ +} __attribute__((packed)); + +/* + * For checkpoint + */ +struct f2fs_checkpoint { + __le64 checkpoint_ver; /* Checkpoint block version number */ + __le64 user_block_count; /* # of user blocks */ + __le64 valid_block_count; /* # of valid blocks in Main area */ + __le32 rsvd_segment_count; /* # of reserved segments for gc */ + __le32 overprov_segment_count; /* # of overprovision segments */ + __le32 free_segment_count; /* # of free segments in Main area */ + + /* information of current node segments */ + __le32 cur_node_segno[MAX_ACTIVE_NODE_LOGS]; + __le16 cur_node_blkoff[MAX_ACTIVE_NODE_LOGS]; + __le16 nat_upd_blkoff[MAX_ACTIVE_NODE_LOGS]; + /* information of current data segments */ + __le32 cur_data_segno[MAX_ACTIVE_DATA_LOGS]; + __le16 cur_data_blkoff[MAX_ACTIVE_DATA_LOGS]; + __le32 ckpt_flags; /* Flags : umount and journal_present */ + __le32 cp_pack_total_block_count; + __le32 cp_pack_start_sum; /* start block number of data summary */ + __le32 valid_node_count; /* Total number of valid nodes */ + __le32 valid_inode_count; /* Total number of valid inodes */ + __le32 next_free_nid; /* Next free node number */ + __le32 sit_ver_bitmap_bytesize; /* Default value 64 */ + __le32 nat_ver_bitmap_bytesize; /* Default value 256 */ + __le32 checksum_offset; /* Checksum position + in this checkpoint block */ + __le64 elapsed_time; /* elapsed time while partition + is mounted */ + /* allocation type of current segment */ + unsigned char alloc_type[MAX_ACTIVE_LOGS]; + + /* SIt and NAT version bitmap */ + unsigned char sit_nat_version_bitmap[1]; +} __attribute__((packed)); + +/* + * For NODE structure + */ +struct f2fs_extent { + __le32 fofs; + __le32 blk_addr; + __le32 len; +} __attribute__((packed)); + +#define F2FS_MAX_NAME_LEN 256 +#define ADDRS_PER_INODE 927 /* Address Pointers in an Inode */ +#define ADDRS_PER_BLOCK 1018 /* Address Pointers in a Direct Block */ +#define NIDS_PER_BLOCK 1018 /* Node IDs in an Indirect Block */ + +struct f2fs_inode { + __le16 i_mode; /* File mode */ + __u8 i_advise; /* File hints */ + __u8 i_reserved; /* Reserved */ + __le32 i_uid; /* User ID */ + __le32 i_gid; /* Group ID */ + __le32 i_links; /* Links count */ + __le64 i_size; /* File size in bytes */ + __le64 i_blocks; /* File size in bytes */ + __le64 i_ctime; /* inode Change time */ + __le64 i_mtime; /* Modification time */ + __le32 i_ctime_nsec; + __le32 i_mtime_nsec; + __le32 current_depth; + __le32 i_xattr_nid; + __le32 i_flags; /* file attributes */ + __le32 i_pino; /* parent inode number */ + __le32 i_namelen; /* file name length */ + __u8 i_name[F2FS_MAX_NAME_LEN]; /* file name for SPOR */ + + struct f2fs_extent i_ext; /* caching a largest extent */ + + __le32 i_addr[ADDRS_PER_INODE]; /* Pointers to data blocks */ + + __le32 i_nid[5]; /* direct(2), indirect(2), + double_indirect(1) node id */ +} __attribute__((packed)); + +struct direct_node { + __le32 addr[ADDRS_PER_BLOCK]; /* aray of data block address */ +} __attribute__((packed)); + +struct indirect_node { + __le32 nid[NIDS_PER_BLOCK]; /* aray of data block address */ +} __attribute__((packed)); + +struct node_footer { + __le32 nid; /* node id */ + __le32 ino; /* iNode no */ + __le32 flag; /* include cold/fsync/dentry marks and offset */ + __le64 cp_ver; /* checkpoint version */ + __le32 next_blkaddr; /* next node page block address */ +} __attribute__((packed)); + +struct f2fs_node { + union { + struct f2fs_inode i; + struct direct_node dn; + struct indirect_node in; + }; + struct node_footer footer; +} __attribute__((packed)); + +/* + * For NAT entries + */ +#define NAT_ENTRY_PER_BLOCK (PAGE_CACHE_SIZE / sizeof(struct f2fs_nat_entry)) + +struct f2fs_nat_entry { + __u8 version; + __le32 ino; + __le32 block_addr; +} __attribute__((packed)); + +struct f2fs_nat_block { + struct f2fs_nat_entry entries[NAT_ENTRY_PER_BLOCK]; +} __attribute__((packed)); + +/* + * For SIT entries + */ +#define CURSEG_NULL ((-1 << 10) >> 10) /* use 6bit - 0x3f */ +enum { + CURSEG_HOT_DATA, /* directory entry pages */ + CURSEG_WARM_DATA, /* updated or appended user data pages */ + CURSEG_COLD_DATA, /* multimedia or GCed data pages */ + CURSEG_HOT_NODE, /* node pages to save index of directory entry pages */ + CURSEG_WARM_NODE, /* node pages to save index of user data pages */ + CURSEG_COLD_NODE, /* node page to save indirect node index */ +}; + +#define SIT_VBLOCK_MAP_SIZE 64 +#define SIT_ENTRY_PER_BLOCK (PAGE_CACHE_SIZE / sizeof(struct f2fs_sit_entry)) + +struct f2fs_sit_entry { + __le16 vblocks; + __u8 valid_map[SIT_VBLOCK_MAP_SIZE]; + __le64 mtime; +} __attribute__((packed)); + +struct f2fs_sit_block { + struct f2fs_sit_entry entries[SIT_ENTRY_PER_BLOCK]; +} __attribute__((packed)); + +struct f2fs_summary { + __le32 nid; /* parent node id */ + union { + __u8 reserved[3]; + struct { + __u8 version; /* node version number */ + __le16 bidx; /* block index in parent node */ + } __attribute__((packed)); + }; +} __attribute__((packed)); + +struct summary_footer { + unsigned char entry_type; + __u32 check_sum; +} __attribute__((packed)); + +#define SUM_TYPE_NODE (1) +#define SUM_TYPE_DATA (0) +#define GET_SUM_TYPE(footer) (footer->entry_type) +#define SET_SUM_TYPE(footer, type) (footer->entry_type = type) + +#define SUMMARY_SIZE (sizeof(struct f2fs_summary)) +#define SUM_FOOTER_SIZE (sizeof(struct summary_footer)) +#define ENTRIES_IN_SUM 512 +#define SUM_ENTRY_SIZE (SUMMARY_SIZE * ENTRIES_IN_SUM) +#define SUM_JOURNAL_SIZE (PAGE_CACHE_SIZE - SUM_FOOTER_SIZE -\ + SUM_ENTRY_SIZE) + +struct nat_journal_entry { + __le32 nid; + struct f2fs_nat_entry ne; +} __attribute__((packed)); + +struct sit_journal_entry { + __le32 segno; + struct f2fs_sit_entry se; +} __attribute__((packed)); + +#define NAT_JOURNAL_ENTRIES ((SUM_JOURNAL_SIZE - 2) /\ + sizeof(struct nat_journal_entry)) +#define NAT_JOURNAL_RESERVED ((SUM_JOURNAL_SIZE - 2) %\ + sizeof(struct nat_journal_entry)) +#define SIT_JOURNAL_ENTRIES ((SUM_JOURNAL_SIZE - 2) /\ + sizeof(struct sit_journal_entry)) +#define SIT_JOURNAL_RESERVED ((SUM_JOURNAL_SIZE - 2) %\ + sizeof(struct sit_journal_entry)) +enum { + NAT_JOURNAL = 0, + SIT_JOURNAL +}; + +struct nat_journal { + struct nat_journal_entry entries[NAT_JOURNAL_ENTRIES]; + __u8 reserved[NAT_JOURNAL_RESERVED]; +} __attribute__((packed)); + +struct sit_journal { + struct sit_journal_entry entries[SIT_JOURNAL_ENTRIES]; + __u8 reserved[SIT_JOURNAL_RESERVED]; +} __attribute__((packed)); + +struct f2fs_summary_block { + struct f2fs_summary entries[ENTRIES_IN_SUM]; + union { + __le16 n_nats; + __le16 n_sits; + }; + union { + struct nat_journal nat_j; + struct sit_journal sit_j; + }; + struct summary_footer footer; +} __attribute__((packed)); + +/* + * For directory operations + */ +#define F2FS_NAME_LEN 8 /* 256 Unicode */ +#define NR_DENTRY_IN_BLOCK 214 /* the number of dentry in a block */ +#define MAX_DIR_HASH_DEPTH 63 /* MAX level for dir lookup */ + +#define SIZE_OF_DIR_ENTRY 11 /* by byte */ +#define SIZE_OF_DENTRY_BITMAP ((NR_DENTRY_IN_BLOCK + BITS_PER_BYTE - 1) / \ + BITS_PER_BYTE) +#define SIZE_OF_RESERVED (PAGE_SIZE - ((SIZE_OF_DIR_ENTRY + \ + F2FS_NAME_LEN) * \ + NR_DENTRY_IN_BLOCK + SIZE_OF_DENTRY_BITMAP)) + +struct f2fs_dir_entry { + __le32 hash_code; /* hash code of file name */ + __le32 ino; /* node number of inode */ + __le16 name_len; /* the size of file name + * length in unicode characters */ + __u8 file_type; +} __attribute__((packed)); + +struct f2fs_dentry_block { + __u8 dentry_bitmap[SIZE_OF_DENTRY_BITMAP]; + __u8 reserved[SIZE_OF_RESERVED]; + struct f2fs_dir_entry dentry[NR_DENTRY_IN_BLOCK]; + __u8 filename[NR_DENTRY_IN_BLOCK][F2FS_NAME_LEN]; +} __attribute__((packed)); + +enum { + F2FS_FT_UNKNOWN, + F2FS_FT_REG_FILE, + F2FS_FT_DIR, + F2FS_FT_CHRDEV, + F2FS_FT_BLKDEV, + F2FS_FT_FIFO, + F2FS_FT_SOCK, + F2FS_FT_SYMLINK, + F2FS_FT_MAX +}; + +#endif //__F2FS_FORMAT_H__